menu_module::get_forums_string() - Code Metrics - Inspection of "Generate menu from forum categories" - blitze/phpBB-ext-sitemaker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 1387e8...f74656 )

by Daniel

created 2017-09-27 19:46 UTC

menu_module::get_forums_string() A

↳ Parent: menu_module

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	8
cts	8
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	1
crap	2

<?php
/**
 *
 * @package sitemaker
 * @copyright (c) 2013 Daniel A. (blitze)
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
 */

namespace blitze\sitemaker\acp;

use Symfony\Component\Yaml\Yaml;
use blitze\sitemaker\services\menus\nestedset;

/**
* @package acp
*/
class menu_module
{
	/** @var \phpbb\controller\helper */
	protected $controller_helper;

	/** @var \phpbb\event\dispatcher_interface */
	protected $phpbb_dispatcher;

	/** @var \phpbb\request\request_interface */
	protected $request;

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

	/** @var \blitze\sitemaker\services\icon_picker */
	protected $icon;

	/** @var \blitze\sitemaker\model\mapper_factory */
	protected $mapper_factory;

	/** @var \blitze\sitemaker\services\util */
	protected $util;

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

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

	/** @var string */
	public $tpl_name;

	/** @var string */
	public $page_title;

	/** @var string */
	public $u_action;

	/**
	 * menu_module constructor.
	 */
	public function __construct()
	{
		global $phpbb_container, $phpbb_dispatcher, $request, $template, $phpbb_root_path, $phpEx;
function myFunction($a, $b) {
    // Do something
}

		$this->phpbb_dispatcher = $phpbb_dispatcher;
		$this->request = $request;
		$this->template = $template;
		$this->phpbb_root_path = $phpbb_root_path;
		$this->php_ext = $phpEx;

		$this->controller_helper = $phpbb_container->get('controller.helper');
		$this->mapper_factory = $phpbb_container->get('blitze.sitemaker.mapper.factory');
		$this->icon = $phpbb_container->get('blitze.sitemaker.icon_picker');
		$this->util = $phpbb_container->get('blitze.sitemaker.util');
	}

	/**
	 * @return void
	 */
	public function main()
	{
		$menu_id = $this->request->variable('menu_id', 0);

		nestedset::load_scripts($this->util);
		$this->util->add_assets(array(
			'js'	=> array('@blitze_sitemaker/assets/menu/admin.min.js'),
			'css'	=> array('@blitze_sitemaker/assets/menu/admin.min.css')
		));

		$this->list_menus($menu_id);
		$this->build_bulk_options();

		$this->template->assign_vars(array(
			'S_MENU'		=> true,
			'MENU_ID'		=> $menu_id,
			'ICON_PICKER'	=> $this->icon->picker(),
			'T_PATH'		=> $this->phpbb_root_path,
			'UA_AJAX_URL'   => $this->controller_helper->route('blitze_sitemaker_menus_admin', array(), true, '') . '/',
		));

		$this->tpl_name = 'acp_menu';
		$this->page_title = 'ACP_MENU';
	}

	/**
	 * @param int $menu_id
	 * @return void
	 */
	protected function list_menus(&$menu_id)
	{
		$menu_mapper = $this->mapper_factory->create('menus');

		// Get all menus
		$collection = $menu_mapper->find();

		if ($collection->valid())
		{
			$menu = (isset($collection[$menu_id])) ? $collection[$menu_id] : $collection->current();
			$menu_id = $menu->get_menu_id();

			foreach ($collection as $entity)
			{
				$id = $entity->get_menu_id();
				$this->template->assign_block_vars('menu', array(
					'ID'		=> $id,
					'NAME'		=> $entity->get_menu_name(),
					'S_ACTIVE'	=> ($id == $menu_id) ? true : false,
				));
			}
		}
	}

	/**
	 * @return void
	 */
	protected function build_bulk_options()
	{
		$bulk_options = array();
		$forumslist = make_forum_select(false, false, true, false, false, false, true);

		/**
		 * Event to add bulk menu options
		 *
		 * @event blitze_sitemaker.acp_add_bulk_menu_options
		 * @var	array	bulk_options	Array of bulk menu options
		 * @since 3.1.0-RC1
		 */
		$vars = array('bulk_options', 'forumslist');
		extract($this->phpbb_dispatcher->trigger_event('blitze_sitemaker.acp_add_bulk_menu_options', compact($vars)));


		$bulk_options['FORUMS']	= $this->get_forums_string($forumslist);

		$this->template->assign_var('bulk_options', $bulk_options);
	}

	/**
	 * @param array $forumslist
	 * @return string
	 */
	protected function get_forums_string(array $forumslist)
	{
		$text = '';
		foreach ($forumslist as $forum_id => $row)
		{
			$text .= str_replace('&nbsp; &nbsp;', "\t", $row['padding']);
			$text .= $row['forum_name'] . '|';
			$text .= "viewforum.{$this->php_ext}?f=$forum_id\n";
		}

		return trim($text);
	}
}


