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;

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';

location/type/after_posts.php

Indentation +4 added lines, -4 removed lines

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