manager::delete_ad() - Code Metrics - Inspection of "Views & Clicks" - phpbb-extensions/ad-management - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#43)

by Jakub

created 2017-07-15 20:49 UTC

manager::delete_ad() A

↳ Parent: manager

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

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

<?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\ad;

class manager
{
	/** @var \phpbb\db\driver\driver_interface */
	protected $db;

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

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

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

	/**
	 * Constructor
	 *
	 * @param    \phpbb\db\driver\driver_interface $db                 DB driver interface
	 * @param    \phpbb\config\config              $config             Config object
	 * @param    string                            $ads_table          Ads table
	 * @param    string                            $ad_locations_table Ad locations table
	 */
	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, $ads_table, $ad_locations_table)
	{
		$this->db = $db;
		$this->config = $config;
		$this->ads_table = $ads_table;
		$this->ad_locations_table = $ad_locations_table;
	}

	/**
	* Get specific ad
	*
	* @param	int		$ad_id	Advertisement ID
	* @return	mixed	Array with advertisement data, false if ad doesn't exist
	*/
	public function get_ad($ad_id)

	{
		$sql = 'SELECT *
			FROM ' . $this->ads_table . '
			WHERE ad_id = ' . (int) $ad_id;
		$result = $this->db->sql_query($sql);
		$data = $this->db->sql_fetchrow($result);
		$this->db->sql_freeresult($result);

		return $data;
	}

	/**
	* Get one ad per every location
	*
	* @param	array	$ad_locations	List of ad locations to fetch ads for
	* @return	array	List of ad codes for each location
	*/
	public function get_ads($ad_locations)
	{
		$sql_where_views = $this->config['phpbb_ads_enable_views'] ? 'AND (a.ad_views_limit = 0 OR a.ad_views_limit > a.ad_views)' : '';
		$sql_where_clicks = $this->config['phpbb_ads_enable_clicks'] ? 'AND (a.ad_clicks_limit = 0 OR a.ad_clicks_limit > a.ad_clicks)' : '';

		$sql = 'SELECT location_id, ad_id, ad_code
			FROM (
				SELECT al.location_id, a.ad_id, a.ad_code
				FROM ' . $this->ad_locations_table . ' al
				LEFT JOIN ' . $this->ads_table . " a
					ON (al.ad_id = a.ad_id)
				WHERE a.ad_enabled = 1
					AND (a.ad_end_date = 0
						OR a.ad_end_date > " . time() . ")
					$sql_where_views
					$sql_where_clicks
					AND " . $this->db->sql_in_set('al.location_id', $ad_locations) . '
				ORDER BY (' . $this->sql_random() . ' * a.ad_priority) DESC
			) z
			ORDER BY z.location_id';
		$result = $this->db->sql_query($sql);
		$data = $this->db->sql_fetchrowset($result);
		$this->db->sql_freeresult($result);

		$current_location_id = '';
		$data = array_filter($data, function($row) use (&$current_location_id) {
			$return = $current_location_id != $row['location_id'];
			$current_location_id = $row['location_id'];
			return $return;
		});

		return $data;
	}

	/**
	* Get all advertisements
	*
	* @return	array	List of all ads
	*/
	public function get_all_ads()

	{
		$sql = 'SELECT ad_id, ad_name, ad_enabled, ad_end_date, ad_views, ad_clicks, ad_views_limit, ad_clicks_limit
			FROM ' . $this->ads_table;
		$result = $this->db->sql_query($sql);
		$data = $this->db->sql_fetchrowset($result);
		$this->db->sql_freeresult($result);

		return $data;
	}

	/**
	* Increment views for specified ads
	*
	* Note, that views are incremented only by one even when
	* an ad is displayed multiple times on the same page.
	*
	* @param	array	$ad_ids	IDs of ads to increment views
	* @return	void
	*/
	public function increment_ads_views($ad_ids)
	{
		if (!empty($ad_ids))
		{
			$sql = 'UPDATE ' . $this->ads_table . '
				SET ad_views = ad_views + 1
				WHERE ' . $this->db->sql_in_set('ad_id', $ad_ids);
			$this->db->sql_query($sql);
		}
	}

	/**
	* Increment clicks for specified ad
	*
	* @param	int	$ad_id	ID of an ad to increment clicks
	* @return	void
	*/
	public function increment_ad_clicks($ad_id)
	{
		$sql = 'UPDATE ' . $this->ads_table . '
			SET ad_clicks = ad_clicks + 1
			WHERE ad_id = ' . (int) $ad_id;
		$this->db->sql_query($sql);
	}

	/**
	* Insert new advertisement to the database
	*
	* @param	array	$data	New ad data
	* @return	int		New advertisement ID
	*/
	public function insert_ad($data)
	{
		$data = $this->intersect_ad_data($data);

		$sql = 'INSERT INTO ' . $this->ads_table . ' ' . $this->db->sql_build_array('INSERT', $data);
		$this->db->sql_query($sql);

		return $this->db->sql_nextid();
	}

	/**
	* Update advertisement
	*
	* @param	int		$ad_id	Advertisement ID
	* @param	array	$data	List of data to update in the database
	* @return	int		Number of affected rows. Can be used to determine if any ad has been updated.
	*/
	public function update_ad($ad_id, $data)
	{
		$data = $this->intersect_ad_data($data);

		$sql = 'UPDATE ' . $this->ads_table . '
			SET ' . $this->db->sql_build_array('UPDATE', $data) . '
			WHERE ad_id = ' . (int) $ad_id;
		$this->db->sql_query($sql);

		return $this->db->sql_affectedrows();
	}

	/**
	* Delete advertisement
	*
	* @param	int		$ad_id	Advertisement ID
	* @return	int		Number of affected rows. Can be used to determine if any ad has been deleted.
	*/
	public function delete_ad($ad_id)
	{
		$sql = 'DELETE FROM ' . $this->ads_table . '
			WHERE ad_id = ' . (int) $ad_id;
		$this->db->sql_query($sql);

		return $this->db->sql_affectedrows();
	}

	/**
	* Get all locations for specified advertisement
	*
	* @param	int		$ad_id	Advertisement ID
	* @return	array	List of template locations for specified ad
	*/
	public function get_ad_locations($ad_id)
	{
		$ad_locations = array();

		$sql = 'SELECT location_id
			FROM ' . $this->ad_locations_table . '
			WHERE ad_id = ' . (int) $ad_id;
		$result = $this->db->sql_query($sql);
		while ($row = $this->db->sql_fetchrow($result))
		{
			$ad_locations[] = $row['location_id'];
		}
		$this->db->sql_freeresult($result);

		return $ad_locations;
	}

	/**
	* Insert advertisement locations
	*
	* @param	int		$ad_id			Advertisement ID
	* @param	array	$ad_locations	List of template locations for this ad
	* @return	void
	*/
	public function insert_ad_locations($ad_id, $ad_locations)
	{
		$sql_ary = array();
		foreach ($ad_locations as $ad_location)
		{
			$sql_ary[] = array(
				'ad_id'			=> $ad_id,
				'location_id'	=> $ad_location,
			);
		}
		$this->db->sql_multi_insert($this->ad_locations_table, $sql_ary);
	}

	/**
	* Delete advertisement locations
	*
	* @param	int		$ad_id	Advertisement ID
	* @return	void
	*/
	public function delete_ad_locations($ad_id)
	{
		$sql = 'DELETE FROM ' . $this->ad_locations_table . '
			WHERE ad_id = ' . (int) $ad_id;
		$this->db->sql_query($sql);
	}

	/**
	* Load memberships of the user
	*
	* @param	int		$user_id	User ID to load memberships
	* @return	array	List of group IDs user is member of
	*/
	public function load_memberships($user_id)
	{
		$memberships = array();
		$sql = 'SELECT group_id
			FROM ' . USER_GROUP_TABLE . '
			WHERE user_id = ' . (int) $user_id . '
			AND user_pending = 0';
		$result = $this->db->sql_query($sql, 3600);
		while ($row = $this->db->sql_fetchrow($result))
		{
			$memberships[] = $row['group_id'];
		}
		$this->db->sql_freeresult($result);
		return $memberships;
	}

	/**
	* Load all board groups
	*
	* @return	array	List of groups
	*/
	public function load_groups()
	{
		$sql = 'SELECT group_id, group_name, group_type
			FROM ' . GROUPS_TABLE . '
			ORDER BY group_name ASC';
		$result = $this->db->sql_query($sql);
		$groups = $this->db->sql_fetchrowset($result);
		$this->db->sql_freeresult($result);

		return $groups;
	}

	/**
	* Make sure only necessary data make their way to SQL query
	*
	* @param	array	$data	List of data to query the database
	* @return	array	Cleaned data that contain only valid keys
	*/
	protected function intersect_ad_data($data)
	{
		return array_intersect_key($data, array(
			'ad_name'			=> '',
			'ad_note'			=> '',
			'ad_code'			=> '',
			'ad_enabled'		=> '',
			'ad_end_date'		=> '',
			'ad_priority'		=> '',
			'ad_views_limit'	=> '',
			'ad_clicks_limit'	=> '',
		));
	}

	/**
	* Get the random statement for this database layer
	* Random function should generate a float value between 0 and 1
	*
	* @return	string	Random statement for current database layer
	*/
	protected function sql_random()
	{
		switch ($this->db->get_sql_layer())
		{
			case 'oracle':
				return 'VALUE()';

			case 'postgres':
				return 'RANDOM()';

			// https://stackoverflow.com/a/35369410/2908600
			case 'sqlite':
			case 'sqlite3':
				return '(0.5 - RANDOM() / CAST(-9223372036854775808 AS REAL) / 2)';

			/* All other cases should use the default

			case 'mssql':
			case 'mssql_odbc':
			case 'mssqlnative':
			case 'mysql':
			case 'mysqli':*/
			default:
				return 'RAND()';
		}
	}
}


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\ad;
12
13			class manager
14			{
15			/** @var \phpbb\db\driver\driver_interface */
16			protected $db;
17
18			/** @var \phpbb\config\config */
19			protected $config;
20
21			/** @var string */
22			protected $ads_table;
23
24			/** @var string */
25			protected $ad_locations_table;
26
27			/**
28			* Constructor
29			*
30			* @param \phpbb\db\driver\driver_interface $db DB driver interface
31			* @param \phpbb\config\config $config Config object
32			* @param string $ads_table Ads table
33			* @param string $ad_locations_table Ad locations table
34			*/
35	39		public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, $ads_table, $ad_locations_table)
36			{
37	39		$this->db = $db;
38	39		$this->config = $config;
39	39		$this->ads_table = $ads_table;
40	39		$this->ad_locations_table = $ad_locations_table;
41	39		}
42
43			/**
44			* Get specific ad
45			*
46			* @param int $ad_id Advertisement ID
47			* @return mixed Array with advertisement data, false if ad doesn't exist
48			*/
49	13	View Code Duplication	public function get_ad($ad_id)
			1 ignored issue – show Duplication introduced 2017-07-11 17:21 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
