Maslosoft\Mangan\Cursor

Complexity

Total Complexity

13

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

57.58%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	getCursor()	0	4	1
A	current()	0	10	2
A	key()	0	4	1
A	next()	0	4	1
A	rewind()	0	4	1
A	valid()	0	4	1
A	count()	0	4	1
A	limit()	0	4	1
A	offset()	0	4	1
A	sort()	0	4	1

<?php

/**
 * This software package is licensed under AGPL or Commercial license.
 *
 * @package maslosoft/mangan
 * @licence AGPL or Commercial
 * @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
 * @copyright Copyright (c) Maslosoft
 * @copyright Copyright (c) Others as mentioned in code
 * @link https://maslosoft.com/mangan/
 */

namespace Maslosoft\Mangan;

use Countable;
use Iterator;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Interfaces\Adapters\FinderCursorInterface;
use Maslosoft\Mangan\Transformers\RawArray;
use MongoCursor;
use UnexpectedValueException;

/**
 * Cursor
 *
 * Cursor object, that behaves much like the MongoCursor,
 * but this one returns instantiated objects
 * @author Ianaré Sévi
 * @author Dariusz Górecki <darek.krk@gmail.com>
 * @author Invenzzia Group, open-source division of CleverIT company http://www.invenzzia.org
 * @copyright 2011 CleverIT http://www.cleverit.com.pl
 * @since v1.3.4
 */
class Cursor implements Iterator, Countable
{

	/**
	 * MongoCursor returned by the query
	 * @var FinderCursorInterface|MongoCursor
	 * @since v1.3.4
	 */
	private $cursor;

	/**
	 * Model used for instantiating objects
	 * @var AnnotatedInterface
	 * @since v1.3.4
	 */
	private $model;

	/**
	 * Construct a new Cursor
	 *
	 * @param FinderCursorInterface|MongoCursor $cursor the cursor returned by the query
	 * @param AnnotatedInterface $model the model for instantiating objects
	 * @since v1.3.4
	 */
	public function __construct(Iterator $cursor, AnnotatedInterface $model)
	{
		assert($cursor instanceof FinderCursorInterface || $cursor instanceof MongoCursor, new UnexpectedValueException(sprintf('Expected `%s` or `%s` got `%s`', FinderCursorInterface::class, MongoCursor::class, get_class($cursor))));
		$this->cursor = $cursor;
		$this->model = $model;
	}

	/**
	 * Return MongoCursor for additional tuning
	 *
	 * @return FinderCursorInterface|MongoCursor the cursor used for this query
	 * @since v1.3.4
	 */
	public function getCursor()
	{
		return $this->cursor;
	}

	/**
	 * Return the current element
	 * @return AnnotatedInterface|Document|null
	 * @since v1.3.4
	 */
	public function current()
	{
		$document = $this->cursor->current();
		if (empty($document))
		{
			return null;
		}

		return RawArray::toModel($document, $this->model);
	}

	/**
	 * Return the key of the current element
	 * @return scalar
	 * @since v1.3.4
	 */
	public function key()
	{
		return $this->cursor->key();
	}

	/**
	 * Move forward to next element
	 * @return void
	 * @since v1.3.4
	 */
	public function next()
	{
		$this->cursor->next();
	}

	/**
	 * Rewind the Iterator to the first element
	 * @return void
	 * @since v1.3.4
	 */
	public function rewind()
	{
		$this->cursor->rewind();
	}

	/**
	 * Checks if current position is valid
	 * @return boolean
	 * @since v1.3.4
	 */
	public function valid()
	{
		return $this->cursor->valid();
	}

	/**
	 * Returns the number of documents found
	 * {@see http://www.php.net/manual/en/mongocursor.count.php}
	 * @param boolean $foundOnly default FALSE
	 * @return integer count of documents found
	 * @since v1.3.4
	 */
	public function count($foundOnly = false)
	{
		return $this->cursor->count($foundOnly);
	}

	/**
	 * Apply a limit to this cursor
	 * {@see http://www.php.net/manual/en/mongocursor.limit.php}
	 * @param integer $limit new limit
	 * @since v1.3.4
	 */
	public function limit($limit)
	{
		$this->cursor->limit($limit);
	}

	/**
	 * Skip a $offset records
	 * {@see http://www.php.net/manual/en/mongocursor.skip.php}
	 * @param integer $offset new skip
	 * @since v1.3.4
	 */
	public function offset($offset)
	{
		$this->cursor->skip($offset);

The method skip does only exist in MongoCursor, but not in Maslosoft\Mangan\Interfaces\Adapters\FinderCursorInterface.

	}

	/**
	 * Apply sorting directives
	 * {@see http://www.php.net/manual/en/mongocursor.sort.php}
	 * @param array $fields sorting directives
	 * @since v1.3.4
	 */
	public function sort(array $fields)
	{
		$this->cursor->sort($fields);
	}

}