Categories::construct() - Code Metrics - Inspection of "Dropped undocumented `indexed` key from `cs\CRUD`..." - nazar-pc/CleverStyle-Framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c5384d...c1ead9 )

by Nazar

created 2016-04-16 01:00 UTC

Categories::construct() A

↳ Parent: Categories

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	3
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 * @package   Shop
 * @category  modules
 * @author    Nazar Mokrynskyi <[email protected]>
 * @copyright Copyright (c) 2014-2016, Nazar Mokrynskyi
 * @license   MIT License, see license.txt
 */
namespace cs\modules\Shop;
use
	cs\Cache\Prefix,
	cs\Config,
	cs\Event,
	cs\Language,
	cs\User,
	cs\CRUD_helpers,
	cs\Singleton;

/**
 * Provides next events:<br>
 *  Shop/Categories/get<code>
 *  [
 *   'data' => &$data
 *  ]</code>
 *
 *  Shop/Categories/get_for_user<code>
 *  [
 *   'data' => &$data,
 *   'user' => $user
 *  ]</code>
 *
 *  Shop/Categories/add<code>
 *  [
 *   'id' => $id
 *  ]</code>
 *
 *  Shop/Categories/set<code>
 *  [
 *   'id' => $id
 *  ]</code>
 *
 *  Shop/Categories/del<code>
 *  [
 *   'id' => $id
 *  ]</code>
 *
 * @method static $this instance($check = false)
 */
class Categories {
	use
		CRUD_helpers,
		Singleton;

	const VISIBLE   = 1;
	const INVISIBLE = 0;

	protected $data_model                  = [
		'id'                    => 'int:1',
		'parent'                => 'int:0',
		'title'                 => 'ml:text',
		'description'           => 'ml:html',
		'title_attribute'       => 'int:1',
		'description_attribute' => 'int:1',
		'image'                 => 'string',
		'visible'               => 'int:0..1',
		'attributes'            => [
			'data_model' => [
				'id'        => 'int:1',
				'attribute' => 'int:1'
			]
		]
	];
	protected $table                       = '[prefix]shop_categories';
	protected $data_model_ml_group         = 'Shop/categories';
	protected $data_model_files_tag_prefix = 'Shop/categories';
	/**
	 * @var Prefix
	 */
	protected $cache;

