donation_pages_controller::__construct() - Code Metrics - Inspection of "Merge pull request #71 from Skouat/prep-release-2...." - Skouat/ext_paypal_donation - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Branch — 3.2.x (99ec7e)

by Mario
created 2019-05-25 21:15 UTC
donation_pages_controller::__construct() A

↳ Parent: donation_pages_controller
Complexity

Conditions	1
Paths	1
Size

Total Lines	27
Code Lines	14
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	14
nc	1
nop	10
dl	0
loc	27
rs	9.7998
c	0
b	0
f	0
How to fix Many Parameters

<?php
/**
 *
 * PayPal Donation extension for the phpBB Forum Software package.
 *
 * @copyright (c) 2015 Skouat
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace skouat\ppde\controller\admin;

use phpbb\language\language;
use phpbb\log\log;
use phpbb\request\request;
use phpbb\template\template;
use phpbb\user;
use skouat\ppde\operators\donation_pages;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * @property ContainerInterface container         Service container interface
 * @property string             id_prefix_name    Prefix name for identifier in the URL
 * @property string             lang_key_prefix   Prefix for the messages thrown by exceptions
 * @property language           language          Language user object
 * @property log                log               The phpBB log system.
 * @property string             module_name       Name of the module currently used
 * @property bool               preview           State of preview $_POST variable
 * @property request            request           Request object.
 * @property bool               submit            State of submit $_POST variable
 * @property template           template          Template object
 * @property user               user              User object.
 */
class donation_pages_controller extends admin_main
{
	protected $phpbb_root_path;
	protected $php_ext;
	protected $ppde_entity;
	protected $ppde_operator;
	protected $lang_local_name;

	/**
	 * Constructor
	 *
	 * @param ContainerInterface                 $container                    Service container interface
	 * @param language                           $language                     Language user object
	 * @param log                                $log                          The phpBB log system
	 * @param \skouat\ppde\entity\donation_pages $ppde_entity_donation_pages   PPDE Entity object
	 * @param donation_pages                     $ppde_operator_donation_pages Operator object
	 * @param request                            $request                      Request object
	 * @param template                           $template                     Template object
	 * @param user                               $user                         User object
	 * @param string                             $phpbb_root_path              phpBB root path
	 * @param string                             $php_ext                      phpEx
	 *
	 * @access public
	 */
	public function __construct(
		ContainerInterface $container,
		language $language,
		log $log,
		\skouat\ppde\entity\donation_pages $ppde_entity_donation_pages,
		donation_pages $ppde_operator_donation_pages,
		request $request,
		template $template,
		user $user,
		$phpbb_root_path,
		$php_ext
	)
	{
		$this->container = $container;
		$this->language = $language;
		$this->log = $log;
		$this->ppde_entity = $ppde_entity_donation_pages;
		$this->ppde_operator = $ppde_operator_donation_pages;
		$this->request = $request;
		$this->template = $template;
		$this->user = $user;
		$this->phpbb_root_path = $phpbb_root_path;
		$this->php_ext = $php_ext;
		parent::__construct(
			'donation_pages',
			'PPDE_DP',
			'page'
		);
	}

	/**
	 * Display the pages
	 *
	 * @return void
	 * @access public
	 */
	public function display()
	{
		// Get list of available language packs
		$langs = $this->ppde_operator->get_languages();

		// Set output vars
		foreach ($langs as $lang => $entry)
		{
			$this->assign_langs_template_vars($entry);

			// Grab all the pages from the db
			$data_ary = $this->ppde_entity->get_data($this->ppde_operator->build_sql_data($entry['id']));

			foreach ($data_ary as $data)
			{
				// Do not treat the item whether language identifier does not match
				if ($data['page_lang_id'] != $entry['id'])
				{
					continue;
				}

				$this->template->assign_block_vars('ppde_langs.dp_list', array(
					'DONATION_PAGE_TITLE' => $this->language->lang(strtoupper($data['page_title'])),
					'DONATION_PAGE_LANG'  => (string) $lang,
					'U_DELETE'            => $this->u_action . '&amp;action=delete&amp;' . $this->id_prefix_name . '_id=' . $data['page_id'],
					'U_EDIT'              => $this->u_action . '&amp;action=edit&amp;' . $this->id_prefix_name . '_id=' . $data['page_id'],
				));
			}
			unset($data_ary, $data);
		}
		unset($entry, $langs, $lang);

		$this->u_action_assign_template_vars();
	}

