ManageUltimateMenu::ListButtons() - Code Metrics - Inspection of "ListButtons" - live627/smf-ultimate-menu - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( f4108d...932680 )

by John
created 2020-11-13 08:32 UTC
ManageUltimateMenu::ListButtons() B

↳ Parent: ManageUltimateMenu
Complexity

Conditions	3
Paths	1
Size

Total Lines	160
Code Lines	106
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	3
eloc	106
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	160
rs	8
How to fix Long Method

<?php
/**
 * @package   Ultimate Menu mod
 * @version   1.1
 * @author    John Rayes <[email protected]>
 * @copyright Copyright (c) 2014, John Rayes
 * @license   http://opensource.org/licenses/MIT MIT
 */

class ManageUltimateMenu
{
	private $um;

	public function __construct()
	{
		global $context, $sourcedir, $txt;

		isAllowedTo('admin_forum');

		$context['page_title'] = $txt['admin_menu_title'];
		$context[$context['admin_menu_name']]['tab_data'] = array(
			'title' => $txt['admin_menu'],
			'description' => $txt['admin_menu_desc'],
			'tabs' => array(
				'manmenu' => array(
					'description' => $txt['admin_manage_menu_desc'],
				),
				'addbutton' => array(
					'description' => $txt['admin_menu_add_button_desc'],
				),
			),
		);
		loadTemplate('ManageUltimateMenu');
		require_once $sourcedir . '/Class-UltimateMenu.php';
		$this->um = new UltimateMenu;

		$subActions = array(
			'manmenu' => 'ManageUltimateMenu',
			'addbutton' => 'PrepareContext',
			'savebutton' => 'SaveButton',
		);
		if (!isset($_GET['sa']) || !isset($subActions[$_GET['sa']]))
			$_GET['sa'] = 'manmenu';
		$this->$subActions[$_GET['sa']]();
	}

	public function ManageUltimateMenu()
	{
		// Get rid of all of em!
		if (!empty($_POST['removeAll']))
		{
			checkSession();
			$this->um->deleteallButtons();
			$this->um->rebuildMenu();
			redirectexit('action=admin;area=umen');
		}
		// User pressed the 'remove selection button'.
		elseif (!empty($_POST['removeButtons']) && !empty($_POST['remove']) && is_array($_POST['remove']))
		{
			checkSession();

			// Make sure every entry is a proper integer.
			foreach ($_POST['remove'] as $index => $page_id)
				$_POST['remove'][(int) $index] = (int) $page_id;

			// Delete the page(s)!
			$this->um->deleteButton($_POST['remove']);
			$this->um->rebuildMenu();
			redirectexit('action=admin;area=umen');
		}
		// Changing the status?
		elseif (isset($_POST['save']))
		{
			checkSession();
			$this->um->updateButton($_POST);
			$this->um->rebuildMenu();
			redirectexit('action=admin;area=umen');
		}
		// New item?
		elseif (isset($_POST['new']))
			redirectexit('action=admin;area=umen;sa=addbutton');

		ListButtons();
  ListButtons();
	}