	protected function construct () {
		$this->cache = new Prefix('Shop/categories');
	}
	/**
	 * Returns database index
	 *
	 * @return int
	 */
	protected function cdb () {
		return Config::instance()->module('Shop')->db('shop');
	}
	/**
	 * Get category
	 *
	 * @param int|int[] $id
	 *
	 * @return array|false
	 */
	function get ($id) {
		if (is_array($id)) {
			foreach ($id as &$i) {
				$i = $this->get($i);
			}
			return $id;
		}
		$L    = Language::instance();
		$id   = (int)$id;
		$data = $this->cache->get(
			"$id/$L->clang",
			function () use ($id) {
				$data = $this->read($id);
				if ($data) {
					$data['attributes'] = $this->clean_nonexistent_attributes($data['attributes']);
				}
				return $data;
			}
		);
		if (!Event::instance()->fire(
			'Shop/Categories/get',
			[
				'data' => &$data
			]
		)
		) {
			return false;
		}
		return $data;
	}
	/**
	 * Get category data for specific user (some categories may be restricted and so on)
	 *
	 * @param int|int[] $id
	 * @param bool|int  $user
	 *
	 * @return array|false
	 */
	function get_for_user ($id, $user = false) {
		if (is_array($id)) {
			foreach ($id as $index => &$i) {
				$i = $this->get_for_user($i, $user);
				if ($i === false) {
					unset($id[$index]);
				}
			}
			return $id;
		}
		$user = (int)$user ?: User::instance()->id;
		$data = $this->get($id);
		if (!Event::instance()->fire(
			'Shop/Categories/get_for_user',
			[
				'data' => &$data,
				'user' => $user
			]
		)
		) {
			return false;
		}
		return $data;
	}
	/**
	 * Get array of all categories
	 *
	 * @return int[] Array of categories ids
	 */
	function get_all () {
		return $this->cache->get(
			'all',
			function () {
				return $this->search([], 1, PHP_INT_MAX, 'id', true) ?: [];
			}
		);
	}
	/**
	 * @param int[] $attributes
	 *
	 * @return int[]
	 */
	protected function clean_nonexistent_attributes ($attributes) {
		if (!$attributes) {
			return [];
		}
		$Attributes = Attributes::instance();
		/**
		 * Remove nonexistent attributes
		 */
		foreach ($attributes as $i => &$attribute) {
			if (!$Attributes->get($attribute)) {
				unset($attributes[$i]);
			}
		}
		return $attributes;
	}
	/**
	 * Add new category
	 *
	 * @param int    $parent
	 * @param string $title
	 * @param string $description
	 * @param int    $title_attribute       Attribute that will be considered as title
	 * @param int    $description_attribute Attribute that will be considered as description
	 * @param string $image
	 * @param int    $visible               `Categories::VISIBLE` or `Categories::INVISIBLE`
	 * @param int[]  $attributes            Array of attributes ids used in category
	 *
	 * @return false|int Id of created category on success of <b>false</> on failure

	 */
	function add ($parent, $title, $description, $title_attribute, $description_attribute, $image, $visible, $attributes) {
		$attributes = $this->clean_nonexistent_attributes($attributes);
		$id         = $this->create(
			$parent,
			trim($title),
			trim($description),
			in_array($title_attribute, $attributes) ? $title_attribute : $attributes[0],
			in_array($description_attribute, $attributes) || $description == 0 ? $description_attribute : $attributes[0],
			$image,
			$visible,
			$attributes
		);
		if ($id) {
			unset($this->cache->all);
			Event::instance()->fire(
				'Shop/Categories/add',
				[
					'id' => $id
				]
			);
		}
		return $id;
	}
	/**
	 * Set data of specified category
	 *
	 * @param int    $id
	 * @param int    $parent
	 * @param string $title
	 * @param string $description
	 * @param int    $title_attribute       Attribute that will be considered as title
	 * @param int    $description_attribute Attribute that will be considered as description
	 * @param string $image
	 * @param int    $visible               `Categories::VISIBLE` or `Categories::INVISIBLE`
	 * @param int[]  $attributes            Array of attributes ids used in category
	 *
	 * @return bool
	 */
	function set ($id, $parent, $title, $description, $title_attribute, $description_attribute, $image, $visible, $attributes) {
		$id         = (int)$id;
		$attributes = $this->clean_nonexistent_attributes($attributes);
		$result     = $this->update(
			$id,
			$parent,
			trim($title),
			trim($description),
			in_array($title_attribute, $attributes) ? $title_attribute : $attributes[0],
			in_array($description_attribute, $attributes) || $description == 0 ? $description_attribute : $attributes[0],
			$image,
			$visible
		);
		if ($result) {
			$L = Language::instance();
			unset(
				$this->cache->{"$id/$L->clang"},
				$this->cache->all
			);
			Event::instance()->fire(
				'Shop/Categories/set',
				[
					'id' => $id
				]
			);
		}
		return $result;
	}
	/**
	 * Delete specified category
	 *
	 * @param int $id
	 *
	 * @return bool
	 */
	function del ($id) {
		$id     = (int)$id;
		$result = $this->delete($id);
		if ($result) {
			unset(
				$this->cache->$id,
				$this->cache->all
			);
			Event::instance()->fire(
				'Shop/Categories/del',
				[
					'id' => $id
				]
			);
		}
		return $result;
	}
}