50			{
51			$sql = 'SELECT *
52	13		FROM ' . $this->ads_table . '
53	13		WHERE ad_id = ' . (int) $ad_id;
54	13		$result = $this->db->sql_query($sql);
55	13		$data = $this->db->sql_fetchrow($result);
56	13		$this->db->sql_freeresult($result);
57
58	13		return $data;
59			}
60
61			/**
62			* Get one ad per every location
63			*
64			* @param array $ad_locations List of ad locations to fetch ads for
65			* @return array List of ad codes for each location
66			*/
67	6		public function get_ads($ad_locations)
68			{
69	6		$sql_where_views = $this->config['phpbb_ads_enable_views'] ? 'AND (a.ad_views_limit = 0 OR a.ad_views_limit > a.ad_views)' : '';
70	6		$sql_where_clicks = $this->config['phpbb_ads_enable_clicks'] ? 'AND (a.ad_clicks_limit = 0 OR a.ad_clicks_limit > a.ad_clicks)' : '';
71
72			$sql = 'SELECT location_id, ad_id, ad_code
73			FROM (
74			SELECT al.location_id, a.ad_id, a.ad_code
75	6		FROM ' . $this->ad_locations_table . ' al
76	6		LEFT JOIN ' . $this->ads_table . " a
77			ON (al.ad_id = a.ad_id)
78			WHERE a.ad_enabled = 1
79			AND (a.ad_end_date = 0
80	6		OR a.ad_end_date > " . time() . ")
81			$sql_where_views
82	6		$sql_where_clicks
83	6		AND " . $this->db->sql_in_set('al.location_id', $ad_locations) . '
84	6		ORDER BY (' . $this->sql_random() . ' * a.ad_priority) DESC
85			) z
86	6		ORDER BY z.location_id';
87	6		$result = $this->db->sql_query($sql);
88	6		$data = $this->db->sql_fetchrowset($result);
89	6		$this->db->sql_freeresult($result);
90
91	6		$current_location_id = '';
92	6		$data = array_filter($data, function($row) use (&$current_location_id) {
93	4		$return = $current_location_id != $row['location_id'];
94	4		$current_location_id = $row['location_id'];
95	4		return $return;
96	6		});
97
98	6		return $data;
99			}
100
101			/**
102			* Get all advertisements
103			*
104			* @return array List of all ads
105			*/
106	2	View Code Duplication	public function get_all_ads()
			1 ignored issue – show Duplication introduced 2017-07-11 15:51 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
