phpbb\ads\controller\helper

Complexity

Total Complexity

19

Size/Duplication

Total Lines	180
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	1

Test Coverage

Coverage

97.01%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	assign_data()	0	21	2
A	__construct()	0	11	1
A	log()	0	4	1
A	get_find_username_link()	0	4	1
A	assign_locations()	0	19	4
A	get_enable_visual_demo_link()	0	4	1
B	is_expired()	0	19	7
A	get_username()	0	10	2

<?php
/**
 *
 * Advertisement management. An extension for the phpBB Forum Software package.
 *
 * @copyright (c) 2017 phpBB Limited <https://www.phpbb.com>
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace phpbb\ads\controller;

/**
 * Helper
 */
class helper
{
	/** @var \phpbb\user */
	protected $user;

	/** @var \phpbb\user_loader */
	protected $user_loader;

	/** @var \phpbb\language\language */
	protected $language;

	/** @var \phpbb\template\template */
	protected $template;

	/** @var \phpbb\log\log */
	protected $log;

	/** @var \phpbb\ads\location\manager */
	protected $location_manager;

	/** @var string root_path */
	protected $root_path;

	/** @var string php_ext */
	protected $php_ext;

	/**
	 * Constructor
	 *
	 * @param \phpbb\user                 $user             User object
	 * @param \phpbb\user_loader          $user_loader      User loader object
	 * @param \phpbb\language\language    $language         Language object
	 * @param \phpbb\template\template    $template         Template object
	 * @param \phpbb\log\log              $log              The phpBB log system
	 * @param \phpbb\ads\location\manager $location_manager Template location manager object
	 * @param string                      $root_path        phpBB root path
	 * @param string                      $php_ext          PHP extension
	 */
	public function __construct(\phpbb\user $user, \phpbb\user_loader $user_loader, \phpbb\language\language $language, \phpbb\template\template $template, \phpbb\log\log $log, \phpbb\ads\location\manager $location_manager, $root_path, $php_ext)
	{
		$this->user = $user;
		$this->user_loader = $user_loader;
		$this->language = $language;
		$this->template = $template;
		$this->log = $log;
		$this->location_manager = $location_manager;
		$this->root_path = $root_path;
		$this->php_ext = $php_ext;
	}

	/**
	 * Assign ad data for ACP form template.
	 *
	 * @param	array	$data	Ad data
	 * @param	array	$errors	Validation errors
	 */
	public function assign_data($data, $errors)
	{
		$this->assign_locations($data['ad_locations']);

		$errors = array_map(array($this->language, 'lang'), $errors);
		$this->template->assign_vars(array(
			'S_ERROR'   => (bool) count($errors),
			'ERROR_MSG' => count($errors) ? implode('<br />', $errors) : '',

			'AD_NAME'         	=> $data['ad_name'],
			'AD_NOTE'         	=> $data['ad_note'],
			'AD_CODE'         	=> $data['ad_code'],
			'AD_ENABLED'      	=> $data['ad_enabled'],
			'AD_END_DATE'     	=> $data['ad_end_date'],
			'AD_PRIORITY'     	=> $data['ad_priority'],
			'AD_CONTENT_ONLY'	=> $data['ad_content_only'],
			'AD_VIEWS_LIMIT'  	=> $data['ad_views_limit'],
			'AD_CLICKS_LIMIT' 	=> $data['ad_clicks_limit'],
			'AD_OWNER'        	=> $this->get_username($data['ad_owner']),
		));
	}

	/**
	 * Assign template locations data to the template.
	 *
	 * @param	mixed	$ad_locations	The form data or nothing.
	 * @return	void
	 */
	public function assign_locations($ad_locations = false)
	{
		foreach ($this->location_manager->get_all_locations() as $location_category_id => $location_category)
		{
			$this->template->assign_block_vars('ad_locations', array(
				'CATEGORY_NAME' => $this->language->lang($location_category_id),
			));

			foreach ($location_category as $location_id => $location_data)
			{
				$this->template->assign_block_vars('ad_locations', array(
					'LOCATION_ID'   => $location_id,
					'LOCATION_DESC' => $location_data['desc'],
					'LOCATION_NAME' => $location_data['name'],
					'S_SELECTED'    => $ad_locations ? in_array($location_id, $ad_locations) : false,
				));
			}
		}
	}

	/**
	 * Log action
	 *
	 * @param	string	$action		Performed action in uppercase
	 * @param	string	$ad_name	Advertisement name
	 * @return	void
	 */
	public 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));
	}

	/**
	 * Get "Find username" URL to easily look for ad owner.
	 *
	 * @return	string	Find username URL
	 */
	public function get_find_username_link()
	{
		return append_sid("{$this->root_path}memberlist.{$this->php_ext}", 'mode=searchuser&amp;form=acp_admanagement_add&amp;field=ad_owner&amp;select_single=true');
	}

	/**
	 * Generate URL to enable visual demo of ad locations.
	 *
	 * @return	string	Enable visual demo URL
	 */
	public function get_enable_visual_demo_link()
	{
		return append_sid("{$this->root_path}index.{$this->php_ext}", 'enable_visual_demo=true');
	}

	/**
	 * Is an ad expired?
	 *
	 * @param	array	$row	Advertisement data
	 * @return	bool	True if expired, false otherwise
	 */
	public function is_expired($row)
	{
		if ((int) $row['ad_end_date'] > 0 && (int) $row['ad_end_date'] < time())
		{
			return true;
		}

		if ($row['ad_views_limit'] && $row['ad_views'] >= $row['ad_views_limit'])
		{
			return true;
		}

		if ($row['ad_clicks_limit'] && $row['ad_clicks'] >= $row['ad_clicks_limit'])
		{
			return true;
		}

		return false;
	}

	/**
	 * Prepare ad owner for display. Method takes user_id
	 * of the ad owner and returns username.
	 *
	 * @param	int		$user_id	User ID
	 * @return	string	Username belonging to $user_id.
	 */
	protected function get_username($user_id)
	{
		if (!$user_id)
		{
			return '';
		}

		$this->user_loader->load_users(array($user_id));
		return $this->user_loader->get_username($user_id, 'username');
	}
}