DoctrineCollectionDataSource::getData() - Code Metrics - Inspection of "Added DoctrineCollectionDataSource data-source" - ublaboo/datagrid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#300)

by Martin

created 2016-07-30 22:57 UTC

DoctrineCollectionDataSource::getData() A

↳ Parent: DoctrineCollectionDataSource

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

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

<?php

/**
 * @copyright   Copyright (c) 2015 ublaboo <[email protected]>
 * @author      Jakub Kontra <[email protected]>
 * @author      Pavel Janda <[email protected]>
 * @package     Ublaboo
 */

namespace Ublaboo\DataGrid\DataSource;

use Doctrine\Common\Collections\Collection;
use Doctrine\Common\Collections\Criteria;
use Ublaboo\DataGrid\Filter;
use Ublaboo\DataGrid\Utils\Sorting;

final class DoctrineCollectionDataSource extends FilterableDataSource implements IDataSource
{

	/**
	 * @var Collection
	 */
	private $data_source;

	/**
	 * @var string
	 */
	private $primary_key;

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


	/**
	 * @param Collection  $collection
	 * @param string      $primary_key
	 */
	public function __construct(Collection $collection, $primary_key)
	{
		$this->criteria = Criteria::create();
		$this->data_source = $collection;
		$this->primary_key = $primary_key;
	}


	/**
	 * @return Collection
	 */
	private function getFilteredCollection()
	{
		return $this->data_source->matching($this->criteria);
	}


	/********************************************************************************
	 *                          IDataSource implementation                          *
	 ********************************************************************************/


	/**
	 * Get count of data
	 * @return int
	 */
	public function getCount()
	{
		return $this->getFilteredCollection()->count();
	}


	/**
	 * Get the data
	 * @return array
	 */
	public function getData()
	{
		return $this->getFilteredCollection()->toArray();
	}


	/**
	 * Filter data - get one row
	 * @param array $condition
	 * @return static
	 */
	public function filterOne(array $condition)
	{
		foreach ($condition as $column => $value) {
			$expr = Criteria::expr()->eq($column, $value);
			$this->criteria->andWhere($expr);
		}

		return $this;
	}


	/**
	 * Filter by date
	 * @param  Filter\FilterDate $filter
	 * @return void
	 */
	public function applyFilterDate(Filter\FilterDate $filter)
	{
		foreach ($filter->getCondition() as $column => $value) {
			$date = \DateTime::createFromFormat($filter->getPhpFormat(), $value)
				->format('Y-m-d H:i:s');

			$from = Criteria::expr()->gte($filter->getColumn(), $date->format('Y-m-d 00:00:00'));
			$to = Criteria::expr()->lte($filter->getColumn(), $date->format('Y-m-d 23:59:59'));

			$this->criteria->andWhere($from)->andWhere($to);
		}
	}


	/**
	 * Filter by date range
	 * @param  Filter\FilterDateRange $filter
	 * @return void
	 */
	public function applyFilterDateRange(Filter\FilterDateRange $filter)
	{
		$values = $conditions[$filter->getColumn()];


		if ($value_from = $values['from']) {

			$date_from = \DateTime::createFromFormat($filter->getPhpFormat(), $value_from)
				->setTime(0, 0, 0)
				->format('Y-m-d H:i:s');

			$expr = Criteria::expr()->gte($filter->getColumn(), $date_from);
			$this->criteria->andWhere($expr);
		}

		if ($value_to = $values['to']) {

			$date_to = \DateTime::createFromFormat($filter->getPhpFormat(), $value_to)
				->setTime(23, 59, 59)
				->format('Y-m-d H:i:s');

			$expr = Criteria::expr()->lte($filter->getColumn(), $date_to);
			$this->criteria->andWhere($expr);
		}
	}


	/**
	 * Filter by range
	 * @param  Filter\FilterRange $filter
	 * @return void
	 */
	public function applyFilterRange(Filter\FilterRange $filter)
	{
		$values = $conditions[$filter->getColumn()];


		if ($value_from = $values['from']) {
			$expr = Criteria::expr()->gte($filter->getColumn(), $value_from);
			$this->criteria->andWhere($expr);
		}

		if ($value_to = $values['to']) {
			$expr = Criteria::expr()->lte($filter->getColumn(), $value_to);
			$this->criteria->andWhere($expr);
		}
	}


	/**
	 * Filter by keyword
	 * @param  Filter\FilterText $filter
	 * @return void
	 */
	public function applyFilterText(Filter\FilterText $filter)
	{
		$exprs = [];

		foreach ($filter->getCondition() as $column => $value) {
			if ($filter->hasSplitWordsSearch() === FALSE) {

				$words = [$value];
			} else {
				$words = explode(' ', $value);
			}

			foreach ($words as $word) {
				$exprs[] = Criteria::expr()->contains($column, $word);
			}
		}

		$expr = call_user_func_array([Criteria::expr(), 'orX'], $exprs);
		$this->criteria->andWhere($expr);
	}


