admin_helper::is_expired() - 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-14 10:24 UTC

admin_helper::is_expired() B

↳ Parent: admin_helper

Complexity

Conditions	7
Paths	4

Size

Total Lines	19
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	7

Importance

Changes

Metric	Value
dl	0
loc	19
ccs	11
cts	11
cp	1
rs	8.2222
c	0
b	0
f	0
cc	7
eloc	8
nc	4
nop	1
crap	7

<?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 helper
 */
class admin_helper
{
	/** @var \phpbb\user */
	protected $user;

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

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

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

	/** @var \phpbb\ads\location\manager */
	protected $location_manager;

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

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

	/**
	 * Constructor
	 *
	 * @param \phpbb\user						$user				User object
	 * @param \phpbb\language\language          $language           Language object
	 * @param \phpbb\template\template			$template			Template object
	 * @param \phpbb\log\log					$log				The phpBB log system
	 * @param \phpbb\ads\location\manager		$location_manager	Template location manager object
	 * @param string							$root_path			phpBB root path
	 * @param string							$php_ext			PHP extension
	 */
	public function __construct(\phpbb\user $user, \phpbb\language\language $language, \phpbb\template\template $template, \phpbb\log\log $log, \phpbb\ads\location\manager $location_manager, $root_path, $php_ext)
	{
		$this->user = $user;
		$this->language = $language;
		$this->template = $template;
		$this->log = $log;
		$this->location_manager = $location_manager;
		$this->root_path = $root_path;
		$this->php_ext = $php_ext;
	}

