transactions_controller::build_data_ary() - Code Metrics - Inspection of "Refactor action/currency class" - Skouat/ext_paypal_donation - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — develop-3.3.x ( 95f552...b7db6e )

by Mario
created 2024-10-06 13:26 UTC
transactions_controller::build_data_ary() A

↳ Parent: transactions_controller
Complexity

Conditions	3
Paths	4
Size

Total Lines	72
Code Lines	54
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	0	Features	0
Metric	Value
cc	3
eloc	54
c	2
b	0
f	0
nc	4
nop	1
dl	0
loc	72
rs	9.0036
How to fix Long Method

<?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\auth\auth;
use phpbb\config\config;
use phpbb\language\language;
use phpbb\log\log;
use phpbb\request\request;
use phpbb\template\template;
use phpbb\user;
use phpbb\user_loader;
use skouat\ppde\actions\core;
use skouat\ppde\actions\currency;
use skouat\ppde\exception\transaction_exception;
use skouat\ppde\operators\transactions;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * @property array              args               Array of args for hidden fiels
 * @property config             config             Config object
 * @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 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.
 * @property user_loader        user_loader        User loader object
 */
class transactions_controller extends admin_main
{
	public $ppde_operator;
	protected $adm_relative_path;
	protected $auth;
	protected $user_loader;
	protected $entry_count;
	protected $last_page_offset;
	protected $php_ext;
	protected $phpbb_admin_path;
	protected $phpbb_root_path;
	protected $ppde_actions;
	protected $ppde_actions_currency;
	protected $ppde_entity;
	protected $table_prefix;
	protected $table_ppde_transactions;

	/**
	 * Constructor
	 *
	 * @param auth                             $auth                       Authentication object
	 * @param config                           $config                     Config object
	 * @param ContainerInterface               $container                  Service container interface
	 * @param language                         $language                   Language user object
	 * @param log                              $log                        The phpBB log system
	 * @param core                             $ppde_actions               PPDE actions object
	 * @param currency                         $ppde_actions_currency      PPDE currency actions object
	 * @param \skouat\ppde\entity\transactions $ppde_entity_transactions   Entity object
	 * @param transactions                     $ppde_operator_transactions Operator object
	 * @param request                          $request                    Request object
	 * @param template                         $template                   Template object
	 * @param user                             $user                       User object.
	 * @param user_loader                      $user_loader                User loader object
	 * @param string                           $adm_relative_path          phpBB admin relative path
	 * @param string                           $phpbb_root_path            phpBB root path
	 * @param string                           $php_ext                    phpEx
	 * @param string                           $table_prefix               The table prefix
	 * @param string                           $table_ppde_transactions    Name of the table used to store data
	 *
	 * @access public
	 */
	public function __construct(
		auth $auth,
		config $config,
		ContainerInterface $container,
		language $language,
		log $log,
		core $ppde_actions,
		currency $ppde_actions_currency,
		\skouat\ppde\entity\transactions $ppde_entity_transactions,
		transactions $ppde_operator_transactions,
		request $request,
		template $template,
		user $user,
		user_loader $user_loader,
		string $adm_relative_path,
		string $phpbb_root_path,
		string $php_ext,
		string $table_prefix,
		string $table_ppde_transactions
	)
	{
		$this->auth = $auth;
		$this->config = $config;
		$this->container = $container;
		$this->language = $language;
		$this->log = $log;
		$this->ppde_actions = $ppde_actions;
		$this->ppde_actions_currency = $ppde_actions_currency;
		$this->ppde_entity = $ppde_entity_transactions;
		$this->ppde_operator = $ppde_operator_transactions;
		$this->request = $request;
		$this->template = $template;
		$this->user = $user;
		$this->user_loader = $user_loader;
		$this->adm_relative_path = $adm_relative_path;
		$this->phpbb_admin_path = $phpbb_root_path . $adm_relative_path;
		$this->phpbb_root_path = $phpbb_root_path;
		$this->php_ext = $php_ext;
		$this->table_prefix = $table_prefix;
		$this->table_ppde_transactions = $table_ppde_transactions;
		parent::__construct(
			'transactions',
			'PPDE_DT',
			'transaction'
		);
	}

