phpbb-extensions / ad-management

location/type/type_interface.php

Indentation +20 added lines, -20 removed lines

@@ -16,34 +16,34 @@
 interface type_interface
 {
 	/**
-	* Returns the unique ID of the location.
-	*
-	* @return string	ID of location.
-	*/
+	 * Returns the unique ID of the location.
+	 *
+	 * @return string	ID of location.
+	 */
 	public function get_id();
 
 	/**
-	* Returns the name of the location.
-	*
-	* @return string	Name of location.
-	*/
+	 * Returns the name of the location.
+	 *
+	 * @return string	Name of location.
+	 */
 	public function get_name();
 
 	/**
-	* Returns the description of the location.
-	*
-	* @return string	Description of location.
-	*/
+	 * Returns the description of the location.
+	 *
+	 * @return string	Description of location.
+	 */
 	public function get_desc();
 
 	/**
-	* Returns whether or not this location type will be displayed on a current page.
-	*
-	* Generally, you can always return true, but if you can narrow down the usage
-	* without adding extra load to server, this will further enhance the extension's
-	* performance.
-	*
-	* @return bool	True when location type will be displayed on a current page and false if not.
-	*/
+	 * Returns whether or not this location type will be displayed on a current page.
+	 *
+	 * Generally, you can always return true, but if you can narrow down the usage
+	 * without adding extra load to server, this will further enhance the extension's
+	 * performance.
+	 *
+	 * @return bool	True when location type will be displayed on a current page and false if not.
+	 */
 	public function will_display();
 }

migrations/v10x/m3_template_locations_schema.php

Indentation +18 added lines, -18 removed lines

