admin_controller - Code Metrics - Inspection of "Improve Scrutinizer score" - phpbb-extensions/ad-management - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#75)

by Jakub

created 2017-08-20 17:34 UTC

admin_controller B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	493
Duplicated Lines	1.62 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

93.01%

Importance

Changes

Metric	Value
wmc	48
lcom	1
cbo	4
dl	8
loc	493
ccs	213
cts	229
cp	0.9301
rs	8.4864
c	0
b	0
f	0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	23	2
A	set_page_url()	0	4	1
A	get_page_title()	0	4	1
B	mode_settings()	8	36	4
A	mode_manage()	0	14	2
A	action_add()	0	23	2
B	action_edit()	0	31	3
A	action_enable()	0	4	1
A	action_disable()	0	4	1
B	action_delete()	0	40	5
B	list_ads()	0	36	6
A	get_submitted_action()	0	13	3
B	ad_enable()	0	28	6
A	preview()	0	4	1
A	upload_banner()	0	4	1
A	analyse_ad_code()	0	4	1
A	submit_add()	0	12	2
A	submit_edit()	0	20	4
A	success()	0	4	1
A	error()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like admin_controller often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use admin_controller, and based on these observations, apply Extract Interface, too.

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

namespace phpbb\ads\controller;

use phpbb\ads\controller\admin_input as input;

/**
* Admin controller
*/
class admin_controller
{
	/** @var array|bool Form data */
	protected $data = false;

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

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

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

	/** @var \phpbb\ads\ad\manager */
	protected $manager;

	/** @var \phpbb\config\db_text */
	protected $config_text;

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

	/** @var \phpbb\group\helper */
	protected $group_helper;

	/** @var \phpbb\ads\controller\admin_input */
	protected $input;

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

	/** @var \phpbb\ads\analyser\manager */
	protected $analyser;

	/** @var string Custom form action */
	protected $u_action;

