Manganel::getVersion() - Code Metrics - Inspection of "+ getVersion method" - Maslosoft/Manganel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 550d3d...251c7d )

by Peter

created 2017-07-11 10:32 UTC

Manganel::getVersion() A

↳ Parent: Manganel

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
dl	0
loc	8
ccs	0
cts	4
cp	0
rs	9.4285
c	1
b	0
f	0
cc	2
eloc	4
nc	2
nop	0
crap	6

<?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 Closure;
use Elasticsearch\Client;
use Elasticsearch\ClientBuilder;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\EmbeDi\EmbeDi;
use Maslosoft\Mangan\Interfaces\ProfilerInterface;
use Maslosoft\Mangan\Profillers\NullProfiler;
use Maslosoft\Manganel\Decorators\QueryBuilder\ConditionDecorator;
use Maslosoft\Manganel\Decorators\QueryBuilder\ConditionsDecorator;
use Maslosoft\Manganel\Decorators\QueryBuilder\Operators\InDecorator;
use Maslosoft\Manganel\Decorators\QueryBuilder\Operators\SimpleTermDecorator;
use Maslosoft\Manganel\Decorators\QueryBuilder\QueryString\BoostDecorator;
use Maslosoft\Manganel\Decorators\QueryBuilder\QueryString\PrefixQueryDecorator;
use Maslosoft\Manganel\Decorators\QueryBuilder\ScrollDecorator;
use Maslosoft\Manganel\Decorators\QueryBuilder\SearchDecorator;
use Maslosoft\Manganel\Interfaces\ManganelAwareInterface;
use Maslosoft\Manganel\Meta\ManganelMeta;

/**
 * Manganel
 *
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 */
class Manganel
{

	const DefaultIndexId = 'manganel';

	public $decorators = [
		SearchCriteria::class => [
			ConditionDecorator::class,
			ConditionsDecorator::class,
			ScrollDecorator::class,
			SearchDecorator::class,
			InDecorator::class,
			SimpleTermDecorator::class,
			BoostDecorator::class,
			PrefixQueryDecorator::class,
		]
	];
	public $hosts = [
		'localhost:9200'
	];
	public $auth = null;
	public $username = '';
	public $password = '';
	public $params = [];

	/**
	 * TODO Enforce lowercase
	 */
	public $index = 'my_index';
	public $indexId = self::DefaultIndexId;

	/**
	 * Whether to use refresh option when indexing document.
	 * NOTE: Due to performance reasons, this should be set to `true` only when
	 * really necessary - so it can be also callback.
	 *
	 * Callback function signature:
	 * ```
	 * function(AnnotatedInterface $model)
	 * ```
	 * @var string|Closure
	 */
	public $refresh = false;

	/**
	 *
	 * @var Client
	 */
	private $client = null;

	/**
	 * Dependency injection container
	 * @var EmbeDi
	 */
	private $di = null;

	/**
	 * Version number holder
	 * @var string
	 */
	private static $_version = null;

	/**
	 * Instances of manganel
	 * @var Manganel[]
	 */
	private static $mnl = [];

	/**
	 * Hash map of class name to id. This is to reduce overhead of Mangan::fromModel()
	 * @var string[]
	 */
	private static $classToId = [];

	/**
	 * Profiler instance
	 * @var ProfilerInterface
	 */
	private $profiler = null;

	/**
	 * Class constructor
	 * @codeCoverageIgnore This is implicitly tested
	 * @param string $indexId
	 */
	public function __construct($indexId = self::DefaultIndexId)
	{
		if (empty($indexId))
		{
			$indexId = self::DefaultIndexId;
		}
		$this->indexId = $indexId;
		$this->di = new EmbeDi($this->indexId);
		$this->di->configure($this);

		if (empty(self::$mnl[$indexId]))
		{
			self::$mnl[$indexId] = $this;
		}
	}

	/**
	 * @codeCoverageIgnore This is implicitly tested
	 * @param AnnotatedInterface $model
	 * @return static
	 */
	public static function create(AnnotatedInterface $model)
	{
		$key = get_class($model);
		if (isset(self::$classToId[$key]))
		{
			$indexId = self::$classToId[$key];
		}
		else
		{
			$indexId = ManganelMeta::create($model)->type()->indexId;
			self::$classToId[$key] = $indexId;
		}
		return static::fly($indexId);
	}

	/**
	 * Get flyweight instance of Manganel component.
	 * Only one instance will be created for each `$indexId`.
	 *
	 * @codeCoverageIgnore This is implicitly tested
	 * @new
	 * @param string $indexId
	 * @return Manganel
	 */
	public static function fly($indexId = self::DefaultIndexId)
	{
		if (empty($indexId))
		{
			$indexId = self::DefaultIndexId;
		}
		if (empty(self::$mnl[$indexId]))
		{
			self::$mnl[$indexId] = new static($indexId);
		}
		return self::$mnl[$indexId];
	}

