DriverConfig::onLoadDriverSettings() - Code Metrics - Inspection of "Set up driver config forms" - scottbedard/oc-shop-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 141c37...4e2b2d )

by Scott

created 2017-01-08 17:16 UTC

DriverConfig::onLoadDriverSettings() A

↳ Parent: DriverConfig

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	7
nc	1
nop	0

<?php namespace Bedard\Shop\FormWidgets;

use Backend\Classes\FormWidgetBase;
use Bedard\Shop\Classes\DriverManager;
use Bedard\Shop\Interfaces\DriverInterface;
use Model;

/**
 * DriverConfig Form Widget.
 */
class DriverConfig extends FormWidgetBase
{
    use \Bedard\Shop\Traits\LangJsonable;

    /**
     * {@inheritdoc}
     */
    protected $defaultAlias = 'bedard_shop_driver_config';

    /**
     * @var \Bedard\Shop\Classes\DriverManager;
     */
    protected $manager;

    /**
     * {@inheritdoc}
     */
    public function init()
    {
        $this->manager = DriverManager::instance();
    }

    /**
     * {@inheritdoc}
     */
    public function render()
    {
        $this->prepareVars();

        return $this->makePartial('driverconfig');
    }

    /**
     * Prepares the form widget view data.
     */
    public function prepareVars()
    {
        $this->vars['drivers'] = $this->getShippingDriverDetails();
    }

    /**
     * {@inheritdoc}
     */
    public function loadAssets()
    {
        $this->addJs('/plugins/bedard/shop/assets/dist/vendor.js');
        $this->addJs('/plugins/bedard/shop/assets/dist/driverconfig.js', 'Bedard.Shop');
    }

    /**
     * Get the form for a driver.
     *
     * @param  DriverInterface $driver
     * @return object
     */
    protected function getDriverForm(DriverInterface $driver)
    {
        $model = new Model;
        // foreach (array_merge(array_keys($fields), array_keys($tabFields)) as $key) {

        //     $model->$key = $driver->getConfig($key);

        // }

        $form = $this->makeConfigFromArray($driver->getFormFields());
        $form->model = $model;

        return $form;
    }

    /**
     * {@inheritdoc}
     */
    public function getSaveValue($value)
    {
        return $value;
    }

    /**
     * Get the driver details.
     *
     * @return array
     */
    protected function getShippingDriverDetails()
    {
        foreach ($this->manager->getShippingDrivers() as $driver) {
            $details[]  = [
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                "class" => get_class($driver),
                "details" => $driver->driverDetails(),
            ];
        }

        return $details;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }

    /**
     * Load the driver settings.
     *
     * @return string
     */
    public function onLoadDriverSettings()
    {
        $input = input('driver');
        $driver = new $input['class'];

        $form = $this->getDriverForm($driver);

        return $this->makePartial('popup', [
            'driver' => $driver,
            'form' => $this->makeWidget('Backend\Widgets\Form', $form)->render(),
        ]);
    }
}


1			<?php namespace Bedard\Shop\FormWidgets;
2
3			use Backend\Classes\FormWidgetBase;
4			use Bedard\Shop\Classes\DriverManager;
5			use Bedard\Shop\Interfaces\DriverInterface;
6			use Model;
7
8			/**
9			* DriverConfig Form Widget.
10			*/
11			class DriverConfig extends FormWidgetBase
12			{
13			use \Bedard\Shop\Traits\LangJsonable;
14
15			/**
16			* {@inheritdoc}
17			*/
18			protected $defaultAlias = 'bedard_shop_driver_config';
19
20			/**
21			* @var \Bedard\Shop\Classes\DriverManager;
22			*/
23			protected $manager;
24
25			/**
26			* {@inheritdoc}
27			*/
28			public function init()
29			{
30			$this->manager = DriverManager::instance();
31			}
32
33			/**
34			* {@inheritdoc}
35			*/
36			public function render()
37			{
38			$this->prepareVars();
39
40			return $this->makePartial('driverconfig');
41			}
42
43			/**
44			* Prepares the form widget view data.
45			*/
46			public function prepareVars()
47			{
48			$this->vars['drivers'] = $this->getShippingDriverDetails();
49			}
50
51			/**
52			* {@inheritdoc}
53			*/
54			public function loadAssets()
55			{
56			$this->addJs('/plugins/bedard/shop/assets/dist/vendor.js');
57			$this->addJs('/plugins/bedard/shop/assets/dist/driverconfig.js', 'Bedard.Shop');
58			}
59
60			/**
61			* Get the form for a driver.
62			*
63			* @param DriverInterface $driver
64			* @return object
65			*/
66			protected function getDriverForm(DriverInterface $driver)
67			{
68			$model = new Model;
69			// foreach (array_merge(array_keys($fields), array_keys($tabFields)) as $key) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-08 17:20 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
70			// $model->$key = $driver->getConfig($key);
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-08 17:20 UTC by Report Bug Copy Issue Report `65%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
71			// }
72
73			$form = $this->makeConfigFromArray($driver->getFormFields());
74			$form->model = $model;
75
76			return $form;
77			}
78
79			/**
80			* {@inheritdoc}
81			*/
82			public function getSaveValue($value)
83			{
84			return $value;
85			}
86
87			/**
88			* Get the driver details.
89			*
90			* @return array
91			*/
92			protected function getShippingDriverDetails()
93			{
94			foreach ($this->manager->getShippingDrivers() as $driver) {
95			$details[] = [
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-01-08 17:20 UTC by Report Bug Copy Issue Report `$details` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$details = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
96			"class" => get_class($driver),
97			"details" => $driver->driverDetails(),
98			];
99			}
100
101			return $details;
			0 ignored issues – show Bug introduced 2017-01-06 15:54 UTC by Report Bug Copy Issue Report The variable `$details` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
102			}
103
104			/**
105			* Load the driver settings.
106			*
107			* @return string
108			*/
109			public function onLoadDriverSettings()
110			{
111			$input = input('driver');
112			$driver = new $input['class'];
113
114			$form = $this->getDriverForm($driver);
115
116			return $this->makePartial('popup', [
117			'driver' => $driver,
118			'form' => $this->makeWidget('Backend\Widgets\Form', $form)->render(),
119			]);
120			}
121			}
122

scottbedard / oc-shop-plugin

Push — master ( 141c37...4e2b2d )

DriverConfig::onLoadDriverSettings() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like