admin_controller::__construct() - Code Metrics - Inspection of "Ad CRUD in ACP" - phpbb-extensions/ad-management - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by Jakub

created 2017-05-24 20:24 UTC

admin_controller::__construct() A

↳ Parent: admin_controller

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?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\admanagement\controller;

/**
* Admin controller
*/
class admin_controller
{
	/** @var \phpbb\db\driver\driver_interface */
	protected $db;

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

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

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

	/** @var string ads_table */
	protected $ads_table;

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

	/**
	* Constructor
	*
	* @param \phpbb\db\driver\driver_interface	$db			DB driver interface
	* @param \phpbb\template\template			$template	Template object
	* @param \phpbb\user						$user		User object
	* @param \phpbb\request\request				$request	Request object
	* @param string								$ads_table	Ads table
	*/
	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\template\template $template, \phpbb\user $user, \phpbb\request\request $request, $ads_table)
	{
		$this->db = $db;
		$this->template = $template;
		$this->user = $user;
		$this->request = $request;
		$this->ads_table = $ads_table;
	}

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

	/**
	* Load module-specific language
	*
	* @return void
	*/
	public function load_lang()
	{
		$this->user->add_lang_ext('phpbb/admanagement', 'acp');
	}

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

	/**
	* Get action
	*
	* @return string	Ads module action
	*/
	public function get_action()
	{
		return $this->request->variable('action', '');
	}

	/**
	* Add an advertisement
	*
	* @return void
	*/
	public function action_add()
	{
		$errors = array();

		add_form_key('phpbb/admanagement/add');
		if ($this->request->is_set_post('submit'))
		{
			if (!check_form_key('phpbb/admanagement/add'))
			{
				$errors[] = $this->user->lang('FORM_INVALID');
			}

			$data = array(
				'ad_name'		=> $this->request->variable('ad_name', '', true),
				'ad_note'		=> $this->request->variable('ad_note', '', true),
				'ad_code'		=> $this->request->variable('ad_code', '', true),
				'ad_enabled'	=> $this->request->variable('ad_enabled', false),
			);

			// Validate data
			if ($data['ad_name'] === '')
			{
				$errors[] = $this->user->lang('AD_NAME_REQUIRED');
			}
			if (truncate_string($data['ad_name'], 255) !== $data['ad_name'])

			{
				$errors[] = $this->user->lang('AD_NAME_TOO_LONG');
			}

			if (empty($errors))
			{
				// Insert the ad data to the database
				$sql = 'INSERT INTO ' . $this->ads_table . ' ' . $this->db->sql_build_array('INSERT', $data);
				$this->db->sql_query($sql);

				trigger_error($this->user->lang('ACP_AD_ADD_SUCCESS') . adm_back_link($this->u_action));
			}
			else
			{
				$this->template->assign_vars(array(
					'S_ERROR'			=> (bool) count($errors),
					'ERROR_MSG'			=> count($errors) ? implode('<br />', $errors) : '',

					'AD_NAME'		=> $data['ad_name'],
					'AD_NOTE'		=> $data['ad_note'],
					'AD_CODE'		=> $data['ad_code'],
					'AD_ENABLED'	=> $data['ad_enabled'],
				));
			}
		}

		// Set output vars for display in the template
		$this->template->assign_vars(array(
			'S_ADD_AD'	=> true,
			'U_BACK'	=> $this->u_action,
		));
	}

	/**
	* Edit an advertisement
	*
	* @return void
	*/
	public function action_edit()
	{
		$ad_id = $this->request->variable('id', 0);
		$errors = array();

		add_form_key('phpbb/admanagement/edit');
		if ($this->request->is_set_post('submit'))
		{
			if (!check_form_key('phpbb/admanagement/edit'))
			{
				$errors[] = $this->user->lang('FORM_INVALID');
			}

			$data = array(
				'ad_name'		=> $this->request->variable('ad_name', '', true),
				'ad_note'		=> $this->request->variable('ad_note', '', true),
				'ad_code'		=> $this->request->variable('ad_code', '', true),
				'ad_enabled'	=> $this->request->variable('ad_enabled', false),
			);

			// Validate data
			if ($data['ad_name'] === '')
			{
				$errors[] = $this->user->lang('AD_NAME_REQUIRED');
			}
			if (truncate_string($data['ad_name'], 255) !== $data['ad_name'])

			{
				$errors[] = $this->user->lang('AD_NAME_TOO_LONG');
			}

			if (empty($errors))
			{
				// Insert the ad data to the database
				$sql = 'UPDATE ' . $this->ads_table . '
					SET ' . $this->db->sql_build_array('UPDATE', $data) . '
					WHERE ad_id = ' . (int) $ad_id;
				$this->db->sql_query($sql);

				trigger_error($this->user->lang('ACP_AD_EDIT_SUCCESS') . adm_back_link($this->u_action));
			}
			else
			{
				$this->template->assign_vars(array(
					'S_ERROR'			=> (bool) count($errors),
					'ERROR_MSG'			=> count($errors) ? implode('<br />', $errors) : '',
				));
			}
		}
		else
		{
			$sql = 'SELECT *
				FROM ' . $this->ads_table . '
				WHERE ad_id = ' . (int) $ad_id;
			$result = $this->db->sql_query($sql);
			$rowset = $this->db->sql_fetchrowset($result);
			$this->db->sql_freeresult($result);

			if (!sizeof($rowset))
			{
				trigger_error($this->user->lang('ACP_AD_DOES_NOT_EXIST') . adm_back_link($this->u_action), E_USER_WARNING);
			}

			$data = $rowset[0];
		}

		// 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,

			'AD_NAME'		=> $data['ad_name'],
			'AD_NOTE'		=> $data['ad_note'],
			'AD_CODE'		=> $data['ad_code'],
			'AD_ENABLED'	=> $data['ad_enabled'],
		));
	}

    /**
     * Enable/disable an advertisement
     *
     * @param	bool	$enable	Enable or disable the advertisement?
     * @return void
     */
	public function ad_enable($enable)
	{
		$sql = 'UPDATE ' . $this->ads_table . '
			SET ad_enabled = ' . (int) $enable . '
			WHERE ad_id = ' . (int) $this->request->variable('id', 0);
		$this->db->sql_query($sql);
		$success = (bool) $this->db->sql_affectedrows();

		// 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->user->lang($enable ? 'ENABLED' : 'DISABLED'),
				'title'	=> $this->user->lang('AD_ENABLE_TITLE', (int) $enable),
			));
		}

		// Otherwise, show traditional infobox
		if ($success)
		{
			trigger_error($this->user->lang($enable ? 'ACP_AD_ENABLE_SUCCESS' : 'ACP_AD_DISABLE_SUCCESS') . adm_back_link($this->u_action));
		}
		else
		{
			trigger_error($this->user->lang($enable ? 'ACP_AD_ENABLE_ERRORED' : 'ACP_AD_DISABLE_ERRORED') . adm_back_link($this->u_action), E_USER_WARNING);
		}
	}

	/**
	* Delete an advertisement
	*
	* @return void
	*/
	public function action_delete()
	{
		$sql = 'DELETE FROM ' . $this->ads_table . '
			WHERE ad_id = ' . (int) $this->request->variable('id', 0);
		$this->db->sql_query($sql);

		if ($this->db->sql_affectedrows())
		{
			trigger_error($this->user->lang('ACP_AD_DELETE_SUCCESS') . adm_back_link($this->u_action));
		}
		else
		{
			trigger_error($this->user->lang('ACP_AD_DELETE_ERRORED') . adm_back_link($this->u_action), E_USER_WARNING);
		}
	}


	/**
	* Display the ads
	*
	* @return void
	*/
	public function list_ads()
	{
		$sql = 'SELECT ad_id, ad_name, ad_enabled
			FROM ' . $this->ads_table;
		$result = $this->db->sql_query($sql);
		while ($row = $this->db->sql_fetchrow($result))
		{
			$ad_enabled = (bool) $row['ad_enabled'];

			$this->template->assign_block_vars('ads', array( // TODO: convert back to original notation (3.1 does not support this)
				'NAME'		=> $row['ad_name'],
				'S_ENABLED'	=> (int) $ad_enabled,
				'U_ENABLE'	=> $this->u_action . '&amp;action=' . ($ad_enabled ? 'disable' : 'enable') . '&amp;id=' . $row['ad_id'], // TODO: ACP method
				'U_PREVIEW'	=> '', // TODO: frontend logic
				'U_EDIT'	=> $this->u_action . '&amp;action=edit&amp;id=' . $row['ad_id'], // TODO: ACP method
				'U_DELETE'	=> $this->u_action . '&amp;action=delete&amp;id=' . $row['ad_id'], // TODO: ACP method
			));
		}
		$this->db->sql_freeresult($result);

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


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\admanagement\controller;
12
13		/**
14		* Admin controller
15		*/
16		class admin_controller
17		{
18		/** @var \phpbb\db\driver\driver_interface */
19		protected $db;
20
21		/** @var \phpbb\template\template */
22		protected $template;
23
24		/** @var \phpbb\user */
25		protected $user;
26
27		/** @var \phpbb\request\request */
28		protected $request;
29
30		/** @var string ads_table */
31		protected $ads_table;
32
33		/** @var string Custom form action */
34		protected $u_action;
35
36		/**
37		* Constructor
38		*
39		* @param \phpbb\db\driver\driver_interface $db DB driver interface
40		* @param \phpbb\template\template $template Template object
41		* @param \phpbb\user $user User object
42		* @param \phpbb\request\request $request Request object
43		* @param string $ads_table Ads table
44		*/
45		public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\template\template $template, \phpbb\user $user, \phpbb\request\request $request, $ads_table)
46		{
47		$this->db = $db;
48		$this->template = $template;
49		$this->user = $user;
50		$this->request = $request;
51		$this->ads_table = $ads_table;
52		}
53
54		/**
55		* Set page url
56		*
57		* @param string $u_action Custom form action
58		* @return void
59		*/
60		public function set_page_url($u_action)
61		{
62		$this->u_action = $u_action;
63		}
64
65		/**
66		* Load module-specific language
67		*
68		* @return void
69		*/
70		public function load_lang()
71		{
72		$this->user->add_lang_ext('phpbb/admanagement', 'acp');
73		}
74
75		/**
76		* Get ACP page title for Ads module
77		*
78		* @return string Language string for Ads ACP module
79		*/
80		public function get_page_title()
81		{
82		return $this->user->lang('ACP_ADMANAGEMENT_TITLE');
83		}
84
85		/**
86		* Get action
87		*
88		* @return string Ads module action
89		*/
90		public function get_action()
91		{
92		return $this->request->variable('action', '');
93		}
94
95		/**
96		* Add an advertisement
97		*
98		* @return void
99		*/
100		public function action_add()
101		{
102		$errors = array();
103
104		add_form_key('phpbb/admanagement/add');
105		if ($this->request->is_set_post('submit'))
106		{
107		if (!check_form_key('phpbb/admanagement/add'))
108		{
109		$errors[] = $this->user->lang('FORM_INVALID');
110		}
111
112		$data = array(
113		'ad_name' => $this->request->variable('ad_name', '', true),
114		'ad_note' => $this->request->variable('ad_note', '', true),
115		'ad_code' => $this->request->variable('ad_code', '', true),
116		'ad_enabled' => $this->request->variable('ad_enabled', false),
117		);
118
119		// Validate data
120		if ($data['ad_name'] === '')
121		{
122		$errors[] = $this->user->lang('AD_NAME_REQUIRED');
123		}
124	View Code Duplication	if (truncate_string($data['ad_name'], 255) !== $data['ad_name'])
		0 ignored issues – show Duplication introduced 2017-05-24 13:00 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
125		{
126		$errors[] = $this->user->lang('AD_NAME_TOO_LONG');
127		}
128
129		if (empty($errors))
130		{
131		// Insert the ad data to the database
132		$sql = 'INSERT INTO ' . $this->ads_table . ' ' . $this->db->sql_build_array('INSERT', $data);
133		$this->db->sql_query($sql);
134
135		trigger_error($this->user->lang('ACP_AD_ADD_SUCCESS') . adm_back_link($this->u_action));
136		}
137		else
138		{
139		$this->template->assign_vars(array(
140		'S_ERROR' => (bool) count($errors),
141		'ERROR_MSG' => count($errors) ? implode('<br />', $errors) : '',
142
143		'AD_NAME' => $data['ad_name'],
144		'AD_NOTE' => $data['ad_note'],
145		'AD_CODE' => $data['ad_code'],
146		'AD_ENABLED' => $data['ad_enabled'],
147		));
148		}
149		}
150
151		// Set output vars for display in the template
152		$this->template->assign_vars(array(
153		'S_ADD_AD' => true,
154		'U_BACK' => $this->u_action,
155		));
156		}
157
158		/**
159		* Edit an advertisement
160		*
161		* @return void
162		*/
163		public function action_edit()
164		{
165		$ad_id = $this->request->variable('id', 0);
166		$errors = array();
167
168		add_form_key('phpbb/admanagement/edit');
169		if ($this->request->is_set_post('submit'))
170		{
171		if (!check_form_key('phpbb/admanagement/edit'))
172		{
173		$errors[] = $this->user->lang('FORM_INVALID');
174		}
175
176		$data = array(
177		'ad_name' => $this->request->variable('ad_name', '', true),
178		'ad_note' => $this->request->variable('ad_note', '', true),
179		'ad_code' => $this->request->variable('ad_code', '', true),
180		'ad_enabled' => $this->request->variable('ad_enabled', false),
181		);
182
183		// Validate data
184		if ($data['ad_name'] === '')
185		{
186		$errors[] = $this->user->lang('AD_NAME_REQUIRED');
187		}
188	View Code Duplication	if (truncate_string($data['ad_name'], 255) !== $data['ad_name'])
		0 ignored issues – show Duplication introduced 2017-05-24 13:00 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
189		{
190		$errors[] = $this->user->lang('AD_NAME_TOO_LONG');
191		}
192
193		if (empty($errors))
194		{
195		// Insert the ad data to the database
196		$sql = 'UPDATE ' . $this->ads_table . '
197		SET ' . $this->db->sql_build_array('UPDATE', $data) . '
198		WHERE ad_id = ' . (int) $ad_id;
199		$this->db->sql_query($sql);
200
201		trigger_error($this->user->lang('ACP_AD_EDIT_SUCCESS') . adm_back_link($this->u_action));
202		}
203		else
204		{
205		$this->template->assign_vars(array(
206		'S_ERROR' => (bool) count($errors),
207		'ERROR_MSG' => count($errors) ? implode('<br />', $errors) : '',
208		));
209		}
210		}
211		else
212		{
213		$sql = 'SELECT *
214		FROM ' . $this->ads_table . '
215		WHERE ad_id = ' . (int) $ad_id;
216		$result = $this->db->sql_query($sql);
217		$rowset = $this->db->sql_fetchrowset($result);
218		$this->db->sql_freeresult($result);
219
220		if (!sizeof($rowset))
221		{
222		trigger_error($this->user->lang('ACP_AD_DOES_NOT_EXIST') . adm_back_link($this->u_action), E_USER_WARNING);
223		}
224
225		$data = $rowset[0];
226		}
227
228		// Set output vars for display in the template
229		$this->template->assign_vars(array(
230		'S_EDIT_AD' => true,
231		'EDIT_ID' => $ad_id,
232		'U_BACK' => $this->u_action,
233
234		'AD_NAME' => $data['ad_name'],
235		'AD_NOTE' => $data['ad_note'],
236		'AD_CODE' => $data['ad_code'],
237		'AD_ENABLED' => $data['ad_enabled'],
238		));
239		}
240
241		/**
242		* Enable/disable an advertisement
243		*
244		* @param bool $enable Enable or disable the advertisement?
245		* @return void
246		*/
247		public function ad_enable($enable)
248		{
249		$sql = 'UPDATE ' . $this->ads_table . '
250		SET ad_enabled = ' . (int) $enable . '
251		WHERE ad_id = ' . (int) $this->request->variable('id', 0);
252		$this->db->sql_query($sql);
253		$success = (bool) $this->db->sql_affectedrows();
254
255		// If AJAX was used, show user a result message
256		if ($this->request->is_ajax())
257		{
258		$json_response = new \phpbb\json_response;
259		$json_response->send(array(
260		'text' => $this->user->lang($enable ? 'ENABLED' : 'DISABLED'),
261		'title' => $this->user->lang('AD_ENABLE_TITLE', (int) $enable),
262		));
263		}
264
265		// Otherwise, show traditional infobox
266		if ($success)
267		{
268		trigger_error($this->user->lang($enable ? 'ACP_AD_ENABLE_SUCCESS' : 'ACP_AD_DISABLE_SUCCESS') . adm_back_link($this->u_action));
269		}
270		else
271		{
272		trigger_error($this->user->lang($enable ? 'ACP_AD_ENABLE_ERRORED' : 'ACP_AD_DISABLE_ERRORED') . adm_back_link($this->u_action), E_USER_WARNING);
273		}
274		}
275
276		/**
277		* Delete an advertisement
278		*
279		* @return void
280		*/
281		public function action_delete()
282		{
283		$sql = 'DELETE FROM ' . $this->ads_table . '
284		WHERE ad_id = ' . (int) $this->request->variable('id', 0);
285		$this->db->sql_query($sql);
286
287		if ($this->db->sql_affectedrows())
288		{
289		trigger_error($this->user->lang('ACP_AD_DELETE_SUCCESS') . adm_back_link($this->u_action));
290		}
291		else
292		{
293		trigger_error($this->user->lang('ACP_AD_DELETE_ERRORED') . adm_back_link($this->u_action), E_USER_WARNING);
294		}
295		}
296
297
298		/**
299		* Display the ads
300		*
301		* @return void
302		*/
303		public function list_ads()
304		{
305		$sql = 'SELECT ad_id, ad_name, ad_enabled
306		FROM ' . $this->ads_table;
307		$result = $this->db->sql_query($sql);
308		while ($row = $this->db->sql_fetchrow($result))
309		{
310		$ad_enabled = (bool) $row['ad_enabled'];
311
312		$this->template->assign_block_vars('ads', array( // TODO: convert back to original notation (3.1 does not support this)
313		'NAME' => $row['ad_name'],
314		'S_ENABLED' => (int) $ad_enabled,
315		'U_ENABLE' => $this->u_action . '&action=' . ($ad_enabled ? 'disable' : 'enable') . '&id=' . $row['ad_id'], // TODO: ACP method
316		'U_PREVIEW' => '', // TODO: frontend logic
317		'U_EDIT' => $this->u_action . '&action=edit&id=' . $row['ad_id'], // TODO: ACP method
318		'U_DELETE' => $this->u_action . '&action=delete&id=' . $row['ad_id'], // TODO: ACP method
319		));
320		}
321		$this->db->sql_freeresult($result);
322
323		// Set output vars for display in the template
324		$this->template->assign_vars(array(
325		'U_ACTION_ADD' => $this->u_action . '&action=add',
326		));
327		}
328		}
329

phpbb-extensions / ad-management

Pull Request — master (#2)

admin_controller::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like