1		<?php
2		/**
3		*
4		* @package sitemaker
5		* @copyright (c) 2013 Daniel A. (blitze)
6		* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
7		*
8		*/
9
10		namespace blitze\sitemaker\acp;
11
12		use Symfony\Component\Yaml\Yaml;
13		use blitze\sitemaker\services\menus\nestedset;
14
15		/**
16		* @package acp
17		*/
18		class menu_module
19		{
20		/** @var \phpbb\controller\helper */
21		protected $controller_helper;
22
23		/** @var \phpbb\event\dispatcher_interface */
24		protected $phpbb_dispatcher;
25
26		/** @var \phpbb\request\request_interface */
27		protected $request;
28
29		/** @var \phpbb\template\template */
30		protected $template;
31
32		/** @var \blitze\sitemaker\services\icon_picker */
33		protected $icon;
34
35		/** @var \blitze\sitemaker\model\mapper_factory */
36		protected $mapper_factory;
37
38		/** @var \blitze\sitemaker\services\util */
39		protected $util;
40
41		/** @var string phpBB root path */
42		protected $phpbb_root_path;
43
44		/** @var string phpEx */
45		protected $php_ext;
46
47		/** @var string */
48		public $tpl_name;
49
50		/** @var string */
51		public $page_title;
52
53		/** @var string */
54		public $u_action;
55
56		/**
57		* menu_module constructor.
58		*/
59	2	public function __construct()
60		{
61	2	global $phpbb_container, $phpbb_dispatcher, $request, $template, $phpbb_root_path, $phpEx;
		1 ignored issue – show Compatibility Best Practice introduced 2017-09-27 19:59 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
62
63	2	$this->phpbb_dispatcher = $phpbb_dispatcher;
64	2	$this->request = $request;
65	2	$this->template = $template;
66	2	$this->phpbb_root_path = $phpbb_root_path;
67	2	$this->php_ext = $phpEx;
68
69	2	$this->controller_helper = $phpbb_container->get('controller.helper');
70	2	$this->mapper_factory = $phpbb_container->get('blitze.sitemaker.mapper.factory');
71	2	$this->icon = $phpbb_container->get('blitze.sitemaker.icon_picker');
72	2	$this->util = $phpbb_container->get('blitze.sitemaker.util');
73	2	}
74
75		/**
76		* @return void
77		*/
78	2	public function main()
79		{
80	2	$menu_id = $this->request->variable('menu_id', 0);
81
82	2	nestedset::load_scripts($this->util);
83	2	$this->util->add_assets(array(
84	2	'js' => array('@blitze_sitemaker/assets/menu/admin.min.js'),
85	2	'css' => array('@blitze_sitemaker/assets/menu/admin.min.css')
86	2	));
87
88	2	$this->list_menus($menu_id);
89	2	$this->build_bulk_options();
90
91	2	$this->template->assign_vars(array(
92	2	'S_MENU' => true,
93	2	'MENU_ID' => $menu_id,
94	2	'ICON_PICKER' => $this->icon->picker(),
95	2	'T_PATH' => $this->phpbb_root_path,
96	2	'UA_AJAX_URL' => $this->controller_helper->route('blitze_sitemaker_menus_admin', array(), true, '') . '/',
97	2	));
98
99	2	$this->tpl_name = 'acp_menu';
100	2	$this->page_title = 'ACP_MENU';
101	2	}
102
103		/**
104		* @param int $menu_id
105		* @return void
106		*/
107	2	protected function list_menus(&$menu_id)
108		{
109	2	$menu_mapper = $this->mapper_factory->create('menus');
110
111		// Get all menus
112	2	$collection = $menu_mapper->find();
113
114	2	if ($collection->valid())
115	2	{
116	2	$menu = (isset($collection[$menu_id])) ? $collection[$menu_id] : $collection->current();
117	2	$menu_id = $menu->get_menu_id();
118
119	2	foreach ($collection as $entity)
120		{
121	2	$id = $entity->get_menu_id();
122	2	$this->template->assign_block_vars('menu', array(
123	2	'ID' => $id,
124	2	'NAME' => $entity->get_menu_name(),
125	2	'S_ACTIVE' => ($id == $menu_id) ? true : false,
126	2	));
127	2	}
128	2	}
129	2	}
130
131		/**
132		* @return void
133		*/
134	2	protected function build_bulk_options()
135		{
136	2	$bulk_options = array();
137	2	$forumslist = make_forum_select(false, false, true, false, false, false, true);
138
139		/**
140		* Event to add bulk menu options
141		*
142		* @event blitze_sitemaker.acp_add_bulk_menu_options
143		* @var array bulk_options Array of bulk menu options
144		* @since 3.1.0-RC1
145		*/
146	2	$vars = array('bulk_options', 'forumslist');
147	2	extract($this->phpbb_dispatcher->trigger_event('blitze_sitemaker.acp_add_bulk_menu_options', compact($vars)));
		1 ignored issue – show Bug introduced 2017-09-27 19:59 UTC by Report Bug Copy Issue Report `$this->phpbb_dispatcher-...tions', compact($vars))` cannot be passed to `extract()` as the parameter `$var_array` expects a reference. Loading history...
148
149	2	$bulk_options['FORUMS'] = $this->get_forums_string($forumslist);
150
151	2	$this->template->assign_var('bulk_options', $bulk_options);
152	2	}
153
154		/**
155		* @param array $forumslist
156		* @return string
157		*/
158	2	protected function get_forums_string(array $forumslist)
159		{
160	2	$text = '';
161	2	foreach ($forumslist as $forum_id => $row)
162		{
163	2	$text .= str_replace('   ', "\t", $row['padding']);
164	2	$text .= $row['forum_name'] . '\|';
165	2	$text .= "viewforum.{$this->php_ext}?f=$forum_id\n";
166	2	}
167
168	2	return trim($text);
169		}
170		}
171

blitze / phpBB-ext-sitemaker

Push — develop ( 1387e8...f74656 )

menu_module::get_forums_string() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like