	/**
	 * {@inheritdoc}
	 */
	public function display(): void
	{
		// Sorting and pagination setup
		$sort_by_text = $this->get_sort_by_text_options();
		$sort_by_sql = $this->get_sort_options();
		$sort_key = $this->request->variable('sk', 't');
		$sort_dir = $this->request->variable('sd', 'd');
		$start = $this->request->variable('start', 0);
		$limit = (int) $this->config['topics_per_page'];

		// Filtering setup
		$limit_days = $this->get_limit_day_options();
		$selected_days = $this->request->variable('st', 0);
		$keywords = $this->request->variable('keywords', '', true);

		// Generate sorting and filtering selects
		$s_limit_days = $s_sort_key = $s_sort_dir = $u_sort_param = '';
		gen_sort_selects($limit_days, $sort_by_text, $selected_days, $sort_key, $sort_dir, $s_limit_days, $s_sort_key, $s_sort_dir, $u_sort_param);

		// Prepare SQL conditions
		$sql_sort = $sort_by_sql[$sort_key] . ' ' . (($sort_dir === 'd') ? 'DESC' : 'ASC');

		// Fetch log data
		$log_data = [];
		$log_count = 0;
		$log_time = $this->calculate_timestamp($selected_days);
		$this->view_txn_log($log_data, $log_count, $limit, $start, $log_time, $sql_sort, $keywords);

		// Generate pagination
		$this->generate_pagination($log_count, $limit, $start, $u_sort_param, $keywords);

		// Assign template variables
		$this->template->assign_vars([
			'S_CLEARLOGS'  => $this->auth->acl_get('a_ppde_manage'),
			'S_KEYWORDS'   => $keywords,
			'S_LIMIT_DAYS' => $s_limit_days,
			'S_SORT_KEY'   => $s_sort_key,
			'S_SORT_DIR'   => $s_sort_dir,
			'U_ACTION'     => $this->u_action . '&amp;' . $u_sort_param . $this->get_keywords_param($keywords) . '&amp;start=' . $start,
		]);

		// Assign log entries to template
		$this->assign_log_entries_to_template($log_data);
	}

	/**
	 * Get sort by text options for transactions.
	 *
	 * @return array An associative array of sort options and their corresponding language strings.
	 */
	private function get_sort_by_text_options(): array
	{
		return [
			'txn'      => $this->language->lang('PPDE_DT_SORT_TXN_ID'),
			'u'        => $this->language->lang('PPDE_DT_SORT_DONORS'),
			'ipn'      => $this->language->lang('PPDE_DT_SORT_IPN_STATUS'),
			'ipn_test' => $this->language->lang('PPDE_DT_SORT_IPN_TYPE'),
			'ps'       => $this->language->lang('PPDE_DT_SORT_PAYMENT_STATUS'),
			't'        => $this->language->lang('SORT_DATE'),
		];
	}

	/**
	 * Get sort options for transactions.
	 *
	 * @return array An associative array of sort keys and their corresponding SQL column names.
	 */
	private function get_sort_options(): array
	{
		return [
			'txn'      => 'txn.txn_id',
			'u'        => 'u.username_clean',
			'ipn'      => 'txn.confirmed',
			'ipn_test' => 'txn.test_ipn',
			'ps'       => 'txn.payment_status',
			't'        => 'txn.payment_date',
		];
	}

	/**
	 * Get limit day options for filtering.
	 *
	 * @return array An associative array of day limits and their corresponding language strings.
	 */
	private function get_limit_day_options(): array
	{
		return [
			0   => $this->language->lang('ALL_ENTRIES'),
			1   => $this->language->lang('1_DAY'),
			7   => $this->language->lang('7_DAYS'),
			14  => $this->language->lang('2_WEEKS'),
			30  => $this->language->lang('1_MONTH'),
			90  => $this->language->lang('3_MONTHS'),
			180 => $this->language->lang('6_MONTHS'),
			365 => $this->language->lang('1_YEAR'),
		];
	}

	/**
	 * Calculate the timestamp for filtering transactions based on the selected number of days.
	 *
	 * @param int $selected_days Number of days to look back for transactions.
	 *
	 * @return int The calculated timestamp, or 0 if no day limit is set.
	 */
	private function calculate_timestamp(int $selected_days): int
	{
		return $selected_days > 0 ? time() - ($selected_days * self::SECONDS_IN_A_DAY) : 0;
	}

	/**
	 * View transaction log.
	 *
	 * @param array &$log        The result array with the logs.
	 * @param mixed &$log_count  If $log_count is set to false, we will skip counting all entries in the database.
	 *                           Otherwise an integer with the number of total matching entries is returned.
	 * @param int    $limit      Limit the number of entries that are returned.
	 * @param int    $offset     Offset when fetching the log entries, e.g. when paginating.
	 * @param int    $log_time   Timestamp to filter logs.
	 * @param string $sort_by    SQL order option, e.g. 'l.log_time DESC'.
	 * @param string $keywords   Will only return log entries that have the keywords in log_operation or log_data.
	 *
	 * @return void Returns the offset of the last valid page, if the specified offset was invalid (too high)
	 * @access private
	 */
	private function view_txn_log(array &$log, &$log_count, int $limit = 0, int $offset = 0, int $log_time = 0, string $sort_by = 'txn.payment_date DESC', string $keywords = ''): void
	{
		$count_logs = ($log_count !== false);

		$log = $this->get_logs($count_logs, $limit, $offset, $log_time, $sort_by, $keywords);
		$log_count = $this->get_log_count();
	}