	/**
	 * Assign language template vars to a block vars
	 * $s_select is for build options select menu
	 *
	 * @param array $lang
	 * @param int   $current
	 *
	 * @return void
	 * @access private
	 */
	private function assign_langs_template_vars($lang, $current = 0)
	{
		$this->template->assign_block_vars('ppde_langs', array(
			'LANG_LOCAL_NAME' => $lang['name'],
			'VALUE'           => $lang['id'],
			'S_SELECTED'      => ((int) $lang['id'] == (int) $current) ? true : false,
		));
	}

	/**
	 * Add a donation page
	 *
	 * @return void
	 * @access public
	 */
	public function add()
	{
		// Add form key
		add_form_key('add_edit_donation_pages');

		// Collect the form data
		$data = array(
			'page_title'   => $this->request->variable('page_title', ''),
			'page_lang_id' => $this->request->variable('lang_id', '', true),
			'page_content' => $this->request->variable('page_content', '', true),
			'bbcode'       => !$this->request->variable('disable_bbcode', false),
			'magic_url'    => !$this->request->variable('disable_magic_url', false),
			'smilies'      => !$this->request->variable('disable_smilies', false),
		);

		// Set template vars for language select menu
		$this->create_language_options($data['page_lang_id']);

		// Process the new page
		$this->add_edit_donation_page_data($this->ppde_entity, $data);

		// Set output vars for display in the template
		$this->add_edit_action_assign_template_vars('add');
	}

	/**
	 * Set template var options for language select menus
	 *
	 * @param int $current ID of the language assigned to the donation page
	 *
	 * @return void
	 * @access protected
	 */
	protected function create_language_options($current)
	{
		// Grab all available language packs
		$langs = $this->ppde_operator->get_languages();

		// Set the options list template vars
		foreach ($langs as $lang)
		{
			$this->assign_langs_template_vars($lang, $current);
		}
	}

	/**
	 * Process donation pages data to be added or edited
	 *
	 * @param \skouat\ppde\entity\donation_pages $entity The donation pages entity object
	 * @param array                              $data   The form data to be processed
	 *
	 * @return void
	 * @access private
	 */
	private function add_edit_donation_page_data(\skouat\ppde\entity\donation_pages $entity, $data)
	{
		// Get form's POST actions (submit or preview)
		$this->submit = $this->request->is_set_post('submit');
		$this->preview = $this->request->is_set_post('preview');

		// Create an array to collect errors that will be output to the user
		$errors = array();

		// Load posting language file for the BBCode editor
		$this->language->add_lang('posting');

		$message_parse_options = array_merge(
			$this->get_message_parse_options($entity, $data, 'bbcode'),
			$this->get_message_parse_options($entity, $data, 'magic_url'),
			$this->get_message_parse_options($entity, $data, 'smilies')
		);

		// Set the message parse options in the entity
		foreach ($message_parse_options as $function => $enabled)
		{
			call_user_func(array($entity, ($enabled ? 'message_enable_' : 'message_disable_') . $function));
		}

		unset($message_parse_options);

		// Set the donation page's data in the entity
		$item_fields = array(
			'lang_id' => $data['page_lang_id'],
			'name'    => $data['page_title'],
			'message' => $data['page_content'],
		);
		$entity->set_entity_data($item_fields);

		// Check some settings before loading and submitting form
		$errors = array_merge($errors,
			$this->is_invalid_form('add_edit_' . $this->module_name, $this->submit_or_preview($this->submit)),
			$this->is_empty_data($entity, 'name', '', $this->submit_or_preview($this->submit)),
			$this->is_empty_data($entity, 'lang_id', 0, $this->submit_or_preview($this->submit))
		);

		// Grab predefined template vars
		$vars = $entity->get_vars();

		// Assign variables in a template block vars
		$this->assign_preview_template_vars($entity, $errors);
		$this->assign_predefined_block_vars($vars);

		// Submit form data
		$this->submit_data($entity, $errors);

		// Set output vars for display in the template
		$this->s_error_assign_template_vars($errors);
		$this->template->assign_vars(array(
			'DONATION_BODY'                  => $entity->get_message_for_edit(),
			'L_DONATION_PAGES_TITLE'         => $this->language->lang(strtoupper($entity->get_name())),
			'L_DONATION_PAGES_TITLE_EXPLAIN' => $this->language->lang(strtoupper($entity->get_name()) . '_EXPLAIN'),

			'S_BBCODE_DISABLE_CHECKED'    => !$entity->message_bbcode_enabled(),
			'S_MAGIC_URL_DISABLE_CHECKED' => !$entity->message_magic_url_enabled(),
			'S_SMILIES_DISABLE_CHECKED'   => !$entity->message_smilies_enabled(),

			'BBCODE_STATUS'  => $this->language->lang('BBCODE_IS_ON', '<a href="' . append_sid("{$this->phpbb_root_path}faq.{$this->php_ext}", 'mode=bbcode') . '">', '</a>'),
			'FLASH_STATUS'   => $this->language->lang('FLASH_IS_ON'),
			'IMG_STATUS'     => $this->language->lang('IMAGES_ARE_ON'),
			'SMILIES_STATUS' => $this->language->lang('SMILIES_ARE_ON'),
			'URL_STATUS'     => $this->language->lang('URL_IS_ON'),

			'S_BBCODE_ALLOWED'  => true,
			'S_BBCODE_FLASH'    => true,
			'S_BBCODE_IMG'      => true,
			'S_LINKS_ALLOWED'   => true,
			'S_SMILIES_ALLOWED' => true,
			'S_HIDDEN_FIELDS'   => '<input type="hidden" name="page_title" value="' . $entity->get_name() . '">',
		));

		// Display custom bbcodes and smilies
		$this->include_custom_bbcodes($this->user->optionget('bbcode') || $entity->message_bbcode_enabled());
		$this->include_custom_bbcodes($this->user->optionget(/** @scrutinizer ignore-type */ 'bbcode') || $entity->message_bbcode_enabled());
		$this->include_smilies($this->user->optionget('smilies') || $entity->message_smilies_enabled());
	}

