vse\topicpreview\core\display

Complexity

Total Complexity

17

Size/Duplication

Total Lines	172
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
A	setup()	0	16	3
A	display_topic_preview()	0	30	2
A	get_text_helper()	0	10	4
A	get_user_avatar_helper()	0	22	4
A	get_theme()	0	9	3

<?php
/**
 *
 * Topic Preview
 *
 * @copyright (c) 2013 Matt Friedman
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace vse\topicpreview\core;

use phpbb\config\config;
use phpbb\event\dispatcher_interface;
use phpbb\language\language;
use phpbb\template\template;
use phpbb\user;
use vse\topicpreview\core\trim\trim;

class display extends base
{
	/** @var int default width of topic preview */
	const PREVIEW_SIZE = 360;

	/** @var int default height and width of topic preview avatars */
	const AVATAR_SIZE = 60;

	/** @var dispatcher_interface */
	protected $dispatcher;

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

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

	/** @var string phpBB root path */
	protected $root_path;

	/** @var trim */
	protected $trim;

	/**
	 * Constructor
	 *
	 * @param config               $config     Config object
	 * @param dispatcher_interface $dispatcher Event dispatcher object
	 * @param language             $language   Language object
	 * @param template             $template   Template object
	 * @param trim                 $trim       Trim text object
	 * @param user                 $user       User object
	 * @param string               $root_path
	 */
	public function __construct(config $config, dispatcher_interface $dispatcher, language $language, template $template, trim $trim, user $user, $root_path)
	{
		$this->dispatcher = $dispatcher;
		$this->language = $language;
		$this->template = $template;
		$this->trim = $trim;
		$this->root_path = $root_path;
		parent::__construct($config, $user);

		$this->setup();
	}

	/**
	 * Set up some common components
	 */
	public function setup()
	{
		// Load our language file (only needed if showing last post text)
		if ($this->last_post_enabled())
		{
			$this->language->add_lang('topic_preview', 'vse/topicpreview');
		}

		$this->template->assign_vars(array(
			'S_TOPICPREVIEW'		=> $this->is_enabled(),
			'TOPICPREVIEW_THEME'	=> $this->get_theme(),
			'TOPICPREVIEW_DELAY'	=> $this->config['topic_preview_delay'],
			'TOPICPREVIEW_DRIFT'	=> $this->config['topic_preview_drift'],
			'TOPICPREVIEW_WIDTH'	=> !empty($this->config['topic_preview_width']) ? $this->config['topic_preview_width'] : self::PREVIEW_SIZE,
		));
	}

	/**
	 * Inject topic preview text into the template
	 *
	 * @param array $row   Row data
	 * @param array $block Template vars array
	 *
	 * @return array Template vars array
	 */
	public function display_topic_preview($row, $block)
	{
		if (!$this->is_enabled())
		{
			return $block;
		}

		$block = array_merge($block, array(
			'TOPIC_PREVIEW_FIRST_POST'		=> $this->get_text_helper($row, 'first_post_text'),
			'TOPIC_PREVIEW_LAST_POST'		=> $this->get_text_helper($row, 'last_post_text'),
			'TOPIC_PREVIEW_FIRST_AVATAR'	=> $this->get_user_avatar_helper($row, 'fp'),
			'TOPIC_PREVIEW_LAST_AVATAR'		=> $this->get_user_avatar_helper($row, 'lp'),
		));

		$tp_avatars = $this->avatars_enabled();

		/**
		 * EVENT to modify the topic preview display output before it gets inserted in the template block
		 *
		 * @event vse.topicpreview.display_topic_preview
		 * @var array row        Topic row data
		 * @var array block      Template vars array
		 * @var bool  tp_avatars Display avatars setting
		 * @since 2.1.0
		 */
		$vars = array('row', 'block', 'tp_avatars');
		extract($this->dispatcher->trigger_event('vse.topicpreview.display_topic_preview', compact($vars)));

$this->dispatcher->trigger_event('vse.topicpreview.display_topic_preview', compact($vars)) cannot be passed to extract() as the parameter $var_array expects a reference.

		return $block;
	}

	/**
	 * Get topic preview text helper function
	 * This handles the trimming and censoring
	 *
	 * @param array  $row  User row data
	 * @param string $post The first or last post text column key
	 *
	 * @return string The trimmed and censored topic preview text
	 */
	protected function get_text_helper($row, $post)
	{
		// Ignore empty/unset text or when the last post is also the first (and only) post
		if (empty($row[$post]) || ($post === 'last_post_text' && $row['topic_first_post_id'] === $row['topic_last_post_id']))
		{
			return '';
		}

		return censor_text($this->trim->trim_text($row[$post], $this->config['topic_preview_limit']));
	}

	/**
	 * Get user avatar helper function
	 *
	 * @param array  $row    User row data
	 * @param string $poster Type of poster, fp or lp
	 *
	 * @return string Avatar image
	 */
	protected function get_user_avatar_helper($row, $poster)
	{
		if (!$this->avatars_enabled())
		{
			return '';
		}

		$avatar = '';
		if (!empty($row[$poster . '_avatar']))
		{
			$map = array(
				'avatar'		=> $row[$poster . '_avatar'],
				'avatar_type'	=> $row[$poster . '_avatar_type'],
				'avatar_width'	=> $row[$poster . '_avatar_width'],
				'avatar_height'	=> $row[$poster . '_avatar_height'],
			);
			$avatar = phpbb_get_user_avatar($map, 'USER_AVATAR', false, true);
		}

		// If avatar string is empty, fall back to no_avatar.gif
		return $avatar ?: '<img class="avatar" src="' . $this->root_path . 'styles/' . rawurlencode($this->user->style['style_path']) . '/theme/images/no_avatar.gif" width="' . self::AVATAR_SIZE . '" height="' . self::AVATAR_SIZE . '" alt="' . $this->language->lang('USER_AVATAR') . '" />';
	}

	/**
	 * Get user's style topic preview theme
	 * Fall back to no theme if expected theme not found
	 *
	 * @return mixed Theme name if theme file found, false otherwise
	 */
	protected function get_theme()
	{
		if (!empty($this->user->style['topic_preview_theme']) && file_exists($this->root_path . 'ext/vse/topicpreview/styles/all/theme/' . $this->user->style['topic_preview_theme'] . '.css'))
		{
			return $this->user->style['topic_preview_theme'];
		}

		return false;
	}
}