SearchProvider::__construct() - Code Metrics - Inspection of "+ $in operator support" - Maslosoft/Manganel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — multimodel-dp ( 745c1d...bcd65b )

by Peter

created 2017-01-05 14:21 UTC

SearchProvider::__construct() A

↳ Parent: SearchProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

/**
 * This software package is licensed under `AGPL, Commercial` license[s].
 *
 * @package maslosoft/manganel
 * @license AGPL, Commercial
 *
 * @copyright Copyright (c) Peter Maselkowski <[email protected]>
 * @link http://maslosoft.com/manganel/
 */

namespace Maslosoft\Manganel;

use Maslosoft\Mangan\Events\Event;
use Maslosoft\Mangan\Interfaces\DataProviderInterface;
use Maslosoft\Mangan\Interfaces\FinderInterface;
use Maslosoft\Mangan\Interfaces\WithCriteriaInterface;
use Maslosoft\Mangan\Traits\DataProvider\ConfigureTrait;
use Maslosoft\Mangan\Traits\DataProvider\CriteriaTrait;
use Maslosoft\Mangan\Traits\DataProvider\DataTrait;
use Maslosoft\Mangan\Traits\DataProvider\PaginationTrait;
use Maslosoft\Mangan\Traits\ModelAwareTrait;
use Maslosoft\Mangan\Traits\SortAwareTrait;
use Maslosoft\Manganel\Interfaces\IndexAwareInterface;
use Maslosoft\Manganel\Interfaces\ScoreAwareInterface;

/**
 * SearchProvider
 *
 * @method SearchCriteria getCriteria()
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 */
class SearchProvider implements DataProviderInterface
{

	use ConfigureTrait,
	  CriteriaTrait,
	  DataTrait,
	  ModelAwareTrait,
	  PaginationTrait,
	  SortAwareTrait;

	const CriteriaClass = SearchCriteria::class;

	/**
	 * Total items count cache
	 * @var int
	 */
	private $totalItemCount = null;

	public function __construct($modelClass = null, $config = [])
	{
		$this->configure($modelClass, $config);
	}

	protected function fetchData()
	{

		$criteria = $this->configureFetch();

		/**
		 * TODO Refactor this into SearchFinder class
		 */
		$qb = new QueryBuilder();
		if ($criteria instanceof SearchCriteria)
		{
			$models = $criteria->getModels();
			if (!empty($models))
			{
				$qb->add($models);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			}
		}
		$model = $this->getModel();
		if (!empty($model) && !Event::handled($model, FinderInterface::EventBeforeFind))
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
		{
			return [];
		}

		$modelCriteria = null;

		// This check is required for plain php objects
		if ($model instanceof WithCriteriaInterface)
		{
			$modelCriteria = $model->getDbCriteria();
		}

		$criteria->mergeWith($modelCriteria);
		if (!empty($model))
		{
			$qb->add($model);
		}
		$qb->setCriteria($criteria);
		$rawResults = $qb->search($criteria->getSearch());
		$results = [];
		foreach ($rawResults as $data)
		{
			$model = SearchArray::toModel($data['_source']);
			if ($model instanceof IndexAwareInterface)
			{
				$model->setIndex($data['_index']);
			}
			if ($model instanceof ScoreAwareInterface)
			{
				$model->setScore($data['_score']);
			}
			$results[] = $model;
		}
		return $results;
	}

	public function getItemCount($refresh = false)
	{
		return count($this->getData($refresh));
	}

	public function getTotalItemCount()
	{
		if ($this->totalItemCount === null)
		{
			$qb = new QueryBuilder($this->getModel());
			/**
			 * TODO Must count with criteria too!
			 * And multi model
			 */
			$criteria = new SearchCriteria($this->getCriteria());
			$criteria->setLimit(false);
			$criteria->setOffset(false);
			$qb->setCriteria($criteria);
			$this->totalItemCount = $qb->count($this->getCriteria()->getSearch());
		}
		return $this->totalItemCount;
	}

}


