Files
doc-fr/reference/mongodb/functions/bson/fromphp.xml
Bruno Veyckemans b75f80928a Fix past participle agreements and cryptographic terminology.
Closes GH-12

Signed-off-by: George Peter Banyard <girgias@php.net>
2021-01-26 19:19:49 +00:00

116 lines
3.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53242ee6628dc1ae6989fe002231fddfd8f005c6 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mongodb.bson-fromphp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\BSON\fromPHP</refname>
<refpurpose>Retourne la représentation BSON d'une valeur PHP</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>MongoDB\BSON\fromPHP</methodname>
<methodparam><type class="union"><type>array</type><type>object</type></type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Sérialise un tableau ou objet PHP (par exemple document) en sa
représentation <link xlink:href="&url.mongodb.docs.bson;">BSON</link>.
La chaîne binaire retourné décrira un document BSON.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>value</parameter> (<type class="union"><type>array</type><type>object</type></type>)</term>
<listitem>
<para>
La valeur PHP à sérialiser.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Le document BSON sérialisé en tant que chaîne binaire.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
<member>
Lance
<classname>MongoDB\Driver\Exception\UnexpectedValueException</classname> si
la valeur PHP ne peut pas être convertie en BSON. Les raisons possibles incluent,
mais sans s'y limiter à, rencontrer une instance inattendue de
<interfacename>MongoDB\BSON\Type</interfacename> ou
<function>MongoDB\BSON\Serializable::bsonSerialize</function> échouant de
retourner un &array; ou une <classname>stdClass</classname>.
</member>
</simplelist>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemple avec <function>MongoDB\BSON\fromPHP</function></title>
<programlisting role="php">
<![CDATA[
<?php
$bson = MongoDB\BSON\fromPHP(['foo' => 1]);
echo bin2hex($bson), "\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
0e00000010666f6f000100000000cat
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>MongoDB\BSON\toPHP</function></member>
<member><link xlink:href="&url.mongodb.docs.bson;">MongoDB BSON</link></member>
<member><xref linkend="mongodb.persistence"/></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->