PaymentProviderConfig::evaluateConfigValue() - Code Metrics - getloy/getloy-php - Measure and Improve Code Quality continuously with Scrutinizer

PaymentProviderConfig::evaluateConfigValue() B
last analyzed 2020-04-14 07:35 UTC

↳ Parent: PaymentProviderConfig

Complexity

Conditions	10
Paths	7

Size

Total Lines	46
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	10
eloc	27
c	1
b	0
f	0
nc	7
nop	3
dl	0
loc	46
rs	7.6666

How to fix Complexity

<?php

namespace Getloy\PaymentProviders\Configuration;

use \Exception;

/**
 * Abstract payment provider config class.
 */
abstract class PaymentProviderConfig
{
  
    protected $config;

    /**
     * Instantiate a payment provider configuration.
     * @param array $config Configuration for the payment method.
     */
    public function __construct(array $config)
    {
        $this->config = $this->evaluateConfig($config, $this->configValidation());
    }

    /**
     * Get configuration value.
     * @param string $configOption Name of the configuration option.
     * @return mixed The configuration value, or an empty string if the option is not set.
     */
    public function get(string $option)
    {
        if (!array_key_exists($option, $this->config)) {
            return '';
        }
        return $this->config[$option];
    }

    /**
     * Generate validation configuration for payment method-specific configuration options.
     * @return array Validation configuration
     */
    abstract protected function paymentMethodConfigValidation(): array;

    /**
     * Generate validation configuration for general and payment method-specific configuration
     * options.
     * @return array Validation configuration
     */
    protected function configValidation(): array
    {
        $configValidation = $this->paymentMethodConfigValidation();
        if (!array_key_exists('testMode', $configValidation)) {
            $configValidation['testMode'] = [
                'type' => 'boolean',
                'required' => false,
                'default' => true,
            ];
        }
        return $configValidation;
    }

    /**
     * Validates the specified config option against the validation rules and returns the config
     * value.
     * @param string $configOption Name of the configuration option to evaluate.
     * @param array $config Configuration for the payment method.
     * @param array $configValidation Validation configuration.
     * @return mixed The config value after validation, or an empty string if there is no value for
     *               the option.
     * @throws Exception If the validation fails.
     */
    protected function evaluateConfigValue(
        string $configOption,
        array $config,
        array $configValidation
    ) {

        if (!array_key_exists($configOption, $configValidation)) {
            throw new Exception(sprintf('Unknown configuration option "%s"', $configOption));
        }

        $optionValidation = $configValidation[$configOption];
        if (!array_key_exists($configOption, $config)) {
            if (array_key_exists('required', $optionValidation) && $optionValidation['required']) {
                throw new Exception(sprintf(
                    'Configuration is missing required option "%s"',
                    $configOption
                ));
            }
            if (array_key_exists('default', $optionValidation)) {
                return $optionValidation['default'];
            }
            return '';
        }

        $optionValue = $config[$configOption];
        if (array_key_exists('type', $optionValidation)
            && gettype($optionValue) !== $optionValidation['type']) {
            throw new Exception(sprintf(
                'Validation of option "%s" failed: expected value of type "%s", but found "%s"!',
                $configOption,
                $optionValidation['type'],
                gettype($optionValue)
            ));
        }

        if (array_key_exists('allowedValues', $optionValidation)
            && !in_array($optionValue, $optionValidation['allowedValues'], true)) {
            throw new Exception(sprintf(
                'Validation of option "%s" failed: value "%s" is not one of the allowed values "%s"!',
                $configOption,
                $optionValue,
                implode('", "', $optionValidation['allowedValues'])
            ));
        }

        return $optionValue;
    }

    /**
     * Validates the specified config options against the validation rules and returns evaluated
     * config.
     * @param array $config Configuration for the payment method.
     * @param array $configValidation Validation configuration.
     * @return array The config after validation.
     * @throws Exception If the validation fails.
     */
    protected function evaluateConfig(array $config, array $configValidation): array
    {
        $evaluatedConfig = [];
        foreach ($configValidation as $option => $validation) {
            $evaldValue = $this->evaluateConfigValue($option, $config, $configValidation);
            if (!is_null($evaldValue)) {
                $evaluatedConfig[$option] = $evaldValue;
            }
        }
        return $evaluatedConfig;
    }
}


