phpbb-extensions / ad-management

ad/manager.php

Indentation +74 added lines, -74 removed lines

@@ -41,11 +41,11 @@ 
 	}
 
 	/**
-	* Get specific ad
-	*
-	* @param	int		$ad_id	Advertisement ID
-	* @return	mixed	Array with advertisement data, false if ad doesn't exist
-	*/
+	 * 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 *
@@ -59,11 +59,11 @@ 
 	}
 
 	/**
-	* 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
-	*/
+	 * 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)' : '';
@@ -120,14 +120,14 @@ 
 	}
 
 	/**
-	* 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
-	*/
+	 * 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))
@@ -140,11 +140,11 @@ 
 	}
 
 	/**
-	* Increment clicks for specified ad
-	*
-	* @param	int	$ad_id	ID of an ad to increment clicks
-	* @return	void
-	*/
+	 * 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 . '
@@ -154,11 +154,11 @@ 
 	}
 
 	/**
-	* Insert new advertisement to the database
-	*
-	* @param	array	$data	New ad data
-	* @return	int		New advertisement ID
-	*/
+	 * 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);
@@ -170,12 +170,12 @@ 
 	}
 
 	/**
-	* 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.
-	*/
+	 * 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);
@@ -189,11 +189,11 @@ 
 	}
 
 	/**
-	* 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.
-	*/
+	 * 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 . '
@@ -204,11 +204,11 @@ 
 	}
 
 	/**
-	* Get all locations for specified advertisement
-	*
-	* @param	int		$ad_id	Advertisement ID
-	* @return	array	List of template locations for specified ad
-	*/
+	 * 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();
@@ -227,12 +227,12 @@ 
 	}
 
 	/**
-	* Insert advertisement locations
-	*
-	* @param	int		$ad_id			Advertisement ID
-	* @param	array	$ad_locations	List of template locations for this ad
-	* @return	void
-	*/
+	 * 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();
@@ -247,11 +247,11 @@ 
 	}
 
 	/**
-	* Delete advertisement locations
-	*
-	* @param	int		$ad_id	Advertisement ID
-	* @return	void
-	*/
+	 * 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 . '
@@ -260,11 +260,11 @@ 
 	}
 
 	/**
-	* Load memberships of the user
-	*
-	* @param	int		$user_id	User ID to load memberships
-	* @return	array	List of group IDs user is member of
-	*/
+	 * 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();
@@ -282,10 +282,10 @@ 
 	}
 
 	/**
-	* Load all board groups
-	*
-	* @return	array	List of groups
-	*/
+	 * Load all board groups
+	 *
+	 * @return	array	List of groups
+	 */
 	public function load_groups()
 	{
 		$sql = 'SELECT group_id, group_name, group_type
@@ -335,11 +335,11 @@ 
 	}
 
 	/**
-	* 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
-	*/
+	 * 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(
@@ -356,11 +356,11 @@ 
 	}
 
 	/**
-	* 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
-	*/
+	 * 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())

controller/admin_controller.php

Indentation +103 added lines, -103 removed lines

