vse\abbc3\core\bbcodes_installer

Complexity

Total Complexity

19

Size/Duplication

Total Lines	208
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	12
Bugs	1	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	install_bbcodes()	0	16	3
A	__construct()	0	10	1
A	get_max_bbcode_id()	0	3	1
A	add_bbcode()	0	11	2
A	update_bbcode()	0	6	1
A	bbcode_exists()	0	11	1
A	get_acp_bbcodes()	0	8	2
A	delete_bbcodes()	0	13	3
A	build_bbcode()	0	10	1
A	remove_bbcode()	0	15	4

<?php
/**
 *
 * Advanced BBCode Box
 *
 * @copyright (c) 2016 Matt Friedman
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace vse\abbc3\core;

use phpbb\db\driver\driver_interface;

The type phpbb\db\driver\driver_interface was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\group\helper;

The type phpbb\group\helper was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\language\language;

The type phpbb\language\language was not found. Maybe you did not declare it correctly or list all dependencies?

use phpbb\request\request;

The type phpbb\request\request was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Class bbcodes_installer
 *
 * @package vse\abbc3\core
 */
class bbcodes_installer extends acp_manager
{
	/** @var \acp_bbcodes */

The type acp_bbcodes was not found. Maybe you did not declare it correctly or list all dependencies?

	protected $acp_bbcodes;

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

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

	/**
	 * Constructor
	 *
	 * @param driver_interface $db
	 * @param helper           $group_helper
	 * @param language         $language
	 * @param request          $request
	 * @param string           $phpbb_root_path
	 * @param string           $php_ext
	 * @access public
	 */
	public function __construct(driver_interface $db, helper $group_helper, language $language, request $request, $phpbb_root_path, $php_ext)
	{
		parent::__construct($db, $group_helper, $language, $request);

		$this->phpbb_root_path = $phpbb_root_path;
		$this->php_ext         = $php_ext;

		$this->acp_bbcodes     = $this->get_acp_bbcodes();

		$this->language->add_lang('acp/posting');
	}

	/**
	 * Installs bbcodes, used by migrations to perform add/updates
	 *
	 * @param array $bbcodes Array of bbcodes to install
	 * @access public
	 */
	public function install_bbcodes(array $bbcodes)
	{
		foreach ($bbcodes as $bbcode_name => $bbcode_data)
		{
			$bbcode_data = $this->build_bbcode($bbcode_data);

			if ($bbcode_id = $this->bbcode_exists($bbcode_name, $bbcode_data['bbcode_tag']))
			{
				$this->update_bbcode($bbcode_id, $bbcode_data);

$bbcode_id of type string is incompatible with the type integer expected by parameter $bbcode_id of vse\abbc3\core\bbcodes_installer::update_bbcode().

				continue;
			}

			$this->add_bbcode($bbcode_data);
		}

		$this->resynchronize_bbcode_order();
	}

	/**
	 * Deletes bbcodes, used by migrations to perform add/updates.
	 *
	 * @param array $bbcodes Array of bbcodes to delete
	 * @access public
	 */
	public function delete_bbcodes(array $bbcodes)
	{
		foreach ($bbcodes as $bbcode_name => $bbcode_data)
		{
			$bbcode_data = $this->build_bbcode($bbcode_data);

			if ($bbcode_id = $this->bbcode_exists($bbcode_name, $bbcode_data['bbcode_tag']))
			{
				$this->remove_bbcode($bbcode_id, $bbcode_data);

$bbcode_id of type string is incompatible with the type integer expected by parameter $bbcode_id of vse\abbc3\core\bbcodes_installer::remove_bbcode().

			}
		}

		$this->resynchronize_bbcode_order();
	}

	/**
	 * Get the acp_bbcodes class
	 *
	 * @return \acp_bbcodes
	 * @access protected
	 */
	protected function get_acp_bbcodes()
	{
		if (!class_exists('acp_bbcodes'))
		{
			include $this->phpbb_root_path . 'includes/acp/acp_bbcodes.' . $this->php_ext;
		}

		return new \acp_bbcodes();
	}

	/**
	 * Build the bbcode
	 *
	 * @param array $bbcode_data Initial bbcode data
	 * @return array Complete bbcode data array
	 * @access protected
	 */
	protected function build_bbcode(array $bbcode_data)
	{
		$data = $this->acp_bbcodes->build_regexp($bbcode_data['bbcode_match'], $bbcode_data['bbcode_tpl']);

		return array_replace($bbcode_data, [
			'bbcode_tag'          => $data['bbcode_tag'],
			'first_pass_match'    => $data['first_pass_match'],
			'first_pass_replace'  => $data['first_pass_replace'],
			'second_pass_match'   => $data['second_pass_match'],
			'second_pass_replace' => $data['second_pass_replace'],
		]);
	}

