cs\modules\Comments\Comments

Complexity

Total Complexity

26

Size/Duplication

Total Lines	224
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	6
Bugs	2	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	construct()	0	3	1
A	cdb()	0	3	1
A	get()	0	3	1
A	get_extended()	0	15	3
A	get_for_module_item()	0	7	2
B	add()	0	19	6
A	set()	0	16	4
A	del()	0	19	4
A	del_all()	0	15	2
A	count()	0	17	1
A	block()	0	9	1

<?php
/**
 * @package   Comments
 * @category  modules
 * @author    Nazar Mokrynskyi <nazar@mokrynskyi.com>
 * @copyright Copyright (c) 2011-2016, Nazar Mokrynskyi
 * @license   MIT License, see license.txt
 */
namespace cs\modules\Comments;
use
	h,
	cs\Cache,
	cs\Config,
	cs\Language,
	cs\Request,
	cs\User,
	cs\CRUD_helpers,
	cs\Singleton;

/**
 * @method static $this instance($check = false)
 */
class Comments {
	use
		CRUD_helpers,
		Singleton;

	/**
	 * @var Cache\Prefix
	 */
	protected $cache;

	protected $data_model = [
		'id'     => 'int:1',
		'parent' => 'int:0',
		'module' => 'text',
		'item'   => 'int:1',
		'user'   => 'int:1',
		'date'   => 'int:1',
		'text'   => 'html',
		'lang'   => 'text'
	];

	protected $table = '[prefix]comments';

	protected function construct () {
		$this->cache = Cache::prefix('Comments');
	}
	/**
	 * Returns database index
	 *
	 * @return int
	 */
	protected function cdb () {
		return Config::instance()->module('Comments')->db('comments');
	}
	/**
	 * Get comment data
	 *
	 * @param int|int[] $id
	 *
	 * @return array|false
	 */
	function get ($id) {
		return $this->read($id);
	}
	/**
	 * Get comment data with user details and formatted date
	 *
	 * @param int|int[] $id
	 *
	 * @return array|false

Should the return type not be array|false|integer|string? Also, consider making the array more specific, something like array<String>, or String[].

	 */
	function get_extended ($id) {
		if (is_array($id)) {
			foreach ($id as &$i) {
				$i = $this->get_extended($i);
			}
			return $id;
		}
		$comment                   = $this->get($id);
		$profile                   = User::instance()->get(['username', 'avatar'], $comment['user']);
		$comment['username']       = $profile['username'];
		$comment['avatar']         = $profile['avatar'];
		$comment['date_formatted'] = date(Language::instance()->_datetime, $comment['date']);
		$comment['time_formatted'] = date(Language::instance()->_datetime, $comment['date']);
		return $comment;
	}
	/**
	 * @param string $module
	 * @param int    $item
	 *
	 * @return int[]
	 */
	function get_for_module_item ($module, $item) {
		$search_parameters = [
			'module' => $module,
			'item'   => $item
		];
		return $this->search($search_parameters, 1, PHP_INT_MAX, 'id', true) ?: [];
	}
	/**
	 * Add new comment
	 *
	 * @param int    $item   Item id
	 * @param string $module Module name
	 * @param string $text   Comment text
	 * @param int    $parent Parent comment id
	 *
	 * @return false|int
	 */
	function add ($item, $module, $text, $parent = 0) {
		$L    = Language::instance();
		$User = User::instance();
		$text = xap($text, true);
		if (!$text) {
			return false;
		}
		if ($parent) {
			$parent_comment = $this->read($parent);
			if ($parent_comment['item'] != $item || $parent_comment['module'] != $module) {
				return false;
			}
		}
		$id = $this->create($parent, $module, $item, $User->id, time(), $text, $L->clang);
		if ($id) {
			$this->cache->del("$module/$item");
		}
		return $id;
	}
	/**
	 * Set comment text
	 *
	 * @param int    $id
	 * @param string $text
	 *
	 * @return bool
	 */
	function set ($id, $text) {
		$text = xap($text, true);
		if (!$text) {
			return false;
		}
		$comment = $this->get($id);
		if (!$comment) {
			return false;
		}
		$comment['text'] = $text;
		$result          = $this->update($comment);
		if ($result) {
			$this->cache->del("$comment[module]/$comment[item]");
		}
		return $result;
	}
	/**
	 * Delete comment
	 *
	 * @param int $id
	 *
	 * @return bool
	 */
	function del ($id) {
		$comment = $this->read($id);
		if (
			!$comment ||
			$this->search(
				[
					'parent'      => $id,
					'total_count' => true
				]
			)
		) {
			return false;
		}
		$result = $this->delete($id);
		if ($result) {
			$this->cache->del("$comment[module]/$comment[item]");
		}
		return $result;
	}
	/**
	 * Delete all comments of specified item
	 *
	 * @param int    $item   Item id
	 * @param string $module Module name
	 *
	 * @return bool
	 */
	function del_all ($item, $module) {
		$item   = (int)$item;
		$result = $this->db_prime()->q(
			"DELETE FROM `[prefix]comments`
			WHERE
				`module`	= '%s' AND
				`item`		= '%d'",
			$module,
			$item
		);
		if ($result) {
			$this->cache->del("$module/$item");
		}
		return (bool)$result;
	}
	/**
	 * Count of comments for specified item
	 *
	 * @param int    $item   Item id
	 * @param string $module Module name
	 *
	 * @return int
	 */
	function count ($item, $module) {
		$item = (int)$item;
		$L    = Language::instance();
		return $this->cache->get(
			"$module/$item/count/$L->clang",
			function () use ($item, $module, $L) {
				return $this->search(
					[
						'module'      => $module,
						'item'        => $item,
						'lang'        => $L->clang,
						'total_count' => true
					]
				);
			}
		);
	}
	/**
	 * Get comments block with comments tree and comments sending form
	 *
	 * @param int    $item   Item id
	 * @param string $module Module name
	 *
	 * @return string
	 */
	function block ($item, $module) {
		// TODO: get rid of this, insert into DOM directly by consumer
		return h::cs_comments(
			[
				'module' => $module,
				'item'   => $item
			]
		);
	}
}