MongoClient::getWriteConcern() - Code Metrics - Inspection of "[WIP] Implement MongoClient" - alcaeus/mongo-php-adapter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#12)

unknown

created 2016-01-03 04:52 UTC

MongoClient::getWriteConcern() A

↳ Parent: MongoClient::getHosts()

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

use Alcaeus\MongoDbAdapter\Helper;
use MongoDB\Client;

/**
 * A connection between PHP and MongoDB. This class is used to create and manage connections
 * See MongoClient::__construct() and the section on connecting for more information about creating connections.
 * @link http://www.php.net/manual/en/class.mongoclient.php
 */
class MongoClient
namespace YourVendor;

class YourClass { }
{
    use Helper\ReadPreference;
    use Helper\WriteConcern;
    

    const VERSION = '1.6.12';
    const DEFAULT_HOST = "localhost" ;
    const DEFAULT_PORT = 27017 ;
    const RP_PRIMARY = "primary" ;
    const RP_PRIMARY_PREFERRED = "primaryPreferred" ;
    const RP_SECONDARY = "secondary" ;
    const RP_SECONDARY_PREFERRED = "secondaryPreferred" ;
    const RP_NEAREST = "nearest" ;

    /**
     * @var bool
     * @deprecated This will not properly work as the underlying driver connects lazily
     */
    public $connected = false;

    /**
     * @var
     */
    public $status;

    /**
     * @var string
     */
    protected $server;

    /**
     * @var
     */
    protected $persistent;

    /**
     * @var Client
     */
    private $client;

    /**
     * @var \MongoDB\Driver\Manager
     */
    private $manager;


    /**
     * Creates a new database connection object
     *
     * @link http://php.net/manual/en/mongo.construct.php
     * @param string $server The server name.
     * @param array $options An array of options for the connection.
     * @param array $driverOptions An array of options for the MongoDB driver.
     * @throws MongoConnectionException
     */
    public function __construct($server = 'default', array $options = ["connect" => true], array $driverOptions = [])
    {
        if ($server === 'default') {
            $server = 'mongodb://' . self::DEFAULT_HOST . ':' . self::DEFAULT_PORT;
        }

        $this->server = $server;
        
        $this->readPreference = new \MongoDB\Driver\ReadPreference(\MongoDB\Driver\ReadPreference::RP_PRIMARY);
        $this->writeConcern = new \MongoDB\Driver\WriteConcern(1);
        $this->createClientObject($options, $driverOptions);

        /// XXX: this is a hack until we can find better solution
        $info = $this->client->__debugInfo();
        $this->manager = $info['manager'];

        if (isset($options['connect']) && $options['connect']) {
            $this->connect();
        }
    }

    /**
     * Closes this database connection
     *
     * @link http://www.php.net/manual/en/mongoclient.close.php
     * @param  boolean|string $connection
     * @return boolean If the connection was successfully closed.
     */
    public function close($connection = null)

    {
        $this->connected = false;


        return false;
    }

    /**
     * Connects to a database server
     *
     * @link http://www.php.net/manual/en/mongoclient.connect.php
     *
     * @throws MongoConnectionException
     * @return boolean If the connection was successful.
     */
    public function connect()
    {
        $this->connected = true;


        return true;
    }

    /**
     * Drops a database
     *
     * @link http://www.php.net/manual/en/mongoclient.dropdb.php
     * @param mixed $db The database to drop. Can be a MongoDB object or the name of the database.
     * @return array The database response.
     * @deprecated Use MongoDB::drop() instead.
     */
    public function dropDB($db)
    {
        return $this->selectDB($db)->drop();
    }

    /**
     * Gets a database
     *
     * @link http://php.net/manual/en/mongoclient.get.php
     * @param string $dbname The database name.
     * @return MongoDB The database name.
     */
    public function __get($dbname)
    {
        return $this->selectDB($dbname);
    }

    /**
     * Gets the client for this object
     *
     * @internal This part is not of the ext-mongo API and should not be used
     * @return Client
     */
    public function getClient()
    {
        return $this->client;
    }

    /**
     * Get connections
     *
     * Returns an array of all open connections, and information about each of the servers
     *
     * @return array
     */
    static public function getConnections()

    {
        return [];
    }

    /**
     * Get 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.
     *
     * @return array
     */
    public function getHosts()
    {
        $this->forceConnect();
        $servers = $this->manager->getServers();
        $results = [];
        foreach ($servers as $server) {
            $key = sprintf('%s:%d', $server->getHost(), $server->getPort());
            $info = $server->getInfo();
            $results[$key] = [
                'host'     => $server->getHost(),
                'port'     => $server->getPort(),
                'health'   => (int)$info['ok'], // Not totally sure about this
                'state'    => $server->getType(),
                'ping'     => $server->getLatency(),
                'lastPing' => null,
            ];
        }
        return $results;
    }

