Finder::__construct() - Code Metrics - Inspection of ">> Refactor finder" - Maslosoft/Mangan - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0d7bb7...25abba )

by Peter

created 2017-01-04 11:15 UTC

Finder::__construct() A

↳ Parent: Finder

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	14
ccs	10
cts	10
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	9
nc	2
nop	3
crap	2

<?php

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

namespace Maslosoft\Mangan;

use Iterator;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Abstracts\AbstractFinder;
use Maslosoft\Mangan\Adapters\Finder\MongoAdapter;
use Maslosoft\Mangan\Exceptions\ManganException;
use Maslosoft\Mangan\Helpers\FinderEvents;
use Maslosoft\Mangan\Helpers\PkManager;
use Maslosoft\Mangan\Interfaces\CriteriaInterface;
use Maslosoft\Mangan\Interfaces\EntityManagerInterface;
use Maslosoft\Mangan\Interfaces\FinderInterface;
use Maslosoft\Mangan\Interfaces\ScenariosInterface;
use Maslosoft\Mangan\Meta\ManganMeta;
use Maslosoft\Mangan\Traits\Finder\FinderHelpers;
use Maslosoft\Mangan\Transformers\RawArray;

/**
 * Basic Finder implementation
 *
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 */
class Finder extends AbstractFinder implements FinderInterface
{

	use FinderHelpers;

	/**
	 * Constructor
	 *
	 * @param object $model Model instance
	 * @param EntityManagerInterface $em
	 * @param Mangan $mangan
	 */
	public function __construct($model, $em = null, $mangan = null)
	{
		$this->setModel($model);
		$this->setScopeManager(new ScopeManager($model));
		if (null === $mangan)
		{
			$mangan = Mangan::fromModel($model);
		}
		$this->setAdapter(new MongoAdapter($model, $mangan, $em));

		$this->setProfiler($mangan->getProfiler());
		$this->setFinderEvents(new FinderEvents);
		$this->withCursor($mangan->useCursor);
	}

	/**
	 * Create model related finder.
	 * This will create customized finder if defined in model with Finder annotation.
	 * If no custom finder is defined this will return default Finder.
	 *
	 * @param AnnotatedInterface $model
	 * @param EntityManagerInterface $em
	 * @param Mangan $mangan
	 * @return FinderInterface
	 */
	public static function create(AnnotatedInterface $model, $em = null, Mangan $mangan = null)
	{
		$finderClass = ManganMeta::create($model)->type()->finder ?: static::class;
		return new $finderClass($model, $em, $mangan);
	}

	/**
	 * Finds a single Document with the specified condition.
	 *
	 * @param array|CriteriaInterface $criteria query criteria.
	 * @return AnnotatedInterface
	 * @Ignored
	 */
	public function find($criteria = null)
	{
		if ($this->getFinderEvents()->beforeFind($this))
		{
			$criteria = $this->getScopeManager()->apply($criteria);
			$data = $this->getAdapter()->findOne($criteria, $criteria->getSelect());
			return $this->populateRecord($data);
		}
		return null;
	}

	/**
	 * Finds document with the specified primary key. Primary key by default
	 * is defined by `_id` field. But could be any other. For simple (one column)
	 * keys use it's value.
	 *
	 * For composite use key-value with column names as keys
	 * and values for values.
	 *
	 * Example for simple pk:
	 * ```php
	 * $pk = '51b616fcc0986e30026d0748'
	 * ```
	 *
	 * Composite pk:
	 * ```php
	 * $pk = [
	 * 		'mainPk' => 1,
	 * 		'secondaryPk' => 2
	 * ];
	 * ```
	 *
	 * @param mixed $pkValue primary key value. Use array for composite key.
	 * @param array|CriteriaInterface $criteria
	 * @return AnnotatedInterface|null
	 * @Ignored
	 */
	public function findByPk($pkValue, $criteria = null)
	{
		$pkCriteria = $this->getScopeManager()->getNewCriteria($criteria);
		$pkCriteria->mergeWith(PkManager::prepare($this->getModel(), $pkValue));
		return $this->find($pkCriteria);
	}