	public function ListButtons()
	{
		global $context, $txt, $scripturl;

		$button_names = $this->um->getButtonNames();
		$listOptions = array(
			'id' => 'menu_list',
			'items_per_page' => 20,
			'base_href' => $scripturl . '?action=admin;area=umen;sa=manmenu',
			'default_sort_col' => 'name',
			'default_sort_dir' => 'desc',
			'get_items' => array(
				'function' => array($this->um, 'list_getMenu'),
			),
			'get_count' => array(
				'function' => array($this->um, 'list_getNumButtons'),
			),
			'no_items_label' => $txt['um_menu_no_buttons'],
			'columns' => array(
				'name' => array(
					'header' => array(
						'value' => $txt['um_menu_button_name'],
					),
					'data' => array(
						'db_htmlsafe' => 'name',
					),
					'sort' => array(
						'default' => 'name',
						'reverse' => 'name DESC',
					),
				),
				'type' => array(
					'header' => array(
						'value' => $txt['um_menu_button_type'],
					),
					'data' => array(
						'function' => function($rowData) use ($txt)
						{
							return $txt['um_menu_' . $rowData['type'] . '_link'];
						},
					),
					'sort' => array(
						'default' => 'type',
						'reverse' => 'type DESC',
					),
				),
				'position' => array(
					'header' => array(
						'value' => $txt['um_menu_button_position'],
					),
					'data' => array(
						'function' => function($rowData) use ($txt, $button_names)
						{
							return sprintf(
								'%s %s',
								$txt['um_menu_' . $rowData['position']],
								isset($button_names[$rowData['parent']])
									? $button_names[$rowData['parent']]
									: ucwords($rowData['parent'])
							);
						},
					),
					'sort' => array(
						'default' => 'position',
						'reverse' => 'position DESC',
					),
				),
				'link' => array(
					'header' => array(
						'value' => $txt['um_menu_button_link'],
					),
					'data' => array(
						'db_htmlsafe' => 'link',
					),
					'sort' => array(
						'default' => 'link',
						'reverse' => 'link DESC',
					),
				),
				'status' => array(
					'header' => array(
						'value' => $txt['um_menu_button_active'],
						'class' => 'centertext',
					),
					'data' => array(
						'function' => function($rowData)
						{
							return sprintf(
								'<input type="checkbox" name="status[%1$s]" id="status_%1$s" value="%1$s"%2$s />',
								$rowData['id_button'],
								$rowData['status'] == 'inactive' ? '' : ' checked="checked"'
							);
						},
						'class' => 'centertext',
					),
					'sort' => array(
						'default' => 'status',
						'reverse' => 'status DESC',
					),
				),
				'actions' => array(
					'header' => array(
						'value' => $txt['um_menu_actions'],
						'class' => 'centertext',
					),
					'data' => array(
						'function' => function($rowData) use ($scripturl, $txt)
						{
							return sprintf(
								'<a href="%s?action=admin;area=umen;sa=addbutton;edit;in=%d">%s</a>',
								$scripturl,
								$rowData['id_button'],
								$txt['modify']
							);
						},
						'class' => 'centertext',
					),
				),
				'check' => array(
					'header' => array(
						'value' => '<input type="checkbox" onclick="invertAll(this, this.form);" class="input_check" />',
						'class' => 'centertext',
					),
					'data' => array(
						'sprintf' => array(
							'format' => '<input type="checkbox" name="remove[]" value="%d" class="input_check" />',
							'params' => array(
								'id_button' => false,
							),
						),
						'class' => 'centertext',
					),
				),
			),
			'form' => array(
				'href' => $scripturl . '?action=admin;area=umen;sa=manmenu',
			),
			'additional_rows' => array(
				array(
					'position' => 'below_table_data',
					'value' => sprintf('
						<input type="submit" name="removeButtons" value="%s" onclick="return confirm(\'%s\');" class="button_submit" />
						<input type="submit" name="removeAll" value="%s" onclick="return confirm(\'%s\');" class="button_submit" />
						<input type="submit" name="new" value="%s" class="button_submit" />
						<input type="submit" name="save" value="%s" class="button_submit" />',
						$txt['um_menu_remove_selected'],
						$txt['um_menu_remove_confirm'],
						$txt['um_menu_remove_all'],
						$txt['um_menu_remove_all_confirm'],
						$txt['um_admin_add_button'],
						$txt['save']
					),
					'class' => 'righttext',
				),
			),
		);
		require_once $sourcedir . '/Subs-List.php';

		createList($listOptions);
		$context['sub_template'] = 'show_list';
		$context['default_list'] = 'menu_list';
	}