	/**
	 * Get parse options of the message
	 *
	 * @param \skouat\ppde\entity\donation_pages $entity The donation pages entity object
	 * @param array                              $data   The form data to be processed
	 * @param string                             $type
	 *
	 * @return array
	 * @access private
	 */
	private function get_message_parse_options(\skouat\ppde\entity\donation_pages $entity, $data, $type)
	{
		return array($type => $this->submit_or_preview($this->submit, $this->preview) ? $data[$type] : (bool) call_user_func(array($entity, 'message_' . $type . '_enabled')));
	}

	/**
	 * Assign vars to the template if preview is true.
	 *
	 * @param \skouat\ppde\entity\donation_pages $entity The donation pages entity object
	 * @param array                              $errors
	 *
	 * @return void
	 * @access private
	 */
	private function assign_preview_template_vars(\skouat\ppde\entity\donation_pages $entity, $errors)
	{
		if ($this->preview && empty($errors))
		{
			// Set output vars for display in the template
			$this->template->assign_vars(array(
				'PPDE_DP_PREVIEW'   => $entity->replace_template_vars($entity->get_message_for_display()),
				'S_PPDE_DP_PREVIEW' => $this->preview,
			));
		}
	}

	/**
	 * Assign Predefined variables to a template block_vars
	 *
	 * @param array $vars
	 *
	 * @return void
	 * @access private
	 */
	private function assign_predefined_block_vars($vars)
	{
		for ($i = 0, $size = count($vars); $i < $size; $i++)
		{
			$this->template->assign_block_vars('dp_vars', array(
					'NAME'     => $vars[$i]['name'],
					'VARIABLE' => $vars[$i]['var'],
					'EXAMPLE'  => $vars[$i]['value'])
			);
		}
	}