	/**
	 * Get the max bbcode id value
	 *
	 * @return int bbcode identifier
	 * @access protected
	 */
	protected function get_max_bbcode_id()
	{
		return $this->get_max_column_value('bbcode_id');
	}

	/**
	 * Check if bbcode exists
	 *
	 * @param string $bbcode_name Name of bbcode
	 * @param string $bbcode_tag  Tag name of bbcode
	 * @return string|false Existing bbcode identifier or false if not found
	 * @access protected
	 */
	public function bbcode_exists($bbcode_name, $bbcode_tag)
	{
		$sql = 'SELECT bbcode_id
			FROM ' . BBCODES_TABLE . "

The constant vse\abbc3\core\BBCODES_TABLE was not found. Maybe you did not declare it correctly or list all dependencies?

			WHERE LOWER(bbcode_tag) = '" . $this->db->sql_escape(strtolower($bbcode_name)) . "'
			OR LOWER(bbcode_tag) = '" . $this->db->sql_escape(strtolower($bbcode_tag)) . "'";
		$result = $this->db->sql_query($sql);
		$bbcode_id = $this->db->sql_fetchfield('bbcode_id');
		$this->db->sql_freeresult($result);

		return $bbcode_id;
	}

	/**
	 * Update existing bbcode
	 *
	 * @param int $bbcode_id bbcode identifier
	 * @param array $bbcode_data bbcode data
	 * @access protected
	 */
	protected function update_bbcode($bbcode_id, array $bbcode_data)
	{
		$sql = 'UPDATE ' . BBCODES_TABLE . '

The constant vse\abbc3\core\BBCODES_TABLE was not found. Maybe you did not declare it correctly or list all dependencies?

			SET ' . $this->db->sql_build_array('UPDATE', $bbcode_data) . '
			WHERE bbcode_id = ' . (int) $bbcode_id;
		$this->db->sql_query($sql);
	}

	/**
	 * Add new bbcode
	 *
	 * @param array $bbcode_data New bbcode data
	 * @access protected
	 */
	protected function add_bbcode(array $bbcode_data)
	{
		$bbcode_id = max($this->get_max_bbcode_id(), NUM_CORE_BBCODES) + 1;

The constant vse\abbc3\core\NUM_CORE_BBCODES was not found. Maybe you did not declare it correctly or list all dependencies?

		if ($bbcode_id <= BBCODE_LIMIT)

The constant vse\abbc3\core\BBCODE_LIMIT was not found. Maybe you did not declare it correctly or list all dependencies?

		{
			$bbcode_data['bbcode_id'] = (int) $bbcode_id;
			// set display_on_posting to 1 by default, so if 0 is desired, set it in our data array
			$bbcode_data['display_on_posting'] = (int) !array_key_exists('display_on_posting', $bbcode_data);

			$this->db->sql_query('INSERT INTO ' . BBCODES_TABLE . ' ' . $this->db->sql_build_array('INSERT', $bbcode_data));

The constant vse\abbc3\core\BBCODES_TABLE was not found. Maybe you did not declare it correctly or list all dependencies?

		}
	}

	/**
	 * Remove a bbcode
	 * Don't remove just by ID. Also match replace fields. This is to ensure we only delete BBCodes created by ABBC3,
	 * and not if, for example ABBC3 BBCodes that have been altered by the user.
	 *
	 * Note special handling for MSSQL Error: 402 The data types ntext and varchar are incompatible in the equal to operator
	 *
	 * @param int $bbcode_id bbcode identifier
	 * @param array $bbcode_data bbcode data
	 * @access protected
	 */
	protected function remove_bbcode($bbcode_id, array $bbcode_data)
	{
		static $is_mssql;

		if (!isset($is_mssql))
		{
			$is_mssql = strpos($this->db->get_sql_layer(), 'mssql') === 0;
		}

		$sql = 'DELETE FROM ' . BBCODES_TABLE . '

The constant vse\abbc3\core\BBCODES_TABLE was not found. Maybe you did not declare it correctly or list all dependencies?

			WHERE ' . ($is_mssql ? 'CONVERT(NVARCHAR(MAX), first_pass_match) = N' : 'first_pass_match = ') . "'" . $this->db->sql_escape($bbcode_data['first_pass_match']) . "'
				AND " . ($is_mssql ? 'CONVERT(NVARCHAR(MAX), first_pass_replace) = N' : 'first_pass_replace = ') . "'" . $this->db->sql_escape($bbcode_data['first_pass_replace']) . "'
				AND bbcode_id = " . (int) $bbcode_id;

		$this->db->sql_query($sql);
	}
}