@@ -13,31 +13,31 @@ 
 class m3_template_locations_schema extends \phpbb\db\migration\migration
 {
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	public function effectively_installed()
 	{
 		return $this->db_tools->sql_table_exists($this->table_prefix . 'ad_locations');
 	}
 
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	static public function depends_on()
 	{
 		return array('\phpbb\admanagement\migrations\v10x\m2_acp_module');
 	}
 
 	/**
-	* Add the ad_locations table schema to the database:
-	*	ad_locations:
-	*		ad_location_id
-	*		ad_id
-	*		location_id
-	*
-	* @return array Array of table schema
-	* @access public
-	*/
+	 * Add the ad_locations table schema to the database:
+	 *	ad_locations:
+	 *		ad_location_id
+	 *		ad_id
+	 *		location_id
+	 *
+	 * @return array Array of table schema
+	 * @access public
+	 */
 	public function update_schema()
 	{
 		return array(
@@ -54,11 +54,11 @@ 
 	}
 
 	/**
-	* Drop the ad_locations table schema from the database
-	*
-	* @return array Array of table schema
-	* @access public
-	*/
+	 * Drop the ad_locations table schema from the database
+	 *
+	 * @return array Array of table schema
+	 * @access public
+	 */
 	public function revert_schema()
 	{
 		return array(

location/manager.php

Indentation +23 added lines, -23 removed lines

@@ -13,30 +13,30 @@ 
 class manager
 {
 	/**
-	* Array that contains all available template location types which are passed
-	* via the service container
-	* @var array
-	*/
+	 * Array that contains all available template location types which are passed
+	 * via the service container
+	 * @var array
+	 */
 	protected $template_locations;
 
 	/**
-	* Construct an template locations manager object
-	*
-	* @param	array	$template_locations	Template location types passed via the service container
-	*/
+	 * Construct an template locations manager object
+	 *
+	 * @param	array	$template_locations	Template location types passed via the service container
+	 */
 	public function __construct($template_locations)
 	{
 		$this->register_template_locations($template_locations);
 	}
 
 	/**
-	* Get a list of all template location types
-	*
-	* Returns an associated array where key is the location id
-	* and value is array of location name and location description.
-	*
-	* @return	array	Array containing a list of all template locations
-	*/
+	 * Get a list of all template location types
+	 *
+	 * Returns an associated array where key is the location id
+	 * and value is array of location name and location description.
+	 *
+	 * @return	array	Array containing a list of all template locations
+	 */
 	public function get_all_locations()
 	{
 		$location_types = array();
@@ -53,10 +53,10 @@ 
 	}
 
 	/**
-	* Get a list of all template location IDs for display
-	*
-	* @return	array	Array containing a list of all template location IDs
-	*/
+	 * Get a list of all template location IDs for display
+	 *
+	 * @return	array	Array containing a list of all template location IDs
+	 */
 	public function get_all_location_ids()
 	{
 		$template_locations = array();
@@ -73,10 +73,10 @@ 
 	}
 
 	/**
-	* Register template locations
-	*
-	* @param	array	$template_locations	Template location types passed via the service container
-	*/
+	 * Register template locations
+	 *
+	 * @param	array	$template_locations	Template location types passed via the service container
+	 */
 	protected function register_template_locations($template_locations)
 	{
 		if (!empty($template_locations))

location/type/base.php

Doc Comments -1 removed lines

@@ -21,7 +21,6 @@
 	/**
 	* Construct an after_profile template location object
 	*
-	* @param	\phpbb\user	$config	User object
 	*/
 	public function __construct(\phpbb\user $user)
 	{

Indentation +13 added lines, -13 removed lines

@@ -16,40 +16,40 @@
 abstract class base implements \phpbb\admanagement\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	$config	User object
-	*/
+	 * Construct an after_profile template location object
+	 *
+	 * @param	\phpbb\user	$config	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;

controller/admin_controller.php

Indentation +80 added lines, -80 removed lines

@@ -45,16 +45,16 @@ 
 	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\admanagement\ad\manager			$manager			Advertisement manager object
-	* @param \phpbb\admanagement\location\manager	$location_manager	Template location manager 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\admanagement\ad\manager			$manager			Advertisement manager object
+	 * @param \phpbb\admanagement\location\manager	$location_manager	Template location manager 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\admanagement\ad\manager $manager, \phpbb\admanagement\location\manager $location_manager, $php_ext, $ext_path)
 	{
 		$this->template = $template;
@@ -67,10 +67,10 @@ 
 	}
 
 	/**
-	* Process user request
-	*
-	* @return void
-	*/
+	 * Process user request
+	 *
+	 * @return void
+	 */
 	public function main()
 	{
 		$this->user->add_lang_ext('phpbb/admanagement', 'acp');
@@ -87,31 +87,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()
 	{
 		add_form_key('phpbb/admanagement/add');
@@ -142,10 +142,10 @@ 
 	}
 
 	/**
-	* Edit an advertisement
-	*
-	* @return void
-	*/
+	 * Edit an advertisement
+	 *
+	 * @return void
+	 */
 	public function action_edit()
 	{
 		$ad_id = $this->request->variable('id', 0);
@@ -196,30 +196,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);
@@ -253,10 +253,10 @@ 
 	}
 
 	/**
-	* Display the ads
-	*
-	* @return void
-	*/
+	 * Display the ads
+	 *
+	 * @return void
+	 */
 	public function list_ads()
 	{
 		foreach ($this->manager->get_all_ads() as $row)
@@ -281,11 +281,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);
@@ -316,10 +316,10 @@ 
 	}
 
 	/**
-	* Get admin form data.
-	*
-	* @return	array	Form data
-	*/
+	 * Get admin form data.
+	 *
+	 * @return	array	Form data
+	 */
 	protected function get_form_data()
 	{
 		return array(
@@ -332,12 +332,12 @@ 
 	}
 
 	/**
-	* Validate form data.
-	*
-	* @param	array	$data		The form data.
-	* @param	string	$form_name	The form name.
-	* @return void
-	*/
+	 * Validate form data.
+	 *
+	 * @param	array	$data		The form data.
+	 * @param	string	$form_name	The form name.
+	 * @return void
+	 */
 	protected function validate($data, $form_name)
 	{
 		if (!check_form_key($form_name))
@@ -356,11 +356,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(
@@ -375,11 +375,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)
@@ -394,20 +394,20 @@ 
 	}
 
 	/**
-	* 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);

ad/manager.php

Indentation +61 added lines, -61 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	array	Advertisement data
-	*/
+	 * Get specific ad
+	 *
+	 * @param	int		$ad_id	Advertisement ID
+	 * @return	array	Advertisement data
+	 */
 	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
@@ -80,10 +80,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
@@ -96,11 +96,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);
@@ -112,12 +112,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 udated.
-	*/
+	 * 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 udated.
+	 */
 	public function update_ad($ad_id, $data)
 	{
 		$data = $this->intersect_ad_data($data);
@@ -131,11 +131,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 . '
@@ -146,11 +146,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();
@@ -169,12 +169,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();
@@ -189,11 +189,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 . '
@@ -202,11 +202,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(
@@ -218,10 +218,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())

location/type/above_footer.php

Indentation +2 added lines, -2 removed lines

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

location/type/before_posts.php

Indentation +4 added lines, -4 removed lines

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

location/type/above_header.php

Indentation +2 added lines, -2 removed lines

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