ElkArte\Menu\MenuOptions

Complexity

Total Complexity

33

Size/Duplication

Total Lines	281
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

96.51%

Importance

Changes

0

24 Methods

Rating	Name	Duplication	Size	Complexity
A	getAction()	0	4	1
A	setAction()	0	4	1
A	getArea()	0	4	1
A	setArea()	0	4	1
A	getExtraUrlParameters()	0	4	1
A	setExtraUrlParameters()	0	4	1
A	isUrlSessionCheckDisabled()	0	4	1
A	setDisableUrlSessionCheck()	0	4	1
A	getBaseUrl()	0	4	1
A	setBaseUrl()	0	4	1
A	getMenuType()	0	4	1
A	setMenuType()	0	4	1
A	isDropDownToggleable()	0	4	1
A	setCanToggleDropDown()	0	4	1
A	getTemplateName()	0	4	1
A	setTemplateName()	0	4	1
A	getLayerName()	0	4	1
A	setLayerName()	0	4	1
A	getCounters()	0	4	1
A	setCounters()	0	4	1
A	buildFromArray()	0	15	3
A	buildTemplateVars()	0	12	4
A	buildBaseUrl()	0	14	3
B	buildAdditionalParams()	0	24	3

<?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
 *
 * This file contains code covered by:
 * copyright: 2011 Simple Machines (http://www.simplemachines.org)
 * license:   BSD, See included LICENSE.TXT for terms and conditions.
 *
 * @version   2.0 dev
 */

declare(strict_types=1);

namespace ElkArte\Menu;

/**
 * Class MenuOptions
 *
 * This class implements a standard way of creating menus
 *
 * @package ElkArte\Menu
 */
class MenuOptions
{
	/** @var string $action overrides the default action */
	private $action = '';

	/** @var string $area overrides the current area */
	private $area = '';

	/** @var array $extraUrlParameters an array or pairs or parameters to be added to the url */
	private $extraUrlParameters = [];

	/** @var boolean $disableUrlSessionCheck if true the session var/id are omitted from the url */
	private $disableUrlSessionCheck = false;

	/** @var string $baseUrl an alternative base url */
	private $baseUrl = '';

	/** @var string $menuType alternative menu type to replace the usual sidebar/dropdown. */
	private $menuType = '';

	/** @var boolean $canToggleDropDown if the menu can toggle between sidebar and dropdown. */
	private $canToggleDropDown = true;

	/** @var string $templateName an alternative template to load (instead of Generic) */
	private $templateName = 'GenericMenu';

	/** @var string $layerName alternative layer name for the menu */
	private $layerName = 'generic_menu';

	/** @var array $counters All the counters to be used for a menu. See Menu::parseCounter() */
	private $counters = [];

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

	/**
	 * @param string $action
	 */
	public function setAction(string $action)
	{
		$this->action = $action;
	}

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

	/**
	 * @param string $area
	 */
	public function setArea(string $area)
	{
		$this->area = $area;
	}

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

	/**
	 * @param array $extraUrlParameters
	 */
	public function setExtraUrlParameters(array $extraUrlParameters)
	{
		$this->extraUrlParameters = $extraUrlParameters;
	}

	/**
	 * @return bool
	 */
	public function isUrlSessionCheckDisabled(): bool
	{
		return $this->disableUrlSessionCheck;
	}

	/**
	 * @param bool $disableUrlSessionCheck
	 */
	public function setDisableUrlSessionCheck(bool $disableUrlSessionCheck)
	{
		$this->disableUrlSessionCheck = $disableUrlSessionCheck;
	}

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

	/**
	 * @param string $baseUrl
	 */
	public function setBaseUrl(string $baseUrl)
	{
		$this->baseUrl = $baseUrl;
	}

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

	/**
	 * @param string $menuType
	 */
	public function setMenuType(string $menuType)
	{
		$this->menuType = $menuType;
	}

	/**
	 * @return bool
	 */
	public function isDropDownToggleable(): bool
	{
		return $this->canToggleDropDown;
	}

	/**
	 * @param bool $canToggleDropDown
	 */
	public function setCanToggleDropDown(bool $canToggleDropDown)
	{
		$this->canToggleDropDown = $canToggleDropDown;
	}

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

	/**
	 * @param string $templateName
	 */
	public function setTemplateName(string $templateName)
	{
		$this->templateName = $templateName;
	}

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

	/**
	 * @param string $layerName
	 */
	public function setLayerName(string $layerName)
	{
		$this->layerName = $layerName;
	}

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

	/**
	 * @param array $counters
	 */
	public function setCounters(array $counters)
	{
		$this->counters = $counters;
	}

	/**
	 * Add an array of options for a menu.
	 *
	 * @param array $arr Options as an array. Keys should match properties
	 *                   of MenuOptions and can be either in snake_case or in camelCase,
	 *                   depending on your style.
	 *
	 * @return MenuOptions
	 */
	public static function buildFromArray(array $arr): MenuOptions
	{
		$obj = new self;
		foreach ($arr as $var => $val)
		{
			if (is_callable([$obj, $call = 'set' . str_replace('_', '', ucwords($var, '_'))]))
			{
				$obj->{$call}($val);
			}
		}
		$obj->buildBaseUrl();
		$obj->buildTemplateVars();

		return $obj;
	}

	/**
	 * The theme needs some love, too.
	 */
	private function buildTemplateVars(): void
	{
		global $user_info, $options;

		if (empty($this->getMenuType()))
		{
			$this->setMenuType(empty($options['use_sidebar_menu']) ? 'dropdown' : 'sidebar');
		}
		$this->setCanToggleDropDown(!$user_info['is_guest'] && $this->isDropDownToggleable());

		$this->setLayerName($this->getLayerName() . '_' . $this->getMenuType());
	}

	/**
	 * Process the array of MenuOptions passed to the class
	 */
	protected function buildBaseUrl(): void
	{
		global $context, $scripturl;

		$this->setAction($this->getAction() ?: $context['current_action']);

		$this->setBaseUrl(
			$this->getBaseUrl() ?: sprintf(
				'%s?action=%s',
				$scripturl,
				$this->getAction()
			)
		);
	}

	/**
	 * Build the additional parameters for use in the url
	 *
	 * @return string
	 */
	public function buildAdditionalParams(): string
	{
		global $context;

		$arr = $this->getExtraUrlParameters();

		// Only include the session ID in the URL if it's strictly necessary.
		if (!$this->isUrlSessionCheckDisabled())
		{
			$arr[$context['session_var']] = $context['session_id'];
		}

		$extraUrlParameters = '';
		foreach ($arr as $key => $value)
		{
			$extraUrlParameters .= sprintf(
				';%s=%s',
				$key,
				$value
			);
		}

		return $extraUrlParameters;
	}
}