	/**
	 *  Submit data to the database
	 *
	 * @param \skouat\ppde\entity\donation_pages $entity The donation pages entity object
	 * @param array                              $errors
	 *
	 * @return void
	 * @access private
	 */
	private function submit_data(\skouat\ppde\entity\donation_pages $entity, array $errors)
	{
		if ($this->can_submit_data($errors))
		{
			$this->trigger_error_data_already_exists($entity);

			// Grab the local language name
			$this->get_lang_local_name($this->ppde_operator->get_languages($entity->get_lang_id()));

			$log_action = $entity->add_edit_data();
			// Log and show user confirmation of the saved item and provide link back to the previous page
			$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_' . $this->lang_key_prefix . '_' . strtoupper($log_action), time(), array($this->language->lang(strtoupper($entity->get_name())), $this->lang_local_name));
			trigger_error($this->language->lang($this->lang_key_prefix . '_' . strtoupper($log_action), $this->lang_local_name) . adm_back_link($this->u_action));
		}
	}

	/**
	 * Get Local lang name
	 *
	 * @param array $langs
	 *
	 * @return void
	 * @access private
	 */
	private function get_lang_local_name($langs)
	{
		foreach ($langs as $lang)
		{
			$this->lang_local_name = $lang['name'];
		}
	}

	/**
	 * @param $bbcode_enabled
	 *
	 * @return void
	 * @access private
	 */
	private function include_custom_bbcodes($bbcode_enabled)
	{
		if ($bbcode_enabled)
		{
			$this->include_function('display_custom_bbcodes', $this->phpbb_root_path . 'includes/functions_display.' . $this->php_ext);
			display_custom_bbcodes();
		}
	}

	/**
	 * Includes the file that contains the function, if not loaded.
	 *
	 * @param string $function_name     Name of the function to test
	 * @param string $function_filepath Path of the file that containing the function
	 *
	 * @return void
	 * @access private
	 */
	private function include_function($function_name, $function_filepath)
	{
		if (!function_exists($function_name))
		{
			include($function_filepath);
		}
	}

	/**
	 * @param bool $smilies_enabled
	 *
	 * @return void
	 * @access private
	 */
	private function include_smilies($smilies_enabled)
	{
		if ($smilies_enabled)
		{
			$this->include_function('generate_smilies', $this->phpbb_root_path . 'includes/functions_posting.' . $this->php_ext);
			generate_smilies('inline', 0);
		}
	}

	/**
	 * Edit a donation page
	 *
	 * @param int $page_id Donation page identifier
	 *
	 * @return void
	 * @access public
	 */
	public function edit($page_id)
	{
		// Add form key
		add_form_key('add_edit_donation_pages');

		// Load data
		$this->ppde_entity->load($page_id);

		// Collect the form data
		$data = array(
			'page_id'      => (int) $page_id,
			'page_title'   => $this->request->variable('page_title', $this->ppde_entity->get_name(), false),
			'page_lang_id' => $this->request->variable('page_lang_id', $this->ppde_entity->get_lang_id()),
			'page_content' => $this->request->variable('page_content', $this->ppde_entity->get_message_for_edit(), true),
			'bbcode'       => !$this->request->variable('disable_bbcode', false),
			'magic_url'    => !$this->request->variable('disable_magic_url', false),
			'smilies'      => !$this->request->variable('disable_smilies', false),
		);

		// Set template vars for language select menu
		$this->create_language_options($data['page_lang_id']);

		// Process the new page
		$this->add_edit_donation_page_data($this->ppde_entity, $data);

		// Set output vars for display in the template
		$this->add_edit_action_assign_template_vars('edit', $page_id);
	}

	/**
	 * Delete a donation page
	 *
	 * @param int $page_id The donation page identifier to delete
	 *
	 * @return void
	 * @access public
	 */
	public function delete($page_id)
	{
		// Load data
		$this->ppde_entity->load($page_id);

		// Before deletion, grab the local language name
		$this->get_lang_local_name($this->ppde_operator->get_languages($this->ppde_entity->get_lang_id()));

		$this->ppde_entity->delete($page_id);

		// Log the action
		$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_' . $this->lang_key_prefix . '_DELETED', time(), array($this->language->lang(strtoupper($this->ppde_entity->get_name())), $this->lang_local_name));

		// If AJAX was used, show user a result message
		$message = $this->language->lang($this->lang_key_prefix . '_DELETED', $this->lang_local_name);
		$this->ajax_delete_result_message($message);
	}
}

Skouat / ext_paypal_donation

Branch — 3.2.x (99ec7e)

donation_pages_controller::__construct() A

Complexity

Size

Duplication

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like