	/**
	 * Get logs based on specified parameters.
	 *
	 * @param bool   $count_logs Whether to count the total number of logs.
	 * @param int    $limit      Maximum number of logs to retrieve.
	 * @param int    $offset     Starting point for retrieving logs.
	 * @param int    $log_time   Timestamp to filter logs.
	 * @param string $sort_by    SQL ORDER BY clause.
	 * @param string $keywords   Keywords to filter logs.
	 *
	 * @return array Array of log entries.
	 * @access private
	 */
	private function get_logs(bool $count_logs = true, int $limit = 0, int $offset = 0, int $log_time = 0, string $sort_by = 'txn.payment_date DESC', string $keywords = ''): array
	{
		$this->entry_count = 0;
		$this->last_page_offset = $offset;
		$url_ary = [];

		if ($this->phpbb_admin_path && $this->ppde_actions->is_in_admin())
		{
			$url_ary['profile_url'] = append_sid($this->phpbb_admin_path . 'index.' . $this->php_ext, 'i=users&amp;mode=overview');
			$url_ary['txn_url'] = append_sid($this->phpbb_admin_path . 'index.' . $this->php_ext, 'i=-skouat-ppde-acp-ppde_module&amp;mode=transactions');

		}
		else
		{
			$url_ary['profile_url'] = append_sid($this->phpbb_root_path . 'memberlist.' . $this->php_ext, 'mode=viewprofile');
			$url_ary['txn_url'] = '';
		}

		$get_logs_sql_ary = $this->ppde_operator->get_logs_sql_ary($keywords, $sort_by, $log_time);

		if ($count_logs)
		{
			$this->entry_count = $this->ppde_operator->query_sql_count($get_logs_sql_ary, 'txn.transaction_id');

			if ($this->entry_count === 0)
			{
				// Save the queries, because there are no logs to display
				$this->last_page_offset = 0;

				return [];
			}

			// Return the user to the last page that is valid
			while ($this->last_page_offset >= $this->entry_count)
			{
				$this->last_page_offset = max(0, $this->last_page_offset - $limit);
			}
		}

		return $this->ppde_operator->build_log_entries($get_logs_sql_ary, $url_ary, $limit, $this->last_page_offset);
	}

	/**
	 * Get the total count of log entries.
	 *
	 * @return int The total number of log entries.
	 */
	public function get_log_count(): int
	{
		return (int) $this->entry_count ?: 0;
	}

	/**
	 * Generate pagination for transaction list.
	 *
	 * @param int    $log_count    Total number of log entries.
	 * @param int    $limit        Number of entries per page.
	 * @param int    $start        Starting offset for the current page.
	 * @param string $u_sort_param URL parameters for sorting.
	 * @param string $keywords     Search keywords.
	 */
	private function generate_pagination(int $log_count, int $limit, int $start, string $u_sort_param, string $keywords): void
	{
		$pagination = $this->container->get('pagination');
		$base_url = $this->u_action . '&amp;' . $u_sort_param . $this->get_keywords_param($keywords);
		$pagination->generate_template_pagination($base_url, 'pagination', 'start', $log_count, $limit, $start);
	}

	/**
	 * Get keywords parameter for URL.
	 *
	 * @param string $keywords Search keywords.
	 *
	 * @return string URL-encoded keywords parameter.
	 */
	private function get_keywords_param(string $keywords): string
	{
		return !empty($keywords) ? '&amp;keywords=' . urlencode(htmlspecialchars_decode($keywords)) : '';
	}

	/**
	 * Assign log entries to template.
	 *
	 * @param array $log_data Array of log entries.
	 */
	private function assign_log_entries_to_template(array $log_data): void
	{
		foreach ($log_data as $row)
		{
			$this->template->assign_block_vars('log', [
				'CONFIRMED'        => ($row['confirmed']) ? $this->language->lang('PPDE_DT_VERIFIED') : $this->language->lang('PPDE_DT_UNVERIFIED'),
				'DATE'             => $this->user->format_date($row['payment_date']),
				'ID'               => $row['transaction_id'],
				'PAYMENT_STATUS'   => $this->language->lang(['PPDE_DT_PAYMENT_STATUS_VALUES', strtolower($row['payment_status'])]),
				'TXN_ID'           => $row['txn_id'],
				'USERNAME'         => $row['username_full'],
				'S_CONFIRMED'      => (bool) $row['confirmed'],
				'S_PAYMENT_STATUS' => strtolower($row['payment_status']) === 'completed',
				'S_TXN_ERRORS'     => !empty($row['txn_errors']),
				'S_TEST_IPN'       => (bool) $row['test_ipn'],
			]);
		}
	}

