DataProvider::getTotalItemCount() - Code Metrics - Inspection of "+ Pagination" - Maslosoft/Mangan - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6c4e57...0b7137 )

by Peter

created 2016-05-31 09:49 UTC

DataProvider::getTotalItemCount() A

↳ Parent: DataProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
ccs	0
cts	1
cp	0
rs	9.4285
cc	2
eloc	4
nc	2
nop	0
crap	6

<?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 Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Exceptions\ManganException;
use Maslosoft\Mangan\Interfaces\Criteria\DecoratableInterface;
use Maslosoft\Mangan\Interfaces\Criteria\LimitableInterface;
use Maslosoft\Mangan\Interfaces\CriteriaInterface;
use Maslosoft\Mangan\Interfaces\DataProviderInterface;
use Maslosoft\Mangan\Interfaces\FinderInterface;
use Maslosoft\Mangan\Interfaces\PaginationInterface;
use Maslosoft\Mangan\Interfaces\SortInterface;
use Maslosoft\Mangan\Interfaces\WithCriteriaInterface;
use Maslosoft\Mangan\Meta\ManganMeta;

/**
 * Mongo document data provider
 *
 * Implements a data provider based on Document.
 *
 * DataProvider provides data in terms of Document objects which are
 * of class {@link modelClass}. It uses the AR {@link CActiveRecord::findAll} method
 * to retrieve the data from database. The {@link query} property can be used to
 * specify various query options, such as conditions, sorting, pagination, etc.
 *
 * @author Ianaré Sévi
 * @author Dariusz Górecki <[email protected]>
 * @author Invenzzia Group, open-source division of CleverIT company http://www.invenzzia.org
 * @copyright 2011 CleverIT http://www.cleverit.com.pl
 * @since v1.0
 */
class DataProvider implements DataProviderInterface
{

	/**
	 * Instance of model
	 * @var Document
	 * @since v1.0
	 */
	public $model;

	/**
	 * Finder instance
	 * @var FinderInterface
	 */
	private $finder = null;

	/**
	 * @var CriteriaInterface
	 */
	private $criteria;

	/**
	 * @var SortInterface
	 */
	private $sort;
	private $data = null;
	private $totalItemCount = null;

	/**
	 * Pagination instance
	 * @var PaginationInterface
	 */
	private $pagination = null;

	/**
	 * Constructor.
	 * @param mixed $modelClass the model class (e.g. 'Post') or the model finder instance
	 * (e.g. <code>Post::model()</code>, <code>Post::model()->published()</code>).
	 * @param array $config configuration (name=>value) to be applied as the initial property values of this class.
	 * @since v1.0
	 */
	public function __construct($modelClass, $config = [])
	{
		if (is_string($modelClass))
		{
			$this->model = new $modelClass;
		}
		elseif (is_object($modelClass))
		{
			$this->model = $modelClass;
		}
		else
		{
			throw new ManganException('Invalid model type for ' . __CLASS__);
		}

		$this->finder = Finder::create($this->model);
		if ($this->model instanceof WithCriteriaInterface)
		{
			$this->criteria = $this->model->getDbCriteria();
		}
		else
		{
			$this->criteria = new Criteria();
		}
		if (isset($config['criteria']))
		{
			$this->criteria->mergeWith($config['criteria']);
			unset($config['criteria']);
		}

		if (!$this->criteria->getSelect())
		{
			$fields = array_keys(ManganMeta::create($this->model)->fields());
			$fields = array_fill_keys($fields, true);
			$this->criteria->setSelect($fields);
		}

		foreach ($config as $key => $value)
		{
			$this->$key = $value;
		}
	}

	/**
	 * Get model used by this dataprovider
	 * @return AnnotatedInterface
	 */
	public function getModel()
	{
		return $this->model;
	}

	/**
	 * Returns the criteria.
	 * @return Criteria the query criteria
	 * @since v1.0
	 */
	public function getCriteria()
	{
		// Initialise empty criteria, so it's always available via this method call.
		if (empty($this->criteria))
		{
			$this->criteria = new Criteria;
		}
		return $this->criteria;
	}

	/**
	 * Sets the query criteria.
	 * @param CriteriaInterface|array $criteria the query criteria. Array representing the MongoDB query criteria.
	 * @since v1.0
	 */
	public function setCriteria($criteria)
	{
		if (is_array($criteria))
		{
			$this->criteria = new Criteria($criteria);
		}
		elseif ($criteria instanceof CriteriaInterface)
		{
			$this->criteria = $criteria;
		}
		if ($this->criteria instanceof DecoratableInterface)
		{
			$this->criteria->decorateWith($this->getModel());
		}
	}

	/**
	 * Returns the sort object.
	 * @return Sort the sorting object. If this is false, it means the sorting is disabled.
	 */
	public function getSort()
	{
		if ($this->sort === null)
		{
			$this->sort = new Sort;
			$this->sort->setModel($this->model);
		}
		return $this->sort;
	}

	/**
	 * Set sort
	 * @param SortInterface $sort
	 * @return DataProvider
	 */
	public function setSort(SortInterface $sort)
	{
		$this->sort = $sort;
		$this->sort->setModel($this->model);
		return $this;
	}

