Document MongoDB\Driver\Session::isDirty()

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

Author: jmikola

reference/mongodb/mongodb/driver/session/isdirty.xml

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 344522 $ --> 
+
+<refentry xml:id="mongodb-driver-session.isdirty" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>MongoDB\Driver\Session::isDirty</refname>
+  <refpurpose>Returns whether the session has been marked as dirty</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>final</modifier> <modifier>public</modifier> <type>bool</type><methodname>MongoDB\Driver\Session::isDirty</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Returns whether the session has been marked as dirty (i.e. it has been used
+   with a command that encountered a network error).
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns whether the session has been marked as dirty.
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <simplelist>
+   &mongodb.throws.argumentparsing;
+  </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

@@ -133,6 +133,7 @@
  <function name='mongodb\driver\session::getserver' from='mongodb &gt;=1.6.0'/>
  <function name='mongodb\driver\session::gettransactionoptions' from='mongodb &gt;=1.7.0'/>
  <function name='mongodb\driver\session::gettransactionstate' from='mongodb &gt;=1.7.0'/>
+ <function name='mongodb\driver\session::isdirty' from='mongodb &gt;=1.13.0'/>
  <function name='mongodb\driver\session::isintransaction' from='mongodb &gt;=1.6.0'/>
  <function name='mongodb\driver\session::starttransaction' from='mongodb &gt;=1.5.0'/>