phpbb\collapsiblecategories\operator\operator

Complexity

Total Complexity

15

Size/Duplication

Total Lines	174
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	10
Bugs	1	Features	1

9 Methods

Rating	Name	Duplication	Size	Complexity
A	set_user_categories()	0	22	3
A	toggle_array_value()	0	15	2
A	__construct()	0	7	1
A	set_collapsed_categories()	0	8	2
A	set_cookie_categories()	0	10	1
A	is_collapsed()	0	8	2
A	get_user_categories()	0	12	2
A	get_cookie_categories()	0	7	1
A	get_collapsible_link()	0	5	1

<?php
/**
 *
 * Collapsible Categories extension for the phpBB Forum Software package.
 *
 * @copyright (c) 2015 phpBB Limited <https://www.phpbb.com>
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace phpbb\collapsiblecategories\operator;

use phpbb\config\config;

The type phpbb\config\config was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\controller\helper;

The type phpbb\controller\helper was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\db\driver\driver_interface;

The type phpbb\db\driver\driver_interface was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\request\request;

The type phpbb\request\request was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\user;

The type phpbb\user was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Class operator
 */
class operator implements operator_interface
{
	/** @var array An array of collapsed category forum identifiers */
	protected $collapsed_categories;

	/** @var config */
	protected $config;

	/** @var driver_interface */
	protected $db;

	/** @var helper */
	protected $helper;

	/** @var request */
	protected $request;

	/** @var user */
	protected $user;

	/**
	 * Constructor
	 *
	 * @param config           $config  Config object
	 * @param driver_interface $db      Database object
	 * @param helper           $helper  Controller helper object
	 * @param request          $request Request object
	 * @param user             $user    User object
	 */
	public function __construct(config $config, driver_interface $db, helper $helper, request $request, user $user)
	{
		$this->config = $config;
		$this->db = $db;
		$this->helper = $helper;
		$this->request = $request;
		$this->user = $user;
	}

	/**
	 * {@inheritdoc}
	 */
	public function is_collapsed($forum_id)
	{
		if (!isset($this->collapsed_categories))
		{
			$this->collapsed_categories = $this->get_user_categories();
		}

		return in_array($forum_id, $this->collapsed_categories);
	}

	/**
	 * {@inheritdoc}
	 */
	public function get_collapsible_link($forum_id)
	{
		return $this->helper->route('phpbb_collapsiblecategories_main_controller', array(
			'forum_id'	=> $forum_id,
			'hash'		=> generate_link_hash("collapsible_$forum_id")

The function generate_link_hash was not found. Maybe you did not declare it correctly or list all dependencies?

		));
	}

	/**
	 * {@inheritdoc}
	 */
	public function get_user_categories()
	{
		// Get categories from the user object
		$collapsible_categories = (array) json_decode($this->user->data['collapsible_categories'], true);

		if (empty($collapsible_categories))
		{
			// The user object had no categories, check for a cookie
			$collapsible_categories = $this->get_cookie_categories();
		}

		return $collapsible_categories;
	}

	/**
	 * {@inheritdoc}
	 */
	public function set_user_categories($forum_id)
	{
		// Set the collapsed category data array
		$this->set_collapsed_categories($forum_id);

		// Update the db with json encoded array of collapsed category data
		if ($this->user->data['is_registered'])
		{
			$sql = 'UPDATE ' . USERS_TABLE . "

The constant phpbb\collapsiblecategories\operator\USERS_TABLE was not found. Maybe you did not declare it correctly or list all dependencies?

				SET collapsible_categories = '" . $this->db->sql_escape(json_encode($this->collapsed_categories)) . "'
				WHERE user_id = " . (int) $this->user->data['user_id'];
			$this->db->sql_query($sql);

			// There was an error updating the user's data
			if (!$this->db->sql_affectedrows())
			{
				return false;
			}
		}

		// Set a cookie with the collapsed category data and return true
		return $this->set_cookie_categories($forum_id);
	}

	/**
	 * {@inheritdoc}
	 */
	public function get_cookie_categories()
	{
		// Get categories from the cookie and htmlspecialchars decode it
		$cookie_data = htmlspecialchars_decode($this->request->variable($this->config['cookie_name'] . '_ccat', '', true, \phpbb\request\request_interface::COOKIE), ENT_COMPAT);

The type phpbb\request\request_interface was not found. Maybe you did not declare it correctly or list all dependencies?

		// json decode the cookie data and return an array
		return (array) json_decode($cookie_data, true);
	}

	/**
	 * {@inheritdoc}
	 */
	public function set_cookie_categories($forum_id)
	{
		// Set the collapsed category data array
		$this->set_collapsed_categories($forum_id);

		// Update the cookie with json encoded array of collapsed category data
		$this->user->set_cookie('ccat', json_encode($this->collapsed_categories), strtotime('+1 year'));

		// As we are unable to check immediately if the cookie was set, return true anyway
		return true;
	}

	/**
	 * Set the collapsed_categories property
	 *
	 * @param string $forum_id A forum identifier
	 *
	 * @return operator_interface $this object
	 */
	protected function set_collapsed_categories($forum_id)
	{
		if (!isset($this->collapsed_categories))
		{
			$this->collapsed_categories = $this->toggle_array_value($forum_id, $this->get_user_categories());
		}

		return $this;
	}

	/**
	 * Add a value to an array if it is new or
	 * remove the value if it exists in the array.
	 *
	 * @param mixed $value A string or int value
	 * @param array $array An array
	 *
	 * @return array The updated array
	 */
	protected function toggle_array_value($value, $array)
	{
		if (in_array($value, $array))
		{
			// Remove all matching values from the array using array_diff
			$array = array_diff($array, array($value));
		}
		else
		{
			// Add the new value to the array
			$array[] = $value;
		}

		// Enforce unique array values
		return array_keys(array_count_values($array));
	}
}