	/**
	 * Finds document with the specified attributes.
	 * Attributes should be specified as key-value pairs.
	 * This allows easier syntax for simple queries.
	 *
	 * Example:
	 * ```php
	 * $attributes = [
	 * 		'name' => 'John',
	 * 		'title' => 'dr'
	 * ];
	 * ```
	 *
	 * @param mixed[] Array of stributes and values in form of ['attributeName' => 'value']
	 * @return AnnotatedInterface|null
	 */
	public function findByAttributes(array $attributes)
	{
		$criteria = $this->getScopeManager()->getNewCriteria();
		foreach ($attributes as $name => $value)
		{
			$criteria->addCond($name, '==', $value);
		}
		return $this->find($criteria);
	}

	/**
	 * Finds all documents satisfying the specified condition.
	 * See {@link find()} for detailed explanation about $condition and $params.
	 *
	 * @param array|CriteriaInterface $criteria query criteria.
	 * @return AnnotatedInterface[]|Cursor
	 */
	public function findAll($criteria = null)
	{
		if ($this->getFinderEvents()->beforeFind($this))
		{
			$criteria = $this->getScopeManager()->apply($criteria);
			$cursor = $this->getAdapter()->findMany($criteria);

			if ($criteria->getSort() !== null)
			{
				$cursor->sort($criteria->getSort());
			}
			if ($criteria->getLimit() !== null)
			{
				$cursor->limit($criteria->getLimit());
			}
			if ($criteria->getOffset() !== null)
			{
				$cursor->skip($criteria->getOffset());
			}
			if ($criteria->getSelect())
			{
				$cursor->fields($criteria->getSelect());
			}
			$this->getProfiler()->cursor($cursor);
			if ($this->isWithCursor())
			{
				return new Cursor($cursor, $this->getModel());
			}
			else
			{
				return $this->populateRecords($cursor);
			}
		}
		return [];
	}

	/**
	 * Finds all documents with the specified attributes.
	 *
	 * @param mixed[] Array of stributes and values in form of ['attributeName' => 'value']
	 * @return AnnotatedInterface[]|Cursor - Array or cursor of Documents
	 * @since v1.0
	 */
	public function findAllByAttributes(array $attributes)
	{
		$criteria = $this->getScopeManager()->getNewCriteria();
		foreach ($attributes as $name => $value)
		{
			$criteria->$name('==', $value);
		}

		return $this->findAll($criteria);
	}

	/**
	 * Finds all documents with the specified primary keys.
	 * In MongoDB world every document has '_id' unique field, so with this method that
	 * field is in use as PK by default.
	 * See {@link find()} for detailed explanation about $condition.
	 *
	 * @param mixed $pkValues primary key value(s). Use array for multiple primary keys. For composite key, each key value must be an array (column name=>column value).
	 * @param array|CriteriaInterface $criteria query criteria.
	 * @return AnnotatedInterface[]|Cursor - Array or cursor of Documents
	 * @since v1.0
	 */
	public function findAllByPk($pkValues, $criteria = null)
	{
		$pkCriteria = $this->getScopeManager()->getNewCriteria($criteria);
		PkManager::prepareAll($this->getModel(), $pkValues, $pkCriteria);

		return $this->findAll($pkCriteria);
	}

	/**
	 * Counts all documents satisfying the specified condition.
	 * See {@link find()} for detailed explanation about $condition and $params.
	 * @param array|CriteriaInterface $criteria query criteria.
	 * @return integer Count of all documents satisfying the specified condition.
	 * @since v1.0
	 */
	public function count($criteria = null)
	{
		if ($this->getFinderEvents()->beforeCount($this))
		{
			$criteria = $this->getScopeManager()->apply($criteria);
			$count = $this->getAdapter()->count($criteria);
			$this->getFinderEvents()->afterCount($this);
			return $count;
		}
		return 0;
	}