	/**
	 * Gets vars from POST then build a array of them
	 *
	 * @param string $id     Module id
	 * @param string $mode   Module categorie
	 * @param string $action Action name
	 *
	 * @return void
	 * @access private
	 */
	public function set_hidden_fields($id, $mode, $action): void
	{
		$this->args['action'] = $action;
		$this->args['hidden_fields'] = [
			'start'     => $this->request->variable('start', 0),
			'delall'    => $this->request->variable('delall', false, false, \phpbb\request\request_interface::POST),
			'delmarked' => $this->request->variable('delmarked', false, false, \phpbb\request\request_interface::POST),
			'i'         => $id,
			'mark'      => $this->request->variable('mark', [0]),
			'mode'      => $mode,
			'st'        => $this->request->variable('st', 0),
			'sk'        => $this->request->variable('sk', 't'),
			'sd'        => $this->request->variable('sd', 'd'),
		];

		// Prepares args depending actions
		if (($this->args['hidden_fields']['delall'] || ($this->args['hidden_fields']['delmarked'] && count($this->args['hidden_fields']['mark']))) && $this->auth->acl_get('a_ppde_manage'))

		{
			$this->args['action'] = 'delete';
		}
		else if ($this->request->is_set('approve'))
		{
			$this->args['action'] = 'approve';
			$this->args['hidden_fields'] = array_merge($this->args['hidden_fields'], [
				'approve'             => true,
				'id'                  => $this->request->variable('id', 0),
				'txn_errors_approved' => $this->request->variable('txn_errors_approved', 0),
			]);
		}
		else if ($this->request->is_set('add'))
		{
			$this->args['action'] = 'add';
		}
		else if ($this->request->is_set_post('change'))
		{
			$this->args['action'] = 'change';
		}
	}

	public function get_hidden_fields(): array
	{
		return array_merge(
			['i'                           => $this->args['hidden_fields']['i'],
			 'mode'                        => $this->args['hidden_fields']['mode'],
			 'action'                      => $this->args['action'],
			 $this->id_prefix_name . '_id' => $this->args[$this->id_prefix_name . '_id']],
			$this->args['hidden_fields']);
	}

	/**
	 * {@inheritdoc}
	 */
	public function change(): void
	{
		$username = $this->request->variable('username', '', true);
		$donor_id = $this->request->variable('donor_id', 0);

		try
		{
			$user_id = $this->validate_user_id($username, $donor_id);
		}
		catch (transaction_exception $e)
		{
			trigger_error(implode('<br>', $e->get_errors()) . adm_back_link($this->u_action), E_USER_WARNING);
		}

		// Request Identifier of the transaction
		$transaction_id = $this->request->variable('id', 0);

		$this->ppde_entity->load($transaction_id);

		if (!$this->ppde_entity->data_exists($this->ppde_entity->build_sql_data_exists()))
		{
			trigger_error($this->language->lang('PPDE_DT_NO_TRANSACTION') . adm_back_link($this->u_action), E_USER_WARNING);
		}

		$log_action = $this->ppde_entity
			->set_user_id($user_id)
			->add_edit_data()
		;

		$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_' . $this->lang_key_prefix . '_' . strtoupper($log_action));
		trigger_error($this->language->lang($this->lang_key_prefix . '_' . strtoupper($log_action)) . adm_back_link($this->u_action));
	}

	/**
	 * Returns the intended user ID
	 *
	 * @param string $username
	 * @param int    $donor_id
	 *
	 * @return int returns user_id
	 * @throws transaction_exception if the user_id is less than or equal to the default value for ANONYMOUS.
	 * @access private
	 */
	private function validate_user_id($username, $donor_id = 0): int
	{
		if ($this->should_return_anonymous($username, $donor_id))
		{
			return ANONYMOUS;
		}

		$user_id = ($username !== '') ? $this->user_loader->load_user_by_username($username) : $donor_id;

		if ($user_id <= ANONYMOUS)
		{
			throw (new transaction_exception())->set_errors([$this->language->lang('PPDE_MT_DONOR_NOT_FOUND')]);
		}

		return $user_id;
	}

	/**
	 * Determines if the given username and donor ID should result in an anonymous response.
	 *
	 * @param string $username The username to check.
	 * @param int    $donor_id The donor ID to check.
	 * @return bool Returns true if the username is empty and either the donor ID is ANONYMOUS or the 'u' parameter is
	 *                         set in the URL. Otherwise, returns false.
	 */
	private function should_return_anonymous(string $username, int $donor_id): bool
	{
		// if the username is empty and (donor_id is ANONYMOUS or 'u' parameter is set in URL),
		return $username === '' && ($donor_id === ANONYMOUS || $this->request->is_set('u'));
	}

