cs\modules\Comments\Comments

Complexity

Total Complexity

45

Size/Duplication

Total Lines	403
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes	2
Bugs	1	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	construct()	0	3	1
A	cdb()	0	3	1
A	get()	0	19	1
B	add()	0	58	5
B	set()	0	24	4
B	del()	0	27	4
A	del_all()	0	15	2
A	count()	0	7	2
A	count_internal()	0	10	3
A	tree()	0	3	2
B	tree_data()	0	38	5
C	tree_html()	0	57	12
B	block()	0	39	3

<?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
	cs\DB\Accessor,
	h,
	cs\Cache\Prefix as Cache_prefix,
	cs\Config,
	cs\Language,
	cs\Language\Prefix as Language_prefix,
	cs\Request,
	cs\User,
	cs\Singleton;

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

	/**
	 * @var Cache_prefix
	 */
	protected	$cache;
	/**
	 * @var int	Avatar size in px, can be redefined
	 */
	public		$avatar_size	= 36;

	protected function construct () {
		$this->cache	= new Cache_prefix('Comments');
	}
	/**
	 * Returns database index
	 *
	 * @return int
	 */
	protected function cdb () {
		return Config::instance()->module('Comments')->db('comments');
	}
	/**
	 * Get comment data
	 *
	 * @param int			$id Comment id
	 *
	 * @return array|false		Array of comment data on success or <b>false</b> on failure
	 */
	function get ($id) {
		$id	= (int)$id;
		return $this->db()->qf(
			"SELECT
				`id`,
				`parent`,
				`module`,
				`item`,
				`user`,
				`date`,
				`text`,
				`lang`
			FROM `[prefix]comments`
			WHERE
				`id`	= '%d'
			LIMIT 1",
			$id
		);
	}
	/**
	 * 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;
		}
		$item	= (int)$item;
		$parent	= (int)$parent;
		if (
			$parent != 0 &&
			$this->db_prime()->qfs(
				"SELECT `item`
				FROM `[prefix]comments`
				WHERE
					`id`		= '%d' AND
					`module`	= '%s'
				LIMIT 1",
				$parent,
				$module
			) != $item
		) {
			return false;
		}
		if ($this->db_prime()->q(
			"INSERT INTO `[prefix]comments`
				(
					`parent`,
					`module`,
					`item`,
					`user`,
					`date`,
					`text`,
					`lang`
				)
			VALUES
				(
					'%s',
					'%s',
					'%s',
					'%s',
					'%s',
					'%s',
					'%s'
				)",
			$parent,
			$module,
			$item,
			$User->id,
			time(),
			$text,
			$L->clang
		)) {
			$this->cache->del("$module/$item");
			return $this->db_prime()->id();
		}
		return false;
	}
	/**
	 * Set comment text
	 *
	 * @param int		$id		Comment id
	 * @param string	$text	New comment text
	 *
	 * @return bool
	 */
	function set ($id, $text) {
		$text	= xap($text, true);
		if (!$text) {
			return false;
		}
		$id				= (int)$id;
		$comment		= $this->get($id);
		if (!$comment) {
			return false;
		}
		if ($this->db_prime()->q(
			"UPDATE `[prefix]comments`
			SET `text` = '%s'
			WHERE
				`id`	= '%d'
			LIMIT 1",
			$text,
			$id
		)) {
			$this->cache->del("$comment[module]/$comment[item]");
			return true;
		}
		return false;
	}
	/**
	 * Delete comment
	 *
	 * @param int	$id	Comment id
	 *
	 * @return bool
	 */
	function del ($id) {
		$id				= (int)$id;
		$comment		= $this->db_prime()->qf(
			"SELECT `p`.*, COUNT(`c`.`id`) AS `count`
			FROM `[prefix]comments` AS `p`
			LEFT JOIN `[prefix]comments` AS `c`
			ON `p`.`id` = `c`.`parent`
			WHERE
				`p`.`id`	= '%d'
			LIMIT 1",
			$id
		);
		if (!$comment || $comment['count']) {
			return false;
		}
		if ($this->db_prime()->q(
			"DELETE FROM `[prefix]comments`
			WHERE
				`id`	= '%s'
			LIMIT 1",
			$id
		)) {
			$this->cache->del("$comment[module]/$comment[item]");
			return true;
		}
		return false;
	}
	/**
	 * 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;
		if ($this->db_prime()->q(
			"DELETE FROM `[prefix]comments`
			WHERE
				`module`	= '%s' AND
				`item`		= '%d'",
			$module,
			$item
		)) {
			$this->cache->del("$module/$item");
			return true;
		}
		return false;
	}
	/**
	 * 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)  {
			return $this->count_internal($this->tree_data($item, $module)) ?: 0;
		});
	}
	protected function count_internal ($data) {
		if (!is_array($data)) {
			return 0;
		}
		$count	= 0;
		foreach ($data as &$d) {
			$count	+= $this->count_internal($d['comments']) + 1;
		}
		return $count;
	}
	/**
	 * Get comments tree in html format for specified item (look at ::block() method before usage)
	 *
	 * @param int    $item   Item id
	 * @param string $module Module name
	 *
	 * @return string
	 */
	function tree ($item, $module) {
		return $this->tree_html($this->tree_data($item, $module) ?: []);
	}
	/**
	 * Get comments structure of specified item
	 *
	 * @param int			$item
	 * @param string		$module
	 * @param int			$parent
	 *
	 * @return false|array
	 */
	function tree_data ($item, $module, $parent = 0) {
		$Cache	= $this->cache;
		$L		= Language::instance();
		if (($comments = $Cache->{"$module/$item/$L->clang"}) === false) {
			$item		= (int)$item;
			$parent		= (int)$parent;
			$comments	= $this->db()->qfa(
				"SELECT
					`id`,
					`parent`,
					`user`,
					`date`,
					`text`,
					`lang`
				FROM `[prefix]comments`
				WHERE
					`parent`	= '%d' AND
					`item`		= '%d' AND
					`module`	= '%s' AND
					`lang`		= '%s'",
				$parent,
				$item,
				$module,
				$L->clang
			) ?: [];
			foreach ($comments as &$comment) {
				$comment['comments'] = $this->tree_data($item, $module, $comment['id']);
			}
			unset($comment);
			/**
			 * Cache only root tree data
			 */
			if ($parent == 0) {
				$Cache->{"$module/$item/$L->clang"}	= $comments;
			}
		}
		return $comments;
	}
	/**
	 * Get comments tree in html format for given data structure (usually uses ::tree_data() method)
	 *
	 * @param array[]	$comments
	 *
	 * @return string
	 */
	function tree_html ($comments) {
		$L			= Language::instance();
		$User		= User::instance();
		if (!is_array($comments) || !$comments) {
			return '';
		}
		$content	= '';
		foreach ($comments as $comment) {
			$uniqid		= uniqid('comment_', true);
			$content	.= str_replace($uniqid, $comment['text'], h::{'article.cs-comments-comment'}(
				h::{'img.cs-comments-comment-avatar'}([
					'src'	=> $User->avatar($this->avatar_size, $comment['user']),
					'alt'	=> $User->username($comment['user']),
					'title'	=> $User->username($comment['user'])
				]).
				h::span($User->username($comment['user'])).
				h::{'time.cs-comments-comment-date'}(
					date('dmY', time()) == date('dmY', $comment['date']) ?
						date($L->_time, $comment['date']) : $L->to_locale(date($L->_datetime, $comment['date'])),
					[
						'datetime'		=> date('c', $comment['date'])
					]
				).
				h::{'a.cs-comments-comment-link'}(
					h::icon('anchor'),
					[
						'href'	=> "#comment_$comment[id]"
					]
				).
				(
					$comment['parent'] ? h::{'a.cs-comments-comment-parent'}(
						h::icon('level-up'),
						[
							'href'	=> "#comment_$comment[parent]"
						]
					) : ''
				).
				(
					$User->id == $comment['user'] || $User->admin() ? h::{'icon.cs-comments-comment-edit.cs-cursor-pointer'}('pencil') : ''
				).
				(
					!$comment['comments'] &&
					(
						$User->id == $comment['user'] || $User->admin()
					) ? h::{'icon.cs-comments-comment-delete.cs-cursor-pointer'}('trash-o') : ''
				).
				h::{'div.cs-comments-comment-text'}($uniqid).
				(
					$comment['comments'] ? $this->tree_html($comment['comments']) : ''
				),
				[
					'id'	=> "comment_$comment[id]"
				]
			));
		}
		return $content;
	}
	/**
	 * 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) {
		$L	= new Language_prefix('comments_');
		return h::{'section#comments.cs-comments-comments'}(
			$L->comments.':'.
			(
				$this->tree($item, $module) ?: h::{'article.cs-blogs-no-comments'}($L->no_comments_yet)
			)
		).
		h::{'p.cs-comments-add-comment'}("$L->add_comment:").
		(
			User::instance()->user() ? h::{'section.cs-comments-comment-write'}(
				h::{'cs-editor-simple textarea.cs-comments-comment-write-text[is=cs-textarea][autosize]'}(
					'',
					[
						'data-item'		=> $item,
						'data-parent'	=> 0,
						'data-id'		=> 0,
						'data-module'	=> $module
					]
				).
				h::br().
				h::{'button.cs-comments-comment-write-send[is=cs-button]'}(
					$L->send_comment
				).
				h::{'button.cs-comments-comment-write-edit[is=cs-button]'}(
					$L->save,
					[
						'style'	=>	'display: none'
					]
				).
				h::{'button.cs-comments-comment-write-cancel[is=cs-button]'}(
					$L->cancel,
					[
						'style'	=>	'display: none'
					]
				)
			) : h::p($L->register_for_comments_sending)
		);
	}
}