	/**
	 * Assign ad data for ACP form template.
	 *
	 * @param	array	$data	Ad data
	 * @param	array	$errors	Validation errors
	 */
	public function assign_data($data, $errors)
	{
		$this->assign_locations($data['ad_locations']);

		$errors = array_map(array($this->language, 'lang'), $errors);
		$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'],
			'AD_END_DATE'     => $this->prepare_end_date($data['ad_end_date']),
			'AD_PRIORITY'     => $data['ad_priority'],
			'AD_VIEWS_LIMIT'  => $data['ad_views_limit'],
			'AD_CLICKS_LIMIT' => $data['ad_clicks_limit'],
			'AD_OWNER'        => $this->prepare_ad_owner($data['ad_owner']),
		));
	}

	/**
	 * Assign template locations data to the template.
	 *
	 * @param	mixed	$ad_locations	The form data or nothing.
	 * @return	void
	 */
	public function assign_locations($ad_locations = false)
	{
		foreach ($this->location_manager->get_all_locations() as $location_id => $location_data)
		{
			$this->template->assign_block_vars('ad_locations', array(
				'LOCATION_ID'   => $location_id,
				'LOCATION_DESC' => $location_data['desc'],
				'LOCATION_NAME' => $location_data['name'],
				'S_SELECTED'    => $ad_locations ? in_array($location_id, $ad_locations) : false,
			));
		}
	}

	/**
	 * Log action
	 *
	 * @param	string	$action		Performed action in uppercase
	 * @param	string	$ad_name	Advertisement name
	 * @return	void
	 */
	public function log($action, $ad_name)
	{
		$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'ACP_PHPBB_ADS_' . $action . '_LOG', time(), array($ad_name));
	}

	/**
	 * Get "Find username" URL to easily look for ad owner.
	 *
	 * @return	string	Find username URL
	 */
	public function get_find_username_link()
	{
		return append_sid("{$this->root_path}memberlist.{$this->php_ext}", 'mode=searchuser&amp;form=acp_admanagement_add&amp;field=ad_owner&amp;select_single=true');
	}

	/**
	 * Prepare end date for display
	 *
	 * @param	mixed	$end_date	End date.
	 * @return	string	End date prepared for display.
	 */
	public function prepare_end_date($end_date)
	{
		if (empty($end_date))
		{
			return '';
		}

		if (is_numeric($end_date))
		{
			return $this->user->format_date($end_date, input::DATE_FORMAT);
		}

		return (string) $end_date;
	}

	/**
	 * Is an ad expired?
	 *
	 * @param	array	$row	Advertisement data
	 * @return	bool	True if expired, false otherwise
	 */
	public function is_expired($row)
	{
		if ((int) $row['ad_end_date'] > 0 && (int) $row['ad_end_date'] < time())
		{
			return true;
		}

		if ($row['ad_views_limit'] && $row['ad_views'] >= $row['ad_views_limit'])
		{
			return true;
		}

		if ($row['ad_clicks_limit'] && $row['ad_clicks'] >= $row['ad_clicks_limit'])

		{
			return true;
		}

		return false;
	}

	/**
	 * Prepare ad owner for display. Method takes user_id
	 * of the ad owner and returns his/her username.
	 *
	 * @param	int		$ad_owner	User ID
	 * @return	string	Username belonging to $ad_owner.
	 */
	protected function prepare_ad_owner($ad_owner)
	{
		$user_id = array($ad_owner);
		$user_name = array();

		// Returns false when no errors occur trying to find the user
		if (false === user_get_id_name($user_id, $user_name))
		{
			if (empty($user_name))
			{
				return $user_id[0];
			}
			return $user_name[(int) $user_id[0]];
		}
		return '';
	}
}


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 helper
17			*/
18			class admin_helper
19			{
20			/** @var \phpbb\user */
21			protected $user;
22
23			/** @var \phpbb\language\language */
24			protected $language;
25
26			/** @var \phpbb\template\template */
27			protected $template;
28
29			/** @var \phpbb\log\log */
30			protected $log;
31
32			/** @var \phpbb\ads\location\manager */
33			protected $location_manager;
34
35			/** @var string root_path */
36			protected $root_path;
37
38			/** @var string php_ext */
39			protected $php_ext;
40
41			/**
42			* Constructor
43			*
44			* @param \phpbb\user $user User object
45			* @param \phpbb\language\language $language Language object
46			* @param \phpbb\template\template $template Template object
47			* @param \phpbb\log\log $log The phpBB log system
48			* @param \phpbb\ads\location\manager $location_manager Template location manager object
49			* @param string $root_path phpBB root path
50			* @param string $php_ext PHP extension
51			*/
52	20	View Code Duplication	public function __construct(\phpbb\user $user, \phpbb\language\language $language, \phpbb\template\template $template, \phpbb\log\log $log, \phpbb\ads\location\manager $location_manager, $root_path, $php_ext)
53			{
54	20		$this->user = $user;
55	20		$this->language = $language;
56	20		$this->template = $template;
57	20		$this->log = $log;
58	20		$this->location_manager = $location_manager;
59	20		$this->root_path = $root_path;
60	20		$this->php_ext = $php_ext;
61	20		}
62
63			/**
64			* Assign ad data for ACP form template.
65			*
66			* @param array $data Ad data
67			* @param array $errors Validation errors
68			*/
69	5		public function assign_data($data, $errors)
70			{
71	5		$this->assign_locations($data['ad_locations']);
72
73	5		$errors = array_map(array($this->language, 'lang'), $errors);
74	5		$this->template->assign_vars(array(
75	5		'S_ERROR' => (bool) count($errors),
76	5		'ERROR_MSG' => count($errors) ? implode('<br />', $errors) : '',
77
78	5		'AD_NAME' => $data['ad_name'],
79	5		'AD_NOTE' => $data['ad_note'],
80	5		'AD_CODE' => $data['ad_code'],
81	5		'AD_ENABLED' => $data['ad_enabled'],
82	5		'AD_END_DATE' => $this->prepare_end_date($data['ad_end_date']),
83	5		'AD_PRIORITY' => $data['ad_priority'],
84	5		'AD_VIEWS_LIMIT' => $data['ad_views_limit'],
85	5		'AD_CLICKS_LIMIT' => $data['ad_clicks_limit'],
86	5		'AD_OWNER' => $this->prepare_ad_owner($data['ad_owner']),
87	5		));
88	5		}
89
90			/**
91			* Assign template locations data to the template.
92			*
93			* @param mixed $ad_locations The form data or nothing.
94			* @return void
95			*/
96	7		public function assign_locations($ad_locations = false)
97			{
98	7	View Code Duplication	foreach ($this->location_manager->get_all_locations() as $location_id => $location_data)
99			{
100	2		$this->template->assign_block_vars('ad_locations', array(
101	2		'LOCATION_ID' => $location_id,
102	2		'LOCATION_DESC' => $location_data['desc'],
103	2		'LOCATION_NAME' => $location_data['name'],
104	2		'S_SELECTED' => $ad_locations ? in_array($location_id, $ad_locations) : false,
105	2		));
106	7		}
107	7		}
108
109			/**
110			* Log action
111			*
112			* @param string $action Performed action in uppercase
113			* @param string $ad_name Advertisement name
114			* @return void
115			*/
116	1		public function log($action, $ad_name)
117			{
118	1		$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'ACP_PHPBB_ADS_' . $action . '_LOG', time(), array($ad_name));
119	1		}
120
121			/**
122			* Get "Find username" URL to easily look for ad owner.
123			*
124			* @return string Find username URL
125			*/
126	1		public function get_find_username_link()
127			{
128	1		return append_sid("{$this->root_path}memberlist.{$this->php_ext}", 'mode=searchuser&form=acp_admanagement_add&field=ad_owner&select_single=true');
129			}
130
131			/**
132			* Prepare end date for display
133			*
134			* @param mixed $end_date End date.
135			* @return string End date prepared for display.
136			*/
137	9		public function prepare_end_date($end_date)
138			{
139	9		if (empty($end_date))
140	9		{
141	3		return '';
142			}
143
144	6		if (is_numeric($end_date))
145	6		{
146	4		return $this->user->format_date($end_date, input::DATE_FORMAT);
147			}
148
149	2		return (string) $end_date;
150			}
151
152			/**
153			* Is an ad expired?
154			*
155			* @param array $row Advertisement data
156			* @return bool True if expired, false otherwise
157			*/
158	7		public function is_expired($row)
159			{
160	7		if ((int) $row['ad_end_date'] > 0 && (int) $row['ad_end_date'] < time())
161	7		{
162	1		return true;
163			}
164
165	6		if ($row['ad_views_limit'] && $row['ad_views'] >= $row['ad_views_limit'])
166	6		{
167	1		return true;
168			}
169
170	5		if ($row['ad_clicks_limit'] && $row['ad_clicks'] >= $row['ad_clicks_limit'])
			1 ignored issue – show Unused Code introduced 2017-08-12 20:04 UTC by Report Bug Copy Issue Report This `if` statement, and the following `return` statement can be replaced with `return $row['ad_clicks_l...row['ad_clicks_limit'];`. Loading history...
171	5		{
172	1		return true;
173			}
174
175	4		return false;
176			}
177
178			/**
179			* Prepare ad owner for display. Method takes user_id
180			* of the ad owner and returns his/her username.
181			*
182			* @param int $ad_owner User ID
183			* @return string Username belonging to $ad_owner.
184			*/
185	5		protected function prepare_ad_owner($ad_owner)
186			{
187	5		$user_id = array($ad_owner);
188	5		$user_name = array();
189
190			// Returns false when no errors occur trying to find the user
191	5		if (false === user_get_id_name($user_id, $user_name))
192	5		{
193	1		if (empty($user_name))
194	1		{
195			return $user_id[0];
196			}
197	1		return $user_name[(int) $user_id[0]];
198			}
199	4		return '';
200			}
201			}
202

phpbb-extensions / ad-management

Pull Request — master (#75)

admin_helper::is_expired() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like