	/**
	 * {@inheritdoc}
	 */
	public function add(): void
	{
		$errors = [];

		$transaction_data = $this->request_transaction_vars();

		if ($this->is_form_submitted())
		{
			$errors = $this->process_transaction($transaction_data, $errors);
		}
		$this->prepare_add_template($errors, $transaction_data);
	}

	/**
	 * Returns requested data from manual transaction form
	 *
	 * @return array
	 * @access private
	 */
	private function request_transaction_vars(): array
	{
		return [
			'MT_ANONYMOUS'          => $this->request->is_set('u'),
			'MT_USERNAME'           => $this->request->variable('username', '', true),
			'MT_FIRST_NAME'         => $this->request->variable('first_name', '', true),
			'MT_LAST_NAME'          => $this->request->variable('last_name', '', true),
			'MT_PAYER_EMAIL'        => $this->request->variable('payer_email', '', true),
			'MT_RESIDENCE_COUNTRY'  => $this->request->variable('residence_country', ''),
			'MT_MC_GROSS'           => $this->request->variable('mc_gross', 0.0),
			'MT_MC_CURRENCY'        => $this->request->variable('mc_currency', ''),
			'MT_MC_FEE'             => $this->request->variable('mc_fee', 0.0),
			'MT_PAYMENT_DATE_YEAR'  => $this->request->variable('payment_date_year', (int) $this->user->format_date(time(), 'Y')),
			'MT_PAYMENT_DATE_MONTH' => $this->request->variable('payment_date_month', (int) $this->user->format_date(time(), 'n')),
			'MT_PAYMENT_DATE_DAY'   => $this->request->variable('payment_date_day', (int) $this->user->format_date(time(), 'j')),
			'MT_PAYMENT_TIME'       => $this->request->variable('payment_time', $this->user->format_date(time(), 'H:i:s')),
			'MT_MEMO'               => $this->request->variable('memo', '', true),
		];
	}

	/**
	 * Process a transaction with the given transaction data and handle any errors that occur.
	 *
	 * @param array $transaction_data The data for the transaction.
	 * @param array $errors           The array to store any errors that occur during processing.
	 *
	 * @return array The updated array of errors after processing the transaction.
	 */
	private function process_transaction(array $transaction_data, array $errors): array
	{
		try
		{
			$this->ppde_actions->log_to_db($this->build_data_ary($transaction_data));

			// Prepare transaction settings before doing actions
			$this->ppde_actions->set_transaction_data($transaction_data);
			$this->ppde_actions->is_donor_is_member();

			$this->do_transactions_actions($this->ppde_actions->get_donor_is_member() && !$transaction_data['MT_ANONYMOUS']);

			$this->log_transaction($transaction_data);
		}
		catch (transaction_exception $e)
		{
			$errors = $e->get_errors();
		}

		return $errors;
	}

	/**
	 * Prepare data array before send it to $this->entity
	 *
	 * @param array $transaction_data
	 *
	 * @return array
	 * @throws transaction_exception
	 * @access private
	 */
	private function build_data_ary($transaction_data): array
	{
		$errors = [];

		try
		{
			$user_id = $this->validate_user_id($transaction_data['MT_USERNAME']);
		}
		catch (transaction_exception $e)
		{
			$errors = $e->get_errors();
		}

		$payment_date = implode('-', [
			$transaction_data['MT_PAYMENT_DATE_YEAR'],
			$transaction_data['MT_PAYMENT_DATE_MONTH'],
			$transaction_data['MT_PAYMENT_DATE_DAY'],
		]);

		$payment_date_timestamp_at_midnight = $this->user->get_timestamp_from_format('Y-m-d H:i:s', $payment_date . ' 00:00:00');
		$payment_time = $transaction_data['MT_PAYMENT_TIME'];
		$payment_time_timestamp = strtotime($payment_time);

		// Normalize payment time to start from today at midnight
		$payment_time_timestamp_from_midnight = $payment_time_timestamp - strtotime('00:00:00');

		$payment_date_time = $payment_date_timestamp_at_midnight + $payment_time_timestamp_from_midnight;

		$errors = array_merge($errors,
			$this->mc_gross_too_low($transaction_data),
			$this->mc_fee_negative($transaction_data),
			$this->mc_fee_too_high($transaction_data),
			$this->payment_date_timestamp_at_midnight($payment_date_timestamp_at_midnight, $payment_date),
			$this->payment_time_timestamp($payment_time_timestamp, $payment_date),
			$this->payment_date_time((string) $payment_date_time));

		if (count($errors))
		{
			throw (new transaction_exception())->set_errors($errors);
		}

		return [
			'business'          => $this->config['ppde_account_id'],
			'confirmed'         => true,
			'custom'            => implode('_', ['uid', $user_id, time()]),
			'exchange_rate'     => '',
			'first_name'        => $transaction_data['MT_FIRST_NAME'],
			'item_name'         => '',
			'item_number'       => implode('_', ['uid', $user_id, time()]),
			'last_name'         => $transaction_data['MT_LAST_NAME'],
			'mc_currency'       => $transaction_data['MT_MC_CURRENCY'],
			'mc_gross'          => $transaction_data['MT_MC_GROSS'],
			'mc_fee'            => $transaction_data['MT_MC_FEE'],
			'net_amount'        => 0.0, // This value is calculated in core_actions:log_to_db()
			'parent_txn_id'     => '',
			'payer_email'       => $transaction_data['MT_PAYER_EMAIL'],
			'payer_id'          => '',
			'payer_status'      => '',
			'payment_date'      => $payment_date_time,
			'payment_status'    => 'Completed',
			'payment_type'      => '',
			'memo'              => $transaction_data['MT_MEMO'],
			'receiver_id'       => '',
			'receiver_email'    => '',
			'residence_country' => strtoupper($transaction_data['MT_RESIDENCE_COUNTRY']),
			'settle_amount'     => 0.0,
			'settle_currency'   => '',
			'test_ipn'          => false,
			'txn_errors'        => '',
			'txn_id'            => 'PPDE' . gen_rand_string(13),
			'txn_type'          => 'ppde_manual_donation',
			'user_id'           => $user_id,
		];
	}

