php-doc-en/reference/mongo/mongoresultexception.xml
2012-10-31 19:09:55 +00:00

103 lines
3 KiB
XML

<?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
-->