	public function SaveButton()
	{
		global $context, $txt;

		if (isset($_POST['submit']))
		{
			$post_errors = array();
			$required_fields = array(
				'name',
				'link',
				'parent',
			);
			$member_groups = array_column($this->um->list_groups('-3', 1), 'id');
			$button_names = $this->um->getButtonNames();
			$args = array(
				'in' => FILTER_VALIDATE_INT,
				'name' => FILTER_UNSAFE_RAW,
				'position' => array(
					'filter' => FILTER_CALLBACK,
					'options' => function ($v)
					{
						return in_array($v, ['before', 'child_of', 'after']) ? $v : false;
					},
				),
				'parent' => array(
					'filter' => FILTER_CALLBACK,
					'options' => function ($v) use ($button_names)
					{
						return isset($button_names[$v]) ? $v : false;
					},
				),
				'type' => array(
					'filter' => FILTER_CALLBACK,
					'options' => function ($v)
					{
						return in_array($v, ['forum', 'external']) ? $v : false;
					},
				),
				'link' => FILTER_UNSAFE_RAW,
				'permissions' => array(
					'filter' => FILTER_CALLBACK,
					'flags' => FILTER_REQUIRE_ARRAY,
					'options' => function ($v) use ($member_groups)
					{
						return in_array($v, $member_groups) ? $v : false;
					},
				),
				'status' => array(
					'filter' => FILTER_CALLBACK,
					'options' => function ($v)
					{
						return in_array($v, ['active', 'inactive']) ? $v : false;
					},
				),
				'target' => array(
					'filter' => FILTER_CALLBACK,
					'options' => function ($v)
					{
						return in_array($v, ['_self', '_blank']) ? $v : false;
					},
				),
			);

			// Make sure we grab all of the content
			$menu_entry = array_replace(
				array(
					'target' => '_self',
					'type' => 'forum',
					'position' => 'before',
					'status' => 'active',
					'parent' => 'home',
				),
				filter_input_array(INPUT_POST, $args)
			);

			// These fields are required!
			foreach ($required_fields as $required_field)
				if (empty($menu_entry[$required_field]))
					$post_errors[$required_field] = 'um_menu_empty_' . $required_field;

			// Stop making numeric names!
			if (is_numeric($menu_entry['name']))
				$post_errors['name'] = 'um_menu_numeric';

			// Let's make sure you're not trying to make a name that's already taken.
			$check = $this->um->checkButton($menu_entry['id'], $menu_entry['name']);
			if ($check > 0)
				$post_errors['name'] = 'um_menu_mysql';

			// I see you made it to the final stage, my young padawan.
			if (empty($post_errors))
			{
				$this->um->saveButton($menu_entry);
				$this->um->rebuildMenu();

				// Before we leave, we must clear the cache. See, SMF
				// caches its menu at level 2 or higher.
				clean_cache('menu_buttons');

				redirectexit('action=admin;area=umen');
			}
			else
			{
				$context['page_title'] = $txt['um_menu_edit_title'];
				$context['post_error'] = $post_errors;
				$context['error_title'] = empty($menu_entry['id'])
					? 'um_menu_errors_create'
					: 'um_menu_errors_modify';
				$context['button_data'] = array(
					'name' => $menu_entry['name'],
					'type' => $menu_entry['type'],
					'target' => $menu_entry['target'],
					'position' => $menu_entry['position'],
					'link' => $menu_entry['link'],
					'parent' => $menu_entry['parent'],
					'permissions' => $this->um->list_groups(
						implode(',', array_filter($menu_entry['permissions'], 'strlen')),
						1
					),
					'status' => $menu_entry['status'],
					'id' => $menu_entry['id'],
				);
			}
		}
	}

	public function PrepareContext()
	{
		global $context, $txt;

		if (isset($_GET['in']))
		{
			$row = $this->um->fetchButton($_GET['in']);

			$context['button_data'] = array(
				'id' => $_GET['in'],
				'name' => $row['name'],
				'target' => $row['target'],
				'type' => $row['type'],
				'position' => $row['position'],
				'permissions' => $this->um->list_groups($row['permissions'], 1),
				'link' => $row['link'],
				'status' => $row['status'],
				'parent' => $row['parent'],
			);
		}
		else
		{
			$context['button_data'] = array(
				'name' => '',
				'link' => '',
				'target' => '_self',
				'type' => 'forum',
				'position' => 'before',
				'status' => 'active',
				'permissions' => $this->um->list_groups('-3', 1),
				'parent' => 'home',
				'id' => 0,
			);

			$context['page_title'] = $txt['um_menu_add_title'];
		}
	}
}

live627 / smf-ultimate-menu

Push — master ( f4108d...932680 )

ManageUltimateMenu::ListButtons() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like