1			<?php
2
3			/**
4			* This software package is licensed under `AGPL, Commercial` license[s].
5			*
6			* @package maslosoft/manganel
7			* @license AGPL, Commercial
8			*
9			* @copyright Copyright (c) Peter Maselkowski <[email protected]>
10			* @link http://maslosoft.com/manganel/
11			*/
12
13			namespace Maslosoft\Manganel;
14
15			use Maslosoft\Mangan\Events\Event;
16			use Maslosoft\Mangan\Interfaces\DataProviderInterface;
17			use Maslosoft\Mangan\Interfaces\FinderInterface;
18			use Maslosoft\Mangan\Interfaces\WithCriteriaInterface;
19			use Maslosoft\Mangan\Traits\DataProvider\ConfigureTrait;
20			use Maslosoft\Mangan\Traits\DataProvider\CriteriaTrait;
21			use Maslosoft\Mangan\Traits\DataProvider\DataTrait;
22			use Maslosoft\Mangan\Traits\DataProvider\PaginationTrait;
23			use Maslosoft\Mangan\Traits\ModelAwareTrait;
24			use Maslosoft\Mangan\Traits\SortAwareTrait;
25			use Maslosoft\Manganel\Interfaces\IndexAwareInterface;
26			use Maslosoft\Manganel\Interfaces\ScoreAwareInterface;
27
28			/**
29			* SearchProvider
30			*
31			* @method SearchCriteria getCriteria()
32			* @author Piotr Maselkowski <pmaselkowski at gmail.com>
33			*/
34			class SearchProvider implements DataProviderInterface
35			{
36
37			use ConfigureTrait,
38			CriteriaTrait,
39			DataTrait,
40			ModelAwareTrait,
41			PaginationTrait,
42			SortAwareTrait;
43
44			const CriteriaClass = SearchCriteria::class;
45
46			/**
47			* Total items count cache
48			* @var int
49			*/
50			private $totalItemCount = null;
51
52			public function __construct($modelClass = null, $config = [])
53			{
54			$this->configure($modelClass, $config);
55			}
56
57			protected function fetchData()
58			{
59
60			$criteria = $this->configureFetch();
61
62			/**
63			* TODO Refactor this into SearchFinder class
64			*/
65			$qb = new QueryBuilder();
66			if ($criteria instanceof SearchCriteria)
67			{
68			$models = $criteria->getModels();
69			if (!empty($models))
70			{
71			$qb->add($models);
			0 ignored issues – show Documentation introduced 2017-01-05 14:25 UTC by Report Bug Copy Issue Report `$models` is of type `array`, but the function expects a `object<Maslosoft\Addendu...ces\AnnotatedInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
72			}
73			}
74			$model = $this->getModel();
75			if (!empty($model) && !Event::handled($model, FinderInterface::EventBeforeFind))
			0 ignored issues – show Bug Best Practice introduced 2016-10-27 17:24 UTC by Report Bug Copy Issue Report The expression `\Maslosoft\Mangan\Events...rface::EventBeforeFind)` of type `boolean\|null` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
76			{
77			return [];
78			}
79
80			$modelCriteria = null;
81
82			// This check is required for plain php objects
83			if ($model instanceof WithCriteriaInterface)
84			{
85			$modelCriteria = $model->getDbCriteria();
86			}
87
88			$criteria->mergeWith($modelCriteria);
89			if (!empty($model))
90			{
91			$qb->add($model);
92			}
93			$qb->setCriteria($criteria);
94			$rawResults = $qb->search($criteria->getSearch());
95			$results = [];
96			foreach ($rawResults as $data)
97			{
98			$model = SearchArray::toModel($data['_source']);
99			if ($model instanceof IndexAwareInterface)
100			{
101			$model->setIndex($data['_index']);
102			}
103			if ($model instanceof ScoreAwareInterface)
104			{
105			$model->setScore($data['_score']);
106			}
107			$results[] = $model;
108			}
109			return $results;
110			}
111
112			public function getItemCount($refresh = false)
113			{
114			return count($this->getData($refresh));
115			}
116
117			public function getTotalItemCount()
118			{
119			if ($this->totalItemCount === null)
120			{
121			$qb = new QueryBuilder($this->getModel());
122			/**
123			* TODO Must count with criteria too!
124			* And multi model
125			*/
126			$criteria = new SearchCriteria($this->getCriteria());
127			$criteria->setLimit(false);
128			$criteria->setOffset(false);
129			$qb->setCriteria($criteria);
130			$this->totalItemCount = $qb->count($this->getCriteria()->getSearch());
131			}
132			return $this->totalItemCount;
133			}
134
135			}
136

Maslosoft / Manganel

Push — multimodel-dp ( 745c1d...bcd65b )

SearchProvider::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like