ExportController::actionIndex() - Code Metrics - Inspection of "Store settings in multiple files 159" - nerds-and-company/schematic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#167)

unknown

created 2018-11-07 16:33 UTC

ExportController::actionIndex() B

↳ Parent: ExportController

Complexity

Conditions	8
Paths	32

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	72

Importance

Changes

Metric	Value
dl	0
loc	45
ccs	0
cts	33
cp	0
rs	7.9555
c	0
b	0
f	0
cc	8
nc	32
nop	0
crap	72

<?php

namespace NerdsAndCompany\Schematic\Controllers;

use Craft;
use craft\helpers\FileHelper;
use NerdsAndCompany\Schematic\Models\Data;
use NerdsAndCompany\Schematic\Schematic;

/**
 * Schematic Export Controller.
 *
 * Sync Craft Setups.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2018, Nerds & Company
 * @license   MIT
 *
 * @see      http://www.nerds.company
 */
class ExportController extends Base
{
    /**
     * Exports the Craft datamodel.
     *
     * @return int
     * @throws \yii\base\ErrorException
     */
    public function actionIndex(): int
    {
        $this->disableLogging();
        $result = [];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        foreach ($this->getDataTypes() as $dataTypeHandle) {
            $dataType = $this->module->getDataType($dataTypeHandle);
            if (null == $dataType) {
                continue;
            }

            $mapper = $dataType->getMapperHandle();
            if (!$this->module->checkMapper($mapper)) {
                continue;
            }

            $records = $dataType->getRecords();
            $configurations[$dataTypeHandle] = $this->module->$mapper->export($records);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
        }

        // Parse data in the overrideFile if available.
        $overrideData = Data::parseYamlFile($this->overrideFile);

        // Create export directory if it doesn't exist.
        if (!file_exists($this->path)) {
            mkdir($this->path, 2775, true);
        }

        // Export the configuration to multiple yaml files.
        foreach ($configurations as $dataTypeHandle => $configuration) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
            Schematic::info('Exporting '.$dataTypeHandle);
            foreach ($configuration as $recordName => $records) {
                // Check if there is data in the override file for the current record.
                if (isset($overrideData[$dataTypeHandle][$recordName])) {
                    $records = array_replace_recursive($records, $overrideData[$dataTypeHandle][$recordName]);
                }

                // Export records to file.
                $fileName = $this->toSafeFileName($dataTypeHandle . '.' . $recordName . '.yml');
                FileHelper::writeToFile($this->path . $fileName, Data::toYaml($records));
                Schematic::info('Exported ' . $recordName . ' to ' . $fileName);
            }
        }

        return 0;
    }
}


1			<?php
2
3			namespace NerdsAndCompany\Schematic\Controllers;
4
5			use Craft;
6			use craft\helpers\FileHelper;
7			use NerdsAndCompany\Schematic\Models\Data;
8			use NerdsAndCompany\Schematic\Schematic;
9
10			/**
11			* Schematic Export Controller.
12			*
13			* Sync Craft Setups.
14			*
15			* @author Nerds & Company
16			* @copyright Copyright (c) 2015-2018, Nerds & Company
17			* @license MIT
18			*
19			* @see http://www.nerds.company
20			*/
21			class ExportController extends Base
22			{
23			/**
24			* Exports the Craft datamodel.
25			*
26			* @return int
27			* @throws \yii\base\ErrorException
28			*/
29			public function actionIndex(): int
30			{
31			$this->disableLogging();
32			$result = [];
			0 ignored issues – show Unused Code introduced 2018-11-07 16:35 UTC by Report Bug Copy Issue Report `$result` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
33			foreach ($this->getDataTypes() as $dataTypeHandle) {
34			$dataType = $this->module->getDataType($dataTypeHandle);
35			if (null == $dataType) {
36			continue;
37			}
38
39			$mapper = $dataType->getMapperHandle();
40			if (!$this->module->checkMapper($mapper)) {
41			continue;
42			}
43
44			$records = $dataType->getRecords();
45			$configurations[$dataTypeHandle] = $this->module->$mapper->export($records);
			0 ignored issues – show Coding Style Comprehensibility introduced 2018-11-07 16:35 UTC by Report Bug Copy Issue Report `$configurations` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$configurations = 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...
46			}
47
48			// Parse data in the overrideFile if available.
49			$overrideData = Data::parseYamlFile($this->overrideFile);
50
51			// Create export directory if it doesn't exist.
52			if (!file_exists($this->path)) {
53			mkdir($this->path, 2775, true);
54			}
55
56			// Export the configuration to multiple yaml files.
57			foreach ($configurations as $dataTypeHandle => $configuration) {
			0 ignored issues – show Bug introduced 2018-11-07 16:35 UTC by Report Bug Copy Issue Report The variable `$configurations` 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...
58			Schematic::info('Exporting '.$dataTypeHandle);
59			foreach ($configuration as $recordName => $records) {
60			// Check if there is data in the override file for the current record.
61			if (isset($overrideData[$dataTypeHandle][$recordName])) {
62			$records = array_replace_recursive($records, $overrideData[$dataTypeHandle][$recordName]);
63			}
64
65			// Export records to file.
66			$fileName = $this->toSafeFileName($dataTypeHandle . '.' . $recordName . '.yml');
67			FileHelper::writeToFile($this->path . $fileName, Data::toYaml($records));
68			Schematic::info('Exported ' . $recordName . ' to ' . $fileName);
69			}
70			}
71
72			return 0;
73			}
74			}
75

nerds-and-company / schematic

Pull Request — master (#167)

ExportController::actionIndex() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like