1			<?php
2
3			namespace Getloy\PaymentProviders\Configuration;
4
5			use \Exception;
6
7			/**
8			* Abstract payment provider config class.
9			*/
10			abstract class PaymentProviderConfig
11			{
12
13			protected $config;
14
15			/**
16			* Instantiate a payment provider configuration.
17			* @param array $config Configuration for the payment method.
18			*/
19			public function __construct(array $config)
20			{
21			$this->config = $this->evaluateConfig($config, $this->configValidation());
22			}
23
24			/**
25			* Get configuration value.
26			* @param string $configOption Name of the configuration option.
27			* @return mixed The configuration value, or an empty string if the option is not set.
28			*/
29			public function get(string $option)
30			{
31			if (!array_key_exists($option, $this->config)) {
32			return '';
33			}
34			return $this->config[$option];
35			}
36
37			/**
38			* Generate validation configuration for payment method-specific configuration options.
39			* @return array Validation configuration
40			*/
41			abstract protected function paymentMethodConfigValidation(): array;
42
43			/**
44			* Generate validation configuration for general and payment method-specific configuration
45			* options.
46			* @return array Validation configuration
47			*/
48			protected function configValidation(): array
49			{
50			$configValidation = $this->paymentMethodConfigValidation();
51			if (!array_key_exists('testMode', $configValidation)) {
52			$configValidation['testMode'] = [
53			'type' => 'boolean',
54			'required' => false,
55			'default' => true,
56			];
57			}
58			return $configValidation;
59			}
60
61			/**
62			* Validates the specified config option against the validation rules and returns the config
63			* value.
64			* @param string $configOption Name of the configuration option to evaluate.
65			* @param array $config Configuration for the payment method.
66			* @param array $configValidation Validation configuration.
67			* @return mixed The config value after validation, or an empty string if there is no value for
68			* the option.
69			* @throws Exception If the validation fails.
70			*/
71			protected function evaluateConfigValue(
72			string $configOption,
73			array $config,
74			array $configValidation
75			) {
76
77			if (!array_key_exists($configOption, $configValidation)) {
78			throw new Exception(sprintf('Unknown configuration option "%s"', $configOption));
79			}
80
81			$optionValidation = $configValidation[$configOption];
82			if (!array_key_exists($configOption, $config)) {
83			if (array_key_exists('required', $optionValidation) && $optionValidation['required']) {
84			throw new Exception(sprintf(
85			'Configuration is missing required option "%s"',
86			$configOption
87			));
88			}
89			if (array_key_exists('default', $optionValidation)) {
90			return $optionValidation['default'];
91			}
92			return '';
93			}
94
95			$optionValue = $config[$configOption];
96			if (array_key_exists('type', $optionValidation)
97			&& gettype($optionValue) !== $optionValidation['type']) {
98			throw new Exception(sprintf(
99			'Validation of option "%s" failed: expected value of type "%s", but found "%s"!',
100			$configOption,
101			$optionValidation['type'],
102			gettype($optionValue)
103			));
104			}
105
106			if (array_key_exists('allowedValues', $optionValidation)
107			&& !in_array($optionValue, $optionValidation['allowedValues'], true)) {
108			throw new Exception(sprintf(
109			'Validation of option "%s" failed: value "%s" is not one of the allowed values "%s"!',
110			$configOption,
111			$optionValue,
112			implode('", "', $optionValidation['allowedValues'])
113			));
114			}
115
116			return $optionValue;
117			}
118
119			/**
120			* Validates the specified config options against the validation rules and returns evaluated
121			* config.
122			* @param array $config Configuration for the payment method.
123			* @param array $configValidation Validation configuration.
124			* @return array The config after validation.
125			* @throws Exception If the validation fails.
126			*/
127			protected function evaluateConfig(array $config, array $configValidation): array
128			{
129			$evaluatedConfig = [];
130			foreach ($configValidation as $option => $validation) {
131			$evaldValue = $this->evaluateConfigValue($option, $config, $configValidation);
132			if (!is_null($evaldValue)) {
133			$evaluatedConfig[$option] = $evaldValue;
134			}
135			}
136			return $evaluatedConfig;
137			}
138			}
139

getloy / getloy-php

PaymentProviderConfig::evaluateConfigValue() B last analyzed 2020-04-14 07:35 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

PaymentProviderConfig::evaluateConfigValue() B
last analyzed 2020-04-14 07:35 UTC