	/**
	 * Constructor
	 *
	 * @param \phpbb\template\template           $template     Template object
	 * @param \phpbb\language\language           $language     Language object
	 * @param \phpbb\request\request             $request      Request object
	 * @param \phpbb\ads\ad\manager              $manager      Advertisement manager object
	 * @param \phpbb\config\db_text              $config_text  Config text object
	 * @param \phpbb\config\config               $config       Config object
	 * @param \phpbb\group\helper                $group_helper Group helper object
	 * @param \phpbb\ads\controller\admin_input  $input        Admin input object
	 * @param \phpbb\ads\controller\admin_helper $helper       Admin helper object
	 * @param \phpbb\ads\analyser\manager        $analyser     Ad code analyser object
	 * @param string                             $root_path    phpBB root path
	 * @param string                             $php_ext      PHP extension
	 */
	public function __construct(\phpbb\template\template $template, \phpbb\language\language $language, \phpbb\request\request $request, \phpbb\ads\ad\manager $manager, \phpbb\config\db_text $config_text, \phpbb\config\config $config, \phpbb\group\helper $group_helper, \phpbb\ads\controller\admin_input $input, \phpbb\ads\controller\admin_helper $helper, \phpbb\ads\analyser\manager $analyser, $root_path, $php_ext)
	{
		$this->template = $template;
		$this->language = $language;
		$this->request = $request;
		$this->manager = $manager;
		$this->config_text = $config_text;
		$this->config = $config;
		$this->group_helper = $group_helper;
		$this->input = $input;
		$this->helper = $helper;
		$this->analyser = $analyser;

		if (!function_exists('user_get_id_name'))
		{
			include $root_path . 'includes/functions_user.' . $php_ext;
		}

		$this->language->add_lang('posting'); // Used by banner_upload() file errors
		$this->language->add_lang('acp', 'phpbb/ads');

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

	/**
	 * Set page url
	 *
	 * @param	string	$u_action	Custom form action
	 * @return	void
	 */
	public function set_page_url($u_action)
	{
		$this->u_action = $u_action;
	}

	/**
	 * Get ACP page title for Ads module
	 *
	 * @return	string	Language string for Ads ACP module
	 */
	public function get_page_title()
	{
		return $this->language->lang('ACP_PHPBB_ADS_TITLE');
	}

	/**
	 * Process user request for settings mode
	 *
	 * @return	void
	 */
	public function mode_settings()
	{
		if ($this->request->is_set_post('submit'))
		{
			// Validate form key
			if (check_form_key('phpbb_ads'))
			{
				$this->config->set('phpbb_ads_adblocker_message', $this->request->variable('adblocker_message', 0));
				$this->config->set('phpbb_ads_enable_views', $this->request->variable('enable_views', 0));
				$this->config->set('phpbb_ads_enable_clicks', $this->request->variable('enable_clicks', 0));
				$this->config_text->set('phpbb_ads_hide_groups', json_encode($this->request->variable('hide_groups', array(0))));

				$this->success('ACP_AD_SETTINGS_SAVED');
			}

			$this->error('FORM_INVALID');
		}

		$hide_groups = json_decode($this->config_text->get('phpbb_ads_hide_groups'), true);
		$groups = $this->manager->load_groups();
		foreach ($groups as $group)
		{
			$this->template->assign_block_vars('groups', array(
				'ID'         => $group['group_id'],
				'NAME'       => $this->group_helper->get_name($group['group_name']),
				'S_SELECTED' => in_array($group['group_id'], $hide_groups),
			));
		}

		$this->template->assign_vars(array(
			'U_ACTION'          => $this->u_action,
			'ADBLOCKER_MESSAGE' => $this->config['phpbb_ads_adblocker_message'],
			'ENABLE_VIEWS'      => $this->config['phpbb_ads_enable_views'],
			'ENABLE_CLICKS'     => $this->config['phpbb_ads_enable_clicks'],
		));
	}

	/**
	 * Process user request for manage mode
	 *
	 * @return	void
	 */
	public function mode_manage()
	{
		// Trigger specific action
		$action = $this->request->variable('action', '');
		if (in_array($action, array('add', 'edit', 'enable', 'disable', 'delete')))
		{
			$this->{'action_' . $action}();
		}
		else
		{
			// Otherwise default to this
			$this->list_ads();
		}
	}

	/**
	 * Add an advertisement
	 *
	 * @return	void
	 */
	protected function action_add()
	{
		$action = $this->get_submitted_action();
		if ($action !== false)
		{
			$this->data = $this->input->get_form_data();
			$this->{$action}();
			$this->helper->assign_data($this->data, $this->input->get_errors());
		}
		else
		{
			$this->helper->assign_locations();
		}

		// Set output vars for display in the template
		$this->template->assign_vars(array(
			'S_ADD_AD'				=> true,
			'U_BACK'				=> $this->u_action,
			'U_ACTION'				=> "{$this->u_action}&amp;action=add",
			'PICKER_DATE_FORMAT'	=> input::DATE_FORMAT,
			'U_FIND_USERNAME'		=> $this->helper->get_find_username_link(),
		));
	}

	/**
	 * Edit an advertisement
	 *
	 * @return	void
	 */
	protected function action_edit()
	{
		$ad_id = $this->request->variable('id', 0);
		$action = $this->get_submitted_action();
		if ($action !== false)
		{
			$this->data = $this->input->get_form_data();
			$this->{$action}();
		}
		else
		{
			$this->data = $this->manager->get_ad($ad_id);
			if ($this->data === false)
			{
				$this->error('ACP_AD_DOES_NOT_EXIST');
			}
			// Load ad template locations
			$this->data['ad_locations'] = $this->manager->get_ad_locations($ad_id);
		}

		// Set output vars for display in the template
		$this->template->assign_vars(array(
			'S_EDIT_AD'				=> true,
			'EDIT_ID'				=> $ad_id,
			'U_BACK'				=> $this->u_action,
			'U_ACTION'				=> "{$this->u_action}&amp;action=edit&amp;id=$ad_id",
			'PICKER_DATE_FORMAT'	=> input::DATE_FORMAT,
			'U_FIND_USERNAME'		=> $this->helper->get_find_username_link(),
		));
		$this->helper->assign_data($this->data, $this->input->get_errors());
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
	}

	/**
	 * Enable an advertisement
	 *
	 * @return	void
	 */
	protected function action_enable()
	{
		$this->ad_enable(true);
	}

	/**
	 * Disable an advertisement
	 *
	 * @return	void
	 */
	protected function action_disable()
	{
		$this->ad_enable(false);
	}

	/**
	 * Delete an advertisement
	 *
	 * @return	void
	 */
	protected function action_delete()
	{
		$ad_id = $this->request->variable('id', 0);
		if ($ad_id)
		{
			if (confirm_box(true))
			{
				// Get ad data so that we can log ad name
				$ad_data = $this->manager->get_ad($ad_id);

				// Delete ad and it's template locations
				$this->manager->delete_ad_locations($ad_id);
				$success = $this->manager->delete_ad($ad_id);

				// Only notify user on error or if not ajax
				if (!$success)
				{
					$this->error('ACP_AD_DELETE_ERRORED');
				}
				else
				{
					$this->helper->log('DELETE', $ad_data['ad_name']);

					if (!$this->request->is_ajax())
					{
						$this->success('ACP_AD_DELETE_SUCCESS');
					}
				}
			}
			else
			{
				confirm_box(false, $this->language->lang('CONFIRM_OPERATION'), build_hidden_fields(array(
					'id'     => $ad_id,
					'i'      => $this->request->variable('i', ''),
					'mode'   => $this->request->variable('mode', ''),
					'action' => 'delete',
				)));
			}
		}
	}

	/**
	 * Display the list of all ads
	 *
	 * @return	void
	 */
	protected function list_ads()
	{
		foreach ($this->manager->get_all_ads() as $row)
		{
			$ad_enabled = (int) $row['ad_enabled'];
			$ad_expired = $this->helper->is_expired($row);

			if ($ad_expired && $ad_enabled)
			{
				$ad_enabled = 0;
				$this->manager->update_ad($row['ad_id'], array('ad_enabled' => 0));
			}

			$this->template->assign_block_vars($ad_expired ? 'expired' : 'ads', array(
				'NAME'         => $row['ad_name'],
				'PRIORITY'     => $row['ad_priority'],
				'END_DATE'     => $this->helper->prepare_end_date($row['ad_end_date']),
				'VIEWS'        => $row['ad_views'],
				'CLICKS'       => $row['ad_clicks'],
				'VIEWS_LIMIT'  => $row['ad_views_limit'],
				'CLICKS_LIMIT' => $row['ad_clicks_limit'],
				'S_EXPIRED'    => $ad_expired,
				'S_ENABLED'    => $ad_enabled,
				'U_ENABLE'     => $this->u_action . '&amp;action=' . ($ad_enabled ? 'disable' : 'enable') . '&amp;id=' . $row['ad_id'],
				'U_EDIT'       => $this->u_action . '&amp;action=edit&amp;id=' . $row['ad_id'],
				'U_DELETE'     => $this->u_action . '&amp;action=delete&amp;id=' . $row['ad_id'],
			));
		}

		// Set output vars for display in the template
		$this->template->assign_vars(array(
			'U_ACTION_ADD'     => $this->u_action . '&amp;action=add',
			'S_VIEWS_ENABLED'  => $this->config['phpbb_ads_enable_views'],
			'S_CLICKS_ENABLED' => $this->config['phpbb_ads_enable_clicks'],
		));
	}

	/**
	 * Get what action user wants to do with the form.
	 * Possible options are:
	 *  - preview ad code
	 *  - upload banner to display in an ad code
	 *  - analyse ad code
	 *  - submit form (either add or edit an ad)
	 *
	 * @return	mixed	Action name or false when no action was submitted
	 */
	protected function get_submitted_action()
	{
		$actions = array('preview', 'upload_banner', 'analyse_ad_code', 'submit_add', 'submit_edit');
		foreach ($actions as $action)
		{
			if ($this->request->is_set_post($action))
			{
				return $action;
			}
		}

		return false;
	}

	/**
	 * Enable/disable an advertisement
	 *
	 * @param	bool	$enable	Enable or disable the advertisement?
	 * @return	void
	 */
	protected function ad_enable($enable)
	{
		$ad_id = $this->request->variable('id', 0);

		$success = $this->manager->update_ad($ad_id, array(
			'ad_enabled' => (int) $enable,
		));

		// If AJAX was used, show user a result message
		if ($this->request->is_ajax())
		{
			$json_response = new \phpbb\json_response;
			$json_response->send(array(
				'text'  => $this->language->lang($enable ? 'ENABLED' : 'DISABLED'),
				'title' => $this->language->lang('AD_ENABLE_TITLE', (int) $enable),
			));
		}

		// Otherwise, show traditional infobox
		if ($success)
		{
			$this->success($enable ? 'ACP_AD_ENABLE_SUCCESS' : 'ACP_AD_DISABLE_SUCCESS');
		}
		else
		{
			$this->error($enable ? 'ACP_AD_ENABLE_ERRORED' : 'ACP_AD_DISABLE_ERRORED');
		}
	}

	/**
	 * Submit action "preview".
	 * Prepare advertisement preview.
	 *
	 * @return	void
	 */
	protected function preview()
	{
		$this->template->assign_var('PREVIEW', htmlspecialchars_decode($this->data['ad_code']));
	}

	/**
	 * Submit action "upload_banner".
	 * Upload banner and append it to the ad code.
	 *
	 * @return	void
	 */
	protected function upload_banner()
	{
		$this->data['ad_code'] = $this->input->banner_upload($this->data['ad_code']);
	}

	/**
	 * Submit action "analyse_ad_code".
	 * Upload banner and append it to the ad code.
	 *
	 * @return	void
	 */
	protected function analyse_ad_code()
	{
		$this->analyser->run($this->data['ad_code']);
	}

	/**
	 * Submit action "submit_add".
	 * Add new ad.
	 *
	 * @return	void
	 */
	protected function submit_add()
	{
		if (!$this->input->has_errors())
		{
			$ad_id = $this->manager->insert_ad($this->data);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
			$this->manager->insert_ad_locations($ad_id, $this->data['ad_locations']);

			$this->helper->log('ADD', $this->data['ad_name']);

			$this->success('ACP_AD_ADD_SUCCESS');
		}
	}

	/**
	 * Submit action "submit_edit".
	 * Edit ad.
	 *
	 * @return	void
	 */
	protected function submit_edit()
	{
		$ad_id = $this->request->variable('id', 0);
		if ($ad_id && !$this->input->has_errors())
		{
			$success = $this->manager->update_ad($ad_id, $this->data);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
			if ($success)
			{
				// Only insert new ad locations to DB when ad exists
				$this->manager->delete_ad_locations($ad_id);
				$this->manager->insert_ad_locations($ad_id, $this->data['ad_locations']);

				$this->helper->log('EDIT', $this->data['ad_name']);

				$this->success('ACP_AD_EDIT_SUCCESS');
			}

			$this->error('ACP_AD_DOES_NOT_EXIST');
		}
	}

	/**
	 * Print success message.
	 *
	 * @param	string	$msg	Message lang key
	 */
	protected function success($msg)
	{
		trigger_error($this->language->lang($msg) . adm_back_link($this->u_action));
	}

	/**
	 * Print error message.
	 *
	 * @param	string	$msg	Message lang key
	 */
	protected function error($msg)
	{
		trigger_error($this->language->lang($msg) . adm_back_link($this->u_action), E_USER_WARNING);
	}
}


1			<?php
2			/**
3			*
4			* Advertisement management. An extension for the phpBB Forum Software package.
5			*
6			* @copyright (c) 2017 phpBB Limited <https://www.phpbb.com>
7			* @license GNU General Public License, version 2 (GPL-2.0)
8			*
9			*/
10
11			namespace phpbb\ads\controller;
12
13			use phpbb\ads\controller\admin_input as input;
14
15			/**
16			* Admin controller
17			*/
18			class admin_controller
19			{
20			/** @var array\|bool Form data */
21			protected $data = false;
22
23			/** @var \phpbb\template\template */
24			protected $template;
25
26			/** @var \phpbb\language\language */
27			protected $language;
28
29			/** @var \phpbb\request\request */
30			protected $request;
31
32			/** @var \phpbb\ads\ad\manager */
33			protected $manager;
34
35			/** @var \phpbb\config\db_text */
36			protected $config_text;
37
38			/** @var \phpbb\config\config */
39			protected $config;
40
41			/** @var \phpbb\group\helper */
42			protected $group_helper;
43
44			/** @var \phpbb\ads\controller\admin_input */
45			protected $input;
46
47			/** @var \phpbb\ads\controller\admin_helper */
48			protected $helper;
49
50			/** @var \phpbb\ads\analyser\manager */
51			protected $analyser;
52
53			/** @var string Custom form action */
54			protected $u_action;
55
56			/**
57			* Constructor
58			*
59			* @param \phpbb\template\template $template Template object
60			* @param \phpbb\language\language $language Language object
61			* @param \phpbb\request\request $request Request object
62			* @param \phpbb\ads\ad\manager $manager Advertisement manager object
63			* @param \phpbb\config\db_text $config_text Config text object
64			* @param \phpbb\config\config $config Config object
65			* @param \phpbb\group\helper $group_helper Group helper object
66			* @param \phpbb\ads\controller\admin_input $input Admin input object
67			* @param \phpbb\ads\controller\admin_helper $helper Admin helper object
68			* @param \phpbb\ads\analyser\manager $analyser Ad code analyser object
69			* @param string $root_path phpBB root path
70			* @param string $php_ext PHP extension
71			*/
72	33		public function __construct(\phpbb\template\template $template, \phpbb\language\language $language, \phpbb\request\request $request, \phpbb\ads\ad\manager $manager, \phpbb\config\db_text $config_text, \phpbb\config\config $config, \phpbb\group\helper $group_helper, \phpbb\ads\controller\admin_input $input, \phpbb\ads\controller\admin_helper $helper, \phpbb\ads\analyser\manager $analyser, $root_path, $php_ext)
73			{
74	33		$this->template = $template;
75	33		$this->language = $language;
76	33		$this->request = $request;
77	33		$this->manager = $manager;
78	33		$this->config_text = $config_text;
79	33		$this->config = $config;
80	33		$this->group_helper = $group_helper;
81	33		$this->input = $input;
82	33		$this->helper = $helper;
83	33		$this->analyser = $analyser;
84
85	33		if (!function_exists('user_get_id_name'))
86	33		{
87			include $root_path . 'includes/functions_user.' . $php_ext;
88			}
89
90	33		$this->language->add_lang('posting'); // Used by banner_upload() file errors
91	33		$this->language->add_lang('acp', 'phpbb/ads');
92
93	33		$this->template->assign_var('S_PHPBB_ADS', true);
94	33		}
95
96			/**
97			* Set page url
98			*
99			* @param string $u_action Custom form action
100			* @return void
101			*/
102	27		public function set_page_url($u_action)
103			{
104	27		$this->u_action = $u_action;
105	27		}
106
107			/**
108			* Get ACP page title for Ads module
109			*
110			* @return string Language string for Ads ACP module
111			*/
112	1		public function get_page_title()
113			{
114	1		return $this->language->lang('ACP_PHPBB_ADS_TITLE');
115			}
116
117			/**
118			* Process user request for settings mode
119			*
120			* @return void
121			*/
122	3		public function mode_settings()
123			{
124	3		if ($this->request->is_set_post('submit'))
125	3		{
126			// Validate form key
127	2		if (check_form_key('phpbb_ads'))
128	2		{
129	1		$this->config->set('phpbb_ads_adblocker_message', $this->request->variable('adblocker_message', 0));
130	1		$this->config->set('phpbb_ads_enable_views', $this->request->variable('enable_views', 0));
131	1		$this->config->set('phpbb_ads_enable_clicks', $this->request->variable('enable_clicks', 0));
132	1		$this->config_text->set('phpbb_ads_hide_groups', json_encode($this->request->variable('hide_groups', array(0))));
133
134	1		$this->success('ACP_AD_SETTINGS_SAVED');
135			}
136
137	1		$this->error('FORM_INVALID');
138			}
139
140	1		$hide_groups = json_decode($this->config_text->get('phpbb_ads_hide_groups'), true);
141	1		$groups = $this->manager->load_groups();
142	1	View Code Duplication	foreach ($groups as $group)
143			{
144	1		$this->template->assign_block_vars('groups', array(
145	1		'ID' => $group['group_id'],
146	1		'NAME' => $this->group_helper->get_name($group['group_name']),
147	1		'S_SELECTED' => in_array($group['group_id'], $hide_groups),
148	1		));
149	1		}
150
151	1		$this->template->assign_vars(array(
152	1		'U_ACTION' => $this->u_action,
153	1		'ADBLOCKER_MESSAGE' => $this->config['phpbb_ads_adblocker_message'],
154	1		'ENABLE_VIEWS' => $this->config['phpbb_ads_enable_views'],
155	1		'ENABLE_CLICKS' => $this->config['phpbb_ads_enable_clicks'],
156	1		));
157	1		}
158
159			/**
160			* Process user request for manage mode
161			*
162			* @return void
163			*/
164	29		public function mode_manage()
165			{
166			// Trigger specific action
167	29		$action = $this->request->variable('action', '');
168	29		if (in_array($action, array('add', 'edit', 'enable', 'disable', 'delete')))
169	29		{
170	27		$this->{'action_' . $action}();
171	15		}
172			else
173			{
174			// Otherwise default to this
175	2		$this->list_ads();
176			}
177	17		}
178
179			/**
180			* Add an advertisement
181			*
182			* @return void
183			*/
184	12		protected function action_add()
185			{
186	6		$action = $this->get_submitted_action();
187	6		if ($action !== false)
188	6		{
189	5		$this->data = $this->input->get_form_data();
190	5		$this->{$action}();
191	4		$this->helper->assign_data($this->data, $this->input->get_errors());
192	4		}
193			else
194			{
195	1		$this->helper->assign_locations();
196	12		}
197
198			// Set output vars for display in the template
199	5		$this->template->assign_vars(array(
200	5		'S_ADD_AD' => true,
201	5		'U_BACK' => $this->u_action,
202	5		'U_ACTION' => "{$this->u_action}&action=add",
203	5		'PICKER_DATE_FORMAT' => input::DATE_FORMAT,
204	5		'U_FIND_USERNAME' => $this->helper->get_find_username_link(),
205	5		));
206	5		}
207
208			/**
209			* Edit an advertisement
210			*
211			* @return void
212			*/
213	7		protected function action_edit()
214			{
215	7		$ad_id = $this->request->variable('id', 0);
216	7		$action = $this->get_submitted_action();
217	7		if ($action !== false)
218	7		{
219	5		$this->data = $this->input->get_form_data();
220	5		$this->{$action}();
221	3		}
222			else
223			{
224	2		$this->data = $this->manager->get_ad($ad_id);
225	2		if ($this->data === false)
226	2		{
227	1		$this->error('ACP_AD_DOES_NOT_EXIST');
228			}
229			// Load ad template locations
230	1		$this->data['ad_locations'] = $this->manager->get_ad_locations($ad_id);
231			}
232
233			// Set output vars for display in the template
234	4		$this->template->assign_vars(array(
235	4		'S_EDIT_AD' => true,
236	4		'EDIT_ID' => $ad_id,
237	4		'U_BACK' => $this->u_action,
238	4		'U_ACTION' => "{$this->u_action}&action=edit&id=$ad_id",
239	4		'PICKER_DATE_FORMAT' => input::DATE_FORMAT,
240	4		'U_FIND_USERNAME' => $this->helper->get_find_username_link(),
241	4		));
242	4		$this->helper->assign_data($this->data, $this->input->get_errors());
			0 ignored issues – show Bug introduced 2017-08-15 08:51 UTC by Report Bug Copy Issue Report It seems like `$this->data` can also be of type `boolean`; however, `phpbb\ads\controller\admin_helper::assign_data()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
243	4		}
244
245			/**
246			* Enable an advertisement
247			*
248			* @return void
249			*/
250	4		protected function action_enable()
251			{
252	4		$this->ad_enable(true);
253	1		}
254
255			/**
256			* Disable an advertisement
257			*
258			* @return void
259			*/
260	4		protected function action_disable()
261			{
262	4		$this->ad_enable(false);
263	1		}
264
265			/**
266			* Delete an advertisement
267			*
268			* @return void
269			*/
270	3		protected function action_delete()
271			{
272	3		$ad_id = $this->request->variable('id', 0);
273			if ($ad_id)
274	3		{
275	3		if (confirm_box(true))
276	3		{
277			// Get ad data so that we can log ad name
278	2		$ad_data = $this->manager->get_ad($ad_id);
279
280			// Delete ad and it's template locations
281	2		$this->manager->delete_ad_locations($ad_id);
282	2		$success = $this->manager->delete_ad($ad_id);
283
284			// Only notify user on error or if not ajax
285	2		if (!$success)
286	2		{
287	1		$this->error('ACP_AD_DELETE_ERRORED');
288			}
289			else
290			{
291	1		$this->helper->log('DELETE', $ad_data['ad_name']);
292
293	1		if (!$this->request->is_ajax())
294	1		{
295	1		$this->success('ACP_AD_DELETE_SUCCESS');
296			}
297			}
298			}
299			else
300			{
301	1		confirm_box(false, $this->language->lang('CONFIRM_OPERATION'), build_hidden_fields(array(
302	1		'id' => $ad_id,
303	1		'i' => $this->request->variable('i', ''),
304	1		'mode' => $this->request->variable('mode', ''),
305	1		'action' => 'delete',
306	1		)));
307			}
308	1		}
309	1		}
310
311			/**
312			* Display the list of all ads
313			*
314			* @return void
315			*/
316	1		protected function list_ads()
317			{
318	1		foreach ($this->manager->get_all_ads() as $row)
319			{
320	1		$ad_enabled = (int) $row['ad_enabled'];
321	1		$ad_expired = $this->helper->is_expired($row);
322
323	1		if ($ad_expired && $ad_enabled)
324	1		{
325	1		$ad_enabled = 0;
326	1		$this->manager->update_ad($row['ad_id'], array('ad_enabled' => 0));
327	1		}
328
329	1		$this->template->assign_block_vars($ad_expired ? 'expired' : 'ads', array(
330	1		'NAME' => $row['ad_name'],
331	1		'PRIORITY' => $row['ad_priority'],
332	1		'END_DATE' => $this->helper->prepare_end_date($row['ad_end_date']),
333	1		'VIEWS' => $row['ad_views'],
334	1		'CLICKS' => $row['ad_clicks'],
335	1		'VIEWS_LIMIT' => $row['ad_views_limit'],
336	1		'CLICKS_LIMIT' => $row['ad_clicks_limit'],
337	1		'S_EXPIRED' => $ad_expired,
338	1		'S_ENABLED' => $ad_enabled,
339	1		'U_ENABLE' => $this->u_action . '&action=' . ($ad_enabled ? 'disable' : 'enable') . '&id=' . $row['ad_id'],
340	1		'U_EDIT' => $this->u_action . '&action=edit&id=' . $row['ad_id'],
341	1		'U_DELETE' => $this->u_action . '&action=delete&id=' . $row['ad_id'],
342	1		));
343	1		}
344
345			// Set output vars for display in the template
346	1		$this->template->assign_vars(array(
347	1		'U_ACTION_ADD' => $this->u_action . '&action=add',
348	1		'S_VIEWS_ENABLED' => $this->config['phpbb_ads_enable_views'],
349	1		'S_CLICKS_ENABLED' => $this->config['phpbb_ads_enable_clicks'],
350	1		));
351	1		}
352
353			/**
354			* Get what action user wants to do with the form.
355			* Possible options are:
356			* - preview ad code
357			* - upload banner to display in an ad code
358			* - analyse ad code
359			* - submit form (either add or edit an ad)
360			*
361			* @return mixed Action name or false when no action was submitted
362			*/
363	13		protected function get_submitted_action()
364			{
365	13		$actions = array('preview', 'upload_banner', 'analyse_ad_code', 'submit_add', 'submit_edit');
366	13		foreach ($actions as $action)
367			{
368	13		if ($this->request->is_set_post($action))
369	13		{
370	10		return $action;
371			}
372	11		}
373
374	3		return false;
375			}
376
377			/**
378			* Enable/disable an advertisement
379			*
380			* @param bool $enable Enable or disable the advertisement?
381			* @return void
382			*/
383	6		protected function ad_enable($enable)
384			{
385	6		$ad_id = $this->request->variable('id', 0);
386
387	6		$success = $this->manager->update_ad($ad_id, array(
388	6		'ad_enabled' => (int) $enable,
389	6		));
390
391			// If AJAX was used, show user a result message
392	6		if ($this->request->is_ajax())
393	6		{
394	2		$json_response = new \phpbb\json_response;
395	2		$json_response->send(array(
396	2		'text' => $this->language->lang($enable ? 'ENABLED' : 'DISABLED'),
397	2		'title' => $this->language->lang('AD_ENABLE_TITLE', (int) $enable),
398	2		));
399			}
400
401			// Otherwise, show traditional infobox
402			if ($success)
403	4		{
404	2		$this->success($enable ? 'ACP_AD_ENABLE_SUCCESS' : 'ACP_AD_DISABLE_SUCCESS');
405			}
406			else
407			{
408	2		$this->error($enable ? 'ACP_AD_ENABLE_ERRORED' : 'ACP_AD_DISABLE_ERRORED');
409			}
410			}
411
412			/**
413			* Submit action "preview".
414			* Prepare advertisement preview.
415			*
416			* @return void
417			*/
418	2		protected function preview()
419			{
420	2		$this->template->assign_var('PREVIEW', htmlspecialchars_decode($this->data['ad_code']));
421	2		}
422
423			/**
424			* Submit action "upload_banner".
425			* Upload banner and append it to the ad code.
426			*
427			* @return void
428			*/
429	1		protected function upload_banner()
430			{
431	1		$this->data['ad_code'] = $this->input->banner_upload($this->data['ad_code']);
432	1		}
433
434			/**
435			* Submit action "analyse_ad_code".
436			* Upload banner and append it to the ad code.
437			*
438			* @return void
439			*/
440	1		protected function analyse_ad_code()
441			{
442	1		$this->analyser->run($this->data['ad_code']);
443	1		}
444
445			/**
446			* Submit action "submit_add".
447			* Add new ad.
448			*
449			* @return void
450			*/
451	2		protected function submit_add()
452			{
453	2		if (!$this->input->has_errors())
454	2		{
455	1		$ad_id = $this->manager->insert_ad($this->data);
			0 ignored issues – show Bug introduced 2017-08-15 08:51 UTC by Report Bug Copy Issue Report It seems like `$this->data` can also be of type `boolean`; however, `phpbb\ads\ad\manager::insert_ad()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
456	1		$this->manager->insert_ad_locations($ad_id, $this->data['ad_locations']);
457
458	1		$this->helper->log('ADD', $this->data['ad_name']);
459
460	1		$this->success('ACP_AD_ADD_SUCCESS');
461			}
462	1		}
463
464			/**
465			* Submit action "submit_edit".
466			* Edit ad.
467			*
468			* @return void
469			*/
470	4		protected function submit_edit()
471			{
472	4		$ad_id = $this->request->variable('id', 0);
473	4		if ($ad_id && !$this->input->has_errors())
474	4		{
475	2		$success = $this->manager->update_ad($ad_id, $this->data);
			0 ignored issues – show Bug introduced 2017-08-15 08:51 UTC by Report Bug Copy Issue Report It seems like `$this->data` can also be of type `boolean`; however, `phpbb\ads\ad\manager::update_ad()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
476			if ($success)
477	2		{
478			// Only insert new ad locations to DB when ad exists
479	1		$this->manager->delete_ad_locations($ad_id);
480	1		$this->manager->insert_ad_locations($ad_id, $this->data['ad_locations']);
481
482	1		$this->helper->log('EDIT', $this->data['ad_name']);
483
484	1		$this->success('ACP_AD_EDIT_SUCCESS');
485			}
486
487	1		$this->error('ACP_AD_DOES_NOT_EXIST');
488			}
489	2		}
490
491			/**
492			* Print success message.
493			*
494			* @param string $msg Message lang key
495			*/
496	6		protected function success($msg)
497			{
498	6		trigger_error($this->language->lang($msg) . adm_back_link($this->u_action));
499			}
500
501			/**
502			* Print error message.
503			*
504			* @param string $msg Message lang key
505			*/
506	6		protected function error($msg)
507			{
508	6		trigger_error($this->language->lang($msg) . adm_back_link($this->u_action), E_USER_WARNING);
509			}
510			}
511

phpbb-extensions / ad-management