ElkArte\Menu\MenuArea

Complexity

Total Complexity

19

Size/Duplication

Total Lines	197
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	buildMoreFromArray()	0	16	4
A	addSubsection()	0	6	1
A	getFunction()	0	4	1
A	setFunction()	0	6	1
A	getIcon()	0	4	1
A	setIcon()	0	6	1
A	getController()	0	4	1
A	setController()	0	6	1
A	getSelect()	0	4	1
A	setSelect()	0	6	1
A	getClass()	0	4	1
A	setClass()	0	6	1
A	isHidden()	0	4	1
A	setHidden()	0	6	1
A	toArray()	0	4	1
A	getSubsections()	0	4	1

<?php

/**
 * This class contains a standard way of displaying side/drop down menus.
 *
 * @name      ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause
 *
 * @version   2.0 dev
 */

namespace ElkArte\Menu;

/**
 * Class MenuArea
 *
 * This class implements a standard way of creating menus
 *
 * @package ElkArte\Menu
 */
class MenuArea extends MenuItem
{
	/** @var callable $function function to call when area is selected. */
	protected $function;

	/** @var string $icon File name of an icon to use on the menu, if using the sprite class, set as transparent.png */
	protected $icon = '';

	/** @var string $controller URL to use for this menu item. */
	protected $controller = '';

	/** @var string $select References another area to be highlighted while this one is active */
	public $select = '';

	/** @var string $class Class name to apply to the icon img, used to apply a sprite icon */
	protected $class = '';

	/** @var bool $enabled Should this area even be accessible? */
	protected $enabled = true;

	/** @var bool $hidden Should this area be visible? */
	protected $hidden = false;

	/** @var array $subsections Array of subsections from this area. */
	private $subsections = [];

	/**
	 * @param array $arr
	 *
	 * @return MenuArea
	 */
	protected function buildMoreFromArray(array $arr): MenuArea
	{
		if (isset($arr['custom_url']))
		{
			$this->setUrl($arr['custom_url']);
		}
		if (isset($arr['subsections']))
		{
			foreach ($arr['subsections'] as $var => $subsection)
			{
				$this->addSubsection($var, $subsection);
			}
		}

		return $this;
	}

	/**
	 * @param string         $id
	 * @param MenuSubsection $subsection
	 *
	 * @return $this
	 */
	public function addSubsection(string $id, MenuSubsection $subsection): MenuArea
	{
		$this->subsections[$id] = $subsection;

		return $this;
	}

	/**
	 * @return callable
	 */
	public function getFunction()
	{
		return $this->function;
	}

	/**
	 * @param callable $function
	 *
	 * @return MenuArea
	 */
	public function setFunction($function): MenuArea
	{
		$this->function = $function;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getIcon(): string
	{
		return $this->icon;
	}

	/**
	 * @param string $icon
	 *
	 * @return MenuArea
	 */
	public function setIcon(string $icon): MenuArea
	{
		$this->icon = $icon;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getController(): string
	{
		return $this->controller;
	}

	/**
	 * @param string $controller
	 *
	 * @return MenuArea
	 */
	public function setController(string $controller): MenuArea
	{
		$this->controller = $controller;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getSelect(): string
	{
		return $this->select;
	}

	/**
	 * @param string $select
	 *
	 * @return MenuArea
	 */
	public function setSelect(string $select): MenuArea
	{
		$this->select = $select;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getClass(): string
	{
		return $this->class;
	}

	/**
	 * @param string $class
	 *
	 * @return MenuArea
	 */
	public function setClass(string $class): MenuArea
	{
		$this->class = $class;

		return $this;
	}

	/**
	 * @return boolean
	 */
	public function isHidden(): bool
	{
		return $this->hidden;
	}

	/**
	 * @param boolean $hidden
	 *
	 * @return MenuArea
	 */
	public function setHidden(bool $hidden): MenuArea
	{
		$this->hidden = $hidden;

		return $this;
	}

	/**
	 * @return array
	 */
	public function toArray(): array
	{
		return get_object_vars($this);
	}

	/**
	 * @return array
	 */
	public function getSubsections(): array
	{
		return $this->subsections;
	}
}