	/**
	 * Tests if mc_gross is to low
	 *
	 * @param array $data
	 *
	 * @return array
	 * @access private
	 */
	private function mc_gross_too_low($data): array
	{
		if ($data['MT_MC_GROSS'] <= 0)
		{
			return [$this->language->lang('PPDE_MT_MC_GROSS_TOO_LOW')];
		}

		return [];
	}

	/**
	 * Tests if mc_fee has a negative value
	 *
	 * @param array $data
	 *
	 * @return array
	 * @access private
	 */
	private function mc_fee_negative($data): array
	{
		if ($data['MT_MC_FEE'] < 0)
		{
			return [$this->language->lang('PPDE_MT_MC_FEE_NEGATIVE')];
		}

		return [];
	}

	/**
	 * Tests if mc_fee is too high
	 *
	 * @param array $data
	 *
	 * @return array
	 * @access private
	 */
	private function mc_fee_too_high($data): array
	{
		if ($data['MT_MC_FEE'] >= $data['MT_MC_GROSS'])
		{
			return [$this->language->lang('PPDE_MT_MC_FEE_TOO_HIGH')];
		}

		return [];
	}

	/**
	 * Tests if the date is valid
	 *
	 * @param string|false $payment_date_timestamp_at_midnight
	 * @param string       $payment_date
	 *
	 * @return array
	 * @access private
	 */
	private function payment_date_timestamp_at_midnight($payment_date_timestamp_at_midnight, $payment_date): array
	{
		if ($payment_date_timestamp_at_midnight === false)
		{
			return [$this->language->lang('PPDE_MT_PAYMENT_DATE_ERROR', $payment_date)];
		}

		return [];
	}

	/**
	 * @param int|false $payment_time_timestamp
	 * @param string    $payment_date
	 *
	 * @return array
	 * @access private
	 */
	private function payment_time_timestamp($payment_time_timestamp, $payment_date): array
	{
		if ($payment_time_timestamp === false)
		{
			return [$this->language->lang('PPDE_MT_PAYMENT_TIME_ERROR', $payment_date)];
		}

		return [];
	}

	/**
	 * @param string $payment_date_time
	 *
	 * @return array
	 * @access private
	 */
	private function payment_date_time($payment_date_time): array
	{
		if ($payment_date_time > time())
		{
			return [$this->language->lang('PPDE_MT_PAYMENT_DATE_FUTURE', $this->user->format_date($payment_date_time))];
		}

		return [];
	}

	/**
	 * Does actions for validated transaction
	 *
	 * @param bool $is_member
	 *
	 * @return void
	 * @access private
	 */
	private function do_transactions_actions($is_member): void
	{
		$this->ppde_actions->update_overview_stats();
		$this->ppde_actions->update_raised_amount();

		if ($is_member)
		{
			$this->ppde_actions->update_donor_stats();
			$this->ppde_actions->donors_group_user_add();
			$this->ppde_actions->notification->notify_donor_donation_received();
		}
	}