	/**
	 * Returns the pagination object.
	 * @param string $className the pagination object class name, use this param to override default pagination class.
	 * @return Pagination|false the pagination object. If this is false, it means the pagination is disabled.
	 */
	public function getPagination($className = Pagination::class)
	{
		if ($this->pagination === false)
		{
			return false;
		}
		if ($this->pagination === null)
		{
			$this->pagination = new $className;
		}
		return $this->pagination;
	}

	/**
	 * Returns the number of data items in the current page.
	 * This is equivalent to <code>count($provider->getData())</code>.
	 * When {@link pagination} is set false, this returns the same value as {@link totalItemCount}.
	 * @param boolean $refresh whether the number of data items should be re-calculated.
	 * @return integer the number of data items in the current page.
	 */
	public function getItemCount($refresh = false)
	{
		return count($this->getData($refresh));
	}

	/**
	 * Returns the total number of data items.
	 * When {@link pagination} is set false, this returns the same value as {@link itemCount}.
	 * @return integer total number of possible data items.
	 */
	public function getTotalItemCount()
	{
		if ($this->totalItemCount === null)
		{
			$this->totalItemCount = $this->finder->count($this->criteria);
		}
		return $this->totalItemCount;
	}

	/**
	 * Fetches the data from the persistent data storage.
	 * @return Document[]|Cursor list of data items
	 * @since v1.0
	 */
	protected function fetchData()
	{
		$pagination = $this->getPagination();
		if ($pagination !== false && $this->criteria instanceof LimitableInterface)
		{
			$pagination->setCount($this->getTotalItemCount());
			$pagination->apply($this->criteria);
		}

		$sort = $this->getSort();
		if ($sort->isSorted())
		{
			$this->criteria->setSort($sort);
		}

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

	/**
	 * Returns the data items currently available, ensures that result is at leas empty array
	 * @param boolean $refresh whether the data should be re-fetched from persistent storage.
	 * @return array the list of data items currently available in this data provider.
	 */
	public function getData($refresh = false)
	{
		if ($this->data === null || $refresh)
		{
			$this->data = $this->fetchData();
		}
		if ($this->data === null)
		{
			return [];
		}
		return $this->data;
	}

}


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 Maslosoft\Addendum\Interfaces\AnnotatedInterface;
17			use Maslosoft\Mangan\Exceptions\ManganException;
18			use Maslosoft\Mangan\Interfaces\Criteria\DecoratableInterface;
19			use Maslosoft\Mangan\Interfaces\Criteria\LimitableInterface;
20			use Maslosoft\Mangan\Interfaces\CriteriaInterface;
21			use Maslosoft\Mangan\Interfaces\DataProviderInterface;
22			use Maslosoft\Mangan\Interfaces\FinderInterface;
23			use Maslosoft\Mangan\Interfaces\PaginationInterface;
24			use Maslosoft\Mangan\Interfaces\SortInterface;
25			use Maslosoft\Mangan\Interfaces\WithCriteriaInterface;
26			use Maslosoft\Mangan\Meta\ManganMeta;
27
28			/**
29			* Mongo document data provider
30			*
31			* Implements a data provider based on Document.
32			*
33			* DataProvider provides data in terms of Document objects which are
34			* of class {@link modelClass}. It uses the AR {@link CActiveRecord::findAll} method
35			* to retrieve the data from database. The {@link query} property can be used to
36			* specify various query options, such as conditions, sorting, pagination, etc.
37			*
38			* @author Ianaré Sévi
39			* @author Dariusz Górecki <[email protected]>
40			* @author Invenzzia Group, open-source division of CleverIT company http://www.invenzzia.org
41			* @copyright 2011 CleverIT http://www.cleverit.com.pl
42			* @since v1.0
43			*/
44			class DataProvider implements DataProviderInterface
45			{
46
47			/**
48			* Instance of model
49			* @var Document
50			* @since v1.0
51			*/
52			public $model;
53
54			/**
55			* Finder instance
56			* @var FinderInterface
57			*/
58			private $finder = null;
59
60			/**
61			* @var CriteriaInterface
62			*/
63			private $criteria;
64
65			/**
66			* @var SortInterface
67			*/
68			private $sort;
69			private $data = null;
70			private $totalItemCount = null;
71
72			/**
73			* Pagination instance
74			* @var PaginationInterface
75			*/
76			private $pagination = null;
77
78			/**
79			* Constructor.
80			* @param mixed $modelClass the model class (e.g. 'Post') or the model finder instance
81			* (e.g. <code>Post::model()</code>, <code>Post::model()->published()</code>).
82			* @param array $config configuration (name=>value) to be applied as the initial property values of this class.
83			* @since v1.0
84			*/
85			public function __construct($modelClass, $config = [])
86			{
87			if (is_string($modelClass))
88			{
89			$this->model = new $modelClass;
90			}
91			elseif (is_object($modelClass))
92			{
93			$this->model = $modelClass;
94			}
95			else
96			{
97			throw new ManganException('Invalid model type for ' . __CLASS__);
98			}
99
100			$this->finder = Finder::create($this->model);
101			if ($this->model instanceof WithCriteriaInterface)
102			{
103			$this->criteria = $this->model->getDbCriteria();
104			}
105			else
106			{
107			$this->criteria = new Criteria();
108			}
109			if (isset($config['criteria']))
110			{
111			$this->criteria->mergeWith($config['criteria']);
112			unset($config['criteria']);
113			}
114
115			if (!$this->criteria->getSelect())
116			{
117			$fields = array_keys(ManganMeta::create($this->model)->fields());
118			$fields = array_fill_keys($fields, true);
119			$this->criteria->setSelect($fields);
120			}
121
122			foreach ($config as $key => $value)
123			{
124			$this->$key = $value;
125			}
126			}
127
128			/**
129			* Get model used by this dataprovider
130			* @return AnnotatedInterface
131			*/
132			public function getModel()
133			{
134			return $this->model;
135			}
136
137			/**
138			* Returns the criteria.
139			* @return Criteria the query criteria
140			* @since v1.0
141			*/
142			public function getCriteria()
143			{
144			// Initialise empty criteria, so it's always available via this method call.
145			if (empty($this->criteria))
146			{
147			$this->criteria = new Criteria;
148			}
149			return $this->criteria;
150			}
151
152			/**
153			* Sets the query criteria.
154			* @param CriteriaInterface\|array $criteria the query criteria. Array representing the MongoDB query criteria.
155			* @since v1.0
156			*/
157			public function setCriteria($criteria)
158			{
159			if (is_array($criteria))
160			{
161			$this->criteria = new Criteria($criteria);
162			}
163			elseif ($criteria instanceof CriteriaInterface)
164			{
165			$this->criteria = $criteria;
166			}
167			if ($this->criteria instanceof DecoratableInterface)
168			{
169			$this->criteria->decorateWith($this->getModel());
170			}
171			}
172
173			/**
174			* Returns the sort object.
175			* @return Sort the sorting object. If this is false, it means the sorting is disabled.
176			*/
177			public function getSort()
178			{
179			if ($this->sort === null)
180			{
181			$this->sort = new Sort;
182			$this->sort->setModel($this->model);
183			}
184			return $this->sort;
185			}
186
187			/**
188			* Set sort
189			* @param SortInterface $sort
190			* @return DataProvider
191			*/
192			public function setSort(SortInterface $sort)
193			{
194			$this->sort = $sort;
195			$this->sort->setModel($this->model);
196			return $this;
197			}
198
199			/**
200			* Returns the pagination object.
201			* @param string $className the pagination object class name, use this param to override default pagination class.
202			* @return Pagination\|false the pagination object. If this is false, it means the pagination is disabled.
203			*/
204			public function getPagination($className = Pagination::class)
205			{
206			if ($this->pagination === false)
207			{
208			return false;
209			}
210			if ($this->pagination === null)
211			{
212			$this->pagination = new $className;
213			}
214			return $this->pagination;
215			}
216
217			/**
218			* Returns the number of data items in the current page.
219			* This is equivalent to <code>count($provider->getData())</code>.
220			* When {@link pagination} is set false, this returns the same value as {@link totalItemCount}.
221			* @param boolean $refresh whether the number of data items should be re-calculated.
222			* @return integer the number of data items in the current page.
223			*/
224			public function getItemCount($refresh = false)
225			{
226			return count($this->getData($refresh));
227			}
228
229			/**
230			* Returns the total number of data items.
231			* When {@link pagination} is set false, this returns the same value as {@link itemCount}.
232			* @return integer total number of possible data items.
233			*/
234			public function getTotalItemCount()
235			{
236			if ($this->totalItemCount === null)
237			{
238			$this->totalItemCount = $this->finder->count($this->criteria);
239			}
240			return $this->totalItemCount;
241			}
242
243			/**
244			* Fetches the data from the persistent data storage.
245			* @return Document[]\|Cursor list of data items
246			* @since v1.0
247			*/
248			protected function fetchData()
249			{
250			$pagination = $this->getPagination();
251			if ($pagination !== false && $this->criteria instanceof LimitableInterface)
252			{
253			$pagination->setCount($this->getTotalItemCount());
254			$pagination->apply($this->criteria);
255			}
256
257			$sort = $this->getSort();
258			if ($sort->isSorted())
259			{
260			$this->criteria->setSort($sort);
261			}
262
263			return $this->finder->findAll($this->criteria);
264			}
265
266			/**
267			* Returns the data items currently available, ensures that result is at leas empty array
268			* @param boolean $refresh whether the data should be re-fetched from persistent storage.
269			* @return array the list of data items currently available in this data provider.
270			*/
271			public function getData($refresh = false)
272			{
273			if ($this->data === null \|\| $refresh)
274			{
275			$this->data = $this->fetchData();
276			}
277			if ($this->data === null)
278			{
279			return [];
280			}
281			return $this->data;
282			}
283
284			}
285

Maslosoft / Mangan

Push — master ( 6c4e57...0b7137 )

DataProvider::getTotalItemCount() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like