phpbb-extensions / ad-management

event/main_listener.php

Indentation +17 added lines, -17 removed lines

@@ -42,8 +42,8 @@ 
 	protected $controller_helper;
 
 	/**
-	* {@inheritdoc}
-	*/
+	 * {@inheritdoc}
+	 */
 	static public function getSubscribedEvents()
 	{
 		return array(
@@ -53,16 +53,16 @@ 
 	}
 
 	/**
-	* 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\config\config					$config				Config object
-	* @param \phpbb\ads\ad\manager					$manager			Advertisement manager object
-	* @param \phpbb\ads\location\manager			$location_manager	Template location manager object
-	* @param \phpbb\controller\helper				$controller_helper	Controller helper 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\config\config					$config				Config object
+	 * @param \phpbb\ads\ad\manager					$manager			Advertisement manager object
+	 * @param \phpbb\ads\location\manager			$location_manager	Template location manager object
+	 * @param \phpbb\controller\helper				$controller_helper	Controller helper object
+	 */
 	public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\config\db_text $config_text, \phpbb\config\config $config, \phpbb\ads\ad\manager $manager, \phpbb\ads\location\manager $location_manager, \phpbb\controller\helper $controller_helper)
 	{
 		$this->template = $template;
@@ -75,11 +75,11 @@ 
 	}
 
 	/**
-	* Load common language file during user setup
-	*
-	* @param	\phpbb\event\data	$event	The event object
-	* @return	void
-	*/
+	 * Load common language file during user setup
+	 *
+	 * @param	\phpbb\event\data	$event	The event object
+	 * @return	void
+	 */
 	public function load_language_on_setup($event)
 	{
 		$lang_set_ext = $event['lang_set_ext'];

migrations/v10x/m9_views_clicks.php

Indentation +14 added lines, -14 removed lines

@@ -13,27 +13,27 @@ 
 class m9_views_clicks extends \phpbb\db\migration\migration
 {
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	public function effectively_installed()
 	{
 		return $this->db_tools->sql_column_exists($this->table_prefix . 'ads', 'ad_views');
 	}
 
 	/**
-	* {@inheritDoc}
-	*/
+	 * {@inheritDoc}
+	 */
 	static public function depends_on()
 	{
 		return array('\phpbb\ads\migrations\v10x\m1_initial_schema');
 	}
 
 	/**
-	* Add the views and clicks to ads table
-	*
-	* @return array Array of table schema
-	* @access public
-	*/
+	 * Add the views and clicks to ads table
+	 *
+	 * @return array Array of table schema
+	 * @access public
+	 */
 	public function update_schema()
 	{
 		return array(
@@ -57,11 +57,11 @@ 
 	}
 
 	/**
-	* Drop the views and clicks from ads table
-	*
-	* @return array Array of table schema
-	* @access public
-	*/
+	 * Drop the views and clicks from ads table
+	 *
+	 * @return array Array of table schema
+	 * @access public
+	 */
 	public function revert_schema()
 	{
 		return array(

ad/manager.php

Spacing +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
 		$this->db->sql_freeresult($result);
 
 		$current_location_id = '';
-		$data = array_filter($data, function($row) use (&$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;

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/click_controller.php

Indentation +5 added lines, -5 removed lines

@@ -34,11 +34,11 @@
 	}
 
 	/**
-	* Increment clicks for an ad
-	*
-	* @param	int	$ad_id	Advertisement ID
-	* @return	\Symfony\Component\HttpFoundation\JsonResponse	A Symfony JsonResponse object
-	*/
+	 * Increment clicks for an ad
+	 *
+	 * @param	int	$ad_id	Advertisement ID
+	 * @return	\Symfony\Component\HttpFoundation\JsonResponse	A Symfony JsonResponse object
+	 */
 	public function increment_clicks($ad_id)
 	{
 		if ($this->request->is_ajax() && !empty($ad_id))

controller/admin_input.php

Doc Comments +1 added lines, -1 removed lines

@@ -113,7 +113,7 @@
 	 * Upload image and return updated ad code or <img> of new banner when using ajax.
 	 *
 	 * @param	 string	 $ad_code	 Current ad code
-	 * @return	 mixed	 \phpbb\json_response when request is ajax or updated ad code otherwise.
+	 * @return	 string	 \phpbb\json_response when request is ajax or updated ad code otherwise.
 	 */
 	public function banner_upload($ad_code)
 	{

controller/admin_controller.php

Indentation +14 added lines, -14 removed lines

@@ -54,20 +54,20 @@
 	protected $u_action;
 
 	/**
-	* Constructor
-	*
-	* @param \phpbb\template\template		    $template		  Template object
-	* @param \phpbb\language\language           $language         Language object
-	* @param \phpbb\request\request             $request          Request object
-	* @param \phpbb\ads\ad\manager              $manager          Advertisement manager object
-	* @param \phpbb\config\db_text              $config_text      Config text object
-	* @param \phpbb\config\config               $config           Config object
-	* @param \phpbb\group\helper                $group_helper     Group helper object
-	* @param \phpbb\ads\controller\admin_input 	$input			  Admin input object
-	* @param \phpbb\ads\controller\admin_helper $helper			  Admin helper object
-	* @param string								$root_path		  phpBB root path
-	* @param string								$php_ext		  PHP extension
-	*/
+	 * Constructor
+	 *
+	 * @param \phpbb\template\template		    $template		  Template object
+	 * @param \phpbb\language\language           $language         Language object
+	 * @param \phpbb\request\request             $request          Request object
+	 * @param \phpbb\ads\ad\manager              $manager          Advertisement manager object
+	 * @param \phpbb\config\db_text              $config_text      Config text object
+	 * @param \phpbb\config\config               $config           Config object
+	 * @param \phpbb\group\helper                $group_helper     Group helper object
+	 * @param \phpbb\ads\controller\admin_input 	$input			  Admin input object
+	 * @param \phpbb\ads\controller\admin_helper $helper			  Admin helper object
+	 * @param string								$root_path		  phpBB root path
+	 * @param string								$php_ext		  PHP extension
+	 */
 	public function __construct(\phpbb\template\template $template, \phpbb\language\language $language, \phpbb\request\request $request, \phpbb\ads\ad\manager $manager, \phpbb\config\db_text $config_text, \phpbb\config\config $config, \phpbb\group\helper $group_helper, \phpbb\ads\controller\admin_input $input, \phpbb\ads\controller\admin_helper $helper, $root_path, $php_ext)
 	{
 		$this->template = $template;

location/type/base.php

Indentation +14 added lines, -14 removed lines

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