1			<?php
2			/**
3			* @package Shop
4			* @category modules
5			* @author Nazar Mokrynskyi <[email protected]>
6			* @copyright Copyright (c) 2014-2016, Nazar Mokrynskyi
7			* @license MIT License, see license.txt
8			*/
9			namespace cs\modules\Shop;
10			use
11			cs\Cache\Prefix,
12			cs\Config,
13			cs\Event,
14			cs\Language,
15			cs\User,
16			cs\CRUD_helpers,
17			cs\Singleton;
18
19			/**
20			* Provides next events:<br>
21			* Shop/Categories/get<code>
22			* [
23			* 'data' => &$data
24			* ]</code>
25			*
26			* Shop/Categories/get_for_user<code>
27			* [
28			* 'data' => &$data,
29			* 'user' => $user
30			* ]</code>
31			*
32			* Shop/Categories/add<code>
33			* [
34			* 'id' => $id
35			* ]</code>
36			*
37			* Shop/Categories/set<code>
38			* [
39			* 'id' => $id
40			* ]</code>
41			*
42			* Shop/Categories/del<code>
43			* [
44			* 'id' => $id
45			* ]</code>
46			*
47			* @method static $this instance($check = false)
48			*/
49			class Categories {
50			use
51			CRUD_helpers,
52			Singleton;
53
54			const VISIBLE = 1;
55			const INVISIBLE = 0;
56
57			protected $data_model = [
58			'id' => 'int:1',
59			'parent' => 'int:0',
60			'title' => 'ml:text',
61			'description' => 'ml:html',
62			'title_attribute' => 'int:1',
63			'description_attribute' => 'int:1',
64			'image' => 'string',
65			'visible' => 'int:0..1',
66			'attributes' => [
67			'data_model' => [
68			'id' => 'int:1',
69			'attribute' => 'int:1'
70			]
71			]
72			];
73			protected $table = '[prefix]shop_categories';
74			protected $data_model_ml_group = 'Shop/categories';
75			protected $data_model_files_tag_prefix = 'Shop/categories';
76			/**
77			* @var Prefix
78			*/
79			protected $cache;
80
81			protected function construct () {
82			$this->cache = new Prefix('Shop/categories');
83			}
84			/**
85			* Returns database index
86			*
87			* @return int
88			*/
89			protected function cdb () {
90			return Config::instance()->module('Shop')->db('shop');
91			}
92			/**
93			* Get category
94			*
95			* @param int\|int[] $id
96			*
97			* @return array\|false
98			*/
99			function get ($id) {
100			if (is_array($id)) {
101			foreach ($id as &$i) {
102			$i = $this->get($i);
103			}
104			return $id;
105			}
106			$L = Language::instance();
107			$id = (int)$id;
108			$data = $this->cache->get(
109			"$id/$L->clang",
110			function () use ($id) {
111			$data = $this->read($id);
112			if ($data) {
113			$data['attributes'] = $this->clean_nonexistent_attributes($data['attributes']);
114			}
115			return $data;
116			}
117			);
118			if (!Event::instance()->fire(
119			'Shop/Categories/get',
120			[
121			'data' => &$data
122			]
123			)
124			) {
125			return false;
126			}
127			return $data;
128			}
129			/**
130			* Get category data for specific user (some categories may be restricted and so on)
131			*
132			* @param int\|int[] $id
133			* @param bool\|int $user
134			*
135			* @return array\|false
136			*/
137			function get_for_user ($id, $user = false) {
138			if (is_array($id)) {
139			foreach ($id as $index => &$i) {
140			$i = $this->get_for_user($i, $user);
141			if ($i === false) {
142			unset($id[$index]);
143			}
144			}
145			return $id;
146			}
147			$user = (int)$user ?: User::instance()->id;
148			$data = $this->get($id);
149			if (!Event::instance()->fire(
150			'Shop/Categories/get_for_user',
151			[
152			'data' => &$data,
153			'user' => $user
154			]
155			)
156			) {
157			return false;
158			}
159			return $data;
160			}
161			/**
162			* Get array of all categories
163			*
164			* @return int[] Array of categories ids
165			*/
166			function get_all () {
167			return $this->cache->get(
168			'all',
169			function () {
170			return $this->search([], 1, PHP_INT_MAX, 'id', true) ?: [];
171			}
172			);
173			}
174			/**
175			* @param int[] $attributes
176			*
177			* @return int[]
178			*/
179			protected function clean_nonexistent_attributes ($attributes) {
180			if (!$attributes) {
181			return [];
182			}
183			$Attributes = Attributes::instance();
184			/**
185			* Remove nonexistent attributes
186			*/
187			foreach ($attributes as $i => &$attribute) {
188			if (!$Attributes->get($attribute)) {
189			unset($attributes[$i]);
190			}
191			}
192			return $attributes;
193			}
194			/**
195			* Add new category
196			*
197			* @param int $parent
198			* @param string $title
199			* @param string $description
200			* @param int $title_attribute Attribute that will be considered as title
201			* @param int $description_attribute Attribute that will be considered as description
202			* @param string $image
203			* @param int $visible `Categories::VISIBLE` or `Categories::INVISIBLE`
204			* @param int[] $attributes Array of attributes ids used in category
205			*
206			* @return false\|int Id of created category on success of <b>false</> on failure
			1 ignored issue – show Documentation introduced 2015-11-21 02:31 UTC by Report Bug Copy Issue Report Should the return type not be `integer\|string\|false`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
207			*/
208			function add ($parent, $title, $description, $title_attribute, $description_attribute, $image, $visible, $attributes) {
209			$attributes = $this->clean_nonexistent_attributes($attributes);
210			$id = $this->create(
211			$parent,
212			trim($title),
213			trim($description),
214			in_array($title_attribute, $attributes) ? $title_attribute : $attributes[0],
215			in_array($description_attribute, $attributes) \|\| $description == 0 ? $description_attribute : $attributes[0],
216			$image,
217			$visible,
218			$attributes
219			);
220			if ($id) {
221			unset($this->cache->all);
222			Event::instance()->fire(
223			'Shop/Categories/add',
224			[
225			'id' => $id
226			]
227			);
228			}
229			return $id;
230			}
231			/**
232			* Set data of specified category
233			*
234			* @param int $id
235			* @param int $parent
236			* @param string $title
237			* @param string $description
238			* @param int $title_attribute Attribute that will be considered as title
239			* @param int $description_attribute Attribute that will be considered as description
240			* @param string $image
241			* @param int $visible `Categories::VISIBLE` or `Categories::INVISIBLE`
242			* @param int[] $attributes Array of attributes ids used in category
243			*
244			* @return bool
245			*/
246			function set ($id, $parent, $title, $description, $title_attribute, $description_attribute, $image, $visible, $attributes) {
247			$id = (int)$id;
248			$attributes = $this->clean_nonexistent_attributes($attributes);
249			$result = $this->update(
250			$id,
251			$parent,
252			trim($title),
253			trim($description),
254			in_array($title_attribute, $attributes) ? $title_attribute : $attributes[0],
255			in_array($description_attribute, $attributes) \|\| $description == 0 ? $description_attribute : $attributes[0],
256			$image,
257			$visible
258			);
259			if ($result) {
260			$L = Language::instance();
261			unset(
262			$this->cache->{"$id/$L->clang"},
263			$this->cache->all
264			);
265			Event::instance()->fire(
266			'Shop/Categories/set',
267			[
268			'id' => $id
269			]
270			);
271			}
272			return $result;
273			}
274			/**
275			* Delete specified category
276			*
277			* @param int $id
278			*
279			* @return bool
280			*/
281			function del ($id) {
282			$id = (int)$id;
283			$result = $this->delete($id);
284			if ($result) {
285			unset(
286			$this->cache->$id,
287			$this->cache->all
288			);
289			Event::instance()->fire(
290			'Shop/Categories/del',
291			[
292			'id' => $id
293			]
294			);
295			}
296			return $result;
297			}
298			}
299

nazar-pc / CleverStyle-Framework

Push — master ( c5384d...c1ead9 )

Categories::construct() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like