	/**
	 * Filter by multi select value
	 * @param  Filter\FilterMultiSelect $filter
	 * @return void
	 */
	public function applyFilterMultiSelect(Filter\FilterMultiSelect $filter)
	{
		$values = $filter->getCondition()[$filter->getColumn()];

		$expr = Criteria::expr()->in($filter->getColumn(), $values);
		$this->criteria->andWhere($expr);
	}


	/**
	 * Filter by select value
	 * @param  Filter\FilterSelect $filter
	 * @return void
	 */
	public function applyFilterSelect(Filter\FilterSelect $filter)
	{
		foreach ($filter->getCondition() as $column => $value) {
			$expr = Criteria::expr()->eq($column, $value);
			$this->criteria->andWhere($expr);
		}
	}


	/**
	 * Apply limit and offset on data
	 * @param int $offset
	 * @param int $limit
	 * @return static
	 */
	public function limit($offset, $limit)
	{
		$this->criteria->setFirstResult($offset)->setMaxResults($limit);

		return $this;
	}


	/**
	 * Sort data
	 * @param Sorting $sorting
	 * @return static
	 */
	public function sort(Sorting $sorting)
	{
		if (is_callable($sorting->getSortCallback())) {
			call_user_func(
				$sorting->getSortCallback(),
				$this->criteria,
				$sorting->getSort()
			);

			return $this;
		}

		if ($sort = $sorting->getSort()) {
			$this->criteria->orderBy($sort);
			return $this;
		}

		$this->criteria->orderBy([$this->primary_key => 'ASC']);

		return $this;
	}

}


