php-doc-en/reference/mongodb/bson/javascript/unserialize.xml

80 lines
2.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mongodb-bson-javascript.unserialize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\BSON\Javascript::unserialize</refname>
<refpurpose>Unserialize a Javascript</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>MongoDB\BSON\Javascript::unserialize</methodname>
<methodparam><type>string</type><parameter>serialized</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>serialized</parameter></term>
<listitem>
<para>
The serialized <classname>MongoDB\BSON\Javascript</classname>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the unserialized <classname>MongoDB\BSON\Javascript</classname>.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
&mongodb.throws.argumentparsing;
<member>Throws <classname>MongoDB\Driver\Exception\UnexpectedValueException</classname> if the properties cannot be unserialized (i.e. <parameter>serialized</parameter> was malformed).</member>
<member>Throws <classname>MongoDB\Driver\Exception\InvalidArgumentException</classname> if the properties are invalid (e.g. missing fields or invalid values).</member>
</simplelist>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>MongoDB\BSON\Javascript::serialize</methodname></member>
<member><function>unserialize</function></member>
<member><link linkend="language.oop5.serialization">Serializing Objects</link></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
-->