phpbb-extensions / ad-management

location/type/after_not_first_post.php

Indentation +4 added lines, -4 removed lines

@@ -13,16 +13,16 @@
 class after_not_first_post extends base
 {
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	public function get_id()
 	{
 		return 'after_not_first_post';
 	}
 
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	public function will_display()
 	{
 		return strpos($this->user->page['page_name'], 'viewtopic') !== false;

location/type/below_footer.php

Indentation +2 added lines, -2 removed lines

@@ -13,8 +13,8 @@
 class below_footer extends base
 {
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	public function get_id()
 	{
 		return 'below_footer';

ad/manager.php

Indentation +70 added lines, -70 removed lines

@@ -22,12 +22,12 @@ 
 	protected $ad_locations_table;
 
 	/**
-	* Constructor
-	*
-	* @param	\phpbb\db\driver\driver_interface	$db					DB driver interface
-	* @param	string								$ads_table			Ads table
-	* @param	string								$ad_locations_table	Ad locations table
-	*/
+	 * Constructor
+	 *
+	 * @param	\phpbb\db\driver\driver_interface	$db					DB driver interface
+	 * @param	string								$ads_table			Ads table
+	 * @param	string								$ad_locations_table	Ad locations table
+	 */
 	public function __construct(\phpbb\db\driver\driver_interface $db, $ads_table, $ad_locations_table)
 	{
 		$this->db = $db;
@@ -36,11 +36,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 *
@@ -54,11 +54,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 = 'SELECT location_id, ad_code
@@ -82,10 +82,10 @@ 
 	}
 
 	/**
-	* Get all advertisements
-	*
-	* @return	array	List of all ads
-	*/
+	 * 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
@@ -98,11 +98,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);
@@ -114,12 +114,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);
@@ -133,11 +133,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 . '
@@ -148,11 +148,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();
@@ -171,12 +171,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();
@@ -191,11 +191,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 . '
@@ -204,11 +204,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();
@@ -226,10 +226,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
@@ -243,11 +243,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(
@@ -260,10 +260,10 @@ 
 	}
 
 	/**
-	* Get the random statement for this database layer
-	*
-	* @return	string	Random statement for current database layer
-	*/
+	 * Get the random statement for this database layer
+	 *
+	 * @return	string	Random statement for current database layer
+	 */
 	protected function sql_random()
 	{
 		switch ($this->db->get_sql_layer())

migrations/v10x/m1_initial_schema.php

Indentation +20 added lines, -20 removed lines

@@ -16,33 +16,33 @@ 
 class m1_initial_schema extends \phpbb\db\migration\migration
 {
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	public function effectively_installed()
 	{
 		return $this->db_tools->sql_table_exists($this->table_prefix . 'ads');
 	}
 
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	static public function depends_on()
 	{
 		return array('\phpbb\db\migration\data\v31x\v316');
 	}
 
 	/**
-	* Add the ads table schema to the database:
-	*	ads:
-	*		ad_id
-	*		ad_name
-	*		ad_note
-	*		ad_code
-	*		ad_enabled
-	*
-	* @return array Array of table schema
-	* @access public
-	*/
+	 * Add the ads table schema to the database:
+	 *	ads:
+	 *		ad_id
+	 *		ad_name
+	 *		ad_note
+	 *		ad_code
+	 *		ad_enabled
+	 *
+	 * @return array Array of table schema
+	 * @access public
+	 */
 	public function update_schema()
 	{
 		return array(
@@ -62,11 +62,11 @@ 
 	}
 
 	/**
-	* Drop the ads table schema from the database
-	*
-	* @return array Array of table schema
-	* @access public
-	*/
+	 * Drop the ads table schema from the database
+	 *
+	 * @return array Array of table schema
+	 * @access public
+	 */
 	public function revert_schema()
 	{
 		return array(

migrations/v10x/m4_indexes.php

Indentation +14 added lines, -14 removed lines

@@ -13,16 +13,16 @@ 
 class m4_indexes extends \phpbb\db\migration\migration
 {
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	public function effectively_installed()
 	{
 		return $this->db_tools->sql_index_exists($this->table_prefix . 'ads', 'ad_enabled');
 	}
 
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	static public function depends_on()
 	{
 		return array(
@@ -32,11 +32,11 @@ 
 	}
 
 	/**
-	* Add the indexes
-	*
-	* @return array Array of altered table schema
-	* @access public
-	*/
+	 * Add the indexes
+	 *
+	 * @return array Array of altered table schema
+	 * @access public
+	 */
 	public function update_schema()
 	{
 		return array(
@@ -52,11 +52,11 @@ 
 	}
 
 	/**
-	* Drop the indexes
-	*
-	* @return array Array of altered table schema
-	* @access public
-	*/
+	 * Drop the indexes
+	 *
+	 * @return array Array of altered table schema
+	 * @access public
+	 */
 	public function revert_schema()
 	{
 		return array(

location/type/base.php

Indentation +13 added lines, -13 removed lines

@@ -16,40 +16,40 @@
 abstract class base implements \phpbb\ads\location\type\type_interface
 {
 	/**
-	* User object
-	* @var \phpbb\user
-	*/
+	 * User object
+	 * @var \phpbb\user
+	 */
 	protected $user;
 
 	/**
-	* Construct an after_profile template location object
-	*
-	* @param	\phpbb\user	$user	User object
-	*/
+	 * Construct an after_profile template location object
+	 *
+	 * @param	\phpbb\user	$user	User object
+	 */
 	public function __construct(\phpbb\user $user)
 	{
 		$this->user = $user;
 	}
 
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	public function get_name()
 	{
 		return $this->user->lang('AD_' . strtoupper($this->get_id()));
 	}
 
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	public function get_desc()
 	{
 		return $this->user->lang('AD_' . strtoupper($this->get_id()) . '_DESC');
 	}
 
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	public function will_display()
 	{
 		return true;

migrations/v10x/m2_acp_module.php

Indentation +8 added lines, -8 removed lines

@@ -13,8 +13,8 @@ 
 class m2_acp_module extends \phpbb\db\migration\migration
 {
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	public function effectively_installed()
 	{
 		$sql = 'SELECT module_id
@@ -29,18 +29,18 @@ 
 	}
 
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	static public function depends_on()
 	{
 		return array('\phpbb\ads\migrations\v10x\m1_initial_schema');
 	}
 
 	/**
-	* Add the ACP module
-	*
-	* @return array Array of data update instructions
-	*/
+	 * Add the ACP module
+	 *
+	 * @return array Array of data update instructions
+	 */
 	public function update_data()
 	{
 		return array(

controller/admin_controller.php

Indentation +101 added lines, -101 removed lines

@@ -52,18 +52,18 @@ 
 	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 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 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, $php_ext, $ext_path)
 	{
 		$this->template = $template;
@@ -78,10 +78,10 @@ 
 	}
 
 	/**
-	* Process user request for manage mode
-	*
-	* @return void
-	*/
+	 * Process user request for manage mode
+	 *
+	 * @return void
+	 */
 	public function mode_manage()
 	{
 		$this->setup();
@@ -98,10 +98,10 @@ 
 	}
 
 	/**
-	* Process user request for settings mode
-	*
-	* @return void
-	*/
+	 * Process user request for settings mode
+	 *
+	 * @return void
+	 */
 	public function mode_settings()
 	{
 		$this->setup();
@@ -143,31 +143,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_ADMANAGEMENT_TITLE');
 	}
 
 	/**
-	* Add an advertisement
-	*
-	* @return void
-	*/
+	 * Add an advertisement
+	 *
+	 * @return void
+	 */
 	public function action_add()
 	{
 		$preview = $this->request->is_set_post('preview');
@@ -209,10 +209,10 @@ 
 	}
 
 	/**
-	* Edit an advertisement
-	*
-	* @return void
-	*/
+	 * Edit an advertisement
+	 *
+	 * @return void
+	 */
 	public function action_edit()
 	{
 		$ad_id = $this->request->variable('id', 0);
@@ -270,30 +270,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);
@@ -336,10 +336,10 @@ 
 	}
 
 	/**
-	* Display the ads
-	*
-	* @return void
-	*/
+	 * Display the ads
+	 *
+	 * @return void
+	 */
 	public function list_ads()
 	{
 		foreach ($this->manager->get_all_ads() as $row)
@@ -369,10 +369,10 @@ 
 	}
 
 	/**
-	* Perform general tasks
-	*
-	* @return void
-	*/
+	 * Perform general tasks
+	 *
+	 * @return void
+	 */
 	protected function setup()
 	{
 		$this->user->add_lang_ext('phpbb/ads', 'acp');
@@ -381,11 +381,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);
@@ -416,11 +416,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(
@@ -471,11 +471,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(
@@ -490,11 +490,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))
@@ -511,11 +511,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)
@@ -530,43 +530,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_ADMANAGEMENT_' . $action . '_LOG', time(), array($ad_name));

event/main_listener.php

Indentation +10 added lines, -10 removed lines

@@ -36,8 +36,8 @@ 
 	protected $location_manager;
 
 	/**
-	* {@inheritdoc}
-	*/
+	 * {@inheritdoc}
+	 */
 	static public function getSubscribedEvents()
 	{
 		return array(
@@ -46,14 +46,14 @@ 
 	}
 
 	/**
-	* Constructor
-	*
-	* @param \phpbb\template\template				$template			Template object
-	* @param \phpbb\user							$user				User object
-	* @param \phpbb\config\db_text					$config_text		Config text object
-	* @param \phpbb\ads\ad\manager			$manager			Advertisement manager object
-	* @param \phpbb\ads\location\manager	$location_manager	Template location manager object
-	*/
+	 * Constructor
+	 *
+	 * @param \phpbb\template\template				$template			Template object
+	 * @param \phpbb\user							$user				User object
+	 * @param \phpbb\config\db_text					$config_text		Config text object
+	 * @param \phpbb\ads\ad\manager			$manager			Advertisement manager object
+	 * @param \phpbb\ads\location\manager	$location_manager	Template location manager object
+	 */
 	public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\config\db_text $config_text, \phpbb\ads\ad\manager $manager, \phpbb\ads\location\manager $location_manager)
 	{
 		$this->template = $template;