Document CommandFailedEvent::getReply()

https://jira.mongodb.org/browse/PHPC-1076


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

reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getreply.xml

@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 342988 $ --> 
+
+<refentry xml:id="mongodb-driver-monitoring-commandfailedevent.getreply" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>MongoDB\Driver\Monitoring\CommandFailedEvent::getReply</refname>
+  <refpurpose>Returns the command reply document</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>final</modifier> <modifier>public</modifier> <type>object</type><methodname>MongoDB\Driver\Monitoring\CommandFailedEvent::getReply</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   The reply document will be converted from BSON to PHP using the default
+   <link linkend="mongodb.persistence.deserialization">deserialization</link>
+   rules (e.g. BSON documents will be converted to <type>stdClass</type>).
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the command reply document as a <classname>stdClass</classname>
+   object.
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <simplelist>
+   &mongodb.throws.argumentparsing;
+  </simplelist>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><xref linkend="mongodb.tutorial.apm" /></member>
+   <member><xref linkend="mongodb.persistence"/></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
+-->
+

reference/mongodb/versions.xml

@@ -161,6 +161,7 @@
  <function name='mongodb\driver\monitoring\commandfailedevent::getdurationmicros' from='mongodb &gt;=1.3.0'/>
  <function name='mongodb\driver\monitoring\commandfailedevent::geterror' from='mongodb &gt;=1.3.0'/>
  <function name='mongodb\driver\monitoring\commandfailedevent::getoperationid' from='mongodb &gt;=1.3.0'/>
+ <function name='mongodb\driver\monitoring\commandfailedevent::getreply' from='mongodb &gt;=1.5.0'/>
  <function name='mongodb\driver\monitoring\commandfailedevent::getrequestid' from='mongodb &gt;=1.3.0'/>
  <function name='mongodb\driver\monitoring\commandfailedevent::getserver' from='mongodb &gt;=1.3.0'/>