added mongoid::__set_state docs

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@299361 c90b9560-bf6c-de11-be94-00142212c4b1

reference/mongo/mongoid/setstate.xml

@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="mongoid.setstate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>MongoId::__set_state</refname>
+  <refpurpose>Create a dummy MongoId</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier><modifier>static</modifier><type>MongoId</type><methodname>MongoId::__set_state</methodname>
+   <methodparam><type>array</type><parameter>props</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   This function is only used by PHP internally, it shouldn't need to ever be
+   called by the user.
+  </para>
+  <para>
+   It is identical to the function:
+  </para>
+  <programlisting role="php">
+<![CDATA[
+<?php
+
+public static function __set_state($props) {
+    return new MongoId("000000000000000000000000");
+}
+
+?>
+]]>
+  </programlisting>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term>
+      <parameter>props</parameter>
+     </term>
+     <listitem>
+      <para>
+       Theoretically, an array of properties used to create the new id.  
+       However, as MongoId instances have no properties, this is not used.
+      </para>
+     </listitem>
+    </varlistentry>   
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   A new id with the value "000000000000000000000000".
+  </para>
+ </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
+-->

reference/mongo/versions.xml

@@ -119,6 +119,7 @@
  <function name='mongoid::__construct' from='PECL mongo &gt;= 0.8.0'/>
  <function name='mongoid::getTimestamp' from='PECL mongo &gt;= 1.0.1'/>
  <function name='mongoid::__tostring' from='PECL mongo &gt;= 0.8.0'/>
+ <function name='mongoid::__set_state' from='PECL mongo &gt;= 1.0.8'/>
  <!-- MongoRegex -->
  <function name='mongoregex::__construct' from='PECL mongo &gt;= 0.8.1'/>
  <function name='mongoregex::__tostring' from='PECL mongo &gt;= 0.8.1'/>