Document what the connected property means

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@327993 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson 2012-10-10 20:29:33 +00:00
parent 5bfc126682
commit e94f617c92

View file

@ -102,7 +102,7 @@ $db = $m->foo; // get the database named "foo"
<fieldsynopsis>
<modifier>public</modifier>
<type>boolean</type>
<varname>connected</varname>
<varname linkend="mongo.props.connected">connected</varname>
<initializer>&false;</initializer>
</fieldsynopsis>
<fieldsynopsis>
@ -222,6 +222,17 @@ $db = $m->foo; // get the database named "foo"
<section>
<title>Fields</title>
<variablelist>
<varlistentry xml:id="mongo.props.connected">
<term><varname>status</varname></term>
<listitem>
<simpara>
This property will be set to &true; if we have a open connection
the database based on the ReadPreference and tagsets (for ReplicaSet
connections), &false; otherwise.
This property does not take authentication into account.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="mongo.props.status">
<term><varname>status</varname></term>
<listitem>