svn: /phpdoc/en/trunk/reference/mongo/ functions/bson-decode.xml functions/bson-encode.xml mongocursor/snapshot.xml versions.xml

From: Date: Tue, 06 Oct 2009 21:57:24 +0000
Subject: svn: /phpdoc/en/trunk/reference/mongo/ functions/bson-decode.xml functions/bson-encode.xml mongocursor/snapshot.xml versions.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-5081@lists.php.net to get a copy of this message
kristina Tue, 06 Oct 2009 21:57:24 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=289263 Log: added bson encode/decode functions Changed paths: A phpdoc/en/trunk/reference/mongo/functions/ A phpdoc/en/trunk/reference/mongo/functions/bson-decode.xml A phpdoc/en/trunk/reference/mongo/functions/bson-encode.xml A phpdoc/en/trunk/reference/mongo/mongocursor/snapshot.xml U phpdoc/en/trunk/reference/mongo/versions.xml Added: phpdoc/en/trunk/reference/mongo/functions/bson-decode.xml =================================================================== --- phpdoc/en/trunk/reference/mongo/functions/bson-decode.xml (rev 0) +++ phpdoc/en/trunk/reference/mongo/functions/bson-decode.xml 2009-10-06 21:57:24 UTC (rev 289263) @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- $Revision: 288721 $ --> +<refentry xml:id="function.bson-decode" xmlns="http://docbook.org/ns/docbook"> + <refnamediv> + <refname>bson_decode</refname> + <refpurpose>Deserializes a BSON object into a PHP array</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>array</type><methodname>bson_decode</methodname> + <methodparam><type>string</type><parameter>bson</parameter></methodparam> + </methodsynopsis> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>bson</parameter></term> + <listitem> + <para> + The BSON to be deserialized. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the deserialized BSON object. + </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 +--> Added: phpdoc/en/trunk/reference/mongo/functions/bson-encode.xml =================================================================== --- phpdoc/en/trunk/reference/mongo/functions/bson-encode.xml (rev 0) +++ phpdoc/en/trunk/reference/mongo/functions/bson-encode.xml 2009-10-06 21:57:24 UTC (rev 289263) @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- $Revision: 288721 $ --> +<refentry xml:id="function.bson-encode" xmlns="http://docbook.org/ns/docbook"> + <refnamediv> + <refname>bson_encode</refname> + <refpurpose>Serializes a PHP variable into a BSON string</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>bson_encode</methodname> + <methodparam><type>mixed</type><parameter>anything</parameter></methodparam> + </methodsynopsis> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>anything</parameter></term> + <listitem> + <para> + The variable to be serialized. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the serialized string. + </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 +--> Added: phpdoc/en/trunk/reference/mongo/mongocursor/snapshot.xml =================================================================== --- phpdoc/en/trunk/reference/mongo/mongocursor/snapshot.xml (rev 0) +++ phpdoc/en/trunk/reference/mongo/mongocursor/snapshot.xml 2009-10-06 21:57:24 UTC (rev 289263) @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="utf-8"?> + +<!-- $Revision: $ --> +<refentry xml:id="mongocursor.snapshot" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>MongoCursor::snapshot</refname> + <refpurpose>Use snapshot mode for the query</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>MongoCursor</type><methodname>MongoCursor::snapshot</methodname> + <void/> + </methodsynopsis> + <para> + Use snapshot mode for the query. Snapshot mode assures no duplicates are returned, + or objects missed, which were present at both the start and end of the query's + execution (if an object is new during the query, or deleted during the query, it + may or may not be returned, even with snapshot mode). + </para> + <para> + Note that short query responses (less than 1MB) are always effectively snapshotted. + </para> + <para> + Currently, snapshot mode may not be used with sorting or explicit hints. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns this cursor. + </para> + </refsect1> + + <refsect1 role="errors"> + &reftitle.errors; + <para> + Throws MongoCursorException if this cursor has started iterating. + </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 +sgml-parent-document:nil +sgml-default-dtd-file:"../../../../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 +--> Modified: phpdoc/en/trunk/reference/mongo/versions.xml =================================================================== --- phpdoc/en/trunk/reference/mongo/versions.xml 2009-10-06 21:41:53 UTC (rev 289262) +++ phpdoc/en/trunk/reference/mongo/versions.xml 2009-10-06 21:57:24 UTC (rev 289263) @@ -4,6 +4,8 @@ Do NOT translate this file --> <versions> + <function name='bson_encode' from='PECL mongo &gt;=1.0.0'/> + <function name='bson_decode' from='PECL mongo &gt;=1.0.0'/> <!-- Methods --> <!-- Mongo --> <function name='mongo::__construct' from='PECL mongo &gt;=0.9.0'/>

« previous php.doc.cvs (#5081) next »