cs\modules\Shop\Categories

Complexity

Total Complexity

31

Size/Duplication

Total Lines	250
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	construct()	0	3	1
A	cdb()	0	3	1
B	get()	0	30	5
B	get_for_user()	0	24	6
A	get_all()	0	8	2
A	clean_nonexistent_attributes()	0	15	4
B	add()	0	23	5
B	set()	0	28	5
A	del()	0	17	2

<?php
/**
 * @package   Shop
 * @category  modules
 * @author    Nazar Mokrynskyi <nazar@mokrynskyi.com>
 * @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

Should the return type not be integer|string|false?

	 */
	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;
	}
}