@@ -59,20 +59,20 @@ 
 	protected $errors = array();
 
 	/**
-	* Constructor
-	*
-	* @param \phpbb\template\template				$template			Template object
-	* @param \phpbb\user							$user				User object
-	* @param \phpbb\request\request					$request			Request object
-	* @param \phpbb\ads\ad\manager					$manager			Advertisement manager object
-	* @param \phpbb\ads\location\manager			$location_manager	Template location manager object
-	* @param \phpbb\log\log							$log				The phpBB log system
-	* @param \phpbb\config\db_text					$config_text		Config text object
-	* @param \phpbb\config\config					$config				Config object
-	* @param string									$root_path			phpBB root path
-	* @param string									$php_ext			PHP extension
-	* @param string									$ext_path			Path to this extension
-	*/
+	 * Constructor
+	 *
+	 * @param \phpbb\template\template				$template			Template object
+	 * @param \phpbb\user							$user				User object
+	 * @param \phpbb\request\request					$request			Request object
+	 * @param \phpbb\ads\ad\manager					$manager			Advertisement manager object
+	 * @param \phpbb\ads\location\manager			$location_manager	Template location manager object
+	 * @param \phpbb\log\log							$log				The phpBB log system
+	 * @param \phpbb\config\db_text					$config_text		Config text object
+	 * @param \phpbb\config\config					$config				Config object
+	 * @param string									$root_path			phpBB root path
+	 * @param string									$php_ext			PHP extension
+	 * @param string									$ext_path			Path to this extension
+	 */
 	public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\request\request $request, \phpbb\ads\ad\manager $manager, \phpbb\ads\location\manager $location_manager, \phpbb\log\log $log, \phpbb\config\db_text $config_text, \phpbb\config\config $config, $root_path, $php_ext, $ext_path)
 	{
 		$this->template = $template;
@@ -89,10 +89,10 @@ 
 	}
 
 	/**
-	* Process user request for manage mode
-	*
-	* @return void
-	*/
+	 * Process user request for manage mode
+	 *
+	 * @return void
+	 */
 	public function mode_manage()
 	{
 		$this->setup();
@@ -109,10 +109,10 @@ 
 	}
 
 	/**
-	* Process user request for settings mode
-	*
-	* @return void
-	*/
+	 * Process user request for settings mode
+	 *
+	 * @return void
+	 */
 	public function mode_settings()
 	{
 		$this->setup();
@@ -164,31 +164,31 @@ 
 	}
 
 	/**
-	* Set page url
-	*
-	* @param string $u_action Custom form action
-	* @return void
-	*/
+	 * 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
-	*/
+	 * 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_PHPBB_ADS_TITLE');
 	}
 
 	/**
-	* Add an advertisement
-	*
-	* @return void
-	*/
+	 * Add an advertisement
+	 *
+	 * @return void
+	 */
 	public function action_add()
 	{
 		$preview = $this->request->is_set_post('preview');
@@ -232,10 +232,10 @@ 
 	}
 
 	/**
-	* Edit an advertisement
-	*
-	* @return void
-	*/
+	 * Edit an advertisement
+	 *
+	 * @return void
+	 */
 	public function action_edit()
 	{
 		$ad_id = $this->request->variable('id', 0);
@@ -295,30 +295,30 @@ 
 	}
 
 	/**
-	* Enable an advertisement
-	*
-	* @return void
-	*/
+	 * Enable an advertisement
+	 *
+	 * @return void
+	 */
 	public function action_enable()
 	{
 		$this->ad_enable(true);
 	}
 
 	/**
-	* Disable an advertisement
-	*
-	* @return void
-	*/
+	 * Disable an advertisement
+	 *
+	 * @return void
+	 */
 	public function action_disable()
 	{
 		$this->ad_enable(false);
 	}
 
 	/**
-	* Delete an advertisement
-	*
-	* @return void
-	*/
+	 * Delete an advertisement
+	 *
+	 * @return void
+	 */
 	public function action_delete()
 	{
 		$ad_id = $this->request->variable('id', 0);
@@ -361,10 +361,10 @@ 
 	}
 
 	/**
-	* Display the ads
-	*
-	* @return void
-	*/
+	 * Display the ads
+	 *
+	 * @return void
+	 */
 	public function list_ads()
 	{
 		foreach ($this->manager->get_all_ads() as $row)
@@ -402,10 +402,10 @@ 
 	}
 
 	/**
-	* Perform general tasks
-	*
-	* @return void
-	*/
+	 * Perform general tasks
+	 *
+	 * @return void
+	 */
 	protected function setup()
 	{
 		$this->user->add_lang_ext('phpbb/ads', 'acp');
@@ -414,11 +414,11 @@ 
 	}
 
 	/**
-	* Enable/disable an advertisement
-	*
-	* @param	bool	$enable	Enable or disable the advertisement?
-	* @return void
-	*/
+	 * 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);
@@ -449,11 +449,11 @@ 
 	}
 
 	/**
-	* Get admin form data.
-	*
-	* @param	string	$form_name	The form name.
-	* @return	array	Form data
-	*/
+	 * Get admin form data.
+	 *
+	 * @param	string	$form_name	The form name.
+	 * @return	array	Form data
+	 */
 	protected function get_form_data($form_name)
 	{
 		$data = array(
@@ -535,11 +535,11 @@ 
 	}
 
 	/**
-	* Assign form data to the template.
-	*
-	* @param	array	$data	The form data.
-	* @return void
-	*/
+	 * Assign form data to the template.
+	 *
+	 * @param	array	$data	The form data.
+	 * @return void
+	 */
 	protected function assign_form_data($data)
 	{
 		$this->template->assign_vars(array(
@@ -559,11 +559,11 @@ 
 	}
 
 	/**
-	* Prepare end date for display
-	*
-	* @param	mixed	$end_date	End date.
-	* @return	string	End date prepared for display.
-	*/
+	 * Prepare end date for display
+	 *
+	 * @param	mixed	$end_date	End date.
+	 * @return	string	End date prepared for display.
+	 */
 	protected function prepare_end_date($end_date)
 	{
 		if (empty($end_date))
@@ -580,11 +580,11 @@ 
 	}
 
 	/**
-	* Assign template locations data to the template.
-	*
-	* @param	mixed	$data	The form data or nothing.
-	* @return	void
-	*/
+	 * Assign template locations data to the template.
+	 *
+	 * @param	mixed	$data	The form data or nothing.
+	 * @return	void
+	 */
 	protected function assign_locations($data = false)
 	{
 		foreach ($this->location_manager->get_all_locations() as $location_id => $location_data)
@@ -599,43 +599,43 @@ 
 	}
 
 	/**
-	* Prepare advertisement preview
-	*
-	* @param	string	$code	Ad code to preview
-	* @return	void
-	*/
+	 * Prepare advertisement preview
+	 *
+	 * @param	string	$code	Ad code to preview
+	 * @return	void
+	 */
 	protected function ad_preview($code)
 	{
 		$this->template->assign_var('PREVIEW', htmlspecialchars_decode($code));
 	}
 
 	/**
-	* Print success message.
-	*
-	* It takes arguments in the form of a language key, followed by language substitution values.
-	*/
+	 * Print success message.
+	 *
+	 * It takes arguments in the form of a language key, followed by language substitution values.
+	 */
 	protected function success()
 	{
 		trigger_error(call_user_func_array(array($this->user, 'lang'), func_get_args()) . adm_back_link($this->u_action));
 	}
 
 	/**
-	* Print error message.
-	*
-	* It takes arguments in the form of a language key, followed by language substitution values.
-	*/
+	 * Print error message.
+	 *
+	 * It takes arguments in the form of a language key, followed by language substitution values.
+	 */
 	protected function error()
 	{
 		trigger_error(call_user_func_array(array($this->user, 'lang'), func_get_args()) . adm_back_link($this->u_action), E_USER_WARNING);
 	}
 
 	/**
-	* Log action
-	*
-	* @param	string	$action		Performed action in uppercase
-	* @param	string	$ad_name	Advertisement name
-	* @return	void
-	*/
+	 * Log action
+	 *
+	 * @param	string	$action		Performed action in uppercase
+	 * @param	string	$ad_name	Advertisement name
+	 * @return	void
+	 */
 	protected 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));