CleanUpEmptyColumnsTrait::clearRow() - Code Metrics - Inspection of "Note attributes entity type for customer attribute" - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 16.x ( d2c595...7c4702 )

unknown

created 2021-05-11 18:27 UTC

CleanUpEmptyColumnsTrait::clearRow() B

↳ Parent: CleanUpEmptyColumnsTrait

Complexity

Conditions	10
Paths	11

Size

Total Lines

Duplication

Lines	18
Ratio	52.94 %

Code Coverage

Tests	0
CRAP Score	110

Importance

Changes

Metric	Value
dl	18
loc	34
ccs	0
cts	21
cp	0
rs	7.6666
c	0
b	0
f	0
cc	10
nc	11
nop	0
crap	110

How to fix Complexity

<?php

/**
 * TechDivision\Import\Observers\CleanUpEmptyColumnsTrait
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Martin Eissenführer <[email protected]>
 * @copyright 2021 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Observers;

use TechDivision\Import\Subjects\CleanUpColumnsSubjectInterface;
use TechDivision\Import\Utils\ConfigurationKeys;

/**
 * Observer that extracts the missing attribute option values from a customer CSV.
 *
 * @author    Martin Eissenführer <[email protected]>
 * @copyright 2021 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-converter-customer-attribute
 * @link      http://www.techdivision.com
 */
trait CleanUpEmptyColumnsTrait
{
    /**
     * The array with the column keys that has to be cleaned up when their values are empty.
     *
     * @var array
     */
    protected $cleanUpEmptyColumnKeys;

    /**
     * Remove all the empty values from the row and return the cleared row.
     *
     * @return array The cleared row
     */
    protected function clearRow()
    {

        // query whether or not the column keys has been initialized
        if ($this->cleanUpEmptyColumnKeys === null) {
            // initialize the array with the column keys that has to be cleaned-up
            $this->cleanUpEmptyColumnKeys = array();

            // query whether or not column names that has to be cleaned up have been configured
            if ($this->getSubject()->getConfiguration()->hasParam(ConfigurationKeys::CLEAN_UP_EMPTY_COLUMNS)
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                && ($this->getSubject() instanceof CleanUpColumnsSubjectInterface)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                // if yes, load the column names
                $cleanUpEmptyColumns = $this->getSubject()->getCleanUpColumns();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

                // translate the column names into column keys
                foreach ($cleanUpEmptyColumns as $cleanUpEmptyColumn) {
                    if ($this->hasHeader($cleanUpEmptyColumn)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                        $this->cleanUpEmptyColumnKeys[] = $this->getHeader($cleanUpEmptyColumn);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    }
                }
            }
        }

        // remove all the empty values from the row, expected the columns has to be cleaned-up
        foreach ($this->row as $key => $value) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            // query whether or not the value is empty AND the column has NOT to be cleaned-up
            if (($value === null || $value === '') && in_array($key, $this->cleanUpEmptyColumnKeys) === false) {
                unset($this->row[$key]);
            }
        }

        // finally return the clean row
        return $this->row;
    }
}


1		<?php
2
3		/**
4		* TechDivision\Import\Observers\CleanUpEmptyColumnsTrait
5		*
6		* NOTICE OF LICENSE
7		*
8		* This source file is subject to the Open Software License (OSL 3.0)
9		* that is available through the world-wide-web at this URL:
10		* http://opensource.org/licenses/osl-3.0.php
11		*
12		* PHP version 5
13		*
14		* @author Martin Eissenführer <[email protected]>
15		* @copyright 2021 TechDivision GmbH <[email protected]>
16		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17		* @link https://github.com/techdivision/import
18		* @link http://www.techdivision.com
19		*/
20
21		namespace TechDivision\Import\Observers;
22
23		use TechDivision\Import\Subjects\CleanUpColumnsSubjectInterface;
24		use TechDivision\Import\Utils\ConfigurationKeys;
25
26		/**
27		* Observer that extracts the missing attribute option values from a customer CSV.
28		*
29		* @author Martin Eissenführer <[email protected]>
30		* @copyright 2021 TechDivision GmbH <[email protected]>
31		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
32		* @link https://github.com/techdivision/import-converter-customer-attribute
33		* @link http://www.techdivision.com
34		*/
35		trait CleanUpEmptyColumnsTrait
36		{
37		/**
38		* The array with the column keys that has to be cleaned up when their values are empty.
39		*
40		* @var array
41		*/
42		protected $cleanUpEmptyColumnKeys;
43
44		/**
45		* Remove all the empty values from the row and return the cleared row.
46		*
47		* @return array The cleared row
48		*/
49		protected function clearRow()
50		{
51
52		// query whether or not the column keys has been initialized
53		if ($this->cleanUpEmptyColumnKeys === null) {
54		// initialize the array with the column keys that has to be cleaned-up
55		$this->cleanUpEmptyColumnKeys = array();
56
57		// query whether or not column names that has to be cleaned up have been configured
58	View Code Duplication	if ($this->getSubject()->getConfiguration()->hasParam(ConfigurationKeys::CLEAN_UP_EMPTY_COLUMNS)
		0 ignored issues – show Duplication introduced 2021-05-11 18:29 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history... Bug introduced 2021-05-11 18:29 UTC by Report Bug Copy Issue Report It seems like `getSubject()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
59		&& ($this->getSubject() instanceof CleanUpColumnsSubjectInterface)) {
		0 ignored issues – show Bug introduced 2021-05-11 18:29 UTC by Report Bug Copy Issue Report It seems like `getSubject()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
60		// if yes, load the column names
61		$cleanUpEmptyColumns = $this->getSubject()->getCleanUpColumns();
		0 ignored issues – show Bug introduced 2021-05-11 18:29 UTC by Report Bug Copy Issue Report It seems like `getSubject()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
62
63		// translate the column names into column keys
64		foreach ($cleanUpEmptyColumns as $cleanUpEmptyColumn) {
65		if ($this->hasHeader($cleanUpEmptyColumn)) {
		0 ignored issues – show Bug introduced 2021-05-11 18:29 UTC by Report Bug Copy Issue Report It seems like `hasHeader()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
66		$this->cleanUpEmptyColumnKeys[] = $this->getHeader($cleanUpEmptyColumn);
		0 ignored issues – show Bug introduced 2021-05-11 18:29 UTC by Report Bug Copy Issue Report It seems like `getHeader()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
67		}
68		}
69		}
70		}
71
72		// remove all the empty values from the row, expected the columns has to be cleaned-up
73	View Code Duplication	foreach ($this->row as $key => $value) {
		0 ignored issues – show Bug introduced 2021-05-11 18:29 UTC by Report Bug Copy Issue Report The property `row` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Duplication introduced 2021-05-11 18:29 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
74		// query whether or not the value is empty AND the column has NOT to be cleaned-up
75		if (($value === null \|\| $value === '') && in_array($key, $this->cleanUpEmptyColumnKeys) === false) {
76		unset($this->row[$key]);
77		}
78		}
79
80		// finally return the clean row
81		return $this->row;
82		}
83		}
84

techdivision / import

Push — 16.x ( d2c595...7c4702 )

CleanUpEmptyColumnsTrait::clearRow() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like