blitze\content\services\form\field\textarea

Complexity

Total Complexity

32

Size/Duplication

Total Lines	276
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

83.65%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	1
A	get_name()	0	4	1
A	get_default_props()	0	9	1
A	display_field()	0	18	3
A	show_form_field()	0	17	2
A	get_editor()	0	18	2
A	get_summary_value()	0	9	2
A	get_detail_value()	0	18	4
A	generate_page_nav()	0	6	1
B	generate_toc()	0	16	5
A	get_page_content()	0	14	2
A	allow_bbcode()	0	4	3
A	allow_flash_bbcode()	0	4	3
A	set_custom_bbcodes()	0	12	2

<?php
/**
 *
 * @package sitemaker
 * @copyright (c) 2013 Daniel A. (blitze)
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
 */

namespace blitze\content\services\form\field;

use Urodoz\Truncate\TruncateService;

class textarea extends base
{
	/** @var \phpbb\auth\auth */
	protected $auth;

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

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

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

	/** @var \blitze\sitemaker\services\util */
	protected $util;

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

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

	/**
	 * Constructor
	 *
	 * @param \phpbb\language\language					$language			Language object
	 * @param \phpbb\request\request_interface			$request			Request object
	 * @param \blitze\sitemaker\services\template		$ptemplate			Sitemaker template object
	 * @param \phpbb\auth\auth							$auth				Auth object
	 * @param \phpbb\config\config						$config				Config object
	 * @param \phpbb\pagination							$pagination			Pagination object
	 * @param \phpbb\template\template					$template			Template object
	 * @param \blitze\sitemaker\services\util			$util				Sitemaker utility object
	 * @param string									$phpbb_root_path	Path to the phpbb includes directory.
	 * @param string									$php_ext			php file extension
	 */
	public function __construct(\phpbb\language\language $language, \phpbb\request\request_interface $request, \blitze\sitemaker\services\template $ptemplate, \phpbb\auth\auth $auth, \phpbb\config\config $config, \phpbb\pagination $pagination, \phpbb\template\template $template, \blitze\sitemaker\services\util $util, $phpbb_root_path, $php_ext)
	{
		parent::__construct($language, $request, $ptemplate);

		$this->auth = $auth;
		$this->config = $config;
		$this->pagination = $pagination;
		$this->template = $template;
		$this->util = $util;
		$this->phpbb_root_path = $phpbb_root_path;
		$this->php_ext = $php_ext;
	}

	/**
	 * @inheritdoc
	 */
	public function get_name()
	{
		return 'textarea';
	}

	/**
	 * @inheritdoc
	 */
	public function get_default_props()
	{
		return array(
			'size'		=> 'large',
			'maxlength'	=> '',
			'max_chars'	=> 200,
			'editor'	=> true,
		);
	}

	/**
	 * Display content field
	 *
	 * @param array $data
	 * @param string $view_mode
	 * @param array $topic_data
	 * @return mixed
	 */
	public function display_field(array $data = array(), $view_mode = 'summary', array $topic_data = array())
	{
		$toc_pattern = '(<h4>(.*?)</h4>)?';
		$pages_pattern = '<p><!-- pagebreak --></p>';
		$split_pattern = $pages_pattern . (($view_mode !== 'detail') ? $toc_pattern : '');

		$pages = array_filter(preg_split('#' . $split_pattern . '#s', $data['field_value']));

		if ($view_mode !== 'detail')
		{
			return $this->get_summary_value(trim($pages[0]), $data['field_props']['max_chars']);
		}

		// get page titles to generate TOC
		preg_match_all('#' . $pages_pattern . $toc_pattern . '#s', $data['field_value'], $matches);

		return $this->get_detail_value($pages, $matches[2], $data);
	}

	/**
	 * @inheritdoc
	 */
	public function show_form_field($name, array &$data, $forum_id = 0)
	{
		if ($data['field_props']['editor'])
		{
			$asset_path = $this->util->get_web_path();
			$this->util->add_assets(array(
				'js'   => array(
					$asset_path . 'assets/javascript/editor.js',
					'@blitze_content/assets/fields/textarea.min.js'
				)
			));

			$data += $this->get_editor($forum_id);
		}

		return parent::show_form_field($name, $data);
	}