1		<?php
2
3		/**
4		* @copyright Copyright (c) 2015 ublaboo <[email protected]>
5		* @author Jakub Kontra <[email protected]>
6		* @author Pavel Janda <[email protected]>
7		* @package Ublaboo
8		*/
9
10		namespace Ublaboo\DataGrid\DataSource;
11
12		use Doctrine\Common\Collections\Collection;
13		use Doctrine\Common\Collections\Criteria;
14		use Ublaboo\DataGrid\Filter;
15		use Ublaboo\DataGrid\Utils\Sorting;
16
17		final class DoctrineCollectionDataSource extends FilterableDataSource implements IDataSource
18		{
19
20		/**
21		* @var Collection
22		*/
23		private $data_source;
24
25		/**
26		* @var string
27		*/
28		private $primary_key;
29
30		/**
31		* @var Criteria
32		*/
33		private $criteria;
34
35
36		/**
37		* @param Collection $collection
38		* @param string $primary_key
39		*/
40		public function __construct(Collection $collection, $primary_key)
41		{
42		$this->criteria = Criteria::create();
43		$this->data_source = $collection;
44		$this->primary_key = $primary_key;
45		}
46
47
48		/**
49		* @return Collection
50		*/
51		private function getFilteredCollection()
52		{
53		return $this->data_source->matching($this->criteria);
54		}
55
56
57		/********************************************************************************
58		* IDataSource implementation *
59		********************************************************************************/
60
61
62		/**
63		* Get count of data
64		* @return int
65		*/
66		public function getCount()
67		{
68		return $this->getFilteredCollection()->count();
69		}
70
71
72		/**
73		* Get the data
74		* @return array
75		*/
76		public function getData()
77		{
78		return $this->getFilteredCollection()->toArray();
79		}
80
81
82		/**
83		* Filter data - get one row
84		* @param array $condition
85		* @return static
86		*/
87		public function filterOne(array $condition)
88		{
89		foreach ($condition as $column => $value) {
90		$expr = Criteria::expr()->eq($column, $value);
91		$this->criteria->andWhere($expr);
92		}
93
94		return $this;
95		}
96
97
98		/**
99		* Filter by date
100		* @param Filter\FilterDate $filter
101		* @return void
102		*/
103		public function applyFilterDate(Filter\FilterDate $filter)
104		{
105		foreach ($filter->getCondition() as $column => $value) {
106		$date = \DateTime::createFromFormat($filter->getPhpFormat(), $value)
107		->format('Y-m-d H:i:s');
108
109		$from = Criteria::expr()->gte($filter->getColumn(), $date->format('Y-m-d 00:00:00'));
110		$to = Criteria::expr()->lte($filter->getColumn(), $date->format('Y-m-d 23:59:59'));
111
112		$this->criteria->andWhere($from)->andWhere($to);
113		}
114		}
115
116
117		/**
118		* Filter by date range
119		* @param Filter\FilterDateRange $filter
120		* @return void
121		*/
122		public function applyFilterDateRange(Filter\FilterDateRange $filter)
123		{
124		$values = $conditions[$filter->getColumn()];
		0 ignored issues – show Bug introduced 2016-07-30 23:00 UTC by Report Bug Copy Issue Report The variable `$conditions` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
125
126	View Code Duplication	if ($value_from = $values['from']) {
		0 ignored issues – show Duplication introduced 2016-07-27 14:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
127		$date_from = \DateTime::createFromFormat($filter->getPhpFormat(), $value_from)
128		->setTime(0, 0, 0)
129		->format('Y-m-d H:i:s');
130
131		$expr = Criteria::expr()->gte($filter->getColumn(), $date_from);
132		$this->criteria->andWhere($expr);
133		}
134
135	View Code Duplication	if ($value_to = $values['to']) {
		0 ignored issues – show Duplication introduced 2016-07-27 14:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
136		$date_to = \DateTime::createFromFormat($filter->getPhpFormat(), $value_to)
137		->setTime(23, 59, 59)
138		->format('Y-m-d H:i:s');
139
140		$expr = Criteria::expr()->lte($filter->getColumn(), $date_to);
141		$this->criteria->andWhere($expr);
142		}
143		}
144
145
146		/**
147		* Filter by range
148		* @param Filter\FilterRange $filter
149		* @return void
150		*/
151		public function applyFilterRange(Filter\FilterRange $filter)
152		{
153		$values = $conditions[$filter->getColumn()];
		0 ignored issues – show Bug introduced 2016-07-30 23:00 UTC by Report Bug Copy Issue Report The variable `$conditions` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
154
155		if ($value_from = $values['from']) {
156		$expr = Criteria::expr()->gte($filter->getColumn(), $value_from);
157		$this->criteria->andWhere($expr);
158		}
159
160		if ($value_to = $values['to']) {
161		$expr = Criteria::expr()->lte($filter->getColumn(), $value_to);
162		$this->criteria->andWhere($expr);
163		}
164		}
165
166
167		/**
168		* Filter by keyword
169		* @param Filter\FilterText $filter
170		* @return void
171		*/
172		public function applyFilterText(Filter\FilterText $filter)
173		{
174		$exprs = [];
175
176		foreach ($filter->getCondition() as $column => $value) {
177	View Code Duplication	if ($filter->hasSplitWordsSearch() === FALSE) {
		0 ignored issues – show Duplication introduced 2016-07-27 14:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
178		$words = [$value];
179		} else {
180		$words = explode(' ', $value);
181		}
182
183		foreach ($words as $word) {
184		$exprs[] = Criteria::expr()->contains($column, $word);
185		}
186		}
187
188		$expr = call_user_func_array([Criteria::expr(), 'orX'], $exprs);
189		$this->criteria->andWhere($expr);
190		}
191
192
193		/**
194		* Filter by multi select value
195		* @param Filter\FilterMultiSelect $filter
196		* @return void
197		*/
198		public function applyFilterMultiSelect(Filter\FilterMultiSelect $filter)
199		{
200		$values = $filter->getCondition()[$filter->getColumn()];
201
202		$expr = Criteria::expr()->in($filter->getColumn(), $values);
203		$this->criteria->andWhere($expr);
204		}
205
206
207		/**
208		* Filter by select value
209		* @param Filter\FilterSelect $filter
210		* @return void
211		*/
212		public function applyFilterSelect(Filter\FilterSelect $filter)
213		{
214		foreach ($filter->getCondition() as $column => $value) {
215		$expr = Criteria::expr()->eq($column, $value);
216		$this->criteria->andWhere($expr);
217		}
218		}
219
220
221		/**
222		* Apply limit and offset on data
223		* @param int $offset
224		* @param int $limit
225		* @return static
226		*/
227		public function limit($offset, $limit)
228		{
229		$this->criteria->setFirstResult($offset)->setMaxResults($limit);
230
231		return $this;
232		}
233
234
235		/**
236		* Sort data
237		* @param Sorting $sorting
238		* @return static
239		*/
240		public function sort(Sorting $sorting)
241		{
242		if (is_callable($sorting->getSortCallback())) {
243		call_user_func(
244		$sorting->getSortCallback(),
245		$this->criteria,
246		$sorting->getSort()
247		);
248
249		return $this;
250		}
251
252		if ($sort = $sorting->getSort()) {
253		$this->criteria->orderBy($sort);
254		return $this;
255		}
256
257		$this->criteria->orderBy([$this->primary_key => 'ASC']);
258
259		return $this;
260		}
261
262		}
263

ublaboo / datagrid

Pull Request — master (#300)

DoctrineCollectionDataSource::getData() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like