1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoClient" namespace="" name="MongoClient">
<constant name="VERSION" value="">
<docblock>
<var type="string"/>
</docblock>
</constant>
<constant name="DEFAULT_HOST" value=""localhost"">
<docblock>
<var type="string"/>
</docblock>
</constant>
<constant name="DEFAULT_PORT" value="27017">
<docblock>
<var type="int"/>
</docblock>
</constant>
<constant name="RP_PRIMARY" value=""primary"">
<docblock>
<var type="string"/>
</docblock>
</constant>
<constant name="RP_PRIMARY_PREFERRED" value=""primaryPreferred"">
<docblock>
<var type="string"/>
</docblock>
</constant>
<constant name="RP_SECONDARY" value=""secondary"">
<docblock>
<var type="string"/>
</docblock>
</constant>
<constant name="RP_SECONDARY_PREFERRED" value=""secondaryPreferred"">
<docblock>
<var type="string"/>
</docblock>
</constant>
<constant name="RP_NEAREST" value=""nearest"">
<docblock>
<var type="string"/>
</docblock>
</constant>
<member name="connected" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="This property will be set to TRUE if we have a open connection to the database, FALSE otherwise. If the connection is to a replica set, this property will only be TRUE if the driver has a connection to a node matching the current read preference. This property does not take authentication into account.">This property will be set to TRUE if we have a open connection to the database, FALSE otherwise. If the connection is to a replica set, this property will only be TRUE if the driver has a connection to a node matching the current read preference. This property does not take authentication into account.</description>
<var type="boolean"/>
</docblock>
</member>
<member name="status" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="This property is no longer used and will be set to NULL In driver versions 1.1.x and earlier, this may be set to a string value (e.g. "recycled", "new") when persistent connections are used.">This property is no longer used and will be set to NULL In driver versions 1.1.x and earlier, this may be set to a string value (e.g. "recycled", "new") when persistent connections are used.</description>
<var type="string"/>
</docblock>
</member>
<member name="server" static="false" visibility="protected">
<default>null</default>
<docblock>
<var type="string"/>
</docblock>
</member>
<member name="persistent" static="false" visibility="protected">
<default>null</default>
<docblock>
<var type="boolean"/>
</docblock>
</member>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Creates a new database connection object">If no parameters are passed, this connects to "localhost:27017" (or whatever was specified in php.ini for mongo.default_host and mongo.default_port).</description>
<return type="void"/>
</docblock>
<parameter name="server" optional="true" byreference="false" type="string"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
<parameter name="driver_options" optional="true" byreference="false" type="object" class="array"/>
</constructor>
<method name="close" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Closes this connection">The MongoClient::close method forcefully closes a connection to the database, even if persistent connections are being used. You should never have to do this under normal circumstances.</description>
<return type="bool"/>
</docblock>
<parameter name="connection" optional="true" byreference="false" type="object" class="boolean|string"/>
</method>
<method name="connect" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Connects to a database server"/>
<return type="bool"/>
</docblock>
</method>
<method name="dropDB" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Drops a database [deprecated]"/>
<return type="array"/>
</docblock>
<parameter name="db" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="__get" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Gets a database"/>
<return type="MongoDB"/>
</docblock>
<parameter name="dbname" optional="false" byreference="false" type="string"/>
</method>
<method name="getConnections" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Return info about all open connections"/>
<return type="array"/>
</docblock>
</method>
<method name="getHosts" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Updates status for all associated hosts">This method is only useful with a connection to a replica set. It returns the status of all of the hosts in the set. Without a replica set, it will just return an array with one element containing the host that you are connected to.</description>
<return type="array"/>
</docblock>
</method>
<method name="getReadPreference" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the read preference for this connection"/>
<return type="array"/>
</docblock>
</method>
<method name="getWriteConcern" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the write concern for this connection"/>
<return type="array"/>
</docblock>
</method>
<method name="killCursor" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Kills a specific cursor on the server"/>
<return type="bool"/>
</docblock>
<parameter name="server_hash" optional="false" byreference="false" type="string"/>
<parameter name="id" optional="false" byreference="false" type="object" class="int|MongoInt64"/>
</method>
<method name="listDBs" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Lists all of the databases available"/>
<return type="array"/>
</docblock>
</method>
<method name="selectCollection" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Gets a database collection"/>
<return type="MongoCollection"/>
</docblock>
<parameter name="db" optional="false" byreference="false" type="string"/>
<parameter name="collection" optional="false" byreference="false" type="string"/>
</method>
<method name="selectDB" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Gets a database"/>
<return type="MongoDB"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
</method>
<method name="setReadPreference" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set the read preference for this connection"/>
<return type="bool"/>
</docblock>
<parameter name="read_preference" optional="false" byreference="false" type="string"/>
<parameter name="tags" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="setWriteConcern" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set the write concern for this connection"/>
<return type="bool"/>
</docblock>
<parameter name="w" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="wtimeout" optional="true" byreference="false" type="int"/>
</method>
<method name="__toString" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="String representation of this connection"/>
<return type="string"/>
</docblock>
</method>
</class>
|