Maslosoft\Mangan\Bridge\MongoCursor

Complexity

Total Complexity

15

Size/Duplication

Total Lines	259
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	2
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	sort()	0	6	1
A	fields()	0	6	1
A	limit()	0	6	1
A	skip()	0	6	1
A	info()	0	18	1
A	count()	0	11	2
A	countQuerying()	0	15	1
A	doQuery()	0	7	2
A	fetchDocuments()	0	10	1
A	getQuery()	0	9	3

<?php

/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */

namespace Maslosoft\Mangan\Bridge;

/**
 * MongoCursor
 *
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 */
class MongoCursor
{

	const DEFAULT_BATCH_SIZE = 100;

	/**
	 * @var integer
	 */
	public static $timeout = 30000;

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

	/**
	 * Full collection name
	 * @var string
	 */
	private $fcn;

	/**
	 * @var array[]
	 */
	private $documents = [];

The property $documents is not used and could be removed.

	/**
	 * @var int
	 */
	private $currKey = -1;

The property $currKey is not used and could be removed.

	/**
	 * @var null|int
	 */
	private $cursorId = null;

	/**
	 * @var bool
	 */
	private $fetching = false;

	/**
	 * @var bool
	 */
	private $end = false;

The property $end is not used and could be removed.

	/**
	 * @var bool
	 */
	private $hasMore = false;

The property $hasMore is not used and could be removed.

	/**
	 * @var array
	 */
	private $query = [];

	/**
	 * @var int
	 */
	private $queryLimit = 0;

	/**
	 * @var int
	 */
	private $querySkip = 0;

	/**
	 * @var int
	 */
	private $queryTimeout = null;

	/**
	 * @var int
	 */
	private $batchSize = self::DEFAULT_BATCH_SIZE;

	/**
	 * @var int
	 */
	private $flags = 0;

	/**
	 * @var array
	 */
	private $readPreference;

	/**
	 * Create a new cursor
	 *
	 * @param MongoClient $client     - Database connection.
	 * @param string      $ns         - Full name of database and collection.
	 * @param array       $query      - Database query.
	 * @param array       $fields     - Fields to return.
	 */
	public function __construct(MongoClient $client, $ns, array $query = [], array $fields = [])
	{
		$this->client = $client;
		$this->readPreference = $client->getReadPreference();
		$this->fcn = $ns;
		$this->fields = $fields;

The property fields does not exist. Did you maybe forget to declare it?

		$this->query['$query'] = $query;
		$this->queryTimeout = self::$timeout;
	}

	/**
	 * Sorts the results by given fields
	 *
	 * @param array $fields - An array of fields by which to sort. Each
	 *   element in the array has as key the field name, and as value either
	 *   1 for ascending sort, or -1 for descending sort.
	 *
	 * @return MongoCursor - Returns the same cursor that this method was
	 *   called on.
	 */
	public function sort(array $fields)
	{
		$this->query['$orderby'] = $fields;

		return $this;
	}

	/**
	 * Sets the fields for a query
	 *
	 * @param array $fields - Fields to return (or not return).
	 *
	 * @return MongoCursor - Returns this cursor.
	 */
	public function fields(array $fields)
	{
		$this->fields = $fields;

		return $this;
	}

	/**
	 * Limits the number of results returned
	 *
	 * @param int $num - The number of results to return.
	 *
	 * @return MongoCursor - Returns this cursor.
	 */
	public function limit($num)
	{
		$this->queryLimit = $num;

		return $this;
	}

	/**
	 * Skips a number of results
	 *
	 * @param int $num - The number of results to skip.
	 *
	 * @return MongoCursor - Returns this cursor.
	 */
	public function skip($num)
	{
		$this->querySkip = $num;

		return $this;
	}

	/**
	 * Gets the query, fields, limit, and skip for this cursor
	 *
	 * @return array - Returns the namespace, limit, skip, query, and
	 *   fields for this cursor.
	 */
	public function info()
	{
		$info = [
			'ns' => $this->fcn,
			'limit' => $this->queryLimit,
			'batchSize' => $this->batchSize,
			'skip' => $this->querySkip,
			'flags' => $this->flags | Mongofill\Protocol::QF_SLAVE_OK,
			'query' => $this->query['$query'],
			'fields' => $this->fields,
			'started_iterating' => $this->fetching,
			'id' => $this->cursorId,
			'server' => $this->client->_getReadProtocol($this->readPreference)->getServerHash(),

The method _getReadProtocol() does not seem to exist on object<Maslosoft\Mangan\Bridge\MongoClient>.

		];

		//TODO: missing opReplay information
		return $info;
	}

	/**
	 * Counts the number of results for this query
	 *
	 * @param bool $foundOnly -
	 *
	 * @return int - The number of documents returned by this cursor's
	 *   query.
	 */
	public function count($foundOnly = false)
	{
		$this->doQuery();

		if ($foundOnly)
		{
			return $this->countLocalData();

The method countLocalData() does not seem to exist on object<Maslosoft\Mangan\Bridge\MongoCursor>.

		}

		return $this->countQuerying();
	}

	private function countQuerying()
	{
		$ns = explode('.', $this->fcn, 2);

		$query = [
			'count' => $ns[1],
			'query' => $this->query['$query']
		];

		$response = $this->client->_getReadProtocol($this->readPreference)->opQuery(

The method _getReadProtocol() does not seem to exist on object<Maslosoft\Mangan\Bridge\MongoClient>.

				$ns[0] . '.$cmd', $query, 0, -1, 0, $this->queryTimeout
		);

		return (int) $response['result'][0]['n'];
	}

	/**
	 * Execute the query.
	 *
	 * @return void - NULL.
	 */
	protected function doQuery()
	{
		if (!$this->fetching)
		{
			$this->fetchDocuments();
		}
	}

	private function fetchDocuments()
	{
		$this->fetching = true;
		$response = $this->client->_getReadProtocol($this->readPreference)->opQuery(

The method _getReadProtocol() does not seem to exist on object<Maslosoft\Mangan\Bridge\MongoClient>.

				$this->fcn, $this->getQuery(), $this->querySkip, $this->calculateRequestLimit(), $this->flags | Mongofill\Protocol::QF_SLAVE_OK, $this->queryTimeout, $this->fields

The method calculateRequestLimit() does not seem to exist on object<Maslosoft\Mangan\Bridge\MongoCursor>.

		);

		$this->cursorId = $response['cursorId'];
		$this->setDocuments($response);

The method setDocuments() does not seem to exist on object<Maslosoft\Mangan\Bridge\MongoCursor>.

	}

	private function getQuery()
	{
		if (isset($this->query['$query']) && count($this->query) == 1)
		{
			return $this->query['$query'];
		}

		return $this->query;
	}

}