	/**
	 * Logs an entry in the phpBB admin log.
	 *
	 * @param array $transaction_data The data of the transaction to be logged.
	 *
	 * @return void
	 * @access private
	 */
	private function log_transaction(array $transaction_data): void
	{
		$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_PPDE_MT_ADDED', time(), [$transaction_data['MT_USERNAME']]);
		trigger_error($this->language->lang('PPDE_MT_ADDED') . adm_back_link($this->u_action));
	}

	/**
	 * Prepare and assign template variables for adding a new transaction.
	 *
	 * @param array $errors           Array of error messages.
	 * @param array $transaction_data Transaction data to be displayed in the form.
	 */
	private function prepare_add_template(array $errors, array $transaction_data): void
	{
		$this->ppde_actions_currency->build_currency_select_menu((int) $this->config['ppde_default_currency']);
		$this->s_error_assign_template_vars($errors);
		$this->template->assign_vars($transaction_data);
		$this->template->assign_vars([
			'U_ACTION'             => $this->u_action,
			'U_BACK'               => $this->u_action,
			'S_ADD'                => true,
			'ANONYMOUS_USER_ID'    => ANONYMOUS,
			'U_FIND_USERNAME'      => append_sid($this->phpbb_root_path . 'memberlist.' . $this->php_ext, 'mode=searchuser&amp;form=manual_transaction&amp;field=username&amp;select_single=true'),
			'PAYMENT_TIME_FORMATS' => $this->get_payment_time_examples(),
		]);
	}

	/**
	 * Returns a list of valid times that the user can provide in the manual transaction form
	 *
	 * @return array Array of strings representing the current time, each in a different format
	 * @access private
	 */
	private function get_payment_time_examples(): array
	{
		$formats = [
			'H:i:s',
			'G:i',
			'h:i:s a',
			'g:i A',
		];

		$examples = [];

		foreach ($formats as $format)
		{
			$examples[] = $this->user->format_date(time(), $format);
		}

		return $examples;
	}

	/**
	 * {@inheritdoc}
	 */
	public function approve(): void
	{
		$transaction_id = (int) $this->args['hidden_fields']['id'];
		$txn_approved = empty($this->args['hidden_fields']['txn_errors_approved']);

		// Update DB record
		$this->ppde_entity->load($transaction_id);
		$this->ppde_entity->set_txn_errors_approved($txn_approved);
		$this->ppde_entity->save(false);

		// Prepare transaction settings before doing actions
		$transaction_data = $this->ppde_entity->get_data($this->ppde_operator->build_sql_data($transaction_id));
		$this->ppde_actions->set_transaction_data($transaction_data[0]);
		$this->ppde_actions->set_ipn_test_properties($this->ppde_entity->get_test_ipn());
		$this->ppde_actions->is_donor_is_member();

		if ($txn_approved)
		{
			$this->do_transactions_actions(!$this->ppde_actions->get_ipn_test() && $this->ppde_actions->get_donor_is_member());
		}

		$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_' . $this->lang_key_prefix . '_UPDATED', time());
	}

	/**
	 * {@inheritdoc}
	 */
	public function view(): void
	{
		// Request Identifier of the transaction
		$transaction_id = (int) $this->request->variable('id', 0);

		// add additional fields to the table schema needed by entity->import()
		$additional_table_schema = [
			'item_username'    => ['name' => 'username', 'type' => 'string'],
			'item_user_colour' => ['name' => 'user_colour', 'type' => 'string'],
		];

		// Grab transaction data
		$data_ary = $this->ppde_entity->get_data($this->ppde_operator->build_sql_data($transaction_id), $additional_table_schema);

		array_map([$this, 'action_assign_template_vars'], $data_ary);

		$this->template->assign_vars([
			'U_FIND_USERNAME' => append_sid($this->phpbb_root_path . 'memberlist.' . $this->php_ext, 'mode=searchuser&amp;form=view_transactions&amp;field=username&amp;select_single=true'),
			'U_ACTION'        => $this->u_action,
			'U_BACK'          => $this->u_action,
			'S_VIEW'          => true,
		]);
	}

	/**
	 * {@inheritdoc}
	 */
	public function delete(): void
	{
		$where_sql = '';

		if ($this->args['hidden_fields']['delmarked'] && count($this->args['hidden_fields']['mark']))
		{
			$where_sql = $this->ppde_operator->build_marked_where_sql($this->args['hidden_fields']['mark']);
		}

		if ($where_sql || $this->args['hidden_fields']['delall'])
		{
			$this->ppde_entity->delete(0, '', $where_sql, $this->args['hidden_fields']['delall']);
			$this->ppde_actions->set_ipn_test_properties(true);
			$this->ppde_actions->update_overview_stats();
			$this->ppde_actions->set_ipn_test_properties(false);
			$this->ppde_actions->update_overview_stats();
			$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_' . $this->lang_key_prefix . '_PURGED', time());
		}
	}

