mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
Document CommandException
https://jira.mongodb.org/browse/PHPC-1089 git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344541 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Katherine Walker
parent
2af032c790
commit
e56d9eadaa
4 changed files with 172 additions and 0 deletions
|
|
@ -7,6 +7,7 @@
|
|||
|
||||
&reference.mongodb.mongodb.driver.exception.authenticationexception;
|
||||
&reference.mongodb.mongodb.driver.exception.bulkwriteexception;
|
||||
&reference.mongodb.mongodb.driver.exception.commandexception;
|
||||
&reference.mongodb.mongodb.driver.exception.connectionexception;
|
||||
&reference.mongodb.mongodb.driver.exception.connectiontimeoutexception;
|
||||
&reference.mongodb.mongodb.driver.exception.exception;
|
||||
|
|
|
|||
107
reference/mongodb/mongodb/driver/exception/commandexception.xml
Normal file
107
reference/mongodb/mongodb/driver/exception/commandexception.xml
Normal file
|
|
@ -0,0 +1,107 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 342988 $ -->
|
||||
|
||||
<phpdoc:classref xml:id="class.mongodb-driver-exception-commandexception" 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 MongoDB\Driver\Exception\CommandException class</title>
|
||||
<titleabbrev>MongoDB\Driver\Exception\CommandException</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
|
||||
<!-- {{{ MongoDB\Driver\Exception\CommandException intro -->
|
||||
<section xml:id="mongodb-driver-exception-commandexception.intro">
|
||||
&reftitle.intro;
|
||||
<para>
|
||||
Thrown when a command fails.
|
||||
</para>
|
||||
</section>
|
||||
<!-- }}} -->
|
||||
|
||||
<section xml:id="mongodb-driver-exception-commandexception.synopsis">
|
||||
&reftitle.classsynopsis;
|
||||
|
||||
<!-- {{{ Synopsis -->
|
||||
<classsynopsis>
|
||||
<ooclass><classname>MongoDB\Driver\Exception\CommandException</classname></ooclass>
|
||||
|
||||
<!-- {{{ Class synopsis -->
|
||||
<classsynopsisinfo>
|
||||
<ooclass>
|
||||
<classname>MongoDB\Driver\Exception\CommandException</classname>
|
||||
</ooclass>
|
||||
|
||||
<ooclass>
|
||||
<modifier>extends</modifier>
|
||||
<classname>MongoDB\Driver\Exception\RuntimeException</classname>
|
||||
</ooclass>
|
||||
|
||||
<oointerface>
|
||||
<interfacename>MongoDB\Driver\Exception\Exception</interfacename>
|
||||
</oointerface>
|
||||
</classsynopsisinfo>
|
||||
<!-- }}} -->
|
||||
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
|
||||
<fieldsynopsis>
|
||||
<modifier>protected</modifier>
|
||||
<type>object</type>
|
||||
<varname linkend="mongodb-driver-exception-commandexception.props.resultdocument">resultDocument</varname>
|
||||
</fieldsynopsis>
|
||||
|
||||
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
|
||||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)" />
|
||||
|
||||
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
||||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodb-driver-exception-commandexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
|
||||
|
||||
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
|
||||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
|
||||
|
||||
</classsynopsis>
|
||||
<!-- }}} -->
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<!-- {{{ MongoDB\Driver\Exception\CommandException properties -->
|
||||
<section xml:id="mongodb-driver-exception-commandexception.props">
|
||||
&reftitle.properties;
|
||||
<variablelist>
|
||||
<varlistentry xml:id="mongodb-driver-exception-commandexception.props.resultdocument">
|
||||
<term><varname>resultDocument</varname></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The result document associated with the failed command.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<!-- }}} -->
|
||||
|
||||
|
||||
</partintro>
|
||||
|
||||
&reference.mongodb.mongodb.driver.exception.entities.commandexception;
|
||||
|
||||
</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
|
||||
-->
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 342988 $ -->
|
||||
|
||||
<refentry xml:id="mongodb-driver-commandexception.getresultdocument" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\Driver\Exception\CommandException::getResultDocument</refname>
|
||||
<refpurpose>Returns the result document for the failed command</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <type>object</type><methodname>MongoDB\Driver\Exception\CommandException::getResultDocument</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns the result document for the failed command.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
&no.function.parameters;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The result document for the failed command.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><function>MongoDB\Driver\Manager::executeCommand</function></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
|
||||
-->
|
||||
|
|
@ -133,6 +133,8 @@
|
|||
|
||||
<function name='mongodb\driver\exception\authenticationexception' from='mongodb >= 1.0.0'/>
|
||||
<function name='mongodb\driver\exception\bulkwriteexception' from='mongodb >= 1.0.0'/>
|
||||
<function name='mongodb\driver\exception\commandexception' from='mongodb >= 1.5.0'/>
|
||||
<function name='mongodb\driver\exception\commandexception::getresultdocument' from='mongodb >= 1.5.0'/>
|
||||
<function name='mongodb\driver\exception\connectionexception' from='mongodb >= 1.0.0'/>
|
||||
<function name='mongodb\driver\exception\connectiontimeoutexception' from='mongodb >= 1.0.0'/>
|
||||
<function name='mongodb\driver\exception\exception' from='mongodb >= 1.0.0'/>
|
||||
|
|
|
|||
Loading…
Reference in a new issue