mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-29 07:18:55 +00:00
0f19fd56d9
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343960 c90b9560-bf6c-de11-be94-00142212c4b1
127 lines
3.2 KiB
XML
127 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="mongodb-bson-unserializable.bsonunserialize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>MongoDB\BSON\Unserializable::bsonUnserialize</refname>
|
|
<refpurpose>Constructs the object from a BSON array or document</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>abstract</modifier> <modifier>public</modifier> <type>void</type><methodname>MongoDB\BSON\Unserializable::bsonUnserialize</methodname>
|
|
<methodparam><type>array</type><parameter>data</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Called during unserialization of the object from BSON. The properties of the
|
|
BSON array or document will be passed to the method as an <type>array</type>.
|
|
</para>
|
|
<para>
|
|
Remember to check for an <property>_id</property> property when handling data
|
|
from a BSON document.
|
|
</para>
|
|
<note>
|
|
<simpara>
|
|
This method acts as the
|
|
<link linkend="language.oop5.decon.constructor">constructor</link> of the
|
|
object. The <link linkend="object.construct">__construct()</link> method
|
|
will <emphasis>not</emphasis> be called after this method.
|
|
</simpara>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>data</parameter> (<type>array</type>)</term>
|
|
<listitem>
|
|
<para>
|
|
Properties within the BSON array or document.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The return value from this method is ignored.
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>MongoDB\BSON\Unserializable::bsonUnserialize</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
class MyDocument implements MongoDB\BSON\Unserializable
|
|
{
|
|
private $data = [];
|
|
|
|
function bsonUnserialize(array $data)
|
|
{
|
|
$this->data = $data;
|
|
}
|
|
}
|
|
|
|
$bson = MongoDB\BSON\fromJSON('{ "foo": "bar" }');
|
|
$value = MongoDB\BSON\toPHP($bson, ['root' => 'MyDocument']);
|
|
var_dump($value);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
object(MyDocument)#1 (1) {
|
|
["data":"MyDocument":private]=>
|
|
array(1) {
|
|
["foo"]=>
|
|
string(3) "bar"
|
|
}
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>MongoDB\BSON\Serializable::bsonSerialize</function></member>
|
|
<member><interfacename>MongoDB\BSON\Persistable</interfacename></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
|
|
-->
|