	/**
	 * @param int $forum_id
	 * @return array
	 */
	protected function get_editor($forum_id)
	{
		if (!$this->allow_bbcode($forum_id))
		{
			return array();
		}

		$this->set_custom_bbcodes();

		// HTML, BBCode, Smilies, Images and Flash status
		return array(
			'S_BBCODE_IMG'			=> $this->auth->acl_get('f_img', $forum_id),
			'S_LINKS_ALLOWED'		=> (bool) $this->config['allow_post_links'],
			'S_BBCODE_FLASH'		=> $this->allow_flash_bbcode($forum_id),
			'S_BBCODE_QUOTE'		=> false,
			'S_SMILIES_ALLOWED'		=> false,
		);
	}

	/**
	 * @param string $html
	 * @param int $max_chars
	 * @return string
	 */
	protected function get_summary_value($html, $max_chars)
	{
		if ($max_chars)
		{
			$truncateService = new TruncateService();
			$html = $truncateService->truncate($html, $max_chars);
		}
		return $html;
	}

	/**
	 * @param array $pages
	 * @param array $titles
	 * @param array $data
	 * @return mixed
	 */
	protected function get_detail_value(array $pages, array $titles, array $data)
	{
		if ($this->request->is_set('preview') || $this->request->variable('view', '') === 'print')
		{
			return join('<p><hr class="dashed"></p>', $pages);
		}

		$page = $this->request->variable('page', 0);

		$start = isset($pages[$page]) ? $page : 0;
		$total_pages = sizeof($pages);
		$topic_url = build_url(array('page'));

		$this->generate_page_nav($topic_url, $total_pages, $start);
		$this->generate_toc($start, $topic_url, array_slice($titles, 0, $total_pages - 1));

		return $this->get_page_content($start, $data['field_name'], $pages);
	}

	/**
	 * Generate pagination for topic subpages
	 *
	 * @param string $topic_url
	 * @param int $total_pages
	 * @param int $start
	 * @return void
	 */
	protected function generate_page_nav($topic_url, $total_pages, &$start)
	{
		$start = $this->pagination->validate_start($start, 1, $total_pages);
		$this->pagination->generate_template_pagination($topic_url, 'page', 'page', $total_pages, 1, $start);
		$this->template->assign_var('S_NOT_LAST_PAGE', !($start === ($total_pages - 1)));
	}

	/**
	 * Generate Table of contents
	 *
	 * @param int $start
	 * @param string $topic_url
	 * @param array $page_titles
	 * @return void
	 */
	protected function generate_toc($start, $topic_url, array $page_titles)
	{
		if (sizeof(array_filter($page_titles)))
		{
			$page_titles = array_merge(array($this->language->lang('CONTENT_TOC_OVERVIEW')), $page_titles);

			foreach ($page_titles as $page => $title)
			{
				$this->template->assign_block_vars('toc', array(
					'TITLE'		=> ($title) ? $title : $this->language->lang('CONTENT_TOC_UNTITLED'),
					'S_PAGE'	=> ($page === $start),
					'U_VIEW'	=> append_sid($topic_url, ($page) ? 'page=' . $page : false),
				));
			}
		}
	}

	/**
	 * When Previewing topic, we show all pages
	 *
	 * @param int $start
	 * @param string $field_name
	 * @param array $pages
	 * @return mixed
	 */
	protected function get_page_content($start, $field_name, array $pages)
	{
		$value = trim($pages[$start]);

		// Hide all other fields if we're looking at page 2+
		if ($start)
		{
			$value = array(
				$field_name => $value,
			);
		}

		return $value;
	}

	/**
	 * @param int $forum_id
	 * @return bool
	 */
	protected function allow_bbcode($forum_id)
	{
		return ($this->config['allow_bbcode'] && $this->auth->acl_get('f_bbcode', $forum_id)) ? true : false;
	}

	/**
	 * @param int $forum_id
	 * @return bool
	 */
	protected function allow_flash_bbcode($forum_id)
	{
		return ($this->auth->acl_get('f_flash', $forum_id) && $this->config['allow_post_flash']) ? true : false;
	}

	protected function set_custom_bbcodes()
	{
		// Assigning custom bbcodes
		if (!function_exists('display_custom_bbcodes'))
		{
			include($this->phpbb_root_path . 'includes/functions_display.' . $this->php_ext);
		}

		display_custom_bbcodes();

		$this->ptemplate->assign_block_vars_array('custom_tags', $this->template->retrieve_block_vars('custom_tags', array()));
	}
}