Driver::saveConfig() - Code Metrics - scottbedard/oc-shop-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Driver::saveConfig() A
last analyzed 2017-05-01 22:11 UTC

↳ Parent: Driver

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	5
nc	1
nop	1

<?php namespace Bedard\Shop\Classes;

use Bedard\Shop\Models\DriverConfig;
use Exception;
use October\Rain\Exception\ValidationException;
use October\Rain\Parse\Yaml;
use ReflectionClass;
use Validator;

abstract class Driver
{
    /**
     * @var array Custom validation messages.
     */
    public $customMessages = [];

    /**
     * @return string Form fields.
     */
    public $formFields;

    /**
     * @var array Validation rules.
     */
    public $rules = [];

    /**
     * After validate.
     *
     * @param  array    $data
     * @return void
     */
    public function afterValidate(array $data)

    {
    }

    /**
     * Before validate.
     *
     * @param  array    $data
     * @return void
     */
    public function beforeValidate(array $data)

    {
    }

    /**
     * Get the configuration model.
     *
     * @return Bedard\Shop\Models\DriverConfig
     */
    public function getConfigModel()
    {
        return DriverConfig::firstOrNew([
            'class' => get_class($this),
        ]);
    }

    /**
     * Get the configuration array.
     *
     * @return array
     */
    public function getConfig()
    {
        $model = $this->getConfigModel();

        return $model->getConfig();
    }

    /**
     * Get form fields.
     *
     * @return array
     */
    public function getFormFields()
    {
        if (! $this->formFields) {
            throw new Exception('Drivers must define a $formFields property, or overwrite the getFormFields() method.');
        }

        if (! is_string($this->formFields)) {
            throw new Exception('Driver $formFields property must be a string.');
        }

        $yaml = new Yaml;

        $reflector = new ReflectionClass(get_class($this));

        return $yaml->parseFile(dirname($reflector->getFileName()).'/'.$this->formFields);
    }

    /**
     * Save driver configuration.
     *
     * @param  array    $config
     * @return void
     */
    public function saveConfig(array $config)
    {
        $this->validate($config);

        $model = $this->getConfigModel(false);


        $model->config = json_encode($config);

        return $model->save();
    }

    /**
     * Validate form data.
     *
     * @param  array $formData
     * @return void
     * @throws \October\Rain\Exception\ValidationException
     */
    public function validate(array $formData)
    {
        $this->beforeValidate($formData);

        $validator = Validator::make($formData, $this->rules, $this->customMessages);

        if ($validator->fails()) {
            throw new ValidationException($validator);
        }

        $this->afterValidate($formData);
    }
}


1			<?php namespace Bedard\Shop\Classes;
2
3			use Bedard\Shop\Models\DriverConfig;
4			use Exception;
5			use October\Rain\Exception\ValidationException;
6			use October\Rain\Parse\Yaml;
7			use ReflectionClass;
8			use Validator;
9
10			abstract class Driver
11			{
12			/**
13			* @var array Custom validation messages.
14			*/
15			public $customMessages = [];
16
17			/**
18			* @return string Form fields.
19			*/
20			public $formFields;
21
22			/**
23			* @var array Validation rules.
24			*/
25			public $rules = [];
26
27			/**
28			* After validate.
29			*
30			* @param array $data
31			* @return void
32			*/
33			public function afterValidate(array $data)
			0 ignored issues – show Unused Code introduced 2017-05-01 22:09 UTC by Report Bug Copy Issue Report The parameter `$data` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
34			{
35			}
36
37			/**
38			* Before validate.
39			*
40			* @param array $data
41			* @return void
42			*/
43			public function beforeValidate(array $data)
			0 ignored issues – show Unused Code introduced 2017-05-01 22:09 UTC by Report Bug Copy Issue Report The parameter `$data` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
44			{
45			}
46
47			/**
48			* Get the configuration model.
49			*
50			* @return Bedard\Shop\Models\DriverConfig
51			*/
52			public function getConfigModel()
53			{
54			return DriverConfig::firstOrNew([
55			'class' => get_class($this),
56			]);
57			}
58
59			/**
60			* Get the configuration array.
61			*
62			* @return array
63			*/
64			public function getConfig()
65			{
66			$model = $this->getConfigModel();
67
68			return $model->getConfig();
69			}
70
71			/**
72			* Get form fields.
73			*
74			* @return array
75			*/
76			public function getFormFields()
77			{
78			if (! $this->formFields) {
79			throw new Exception('Drivers must define a $formFields property, or overwrite the getFormFields() method.');
80			}
81
82			if (! is_string($this->formFields)) {
83			throw new Exception('Driver $formFields property must be a string.');
84			}
85
86			$yaml = new Yaml;
87
88			$reflector = new ReflectionClass(get_class($this));
89
90			return $yaml->parseFile(dirname($reflector->getFileName()).'/'.$this->formFields);
91			}
92
93			/**
94			* Save driver configuration.
95			*
96			* @param array $config
97			* @return void
98			*/
99			public function saveConfig(array $config)
100			{
101			$this->validate($config);
102
103			$model = $this->getConfigModel(false);
			0 ignored issues – show Unused Code introduced 2017-05-01 22:09 UTC by Report Bug Copy Issue Report The call to `Driver::getConfigModel()` has too many arguments starting with `false`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
104
105			$model->config = json_encode($config);
106
107			return $model->save();
108			}
109
110			/**
111			* Validate form data.
112			*
113			* @param array $formData
114			* @return void
115			* @throws \October\Rain\Exception\ValidationException
116			*/
117			public function validate(array $formData)
118			{
119			$this->beforeValidate($formData);
120
121			$validator = Validator::make($formData, $this->rules, $this->customMessages);
122
123			if ($validator->fails()) {
124			throw new ValidationException($validator);
125			}
126
127			$this->afterValidate($formData);
128			}
129			}
130

scottbedard / oc-shop-plugin

Driver::saveConfig() A last analyzed 2017-05-01 22:11 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Driver::saveConfig() A
last analyzed 2017-05-01 22:11 UTC