107			{
108			$sql = 'SELECT ad_id, ad_name, ad_enabled, ad_end_date, ad_views, ad_clicks, ad_views_limit, ad_clicks_limit
109	2		FROM ' . $this->ads_table;
110	2		$result = $this->db->sql_query($sql);
111	2		$data = $this->db->sql_fetchrowset($result);
112	2		$this->db->sql_freeresult($result);
113
114	2		return $data;
115			}
116
117			/**
118			* Increment views for specified ads
119			*
120			* Note, that views are incremented only by one even when
121			* an ad is displayed multiple times on the same page.
122			*
123			* @param array $ad_ids IDs of ads to increment views
124			* @return void
125			*/
126	2		public function increment_ads_views($ad_ids)
127			{
128	2		if (!empty($ad_ids))
129	2		{
130	2		$sql = 'UPDATE ' . $this->ads_table . '
131			SET ad_views = ad_views + 1
132	2		WHERE ' . $this->db->sql_in_set('ad_id', $ad_ids);
133	2		$this->db->sql_query($sql);
134	2		}
135	2		}
136
137			/**
138			* Increment clicks for specified ad
139			*
140			* @param int $ad_id ID of an ad to increment clicks
141			* @return void
142			*/
143	2		public function increment_ad_clicks($ad_id)
144			{
145	2		$sql = 'UPDATE ' . $this->ads_table . '
146			SET ad_clicks = ad_clicks + 1
147	2		WHERE ad_id = ' . (int) $ad_id;
148	2		$this->db->sql_query($sql);
149	2		}
150
151			/**
152			* Insert new advertisement to the database
153			*
154			* @param array $data New ad data
155			* @return int New advertisement ID
156			*/
157	2	View Code Duplication	public function insert_ad($data)
158			{
159	2		$data = $this->intersect_ad_data($data);
160
161	2		$sql = 'INSERT INTO ' . $this->ads_table . ' ' . $this->db->sql_build_array('INSERT', $data);
162	2		$this->db->sql_query($sql);
163
164	2		return $this->db->sql_nextid();
165			}
166
167			/**
168			* Update advertisement
169			*
170			* @param int $ad_id Advertisement ID
171			* @param array $data List of data to update in the database
172			* @return int Number of affected rows. Can be used to determine if any ad has been updated.
173			*/
174	4	View Code Duplication	public function update_ad($ad_id, $data)
175			{
176	4		$data = $this->intersect_ad_data($data);
177
178	4		$sql = 'UPDATE ' . $this->ads_table . '
179	4		SET ' . $this->db->sql_build_array('UPDATE', $data) . '
180	4		WHERE ad_id = ' . (int) $ad_id;
181	4		$this->db->sql_query($sql);
182
183	4		return $this->db->sql_affectedrows();
184			}
185
186			/**
187			* Delete advertisement
188			*
189			* @param int $ad_id Advertisement ID
190			* @return int Number of affected rows. Can be used to determine if any ad has been deleted.
191			*/
192	1		public function delete_ad($ad_id)
193			{
194	1		$sql = 'DELETE FROM ' . $this->ads_table . '
195	1		WHERE ad_id = ' . (int) $ad_id;
196	1		$this->db->sql_query($sql);
197
198	1		return $this->db->sql_affectedrows();
199			}
200
201			/**
202			* Get all locations for specified advertisement
203			*
204			* @param int $ad_id Advertisement ID
205			* @return array List of template locations for specified ad
206			*/
207	7	View Code Duplication	public function get_ad_locations($ad_id)
208			{
209	7		$ad_locations = array();
210
211			$sql = 'SELECT location_id
212	7		FROM ' . $this->ad_locations_table . '
213	7		WHERE ad_id = ' . (int) $ad_id;
214	7		$result = $this->db->sql_query($sql);
215	7		while ($row = $this->db->sql_fetchrow($result))
216			{
217	5		$ad_locations[] = $row['location_id'];
218	5		}
219	7		$this->db->sql_freeresult($result);
220
221	7		return $ad_locations;
222			}
223
224			/**
225			* Insert advertisement locations
226			*
227			* @param int $ad_id Advertisement ID
228			* @param array $ad_locations List of template locations for this ad
229			* @return void
230			*/
231	2		public function insert_ad_locations($ad_id, $ad_locations)
232			{
233	2		$sql_ary = array();
234	2		foreach ($ad_locations as $ad_location)
235			{
236	2		$sql_ary[] = array(
237	2		'ad_id' => $ad_id,
238	2		'location_id' => $ad_location,
239			);
240	2		}
241	2		$this->db->sql_multi_insert($this->ad_locations_table, $sql_ary);
242	2		}
243
244			/**
245			* Delete advertisement locations
246			*
247			* @param int $ad_id Advertisement ID
248			* @return void
249			*/
250	3		public function delete_ad_locations($ad_id)
251			{
252	3		$sql = 'DELETE FROM ' . $this->ad_locations_table . '
253	3		WHERE ad_id = ' . (int) $ad_id;
254	3		$this->db->sql_query($sql);
255	3		}
256
257			/**
258			* Load memberships of the user
259			*
260			* @param int $user_id User ID to load memberships
261			* @return array List of group IDs user is member of
262			*/
263	7	View Code Duplication	public function load_memberships($user_id)
264			{
265	7		$memberships = array();
266			$sql = 'SELECT group_id
267	7		FROM ' . USER_GROUP_TABLE . '
268	7		WHERE user_id = ' . (int) $user_id . '
269	7		AND user_pending = 0';
270	7		$result = $this->db->sql_query($sql, 3600);
271	7		while ($row = $this->db->sql_fetchrow($result))
272			{
273	7		$memberships[] = $row['group_id'];
274	7		}
275	7		$this->db->sql_freeresult($result);
276	7		return $memberships;
277			}
278
279			/**
280			* Load all board groups
281			*
282			* @return array List of groups
283			*/
284	1	View Code Duplication	public function load_groups()
285			{
286			$sql = 'SELECT group_id, group_name, group_type
287	1		FROM ' . GROUPS_TABLE . '
288	1		ORDER BY group_name ASC';
289	1		$result = $this->db->sql_query($sql);
290	1		$groups = $this->db->sql_fetchrowset($result);
291	1		$this->db->sql_freeresult($result);
292
293	1		return $groups;
294			}
295
296			/**
297			* Make sure only necessary data make their way to SQL query
298			*
299			* @param array $data List of data to query the database
300			* @return array Cleaned data that contain only valid keys
301			*/
302	6		protected function intersect_ad_data($data)
303			{
304	6		return array_intersect_key($data, array(
305	6		'ad_name' => '',
306	6		'ad_note' => '',
307	6		'ad_code' => '',
308	6		'ad_enabled' => '',
309	6		'ad_end_date' => '',
310	6		'ad_priority' => '',
311	6		'ad_views_limit' => '',
312	6		'ad_clicks_limit' => '',
313	6		));
314			}
315
316			/**
317			* Get the random statement for this database layer
318			* Random function should generate a float value between 0 and 1
319			*
320			* @return string Random statement for current database layer
321			*/
322	6		protected function sql_random()
323			{
324	6		switch ($this->db->get_sql_layer())
325			{
326	6		case 'oracle':
327			return 'VALUE()';
328
329	6		case 'postgres':
330			return 'RANDOM()';
331
332			// https://stackoverflow.com/a/35369410/2908600
333	6		case 'sqlite':
334	6		case 'sqlite3':
335			return '(0.5 - RANDOM() / CAST(-9223372036854775808 AS REAL) / 2)';
336
337			/* All other cases should use the default
			1 ignored issue – show Unused Code Comprehensibility introduced 2017-05-31 10:41 UTC by Report Bug Copy Issue Report `44%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
338			case 'mssql':
339			case 'mssql_odbc':
340			case 'mssqlnative':
341			case 'mysql':
342			case 'mysqli':*/
343	6		default:
344	6		return 'RAND()';
345	6		}
346			}
347			}
348

phpbb-extensions / ad-management

Pull Request — master (#43)

manager::delete_ad() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like