	/**
	 * Counts all documents found by attribute values.
	 *
	 * Example:
	 * ```php
	 * $attributes = [
	 * 		'name' => 'John',
	 * 		'title' => 'dr'
	 * ];
	 * ```
	 *
	 * @param mixed[] Array of attributes and values in form of ['attributeName' => 'value']
	 * @return int
	 * @since v1.2.2
	 * @Ignored
	 */
	public function countByAttributes(array $attributes)
	{
		if ($this->getFinderEvents()->beforeCount($this))
		{
			$criteria = $this->getScopeManager()->getNewCriteria();
			foreach ($attributes as $name => $value)
			{
				$criteria->$name = $value;
			}

			$scopedCriteria = $this->getScopeManager()->apply($criteria);

			$count = $this->getAdapter()->count($scopedCriteria);
			$this->getFinderEvents()->afterCount($this);
			return $count;
		}
		return 0;
	}

	/**
	 * Checks whether there is document satisfying the specified condition.
	 *
	 * @param CriteriaInterface $criteria
	 * @return bool
	 */
	public function exists(CriteriaInterface $criteria = null)
	{
		if ($this->getFinderEvents()->beforeExists($this))
		{
			$criteria = $this->getScopeManager()->apply($criteria);

			//Select only Pk Fields to not fetch possibly large document
			$pkKeys = PkManager::getPkKeys($this->getModel());
			if (is_string($pkKeys))
			{
				$pkKeys = [$pkKeys];
			}
			$cursor = $this->getAdapter()->findMany($criteria, $pkKeys);
			$cursor->limit(1);

			// NOTE: Cannot use count(true) here because of hhvm mongofill compatibility, see:
			// https://github.com/mongofill/mongofill/issues/86
			$exists = ($cursor->count() !== 0);
			$this->getFinderEvents()->afterExists($this);
			return $exists;
		}
		return false;
	}

	/**
	 * Resets all scopes and criteria applied including default scope.
	 *
	 * @return Finder
	 * @since v1.0
	 */
	public function resetScope()
	{
		$this->getScopeManager()->reset();
		return $this;
	}

	/**
	 * Creates an model with the given attributes.
	 * This method is internally used by the find methods.
	 * @param mixed[] $data attribute values (column name=>column value)
	 * @return AnnotatedInterface|null the newly created document. The class of the object is the same as the model class.
	 * Null is returned if the input data is false.
	 * @since v1.0
	 */
	protected function populateRecord($data)
	{
		if ($data !== null)
		{
			$model = $this->createModel($data);
			ScenarioManager::setScenario($model, ScenariosInterface::Update);
			$this->getFinderEvents()->afterFind($this, $model);
			return $model;
		}
		else
		{
			return null;
		}
	}

	protected function createModel($data)
	{
		if (!empty($data['$err']))
		{
			throw new ManganException(sprintf("There is an error in query: %s", $data['$err']));
		}
		return RawArray::toModel($data, $this->getModel());
	}

	/**
	 * Creates a list of documents based on the input data.
	 * This method is internally used by the find methods.
	 * @param Iterator|array $cursor Results found to populate active records.
	 * @return AnnotatedInterface[] array list of active records.
	 * @since v1.0
	 */
	protected function populateRecords($cursor)
	{
		$records = array();
		foreach ($cursor as $data)
		{
			$records[] = $this->populateRecord($data);
		}
		return $records;
	}

}


