skouat\ppde\controller\admin\settings_controller

Complexity

Total Complexity

7

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	21	1
A	display_settings()	0	38	1
A	build_stat_position_select_menu()	0	15	2
A	rebuild_items_list()	0	23	2
A	set_settings()	0	29	1

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

namespace skouat\ppde\controller\admin;

use phpbb\config\config;
use phpbb\language\language;
use phpbb\log\log;
use phpbb\request\request;
use phpbb\template\template;
use phpbb\user;
use skouat\ppde\helpers\auth_helper;
use skouat\ppde\actions\currency;
use skouat\ppde\actions\locale_icu;

/**
 * @property config   config             Config object
 * @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 request  request            Request object
 * @property bool     submit             State of submit $_POST variable
 * @property template template           Template object
 * @property string   u_action           Action URL
 * @property user     user               User object
 */
class settings_controller extends admin_main
{
	protected $ppde_auth;
	protected $ppde_actions_currency;
	protected $ppde_actions_locale;

	/**
	 * Constructor
	 *
	 * @param config      $config                Config object
	 * @param language    $language              Language user object
	 * @param log         $log                   The phpBB log system
	 * @param currency    $ppde_actions_currency PPDE currency actions object
	 * @param locale_icu  $ppde_actions_locale   PPDE locale actions object
	 * @param auth_helper $ppde_auth             PPDE auth actions object
	 * @param request     $request               Request object
	 * @param template    $template              Template object
	 * @param user        $user                  User object
	 */
	public function __construct(
		config $config,
		language $language,
		log $log,
		auth_helper $ppde_auth,
		currency $ppde_actions_currency,
		locale_icu $ppde_actions_locale,
		request $request,
		template $template,
		user $user
	)
	{
		$this->config = $config;
		$this->language = $language;
		$this->log = $log;
		$this->ppde_auth = $ppde_auth;
		$this->ppde_actions_currency = $ppde_actions_currency;
		$this->ppde_actions_locale = $ppde_actions_locale;
		$this->request = $request;
		$this->template = $template;
		$this->user = $user;
	}

	/**
	 * Display the general settings a user can configure for this extension
	 */
	public function display_settings(): void
	{
		// Define the name of the form for use as a form key
		add_form_key('ppde_settings');

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

		$this->submit_settings();

		// Set output vars for display in the template
		$this->s_error_assign_template_vars($errors);
		$this->u_action_assign_template_vars();
		$this->ppde_actions_currency->build_currency_select_menu((int) $this->config['ppde_default_currency']);
		$this->ppde_actions_locale->build_locale_select_menu($this->config['ppde_default_locale']);
		$this->build_remote_uri_select_menu((int) $this->config['ppde_default_remote'], 'live');
		$this->build_stat_position_select_menu($this->config['ppde_stats_position']);

		$this->template->assign_vars([
			// Global Settings vars
			'PPDE_ACCOUNT_ID'           => $this->check_config($this->config['ppde_account_id'], 'string'),
			'PPDE_DEFAULT_VALUE'        => $this->check_config($this->config['ppde_default_value'], 'integer', 0),
			'PPDE_DROPBOX_VALUE'        => $this->check_config($this->config['ppde_dropbox_value'], 'string', '1,2,3,4,5,10,20,25,50,100'),
			'S_PPDE_DEFAULT_LOCALE'     => $this->ppde_actions_locale->icu_requirements(),
			'S_PPDE_DROPBOX_ENABLE'     => $this->check_config($this->config['ppde_dropbox_enable']),
			'S_PPDE_ENABLE'             => $this->check_config($this->config['ppde_enable']),
			'S_PPDE_HEADER_LINK'        => $this->check_config($this->config['ppde_header_link']),
			'S_PPDE_ALLOW_GUEST'        => $this->check_config($this->config['ppde_allow_guest'], 'boolean', false),

			// Statistics Settings vars
			'PPDE_GOAL'                 => $this->check_config($this->config['ppde_goal'], 'float', 0),
			'PPDE_RAISED'               => $this->check_config($this->config['ppde_raised'], 'float', 0),
			'PPDE_USED'                 => $this->check_config($this->config['ppde_used'], 'float', 0),
			'S_PPDE_GOAL_ENABLE'        => $this->check_config($this->config['ppde_goal_enable']),
			'S_PPDE_RAISED_ENABLE'      => $this->check_config($this->config['ppde_raised_enable']),
			'S_PPDE_STATS_INDEX_ENABLE' => $this->check_config($this->config['ppde_stats_index_enable']),
			'S_PPDE_STATS_TEXT_ONLY'    => $this->check_config($this->config['ppde_stats_text_only']),
			'S_PPDE_USED_ENABLE'        => $this->check_config($this->config['ppde_used_enable']),
		]);
	}

