QueryBuilder::add() - Code Metrics - Inspection of "+ Support for date ranges" - Maslosoft/Manganel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bae495...167f56 )

by Peter

created 2018-01-22 19:23 UTC

QueryBuilder::add() A

↳ Parent: QueryBuilder

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	7
cts	7
cp	1
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	6
nc	3
nop	1
crap	3

<?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 Elasticsearch\Common\Exceptions\BadRequest400Exception;
use Elasticsearch\Common\Exceptions\Missing404Exception;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Interfaces\CriteriaAwareInterface;
use Maslosoft\Mangan\Interfaces\CriteriaInterface;
use Maslosoft\Mangan\Traits\CriteriaAwareTrait;
use Maslosoft\Manganel\Helpers\QueryBuilderDecorator;
use Maslosoft\Manganel\Helpers\RecursiveFilter;
use Maslosoft\Manganel\Helpers\TypeNamer;
use Maslosoft\Manganel\Traits\UniqueModelsAwareTrait;
use UnexpectedValueException;

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

	use CriteriaAwareTrait,
	  UniqueModelsAwareTrait;

	/**
	 * Manganel instance
	 * @var Manganel
	 */
	private $manganel = null;

	public function __construct($model = null)
	{
		if (!empty($model))
		{
			$this->addModel($model);
		}
		if (!empty($model))
		{
			$this->manganel = Manganel::create($model);
		}
		else
		{
			$this->manganel = Manganel::fly();
		}
	}

	/**
	 * Add model or array of models
	 * @param AnnotatedInterface|AnnotatedInterface[] $model
	 * @return void
	 */
	public function add($model)
	{
		if (is_array($model))
		{
			foreach ($model as $m)
			{
				$this->addModel($m);
			}
			return;
		}
		$this->addModel($model);
	}

	/**
	 * Set criteria
	 * @param CriteriaInterface|array $criteria
	 * @return static
	 */
	public function setCriteria($criteria)
	{
		$this->criteria = $criteria;
		assert($criteria instanceof SearchCriteria);
		$this->add($criteria->getModels());
		return $this;
	}

	/**
	 *
	 * @param string $q
	 * @return int
	 */
	public function count($q = null)
	{
		$params = $this->getParams($q);
		try
		{
			$result = $this->manganel->getClient()->count($params);
		}
		catch (Missing404Exception $e)
		{
			$params = ['index' => strtolower($this->manganel->index)];
			$this->manganel->getClient()->indices()->create($params);
		}
		catch (BadRequest400Exception $e)
		{
			// Throw previous exception,
			// as it holds more meaningfull information
			$json = json_encode($params, JSON_PRETTY_PRINT);
			$prevMsg = '';
			$previous = $e->getPrevious();
			if(!empty($previous))
			{
				$prevMsg = '(' . $previous->getMessage() . ') ';
			}
			$message = sprintf("Exception %swhile querying `%s`: \n%s\n", $prevMsg, $this->manganel->indexId, $json);
			throw new BadRequest400Exception($message, 400, $e);
		}
		if (empty($result) && empty($result['count']))
		{
			return 0; // @codeCoverageIgnore
		}
		return $result['count'];
	}

	/**
	 * Get search results - hits from elasticsearch response.
	 * Optionally raw results might be obtained by reference via second param.
	 *
	 * @param string $q
	 * @param array $result
	 * @return array
	 */
	public function search($q = null, &$result = [])
	{
		$params = $this->getParams($q);

		try
		{
			$result = $this->manganel->getClient()->search($params);
		}
		catch (Missing404Exception $e)
		{
			$params = ['index' => strtolower($this->manganel->index)];
			$this->manganel->getClient()->indices()->create($params);
		}
		catch (BadRequest400Exception $e)
		{
			// Throw previous exception,
			// as it holds more meaningful information
			$json = json_encode($params, JSON_PRETTY_PRINT);
			$previous = $e->getPrevious();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

			$prevMsg = '';
			$previous = $e->getPrevious();
			if(!empty($previous))
			{
				$prevMsg = '(' . $previous->getMessage() . ') ';
			}

			$message = sprintf("Exception %swhile querying `%s`: \n%s\n", $prevMsg, $this->manganel->indexId, $json);
			throw new BadRequest400Exception($message, 400, $e);
		}

		if (empty($result) && empty($result['hits']) && empty($result['hits']['hits']))
		{
			return [];
		}
		return $result['hits']['hits'];
	}

	public function getParams($q = null)
	{
		$body = [];
		// Try to get query from criteria if empty
		$criteria = $this->getCriteria();
		if (!$criteria instanceof SearchCriteria && $criteria instanceof CriteriaInterface)
		{
			$criteria = new SearchCriteria($criteria);
		}
		if (empty($criteria))
		{
			$criteria = new SearchCriteria;
		}
		if (!empty($q))
		{
			$criteria->search($q);
		}

		$criteria->setModels($this->getModels());

		$decorator = new QueryBuilderDecorator($this->manganel);
		$decorator->setModels($this->getModels());
		$decorator->decorate($body, $criteria);
		$models = $this->getModels();
		if (empty($models))
		{
			$type = '_all';
		}
		else
		{
			$types = [];
			foreach ($models as $model)
			{
				assert($model instanceof AnnotatedInterface, new UnexpectedValueException(sprintf('Expected `%s` instance, got `%s`', AnnotatedInterface::class, is_object($model) ? get_class($model) : gettype($model))));
				$types[] = TypeNamer::nameType($model);
			}
			$type = implode(',', array_unique($types));
		}

		$params = [
			'index' => strtolower($this->manganel->index),
			'type' => $type,
			'body' => $body
		];
//		return $params;
		return RecursiveFilter::mongoIdToString($params);
	}

}


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 Elasticsearch\Common\Exceptions\BadRequest400Exception;
16		use Elasticsearch\Common\Exceptions\Missing404Exception;
17		use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
18		use Maslosoft\Mangan\Interfaces\CriteriaAwareInterface;
19		use Maslosoft\Mangan\Interfaces\CriteriaInterface;
20		use Maslosoft\Mangan\Traits\CriteriaAwareTrait;
21		use Maslosoft\Manganel\Helpers\QueryBuilderDecorator;
22		use Maslosoft\Manganel\Helpers\RecursiveFilter;
23		use Maslosoft\Manganel\Helpers\TypeNamer;
24		use Maslosoft\Manganel\Traits\UniqueModelsAwareTrait;
25		use UnexpectedValueException;
26
27		/**
28		* QueryBuilder
29		* @method SearchCriteria getCriteria()
30		* @author Piotr Maselkowski <pmaselkowski at gmail.com>
31		*/
32		class QueryBuilder implements CriteriaAwareInterface
33		{
34
35		use CriteriaAwareTrait,
36		UniqueModelsAwareTrait;
37
38		/**
39		* Manganel instance
40		* @var Manganel
41		*/
42		private $manganel = null;
43
44	63	public function __construct($model = null)
45		{
46	63	if (!empty($model))
47		{
48	40	$this->addModel($model);
49		}
50	63	if (!empty($model))
51		{
52	40	$this->manganel = Manganel::create($model);
53		}
54		else
55		{
56	58	$this->manganel = Manganel::fly();
57		}
58	63	}
59
60		/**
61		* Add model or array of models
62		* @param AnnotatedInterface\|AnnotatedInterface[] $model
63		* @return void
64		*/
65	59	public function add($model)
66		{
67	59	if (is_array($model))
68		{
69	57	foreach ($model as $m)
70		{
71	57	$this->addModel($m);
72		}
73	57	return;
74		}
75	2	$this->addModel($model);
76	2	}
77
78		/**
79		* Set criteria
80		* @param CriteriaInterface\|array $criteria
81		* @return static
82		*/
83	55	public function setCriteria($criteria)
84		{
85	55	$this->criteria = $criteria;
86	55	assert($criteria instanceof SearchCriteria);
87	55	$this->add($criteria->getModels());
88	55	return $this;
89		}
90
91		/**
92		*
93		* @param string $q
94		* @return int
95		*/
96	46	public function count($q = null)
97		{
98	46	$params = $this->getParams($q);
99		try
100		{
101	46	$result = $this->manganel->getClient()->count($params);
102		}
103		catch (Missing404Exception $e)
104		{
105		$params = ['index' => strtolower($this->manganel->index)];
106		$this->manganel->getClient()->indices()->create($params);
107		}
108		catch (BadRequest400Exception $e)
109		{
110		// Throw previous exception,
111		// as it holds more meaningfull information
112		$json = json_encode($params, JSON_PRETTY_PRINT);
113		$prevMsg = '';
114		$previous = $e->getPrevious();
115		if(!empty($previous))
116		{
117		$prevMsg = '(' . $previous->getMessage() . ') ';
118		}
119		$message = sprintf("Exception %swhile querying `%s`: \n%s\n", $prevMsg, $this->manganel->indexId, $json);
120		throw new BadRequest400Exception($message, 400, $e);
121		}
122	46	if (empty($result) && empty($result['count']))
123		{
124		return 0; // @codeCoverageIgnore
125		}
126	46	return $result['count'];
127		}
128
129		/**
130		* Get search results - hits from elasticsearch response.
131		* Optionally raw results might be obtained by reference via second param.
132		*
133		* @param string $q
134		* @param array $result
135		* @return array
136		*/
137	54	public function search($q = null, &$result = [])
138		{
139	54	$params = $this->getParams($q);
140
141		try
142		{
143	54	$result = $this->manganel->getClient()->search($params);
144		}
145		catch (Missing404Exception $e)
146		{
147		$params = ['index' => strtolower($this->manganel->index)];
148		$this->manganel->getClient()->indices()->create($params);
149		}
150		catch (BadRequest400Exception $e)
151		{
152		// Throw previous exception,
153		// as it holds more meaningful information
154		$json = json_encode($params, JSON_PRETTY_PRINT);
155		$previous = $e->getPrevious();
		0 ignored issues – show Unused Code introduced 2018-01-22 19:29 UTC by Report Bug Copy Issue Report `$previous` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
156
157		$prevMsg = '';
158		$previous = $e->getPrevious();
159		if(!empty($previous))
160		{
161		$prevMsg = '(' . $previous->getMessage() . ') ';
162		}
163
164		$message = sprintf("Exception %swhile querying `%s`: \n%s\n", $prevMsg, $this->manganel->indexId, $json);
165		throw new BadRequest400Exception($message, 400, $e);
166		}
167
168	54	if (empty($result) && empty($result['hits']) && empty($result['hits']['hits']))
169		{
170		return [];
171		}
172	54	return $result['hits']['hits'];
173		}
174
175	63	public function getParams($q = null)
176		{
177	63	$body = [];
178		// Try to get query from criteria if empty
179	63	$criteria = $this->getCriteria();
180	63	if (!$criteria instanceof SearchCriteria && $criteria instanceof CriteriaInterface)
181		{
182		$criteria = new SearchCriteria($criteria);
183		}
184	63	if (empty($criteria))
185		{
186	8	$criteria = new SearchCriteria;
187		}
188	63	if (!empty($q))
189		{
190	37	$criteria->search($q);
191		}
192
193	63	$criteria->setModels($this->getModels());
194
195	63	$decorator = new QueryBuilderDecorator($this->manganel);
196	63	$decorator->setModels($this->getModels());
197	63	$decorator->decorate($body, $criteria);
198	63	$models = $this->getModels();
199	63	if (empty($models))
200		{
201		$type = '_all';
202		}
203		else
204		{
205	63	$types = [];
206	63	foreach ($models as $model)
207		{
208	63	assert($model instanceof AnnotatedInterface, new UnexpectedValueException(sprintf('Expected `%s` instance, got `%s`', AnnotatedInterface::class, is_object($model) ? get_class($model) : gettype($model))));
209	63	$types[] = TypeNamer::nameType($model);
210		}
211	63	$type = implode(',', array_unique($types));
212		}
213
214		$params = [
215	63	'index' => strtolower($this->manganel->index),
216	63	'type' => $type,
217	63	'body' => $body
218		];
219		// return $params;
220	63	return RecursiveFilter::mongoIdToString($params);
221		}
222
223		}
224

Maslosoft / Manganel

Push — master ( bae495...167f56 )

QueryBuilder::add() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like