	/**
	 * Assign action template variables.
	 *
	 * @param array $data Transaction data.
	 *
	 * @return void
	 * @access protected
	 */
	protected function action_assign_template_vars(array $data): void
	{
		$this->assign_hidden_fields($data);
		$this->assign_currency_data($data);
		$this->assign_user_data($data);
		$this->assign_transaction_details($data);
		$this->assign_payment_details($data);
		$this->assign_error_data($data);
	}

	private function assign_hidden_fields(array $data): void
	{
		$s_hidden_fields = build_hidden_fields([
			'id'                  => $data['transaction_id'],
			'donor_id'            => $data['user_id'],
			'txn_errors_approved' => $data['txn_errors_approved'],
		]);
		$this->template->assign_var('S_HIDDEN_FIELDS', $s_hidden_fields);
	}

	/**
	 * Assign currency data to template variables.
	 *
	 * @param array $data Transaction data.
	 */
	private function assign_currency_data(array $data): void
	{
		$this->ppde_actions_currency->set_currency_data_from_iso_code($data['mc_currency']);
		$this->ppde_actions_currency->set_currency_data_from_iso_code($data['settle_currency']);

		$this->template->assign_vars([
			'EXCHANGE_RATE'                   => '1 ' . $data['mc_currency'] . ' = ' . $data['exchange_rate'] . ' ' . $data['settle_currency'],
			'MC_GROSS'                        => $this->ppde_actions_currency->format_currency($data['mc_gross']),
			'MC_FEE'                          => $this->ppde_actions_currency->format_currency($data['mc_fee']),
			'MC_NET'                          => $this->ppde_actions_currency->format_currency($data['net_amount']),
			'SETTLE_AMOUNT'                   => $this->ppde_actions_currency->format_currency($data['settle_amount']),
			'L_PPDE_DT_SETTLE_AMOUNT'         => $this->language->lang('PPDE_DT_SETTLE_AMOUNT', $data['settle_currency']),
			'L_PPDE_DT_EXCHANGE_RATE_EXPLAIN' => $this->language->lang('PPDE_DT_EXCHANGE_RATE_EXPLAIN', $this->user->format_date($data['payment_date'])),
			'S_CONVERT'                       => !((int) $data['settle_amount'] === 0 && empty($data['exchange_rate'])),
		]);
	}

	/**
	 * Assign user data to template variables.
	 *
	 * @param array $data Transaction data.
	 */
	private function assign_user_data(array $data): void
	{
		$this->template->assign_vars([
			'BOARD_USERNAME' => get_username_string('full', $data['user_id'], $data['username'], $data['user_colour'], $this->language->lang('GUEST'), append_sid($this->phpbb_admin_path . 'index.' . $this->php_ext, 'i=users&amp;mode=overview')),
			'NAME'           => $data['first_name'] . ' ' . $data['last_name'],
			'PAYER_EMAIL'    => $data['payer_email'],
			'PAYER_ID'       => $data['payer_id'],
			'PAYER_STATUS'   => $data['payer_status'] ? $this->language->lang('PPDE_DT_VERIFIED') : $this->language->lang('PPDE_DT_UNVERIFIED'),
		]);
	}

	/**
	 * Assign transaction details to template variables.
	 *
	 * @param array $data Transaction data.
	 */
	private function assign_transaction_details(array $data): void
	{
		$this->template->assign_vars([
			'ITEM_NAME'      => $data['item_name'],
			'ITEM_NUMBER'    => $data['item_number'],
			'MEMO'           => $data['memo'],
			'RECEIVER_EMAIL' => $data['receiver_email'],
			'RECEIVER_ID'    => $data['receiver_id'],
			'TXN_ID'         => $data['txn_id'],
		]);
	}

	/**
	 * Assign payment details to template variables.
	 *
	 * @param array $data Transaction data.
	 */
	private function assign_payment_details(array $data): void
	{
		$this->template->assign_vars([
			'PAYMENT_DATE'   => $this->user->format_date($data['payment_date']),
			'PAYMENT_STATUS' => $this->language->lang(['PPDE_DT_PAYMENT_STATUS_VALUES', strtolower($data['payment_status'])]),
		]);
	}

	/**
	 * Assign error data to template variables.
	 *
	 * @param array $data Transaction data.
	 */
	private function assign_error_data(array $data): void
	{
		$this->template->assign_vars([
			'S_ERROR'          => !empty($data['txn_errors']),
			'S_ERROR_APPROVED' => !empty($data['txn_errors_approved']),
			'ERROR_MSG'        => (!empty($data['txn_errors'])) ? $data['txn_errors'] : '',
		]);
	}
}

Skouat / ext_paypal_donation

Push — develop-3.3.x ( 95f552...b7db6e )

transactions_controller::build_data_ary() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like
