Document MongoClient::getConnections()

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

reference/mongo/mongoclient/getconnections.xml

@@ -0,0 +1,113 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="mongoclient.getconnections" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>MongoClient::getConnections</refname>
+  <refpurpose>Return info about all open connections</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <modifier>static</modifier> <type>void</type><methodname>MongoClient::getConnections</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+  Returns an array of all open connections, and information about each of the
+  servers 
+  </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+  An <type>array</type> of open connections.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples"><!-- {{{ -->
+  &reftitle.examples;
+  <example xml:id="mongoclient-getconnections.example.basic"><!-- {{{ -->
+   <title><methodname>MongoClient::getConnections</methodname> example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+$m = new MongoClient;
+var_dump($m->getConnections());
+?>
+]]>
+   </programlisting>
+   &example.outputs.similar;
+   <screen>
+<![CDATA[
+array(1) {
+  [0]=>
+  array(3) {
+    ["hash"]=>
+    string(26) "localhost:27017;-;X;56052"
+    ["server"]=>
+    array(3) {
+      ["host"]=>
+      string(10) "localhost"
+      ["port"]=>
+      int(27017)
+      ["pid"]=>
+      int(56052)
+    }
+    ["connection"]=>
+    array(8) {
+      ["last_ping"]=>
+      int(1354076401)
+      ["last_ismaster"]=>
+      int(0)
+      ["ping_ms"]=>
+      int(0)
+      ["connection_type"]=>
+      int(1)
+      ["connection_type_desc"]=>
+      string(10) "STANDALONE"
+      ["max_bson_size"]=>
+      int(16777216)
+      ["tag_count"]=>
+      int(0)
+      ["tags"]=>
+      array(0) {
+      }
+    }
+  }
+}
+]]>
+   </screen>
+  </example><!-- }}} -->
+ </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
+-->