    /**
     * Kills a specific cursor on the server
     *
     * @link http://www.php.net/manual/en/mongoclient.killcursor.php
     * @param string $server_hash The server hash that has the cursor. This can be obtained through
     * {@link http://www.php.net/manual/en/mongocursor.info.php MongoCursor::info()}.
     * @param int|MongoInt64 $id The ID of the cursor to kill. You can either supply an {@link http://www.php.net/manual/en/language.types.integer.php int}
     * containing the 64 bit cursor ID, or an object of the
     * {@link http://www.php.net/manual/en/class.mongoint64.php MongoInt64} class. The latter is necessary on 32
     * bit platforms (and Windows).
     */
    public function killCursor($server_hash , $id)

    {
        throw new \Exception('Not implemented');
    }

    /**
     * Lists all of the databases available
     *
     * @link http://php.net/manual/en/mongoclient.listdbs.php
     * @return array Returns an associative array containing three fields. The first field is databases, which in turn contains an array. Each element of the array is an associative array corresponding to a database, giving the database's name, size, and if it's empty. The other two fields are totalSize (in bytes) and ok, which is 1 if this method ran successfully.
     */
    public function listDBs()
    {
        return $this->client->listDatabases();
    }

    /**
     * Gets a database collection
     *
     * @link http://www.php.net/manual/en/mongoclient.selectcollection.php
     * @param string $db The database name.
     * @param string $collection The collection name.
     * @return MongoCollection Returns a new collection object.
     * @throws Exception Throws Exception if the database or collection name is invalid.
     */
    public function selectCollection($db, $collection)
    {
        return new MongoCollection($this->selectDB($db), $collection);
    }

    /**
     * Gets a database
     *
     * @link http://www.php.net/manual/en/mongo.selectdb.php
     * @param string $name The database name.
     * @return MongoDB Returns a new db object.
     * @throws InvalidArgumentException
     */
    public function selectDB($name)
    {
        return new MongoDB($this, $name);
    }

    /**
     * {@inheritdoc}
     */
    public function setReadPreference($readPreference, array $tags = null)
    {
        return $this->setReadPreferenceFromParameters($readPreference, $tags);
    }

    /**
     * {@inheritdoc}
     */
    public function setWriteConcern($wstring, $wtimeout = 0)
    {
        return $this->setWriteConcernFromParameters($wstring, $wtimeout);
    }

    /**
     * Choose a new secondary for slaveOkay reads
     *
     * @link www.php.net/manual/en/mongo.switchslave.php
     * @return string The address of the secondary this connection is using for reads. This may be the same as the previous address as addresses are randomly chosen. It may return only one address if only one secondary (or only the primary) is available.
     * @throws MongoException (error code 15) if it is called on a non-replica-set connection. It will also throw MongoExceptions if it cannot find anyone (primary or secondary) to read from (error code 16).
     */
    public function switchSlave()
    {
        return $this->server;
    }

    /**
     * String representation of this connection
     *
     * @link http://www.php.net/manual/en/mongoclient.tostring.php
     * @return string Returns hostname and port for this connection.
     */
    public function __toString()
    {
        return $this->server;
    }

    private function forceConnect()
    {
        $command = new \MongoDB\Driver\Command(['ping' => 1]);
        $this->manager->executeCommand('db', $command);
    }

    private function createClientObject(array $options = [], array $driverOptions = [])
    {
        $options += [
            'readPreference' => $this->readPreference,
            'writeConcern'   => $this->writeConcern,
        ];

        if ($this->client === null) {
            $this->client = new \MongoDB\Client($this->server, $options, $driverOptions);
        } else {
            $this->client = $this->client->withOptions($options);

        }
    }

}



1			<?php
2			/*
3			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14			*/
15
16			use Alcaeus\MongoDbAdapter\Helper;
17			use MongoDB\Client;
18
19			/**
20			* A connection between PHP and MongoDB. This class is used to create and manage connections
21			* See MongoClient::__construct() and the section on connecting for more information about creating connections.
22			* @link http://www.php.net/manual/en/class.mongoclient.php
23			*/
24			class MongoClient
			1 ignored issue – show Coding Style Compatibility introduced 2015-12-29 16:10 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