	/**
	 * {@inheritdoc}
	 */
	protected function set_settings(): void
	{
		// Set options for Global settings
		$this->config->set('ppde_allow_guest', $this->request->variable('ppde_allow_guest', false));
		$this->config->set('ppde_default_currency', $this->request->variable('ppde_default_currency', 0));
		$this->config->set('ppde_default_locale', $this->request->variable('ppde_default_locale', $this->ppde_actions_locale->locale_get_default()));
		$this->config->set('ppde_default_value', $this->request->variable('ppde_default_value', 0));
		$this->config->set('ppde_dropbox_enable', $this->request->variable('ppde_dropbox_enable', false));
		$this->config->set('ppde_dropbox_value', $this->rebuild_items_list($this->request->variable('ppde_dropbox_value', '1,2,3,4,5,10,20,25,50,100'), (int) $this->config['ppde_default_value']));
		$this->config->set('ppde_enable', $this->request->variable('ppde_enable', false));
		$this->config->set('ppde_header_link', $this->request->variable('ppde_header_link', false));

		// Set options for Advanced settings
		$this->config->set('ppde_default_remote', $this->request->variable('ppde_default_remote', 0));

		// Set options for Statistics Settings
		$this->config->set('ppde_stats_index_enable', $this->request->variable('ppde_stats_index_enable', false));
		$this->config->set('ppde_stats_position', $this->request->variable('ppde_stats_position', 'bottom'));
		$this->config->set('ppde_stats_text_only', $this->request->variable('ppde_stats_text_only', false));
		$this->config->set('ppde_raised_enable', $this->request->variable('ppde_raised_enable', false));
		$this->config->set('ppde_raised', $this->request->variable('ppde_raised', 0.0));
		$this->config->set('ppde_goal_enable', $this->request->variable('ppde_goal_enable', false));
		$this->config->set('ppde_goal', $this->request->variable('ppde_goal', 0.0));
		$this->config->set('ppde_used_enable', $this->request->variable('ppde_used_enable', false));
		$this->config->set('ppde_used', $this->request->variable('ppde_used', 0.0));

		// Settings with dependencies are the last to be set.
		$this->config->set('ppde_account_id', $this->required_settings($this->request->variable('ppde_account_id', ''), (bool) $this->config['ppde_enable']));
		$this->ppde_auth->set_guest_acl();
	}

	/**
	 * Rebuilds the items list to conserve only numeric values.
	 *
	 * @param string $config_value The config value representing the initial items list.
	 * @param int    $added_value  The optional value to be added to the items list. Default is 0.
	 *
	 * @return string The rebuilt items list.
	 */
	private function rebuild_items_list(string $config_value, int $added_value = 0): string
	{
		$items_list = explode(',', $config_value);

		// Map each item in the list to an integer value
		$merged_items = array_map('intval', $items_list);

		// If $added_value is not zero, add it to $merged_items
		if ($added_value !== 0)
		{
			$merged_items[] = $added_value;
		}
		// Remove '0' values from $merged_items
		$merged_items = array_filter($merged_items);

		// Remove any duplicate items
		$merged_items = array_unique($merged_items);

		// Sort the items
		sort($merged_items, SORT_NUMERIC);

		// Convert array back to string and return
		return implode(',', $merged_items);
	}

	/**
	 * Build pull down menu options of available positions
	 *
	 * @param string $default Value of the selected item.
	 */
	public function build_stat_position_select_menu($default): void
	{
		// List of positions allowed
		$positions = ['top', 'bottom', 'both'];

		// Process each menu item for pull-down
		foreach ($positions as $position)
		{
			// Set output block vars for display in the template
			$this->template->assign_block_vars('positions_options', [
				'POSITION_NAME' => $position,
				'S_DEFAULT'     => (string) $default === $position,
			]);
		}
		unset ($positions);
	}
}