	/**
	 * @codeCoverageIgnore This is implicitly tested
	 */
	public function init()
	{
		$this->di->store($this);
	}

	/**
	 * Get mangan version
	 * @return string
	 */
	public function getVersion()
	{
		if (null === self::$_version)
		{
			self::$_version = require __DIR__ . '/version.php';
		}
		return self::$_version;
	}

	/**
	 * Drop current index
	 * @return bool
	 */
	public function drop()
	{
		$params = [
			'index' => strtolower($this->index)
		];
		$result = $this->getClient()->indices()->delete($params);
		if (is_array($result) && array_key_exists('acknowledged', $result) && $result['acknowledged'])
		{
			return true;
		}
		return false;
	}

	/**
	 * @codeCoverageIgnore This is implicitly tested
	 * @return Client
	 */
	public function getClient()
	{
		if (null === $this->client)
		{
			$this->params['hosts'] = $this->hosts;
			$this->params['connectionParams']['auth'] = [
				$this->username,
				$this->password,
				$this->auth
			];
			$cb = ClientBuilder::create();
			$cb->setHosts($this->hosts);
			$this->client = $cb->build();
		}
		return $this->client;
	}

	/**
	 * Get profiler instance. This is guaranted, if not configured will return NullProfiller.
	 * @see NullProfiler
	 * @return ProfilerInterface
	 */
	public function getProfiler()
	{
		if (null === $this->profiler)
		{
			$this->profiler = new NullProfiler;
		}
		if ($this->profiler instanceof ManganelAwareInterface)
		{
			$this->profiler->setManganel($this);
		}
		return $this->profiler;
	}