1		<?php
2
3		/**
4		* This software package is licensed under AGPL or Commercial license.
5		*
6		* @package maslosoft/mangan
7		* @licence AGPL or Commercial
8		* @copyright Copyright (c) Piotr Masełkowski <[email protected]>
9		* @copyright Copyright (c) Maslosoft
10		* @copyright Copyright (c) Others as mentioned in code
11		* @link http://maslosoft.com/mangan/
12		*/
13
14		namespace Maslosoft\Mangan;
15
16		use Iterator;
17		use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
18		use Maslosoft\Mangan\Abstracts\AbstractFinder;
19		use Maslosoft\Mangan\Adapters\Finder\MongoAdapter;
20		use Maslosoft\Mangan\Exceptions\ManganException;
21		use Maslosoft\Mangan\Helpers\FinderEvents;
22		use Maslosoft\Mangan\Helpers\PkManager;
23		use Maslosoft\Mangan\Interfaces\CriteriaInterface;
24		use Maslosoft\Mangan\Interfaces\EntityManagerInterface;
25		use Maslosoft\Mangan\Interfaces\FinderInterface;
26		use Maslosoft\Mangan\Interfaces\ScenariosInterface;
27		use Maslosoft\Mangan\Meta\ManganMeta;
28		use Maslosoft\Mangan\Traits\Finder\FinderHelpers;
29		use Maslosoft\Mangan\Transformers\RawArray;
30
31		/**
32		* Basic Finder implementation
33		*
34		* @author Piotr Maselkowski <pmaselkowski at gmail.com>
35		*/
36		class Finder extends AbstractFinder implements FinderInterface
37		{
38
39		use FinderHelpers;
40
41		/**
42		* Constructor
43		*
44		* @param object $model Model instance
45		* @param EntityManagerInterface $em
46		* @param Mangan $mangan
47		*/
48	69	public function __construct($model, $em = null, $mangan = null)
49		{
50	69	$this->setModel($model);
51	69	$this->setScopeManager(new ScopeManager($model));
52	69	if (null === $mangan)
53		{
54	69	$mangan = Mangan::fromModel($model);
55		}
56	69	$this->setAdapter(new MongoAdapter($model, $mangan, $em));
57
58	69	$this->setProfiler($mangan->getProfiler());
59	69	$this->setFinderEvents(new FinderEvents);
60	69	$this->withCursor($mangan->useCursor);
61	69	}
62
63		/**
64		* Create model related finder.
65		* This will create customized finder if defined in model with Finder annotation.
66		* If no custom finder is defined this will return default Finder.
67		*
68		* @param AnnotatedInterface $model
69		* @param EntityManagerInterface $em
70		* @param Mangan $mangan
71		* @return FinderInterface
72		*/
73	9	public static function create(AnnotatedInterface $model, $em = null, Mangan $mangan = null)
74		{
75	9	$finderClass = ManganMeta::create($model)->type()->finder ?: static::class;
76	9	return new $finderClass($model, $em, $mangan);
77		}
78
79		/**
80		* Finds a single Document with the specified condition.
81		*
82		* @param array\|CriteriaInterface $criteria query criteria.
83		* @return AnnotatedInterface
84		* @Ignored
85		*/
86	52	public function find($criteria = null)
87		{
88	52	if ($this->getFinderEvents()->beforeFind($this))
89		{
90	52	$criteria = $this->getScopeManager()->apply($criteria);
91	52	$data = $this->getAdapter()->findOne($criteria, $criteria->getSelect());
92	52	return $this->populateRecord($data);
93		}
94		return null;
95		}
96
97		/**
98		* Finds document with the specified primary key. Primary key by default
99		* is defined by `_id` field. But could be any other. For simple (one column)
100		* keys use it's value.
101		*
102		* For composite use key-value with column names as keys
103		* and values for values.
104		*
105		* Example for simple pk:
106		* ```php
107		* $pk = '51b616fcc0986e30026d0748'
108		* ```
109		*
110		* Composite pk:
111		* ```php
112		* $pk = [
113		* 'mainPk' => 1,
114		* 'secondaryPk' => 2
115		* ];
116		* ```
117		*
118		* @param mixed $pkValue primary key value. Use array for composite key.
119		* @param array\|CriteriaInterface $criteria
120		* @return AnnotatedInterface\|null
121		* @Ignored
122		*/
123	40	public function findByPk($pkValue, $criteria = null)
124		{
125	40	$pkCriteria = $this->getScopeManager()->getNewCriteria($criteria);
126	40	$pkCriteria->mergeWith(PkManager::prepare($this->getModel(), $pkValue));
127	40	return $this->find($pkCriteria);
128		}
129
130		/**
131		* Finds document with the specified attributes.
132		* Attributes should be specified as key-value pairs.
133		* This allows easier syntax for simple queries.
134		*
135		* Example:
136		* ```php
137		* $attributes = [
138		* 'name' => 'John',
139		* 'title' => 'dr'
140		* ];
141		* ```
142		*
143		* @param mixed[] Array of stributes and values in form of ['attributeName' => 'value']
144		* @return AnnotatedInterface\|null
145		*/
146	2	public function findByAttributes(array $attributes)
147		{
148	2	$criteria = $this->getScopeManager()->getNewCriteria();
149	2	foreach ($attributes as $name => $value)
150		{
151	2	$criteria->addCond($name, '==', $value);
152		}
153	2	return $this->find($criteria);
154		}
155
156		/**
157		* Finds all documents satisfying the specified condition.
158		* See {@link find()} for detailed explanation about $condition and $params.
159		*
160		* @param array\|CriteriaInterface $criteria query criteria.
161		* @return AnnotatedInterface[]\|Cursor
162		*/
163	18	public function findAll($criteria = null)
164		{
165	18	if ($this->getFinderEvents()->beforeFind($this))
166		{
167	18	$criteria = $this->getScopeManager()->apply($criteria);
168	18	$cursor = $this->getAdapter()->findMany($criteria);
169
170	18	if ($criteria->getSort() !== null)
171		{
172	18	$cursor->sort($criteria->getSort());
173		}
174	18	if ($criteria->getLimit() !== null)
175		{
176	1	$cursor->limit($criteria->getLimit());
177		}
178	18	if ($criteria->getOffset() !== null)
179		{
180	1	$cursor->skip($criteria->getOffset());
181		}
182	18	if ($criteria->getSelect())
183		{
184	1	$cursor->fields($criteria->getSelect());
185		}
186	18	$this->getProfiler()->cursor($cursor);
187	18	if ($this->isWithCursor())
188		{
189	1	return new Cursor($cursor, $this->getModel());
190		}
191		else
192		{
193	17	return $this->populateRecords($cursor);
194		}
195		}
196		return [];
197		}
198
199		/**
200		* Finds all documents with the specified attributes.
201		*
202		* @param mixed[] Array of stributes and values in form of ['attributeName' => 'value']
203		* @return AnnotatedInterface[]\|Cursor - Array or cursor of Documents
204		* @since v1.0
205		*/
206	1	public function findAllByAttributes(array $attributes)
207		{
208	1	$criteria = $this->getScopeManager()->getNewCriteria();
209	1	foreach ($attributes as $name => $value)
210		{
211	1	$criteria->$name('==', $value);
212		}
213
214	1	return $this->findAll($criteria);
215		}
216
217		/**
218		* Finds all documents with the specified primary keys.
219		* In MongoDB world every document has '_id' unique field, so with this method that
220		* field is in use as PK by default.
221		* See {@link find()} for detailed explanation about $condition.
222		*
223		* @param mixed $pkValues primary key value(s). Use array for multiple primary keys. For composite key, each key value must be an array (column name=>column value).
224		* @param array\|CriteriaInterface $criteria query criteria.
225		* @return AnnotatedInterface[]\|Cursor - Array or cursor of Documents
226		* @since v1.0
227		*/
228	7	public function findAllByPk($pkValues, $criteria = null)
229		{
230	7	$pkCriteria = $this->getScopeManager()->getNewCriteria($criteria);
231	7	PkManager::prepareAll($this->getModel(), $pkValues, $pkCriteria);
232
233	7	return $this->findAll($pkCriteria);
234		}
235
236		/**
237		* Counts all documents satisfying the specified condition.
238		* See {@link find()} for detailed explanation about $condition and $params.
239		* @param array\|CriteriaInterface $criteria query criteria.
240		* @return integer Count of all documents satisfying the specified condition.
241		* @since v1.0
242		*/
243	19	public function count($criteria = null)
244		{
245	19	if ($this->getFinderEvents()->beforeCount($this))
246		{
247	19	$criteria = $this->getScopeManager()->apply($criteria);
248	19	$count = $this->getAdapter()->count($criteria);
249	19	$this->getFinderEvents()->afterCount($this);
250	19	return $count;
251		}
252		return 0;
253		}
254
255		/**
256		* Counts all documents found by attribute values.
257		*
258		* Example:
259		* ```php
260		* $attributes = [
261		* 'name' => 'John',
262		* 'title' => 'dr'
263		* ];
264		* ```
265		*
266		* @param mixed[] Array of attributes and values in form of ['attributeName' => 'value']
267		* @return int
268		* @since v1.2.2
269		* @Ignored
270		*/
271	1	public function countByAttributes(array $attributes)
272		{
273	1	if ($this->getFinderEvents()->beforeCount($this))
274		{
275	1	$criteria = $this->getScopeManager()->getNewCriteria();
276	1	foreach ($attributes as $name => $value)
277		{
278	1	$criteria->$name = $value;
279		}
280
281	1	$scopedCriteria = $this->getScopeManager()->apply($criteria);
282
283	1	$count = $this->getAdapter()->count($scopedCriteria);
284	1	$this->getFinderEvents()->afterCount($this);
285	1	return $count;
286		}
287		return 0;
288		}
289
290		/**
291		* Checks whether there is document satisfying the specified condition.
292		*
293		* @param CriteriaInterface $criteria
294		* @return bool
295		*/
296	9	public function exists(CriteriaInterface $criteria = null)
297		{
298	9	if ($this->getFinderEvents()->beforeExists($this))
299		{
300	9	$criteria = $this->getScopeManager()->apply($criteria);
301
302		//Select only Pk Fields to not fetch possibly large document
303	9	$pkKeys = PkManager::getPkKeys($this->getModel());
304	9	if (is_string($pkKeys))
305		{
306	7	$pkKeys = [$pkKeys];
307		}
308	9	$cursor = $this->getAdapter()->findMany($criteria, $pkKeys);
309	9	$cursor->limit(1);
310
311		// NOTE: Cannot use count(true) here because of hhvm mongofill compatibility, see:
312		// https://github.com/mongofill/mongofill/issues/86
313	9	$exists = ($cursor->count() !== 0);
314	9	$this->getFinderEvents()->afterExists($this);
315	9	return $exists;
316		}
317		return false;
318		}
319
320		/**
321		* Resets all scopes and criteria applied including default scope.
322		*
323		* @return Finder
324		* @since v1.0
325		*/
326		public function resetScope()
327		{
328		$this->getScopeManager()->reset();
329		return $this;
330		}
331
332		/**
333		* Creates an model with the given attributes.
334		* This method is internally used by the find methods.
335		* @param mixed[] $data attribute values (column name=>column value)
336		* @return AnnotatedInterface\|null the newly created document. The class of the object is the same as the model class.
337		* Null is returned if the input data is false.
338		* @since v1.0
339		*/
340	59	protected function populateRecord($data)
341		{
342	59	if ($data !== null)
343		{
344	58	$model = $this->createModel($data);
345	58	ScenarioManager::setScenario($model, ScenariosInterface::Update);
346	58	$this->getFinderEvents()->afterFind($this, $model);
347	58	return $model;
348		}
349		else
350		{
351	3	return null;
352		}
353		}
354
355	58	protected function createModel($data)
356		{
357	58	if (!empty($data['$err']))
358		{
359		throw new ManganException(sprintf("There is an error in query: %s", $data['$err']));
360		}
361	58	return RawArray::toModel($data, $this->getModel());
362		}
363
364		/**
365		* Creates a list of documents based on the input data.
366		* This method is internally used by the find methods.
367		* @param Iterator\|array $cursor Results found to populate active records.
368		* @return AnnotatedInterface[] array list of active records.
369		* @since v1.0
370		*/
371	17	protected function populateRecords($cursor)
372		{
373	17	$records = array();
374	17	foreach ($cursor as $data)
375		{
376	17	$records[] = $this->populateRecord($data);
377		}
378	17	return $records;
379		}
380
381		}
382

Maslosoft / Mangan

Push — master ( 0d7bb7...25abba )

Finder::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like