mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 08:58:56 +00:00
Document MongoResultException and adjust the version info
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328208 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson
parent
24e0d9472e
commit
d2a496cb22
4 changed files with 201 additions and 17 deletions
|
|
@ -32,6 +32,7 @@ $ sudo update-rc.d umountnfs.sh stop 15 0 6 .
|
|||
</partintro>
|
||||
|
||||
&reference.mongo.mongoexception;
|
||||
&reference.mongo.mongoresultexception;
|
||||
&reference.mongo.mongocursorexception;
|
||||
&reference.mongo.mongocursortimeoutexception;
|
||||
&reference.mongo.mongoconnectionexception;
|
||||
|
|
|
|||
103
reference/mongo/mongoresultexception.xml
Normal file
103
reference/mongo/mongoresultexception.xml
Normal file
|
|
@ -0,0 +1,103 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<phpdoc:classref xml:id="class.mongoresultexception" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
|
||||
<title>The MongoResultException class</title>
|
||||
<titleabbrev>MongoResultException</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
|
||||
<!-- {{{ MongoResultException intro -->
|
||||
<section xml:id="mongoresultexception.intro">
|
||||
&reftitle.intro;
|
||||
<para>
|
||||
The MongoResultException is thrown by several command helpers (such as
|
||||
<methodname>MongoCollection::findAndModify</methodname>) in the event of
|
||||
failure. The original result document is available through
|
||||
<methodname>MongoResultException::getDocument</methodname>.
|
||||
</para>
|
||||
</section>
|
||||
<!-- }}} -->
|
||||
|
||||
<section xml:id="mongoresultexception.synopsis">
|
||||
&reftitle.classsynopsis;
|
||||
|
||||
<!-- {{{ Synopsis -->
|
||||
<classsynopsis>
|
||||
<ooclass><classname>MongoResultException</classname></ooclass>
|
||||
|
||||
<!-- {{{ Class synopsis -->
|
||||
<classsynopsisinfo>
|
||||
<ooclass>
|
||||
<classname>MongoResultException</classname>
|
||||
</ooclass>
|
||||
|
||||
<ooclass>
|
||||
<modifier>extends</modifier>
|
||||
<classname>MongoException</classname>
|
||||
</ooclass>
|
||||
</classsynopsisinfo>
|
||||
<!-- }}} -->
|
||||
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
|
||||
<fieldsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<varname linkend="mongoresultexception.props.document">document</varname>
|
||||
</fieldsynopsis>
|
||||
|
||||
|
||||
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
||||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongoresultexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
|
||||
|
||||
<!--
|
||||
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
|
||||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongoexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
|
||||
-->
|
||||
|
||||
</classsynopsis>
|
||||
<!-- }}} -->
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<!-- {{{ MongoResultException properties -->
|
||||
<section xml:id="mongoresultexception.props">
|
||||
&reftitle.properties;
|
||||
<variablelist>
|
||||
<varlistentry xml:id="mongoresultexception.props.document">
|
||||
<term><varname>document</varname></term>
|
||||
<listitem>
|
||||
<para>The raw result document as an array.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<!-- }}} -->
|
||||
|
||||
|
||||
</partintro>
|
||||
|
||||
&reference.mongo.entities.mongoresultexception;
|
||||
|
||||
</phpdoc:classref>
|
||||
|
||||
<!-- 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
|
||||
-->
|
||||
56
reference/mongo/mongoresultexception/getdocument.xml
Normal file
56
reference/mongo/mongoresultexception/getdocument.xml
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="mongoresultexception.getdocument" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoResultException::getDocument</refname>
|
||||
<refpurpose>Retrieve the full result document</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>array</type><methodname>MongoResultException::getDocument</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Retrieves the full error result document.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
&no.function.parameters;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The full result document as an array, including partial data if available and
|
||||
additional keys.
|
||||
</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
|
||||
-->
|
||||
|
|
@ -7,7 +7,7 @@
|
|||
<function name='bson_encode' from='PECL mongo >=1.0.1'/>
|
||||
<function name='bson_decode' from='PECL mongo >=1.0.1'/>
|
||||
<!-- Methods -->
|
||||
<!-- Mongo -->
|
||||
<!-- {{{ Mongo -->
|
||||
<function name='mongo' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongo::__construct' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongo::__toString' from='PECL mongo >=0.9.0'/>
|
||||
|
|
@ -26,7 +26,8 @@
|
|||
<function name='mongo::switchslave' from='PECL mongo >=1.1.0'/>
|
||||
<function name='mongo::getreadpreference' from='PECL mongo >=1.3.0'/>
|
||||
<function name='mongo::setreadpreference' from='PECL mongo >=1.3.0'/>
|
||||
<!-- MongoDB -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoDB -->
|
||||
<function name='mongodb' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongodb::__construct' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongodb::__tostring' from='PECL mongo >=0.9.0'/>
|
||||
|
|
@ -55,7 +56,8 @@
|
|||
<function name='mongodb::getslaveokay' from='PECL mongo >=1.1.0'/>
|
||||
<function name='mongodb::getreadpreference' from='PECL mongo >=1.3.0'/>
|
||||
<function name='mongodb::setseadpreference' from='PECL mongo >=1.3.0'/>
|
||||
<!-- MongoCollection -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoCollection -->
|
||||
<function name='mongocollection' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongocollection::__construct' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongocollection::__tostring' from='PECL mongo >=0.9.0'/>
|
||||
|
|
@ -68,6 +70,7 @@
|
|||
<function name='mongocollection::drop' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongocollection::ensureindex' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongocollection::find' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongocollection::findAndModify' from='PECL mongo >=1.3.0'/>
|
||||
<function name='mongocollection::findone' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongocollection::getindexinfo' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongocollection::insert' from='PECL mongo >=0.9.0'/>
|
||||
|
|
@ -84,7 +87,8 @@
|
|||
<function name='mongocollection::getslaveokay' from='PECL mongo >=1.1.0'/>
|
||||
<function name='mongocollection::getreadpreference' from='PECL mongo >=1.3.0'/>
|
||||
<function name='mongocollection::setseadpreference' from='PECL mongo >=1.3.0'/>
|
||||
<!-- MongoCursor -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoCursor -->
|
||||
<function name='mongocursor' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongocursor::__construct' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongocursor::hasnext' from='PECL mongo >=0.9.0'/>
|
||||
|
|
@ -114,7 +118,8 @@
|
|||
<function name='mongocursor::partial' from='PECL mongo >=1.2.0'/>
|
||||
<function name='mongocursor::getreadpreference' from='PECL mongo >=1.3.0'/>
|
||||
<function name='mongocursor::setseadpreference' from='PECL mongo >=1.3.0'/>
|
||||
<!-- MongoGridFS -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoGridFS -->
|
||||
<function name='mongogridfs' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongogridfs::__construct' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongogridfs::find' from='PECL mongo >=0.9.0'/>
|
||||
|
|
@ -127,21 +132,24 @@
|
|||
<function name='mongogridfs::get' from='PECL mongo >=1.0.8'/>
|
||||
<function name='mongogridfs::put' from='PECL mongo >=1.0.8'/>
|
||||
<function name='mongogridfs::delete' from='PECL mongo >=1.0.8'/>
|
||||
<!-- MongoGridFSFile -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoGridFSFile -->
|
||||
<function name='mongogridfsfile' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongogridfsfile::__construct' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongogridfsfile::getbytes' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongogridfsfile::getfilename' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongogridfsfile::getsize' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongogridfsfile::write' from='PECL mongo >=0.9.0'/>
|
||||
<!-- MongoGridFSCursor -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoGridFSCursor -->
|
||||
<function name='mongogridfscursor' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongogridfscursor::__construct' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongogridfscursor::getnext' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongogridfscursor::current' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongogridfscursor::key' from='PECL mongo >=0.9.0'/>
|
||||
<!-- }}} -->
|
||||
|
||||
<!-- MongoLog -->
|
||||
<!-- {{{ MongoLog -->
|
||||
<function name='mongolog' from='PECL mongo >=1.2.3'/>
|
||||
<function name='mongolog::getlevel' from='PECL mongo >= 1.2.3'/>
|
||||
<function name='mongolog::setlevel' from='PECL mongo >= 1.2.3'/>
|
||||
|
|
@ -149,8 +157,15 @@
|
|||
<function name='mongolog::setmodule' from='PECL mongo >= 1.2.3'/>
|
||||
<function name='mongolog::getcallback' from='PECL mongo >= 1.3.0'/>
|
||||
<function name='mongolog::setcallback' from='PECL mongo >= 1.3.0'/>
|
||||
<!-- }}} -->
|
||||
|
||||
<!-- MongoId -->
|
||||
|
||||
<!-- {{{ MongoResultException -->
|
||||
<function name='mongoresultexception' from='PECL mongo >=1.3.0'/>
|
||||
<function name='mongoresultexception::getdocument' from='PECL mongo >=1.3.0'/>
|
||||
<!-- }}} -->
|
||||
|
||||
<!-- {{{ MongoId -->
|
||||
<function name='mongoid' from='PECL mongo >=0.8.0'/>
|
||||
<function name='mongoid::__construct' from='PECL mongo >= 0.8.0'/>
|
||||
<function name='mongoid::getTimestamp' from='PECL mongo >= 1.0.1'/>
|
||||
|
|
@ -159,39 +174,48 @@
|
|||
<function name='mongoid::getHostname' from='PECL mongo >= 1.0.8'/>
|
||||
<function name='mongoid::getPID' from='PECL mongo >= 1.0.11'/>
|
||||
<function name='mongoid::getInc' from='PECL mongo >= 1.0.11'/>
|
||||
<!-- MongoRegex -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoRegex -->
|
||||
<function name='mongoregex' from='PECL mongo >=0.8.1'/>
|
||||
<function name='mongoregex::__construct' from='PECL mongo >= 0.8.1'/>
|
||||
<function name='mongoregex::__tostring' from='PECL mongo >= 0.8.1'/>
|
||||
<!-- MongoDate -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoDate -->
|
||||
<function name='mongodate' from='PECL mongo >=0.8.1'/>
|
||||
<function name='mongodate::__construct' from='PECL mongo >= 0.8.1'/>
|
||||
<function name='mongodate::__tostring' from='PECL mongo >= 0.8.1'/>
|
||||
<!-- MongoBinData -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoBinData -->
|
||||
<function name='mongodbbindata' from='PECL mongo >=0.8.1'/>
|
||||
<function name='mongobindata::__construct' from='PECL mongo >= 0.8.1'/>
|
||||
<function name='mongobindata::__tostring' from='PECL mongo >= 0.8.1'/>
|
||||
<!-- MongoCode -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoCode -->
|
||||
<function name='mongocode' from='PECL mongo >=0.8.3'/>
|
||||
<function name='mongocode::__construct' from='PECL mongo >= 0.8.3'/>
|
||||
<function name='mongocode::__tostring' from='PECL mongo >= 0.8.3'/>
|
||||
<!-- MongoTimestamp -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoTimestamp -->
|
||||
<function name='mongotimestamp' from='PECL mongo >=1.0.1'/>
|
||||
<function name='mongotimestamp::__construct' from='PECL mongo >= 1.0.1'/>
|
||||
<function name='mongotimestamp::__tostring' from='PECL mongo >= 1.0.1'/>
|
||||
<!-- MongoDBRef -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoDBRef -->
|
||||
<function name='mongodbref' from='PECL mongo >=0.9.0'/>
|
||||
<function name='mongodbref::create' from='PECL mongo >= 0.9.0'/>
|
||||
<function name='mongodbref::isref' from='PECL mongo >= 0.9.0'/>
|
||||
<function name='mongodbref::get' from='PECL mongo >= 0.9.0'/>
|
||||
<!-- MongoInt32 -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoInt32 -->
|
||||
<function name='mongoint32' from='PECL mongo >=1.0.9'/>
|
||||
<function name='mongoint32::__construct' from='PECL mongo >= 1.0.9'/>
|
||||
<function name='mongoint32::__tostring' from='PECL mongo >= 1.0.9'/>
|
||||
<!-- MongoInt64 -->
|
||||
<!-- }}} -->
|
||||
<!-- {{{ MongoInt64 -->
|
||||
<function name='mongoint64' from='PECL mongo >=1.0.9'/>
|
||||
<function name='mongoint64::__construct' from='PECL mongo >= 1.0.9'/>
|
||||
<function name='mongoint64::__tostring' from='PECL mongo >= 1.0.9'/>
|
||||
<!-- }}} -->
|
||||
</versions>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
Loading…
Reference in a new issue