25			{
26			use Helper\ReadPreference;
27			use Helper\WriteConcern;
28
29
30			const VERSION = '1.6.12';
31			const DEFAULT_HOST = "localhost" ;
32			const DEFAULT_PORT = 27017 ;
33			const RP_PRIMARY = "primary" ;
34			const RP_PRIMARY_PREFERRED = "primaryPreferred" ;
35			const RP_SECONDARY = "secondary" ;
36			const RP_SECONDARY_PREFERRED = "secondaryPreferred" ;
37			const RP_NEAREST = "nearest" ;
38
39			/**
40			* @var bool
41			* @deprecated This will not properly work as the underlying driver connects lazily
42			*/
43			public $connected = false;
44
45			/**
46			* @var
47			*/
48			public $status;
49
50			/**
51			* @var string
52			*/
53			protected $server;
54
55			/**
56			* @var
57			*/
58			protected $persistent;
59
60			/**
61			* @var Client
62			*/
63			private $client;
64
65			/**
66			* @var \MongoDB\Driver\Manager
67			*/
68			private $manager;
69
70
71			/**
72			* Creates a new database connection object
73			*
74			* @link http://php.net/manual/en/mongo.construct.php
75			* @param string $server The server name.
76			* @param array $options An array of options for the connection.
77			* @param array $driverOptions An array of options for the MongoDB driver.
78			* @throws MongoConnectionException
79			*/
80			public function __construct($server = 'default', array $options = ["connect" => true], array $driverOptions = [])
81			{
82			if ($server === 'default') {
83			$server = 'mongodb://' . self::DEFAULT_HOST . ':' . self::DEFAULT_PORT;
84			}
85
86			$this->server = $server;
87
88			$this->readPreference = new \MongoDB\Driver\ReadPreference(\MongoDB\Driver\ReadPreference::RP_PRIMARY);
89			$this->writeConcern = new \MongoDB\Driver\WriteConcern(1);
90			$this->createClientObject($options, $driverOptions);
91
92			/// XXX: this is a hack until we can find better solution
93			$info = $this->client->__debugInfo();
94			$this->manager = $info['manager'];
95
96			if (isset($options['connect']) && $options['connect']) {
97			$this->connect();
98			}
99			}
100
101			/**
102			* Closes this database connection
103			*
104			* @link http://www.php.net/manual/en/mongoclient.close.php
105			* @param boolean\|string $connection
106			* @return boolean If the connection was successfully closed.
107			*/
108			public function close($connection = null)
			0 ignored issues – show Unused Code introduced 2015-12-29 16:10 UTC by Report Bug Copy Issue Report The parameter `$connection` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
109			{
110			$this->connected = false;
			1 ignored issue – show Deprecated Code introduced 2015-12-29 16:10 UTC by Report Bug Copy Issue Report The property `MongoClient::$connected` has been deprecated with message: This will not properly work as the underlying driver connects lazily This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
111
112			return false;
113			}
114
115			/**
116			* Connects to a database server
117			*
118			* @link http://www.php.net/manual/en/mongoclient.connect.php
119			*
120			* @throws MongoConnectionException
121			* @return boolean If the connection was successful.
122			*/
123			public function connect()
124			{
125			$this->connected = true;
			1 ignored issue – show Deprecated Code introduced 2015-12-29 16:10 UTC by Report Bug Copy Issue Report The property `MongoClient::$connected` has been deprecated with message: This will not properly work as the underlying driver connects lazily This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
126
127			return true;
128			}
129
130			/**
131			* Drops a database
132			*
133			* @link http://www.php.net/manual/en/mongoclient.dropdb.php
134			* @param mixed $db The database to drop. Can be a MongoDB object or the name of the database.
135			* @return array The database response.
136			* @deprecated Use MongoDB::drop() instead.
137			*/
138			public function dropDB($db)
139			{
140			return $this->selectDB($db)->drop();
141			}
142
143			/**
144			* Gets a database
145			*
146			* @link http://php.net/manual/en/mongoclient.get.php
147			* @param string $dbname The database name.
148			* @return MongoDB The database name.
149			*/
150			public function __get($dbname)
151			{
152			return $this->selectDB($dbname);
153			}
154
155			/**
156			* Gets the client for this object
157			*
158			* @internal This part is not of the ext-mongo API and should not be used
159			* @return Client
160			*/
161			public function getClient()
162			{
163			return $this->client;
164			}
165
166			/**
167			* Get connections
168			*
169			* Returns an array of all open connections, and information about each of the servers
170			*
171			* @return array
172			*/
173			static public function getConnections()
			0 ignored issues – show Coding Style introduced 2015-12-29 16:10 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
174			{
175			return [];
176			}
177
178			/**
179			* Get hosts
180			*
181			* This method is only useful with a connection to a replica set. It returns the status of all of the hosts in the
182			* set. Without a replica set, it will just return an array with one element containing the host that you are
183			* connected to.
184			*
185			* @return array
186			*/
187			public function getHosts()
188			{
189			$this->forceConnect();
190			$servers = $this->manager->getServers();
191			$results = [];
192			foreach ($servers as $server) {
193			$key = sprintf('%s:%d', $server->getHost(), $server->getPort());
194			$info = $server->getInfo();
195			$results[$key] = [
196			'host' => $server->getHost(),
197			'port' => $server->getPort(),
198			'health' => (int)$info['ok'], // Not totally sure about this
199			'state' => $server->getType(),
200			'ping' => $server->getLatency(),
201			'lastPing' => null,
202			];
203			}
204			return $results;
205			}
206
207			/**
208			* Kills a specific cursor on the server
209			*
210			* @link http://www.php.net/manual/en/mongoclient.killcursor.php
211			* @param string $server_hash The server hash that has the cursor. This can be obtained through
212			* {@link http://www.php.net/manual/en/mongocursor.info.php MongoCursor::info()}.
213			* @param int\|MongoInt64 $id The ID of the cursor to kill. You can either supply an {@link http://www.php.net/manual/en/language.types.integer.php int}
214			* containing the 64 bit cursor ID, or an object of the
215			* {@link http://www.php.net/manual/en/class.mongoint64.php MongoInt64} class. The latter is necessary on 32
216			* bit platforms (and Windows).
217			*/
218			public function killCursor($server_hash , $id)
			0 ignored issues – show Unused Code introduced 2015-12-29 16:10 UTC by Report Bug Copy Issue Report The parameter `$server_hash` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2015-12-29 16:10 UTC by Report Bug Copy Issue Report The parameter `$id` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
219			{
220			throw new \Exception('Not implemented');
221			}
222
223			/**
224			* Lists all of the databases available
225			*
226			* @link http://php.net/manual/en/mongoclient.listdbs.php
227			* @return array Returns an associative array containing three fields. The first field is databases, which in turn contains an array. Each element of the array is an associative array corresponding to a database, giving the database's name, size, and if it's empty. The other two fields are totalSize (in bytes) and ok, which is 1 if this method ran successfully.
228			*/
229			public function listDBs()
230			{
231			return $this->client->listDatabases();
232			}
233
234			/**
235			* Gets a database collection
236			*
237			* @link http://www.php.net/manual/en/mongoclient.selectcollection.php
238			* @param string $db The database name.
239			* @param string $collection The collection name.
240			* @return MongoCollection Returns a new collection object.
241			* @throws Exception Throws Exception if the database or collection name is invalid.
242			*/
243			public function selectCollection($db, $collection)
244			{
245			return new MongoCollection($this->selectDB($db), $collection);
246			}
247
248			/**
249			* Gets a database
250			*
251			* @link http://www.php.net/manual/en/mongo.selectdb.php
252			* @param string $name The database name.
253			* @return MongoDB Returns a new db object.
254			* @throws InvalidArgumentException
255			*/
256			public function selectDB($name)
257			{
258			return new MongoDB($this, $name);
259			}
260
261			/**
262			* {@inheritdoc}
263			*/
264			public function setReadPreference($readPreference, array $tags = null)
265			{
266			return $this->setReadPreferenceFromParameters($readPreference, $tags);
267			}
268
269			/**
270			* {@inheritdoc}
271			*/
272			public function setWriteConcern($wstring, $wtimeout = 0)
273			{
274			return $this->setWriteConcernFromParameters($wstring, $wtimeout);
275			}
276
277			/**
278			* Choose a new secondary for slaveOkay reads
279			*
280			* @link www.php.net/manual/en/mongo.switchslave.php
281			* @return string The address of the secondary this connection is using for reads. This may be the same as the previous address as addresses are randomly chosen. It may return only one address if only one secondary (or only the primary) is available.
282			* @throws MongoException (error code 15) if it is called on a non-replica-set connection. It will also throw MongoExceptions if it cannot find anyone (primary or secondary) to read from (error code 16).
283			*/
284			public function switchSlave()
285			{
286			return $this->server;
287			}
288
289			/**
290			* String representation of this connection
291			*
292			* @link http://www.php.net/manual/en/mongoclient.tostring.php
293			* @return string Returns hostname and port for this connection.
294			*/
295			public function __toString()
296			{
297			return $this->server;
298			}
299
300			private function forceConnect()
301			{
302			$command = new \MongoDB\Driver\Command(['ping' => 1]);
303			$this->manager->executeCommand('db', $command);
304			}
305
306			private function createClientObject(array $options = [], array $driverOptions = [])
307			{
308			$options += [
309			'readPreference' => $this->readPreference,
310			'writeConcern' => $this->writeConcern,
311			];
312
313			if ($this->client === null) {
314			$this->client = new \MongoDB\Client($this->server, $options, $driverOptions);
315			} else {
316			$this->client = $this->client->withOptions($options);
			0 ignored issues – show Bug introduced 2016-01-03 04:55 UTC by Report Bug Copy Issue Report The method `withOptions()` does not seem to exist on `object<MongoDB\Client>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
317			}
318			}
319
320			}
321
322

alcaeus / mongo-php-adapter

Pull Request — master (#12)

MongoClient::getWriteConcern() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like