main_controller.php

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

namespace phpbb\boardrules\controller;

/**
* Main controller
*/
class main_controller implements main_interface
{
	/** @var \phpbb\config\config */
	protected $config;

	/** @var \phpbb\controller\helper */
	protected $helper;

	/** @var \phpbb\language\language */
	protected $lang;

	/** @var \phpbb\boardrules\operators\rule */
	protected $rule_operator;

	/** @var \phpbb\template\template */
	protected $template;

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

	/** @var string phpBB root path */
	protected $root_path;

	/** @var string phpEx */
	protected $php_ext;

	/**
	* Constructor
	*
	* @param \phpbb\config\config             $config        Config object
	* @param \phpbb\controller\helper         $helper        Controller helper object
	* @param \phpbb\language\language         $lang          Language object
	* @param \phpbb\boardrules\operators\rule $rule_operator Rule operator object
	* @param \phpbb\template\template         $template      Template object
	* @param \phpbb\user                      $user          User object
	* @param string                           $root_path     phpBB root path
	* @param string                           $php_ext       phpEx
	* @access public
	*/
	public function __construct(\phpbb\config\config $config, \phpbb\controller\helper $helper, \phpbb\language\language $lang, \phpbb\boardrules\operators\rule $rule_operator, \phpbb\template\template $template, \phpbb\user $user, $root_path, $php_ext)
	{
		$this->config = $config;
		$this->helper = $helper;
		$this->lang = $lang;
		$this->rule_operator = $rule_operator;
		$this->template = $template;
		$this->user = $user;
		$this->root_path = $root_path;
		$this->php_ext = $php_ext;
	}

	/**
	* Display the rules page
	*
	* @return \Symfony\Component\HttpFoundation\Response A Symfony Response object
	* @access public
	*/
	public function display()
	{
		// When board rules are disabled, redirect users back to the forum index
		if (empty($this->config['boardrules_enable']))
		{
			redirect(append_sid("{$this->root_path}index.{$this->php_ext}"));
		}

		// Add boardrules controller language file
		$this->lang->add_lang('boardrules_controller', 'phpbb/boardrules');

		$last_right_id = null; // Used to help determine when to close nesting structures
		$depth = 0; // Used to track the depth of nesting level
		$cat_counter = 1; // Numeric counter used for categories
		$rule_counter = 'a'; // Alpha counter used for rules

		// Grab all the rules in the current user's language
		$entities = $this->rule_operator->get_rules($this->lang->get_used_language());

		// If no rules were found, it may be because no rules exist in the current user's
		// language, so let's look for rules in the board's default language as a fallback.
		if (empty($entities) && $this->lang->get_used_language() !== $this->config['default_lang'])
		{
			$entities = $this->rule_operator->get_rules($this->config['default_lang']);
		}

		/* @var $entity \phpbb\boardrules\entity\rule */
		foreach ($entities as $entity)
		{
			if ($entity->get_right_id() - $entity->get_left_id() > 1)
			{
				// Rule categories
				$is_category = true;
				$anchor = $entity->get_anchor() ?: $this->lang->lang('BOARDRULES_CATEGORY_ANCHOR', $cat_counter);

				// Increment nesting level depth counter
				$depth++;
				// Increment category counter
				$cat_counter++;
				// Reset rule counter
				$rule_counter = 'a';
			}
			else
			{
				// Rules
				$is_category = false;
				$anchor = $entity->get_anchor() ?: $this->lang->lang('BOARDRULES_RULE_ANCHOR', ($cat_counter - 1) . $rule_counter);

				// Increment rule counter
				$rule_counter++;
			}

			// Determine how deeply nested we are and use closing tags as necessary
			$diff = ($last_right_id !== null) ? $entity->get_left_id() - $last_right_id : 1;
			if ($diff > 1)
			{
				for ($i = 1; $i < $diff; $i++)
				{
					$depth--; // decrement the nesting level depth counter
					$this->template->assign_block_vars('rules', array(
						'S_CLOSE_LIST'	=> true,
					));
				}
			}

			// Set last_right_id value with the current item's value
			$last_right_id = $entity->get_right_id();

			// Assign values to template vars for this rule entity
			$this->template->assign_block_vars('rules', array(
				'TITLE'			=> $entity->get_title(),
				'MESSAGE'		=> $entity->get_message_for_display(),
				'U_ANCHOR'		=> $anchor,
				'S_IS_CATEGORY'	=> $is_category,
				'DEPTH'			=> $depth,
			));
		}

		// By this point, if any nested structures are still open, attempt to close them
		if ($depth > 0)
		{
			for ($i = 0; $i < $depth; $i++)
			{
				$this->template->assign_block_vars('rules', array(
					'S_CLOSE_LIST'	=> true,
				));
			}
		}

		// Assign values to template vars for the rules page
		$this->template->assign_vars(array(
			'S_BOARD_RULES'			=> true,
			'S_CATEGORIES'			=> $cat_counter > 1,
			'BOARDRULES_LIST_STYLE'	=> $this->config['boardrules_list_style'],
			'BOARDRULES_EXPLAIN'	=> $this->lang->lang('BOARDRULES_EXPLAIN', $this->config['sitename']),
		));

		// Assign breadcrumb template vars for the rules page
		$this->template->assign_block_vars('navlinks', array(
			'U_VIEW_FORUM'		=> $this->helper->route('phpbb_boardrules_main_controller'),
			'FORUM_NAME'		=> $this->lang->lang('BOARDRULES'),
		));

		// Send all data to the template file
		return $this->helper->render('@phpbb_boardrules/boardrules_controller.html', $this->lang->lang('BOARDRULES'));
	}
}