	/**
	 * Set profiler instance
	 * @param ProfilerInterface $profiller
	 * @return static
	 */
	public function setProfiler(ProfilerInterface $profiller)
	{
		$this->profiler = $profiller;
		return $this;
	}

}


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 Closure;
16		use Elasticsearch\Client;
17		use Elasticsearch\ClientBuilder;
18		use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
19		use Maslosoft\EmbeDi\EmbeDi;
20		use Maslosoft\Mangan\Interfaces\ProfilerInterface;
21		use Maslosoft\Mangan\Profillers\NullProfiler;
22		use Maslosoft\Manganel\Decorators\QueryBuilder\ConditionDecorator;
23		use Maslosoft\Manganel\Decorators\QueryBuilder\ConditionsDecorator;
24		use Maslosoft\Manganel\Decorators\QueryBuilder\Operators\InDecorator;
25		use Maslosoft\Manganel\Decorators\QueryBuilder\Operators\SimpleTermDecorator;
26		use Maslosoft\Manganel\Decorators\QueryBuilder\QueryString\BoostDecorator;
27		use Maslosoft\Manganel\Decorators\QueryBuilder\QueryString\PrefixQueryDecorator;
28		use Maslosoft\Manganel\Decorators\QueryBuilder\ScrollDecorator;
29		use Maslosoft\Manganel\Decorators\QueryBuilder\SearchDecorator;
30		use Maslosoft\Manganel\Interfaces\ManganelAwareInterface;
31		use Maslosoft\Manganel\Meta\ManganelMeta;
32
33		/**
34		* Manganel
35		*
36		* @author Piotr Maselkowski <pmaselkowski at gmail.com>
37		*/
38		class Manganel
39		{
40
41		const DefaultIndexId = 'manganel';
42
43		public $decorators = [
44		SearchCriteria::class => [
45		ConditionDecorator::class,
46		ConditionsDecorator::class,
47		ScrollDecorator::class,
48		SearchDecorator::class,
49		InDecorator::class,
50		SimpleTermDecorator::class,
51		BoostDecorator::class,
52		PrefixQueryDecorator::class,
53		]
54		];
55		public $hosts = [
56		'localhost:9200'
57		];
58		public $auth = null;
59		public $username = '';
60		public $password = '';
61		public $params = [];
62
63		/**
64		* TODO Enforce lowercase
65		*/
66		public $index = 'my_index';
67		public $indexId = self::DefaultIndexId;
68
69		/**
70		* Whether to use refresh option when indexing document.
71		* NOTE: Due to performance reasons, this should be set to `true` only when
72		* really necessary - so it can be also callback.
73		*
74		* Callback function signature:
75		* ```
76		* function(AnnotatedInterface $model)
77		* ```
78		* @var string\|Closure
79		*/
80		public $refresh = false;
81
82		/**
83		*
84		* @var Client
85		*/
86		private $client = null;
87
88		/**
89		* Dependency injection container
90		* @var EmbeDi
91		*/
92		private $di = null;
93
94		/**
95		* Version number holder
96		* @var string
97		*/
98		private static $_version = null;
99
100		/**
101		* Instances of manganel
102		* @var Manganel[]
103		*/
104		private static $mnl = [];
105
106		/**
107		* Hash map of class name to id. This is to reduce overhead of Mangan::fromModel()
108		* @var string[]
109		*/
110		private static $classToId = [];
111
112		/**
113		* Profiler instance
114		* @var ProfilerInterface
115		*/
116		private $profiler = null;
117
118		/**
119		* Class constructor
120		* @codeCoverageIgnore This is implicitly tested
121		* @param string $indexId
122		*/
123		public function __construct($indexId = self::DefaultIndexId)
124		{
125		if (empty($indexId))
126		{
127		$indexId = self::DefaultIndexId;
128		}
129		$this->indexId = $indexId;
130		$this->di = new EmbeDi($this->indexId);
131		$this->di->configure($this);
132
133		if (empty(self::$mnl[$indexId]))
134		{
135		self::$mnl[$indexId] = $this;
136		}
137		}
138
139		/**
140		* @codeCoverageIgnore This is implicitly tested
141		* @param AnnotatedInterface $model
142		* @return static
143		*/
144		public static function create(AnnotatedInterface $model)
145		{
146		$key = get_class($model);
147		if (isset(self::$classToId[$key]))
148		{
149		$indexId = self::$classToId[$key];
150		}
151		else
152		{
153		$indexId = ManganelMeta::create($model)->type()->indexId;
154		self::$classToId[$key] = $indexId;
155		}
156		return static::fly($indexId);
157		}
158
159		/**
160		* Get flyweight instance of Manganel component.
161		* Only one instance will be created for each `$indexId`.
162		*
163		* @codeCoverageIgnore This is implicitly tested
164		* @new
165		* @param string $indexId
166		* @return Manganel
167		*/
168		public static function fly($indexId = self::DefaultIndexId)
169		{
170		if (empty($indexId))
171		{
172		$indexId = self::DefaultIndexId;
173		}
174		if (empty(self::$mnl[$indexId]))
175		{
176		self::$mnl[$indexId] = new static($indexId);
177		}
178		return self::$mnl[$indexId];
179		}
180
181		/**
182		* @codeCoverageIgnore This is implicitly tested
183		*/
184		public function init()
185		{
186		$this->di->store($this);
187		}
188
189		/**
190		* Get mangan version
191		* @return string
192		*/
193		public function getVersion()
194		{
195		if (null === self::$_version)
196		{
197		self::$_version = require __DIR__ . '/version.php';
198		}
199		return self::$_version;
200		}
201
202		/**
203		* Drop current index
204		* @return bool
205		*/
206	1	public function drop()
207		{
208		$params = [
209	1	'index' => strtolower($this->index)
210		];
211	1	$result = $this->getClient()->indices()->delete($params);
212	1	if (is_array($result) && array_key_exists('acknowledged', $result) && $result['acknowledged'])
213		{
214	1	return true;
215		}
216		return false;
217		}
218
219		/**
220		* @codeCoverageIgnore This is implicitly tested
221		* @return Client
222		*/
223		public function getClient()
224		{
225		if (null === $this->client)
226		{
227		$this->params['hosts'] = $this->hosts;
228		$this->params['connectionParams']['auth'] = [
229		$this->username,
230		$this->password,
231		$this->auth
232		];
233		$cb = ClientBuilder::create();
234		$cb->setHosts($this->hosts);
235		$this->client = $cb->build();
236		}
237		return $this->client;
238		}
239
240		/**
241		* Get profiler instance. This is guaranted, if not configured will return NullProfiller.
242		* @see NullProfiler
243		* @return ProfilerInterface
244		*/
245	33	public function getProfiler()
246		{
247	33	if (null === $this->profiler)
248		{
249	1	$this->profiler = new NullProfiler;
250		}
251	33	if ($this->profiler instanceof ManganelAwareInterface)
252		{
253		$this->profiler->setManganel($this);
254		}
255	33	return $this->profiler;
256		}
257
258		/**
259		* Set profiler instance
260		* @param ProfilerInterface $profiller
261		* @return static
262		*/
263		public function setProfiler(ProfilerInterface $profiller)
264		{
265		$this->profiler = $profiller;
266		return $this;
267		}
268
269		}
270

Maslosoft / Manganel

Push — master ( 550d3d...251c7d )

Manganel::getVersion() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like