BunchSubject::getCleanUpColumns() - Code Metrics - Inspection of "Prepare for milestone 1.4" - techdivision/import-attribute-set - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7e2127...77c655 )

by Marcus

created 2020-08-05 09:17 UTC

BunchSubject::getCleanUpColumns() A

↳ Parent: BunchSubject

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
eloc	4
c	0
b	0
f	0
dl	0
loc	13
ccs	0
cts	7
cp	0
rs	10
cc	2
nc	2
nop	0
crap	6

<?php

/**
 * TechDivision\Import\Attribute\Set\Subjects\BunchSubject
 *
 * 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    Tim Wagner <[email protected]>
 * @copyright 2019 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-attribute-set
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Attribute\Set\Subjects;

use TechDivision\Import\Subjects\AbstractEavSubject;
use TechDivision\Import\Attribute\Utils\RegistryKeys;
use TechDivision\Import\Attribute\Set\Utils\MemberNames;
use TechDivision\Import\Attribute\Set\Utils\ConfigurationKeys;
use TechDivision\Import\Subjects\CleanUpColumnsSubjectInterface;
filter:
    dependency_paths: ["lib/*"]

/**
 * The subject implementation that handles the business logic to persist attribute sets.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2019 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-attribute-set
 * @link      http://www.techdivision.com
 */
class BunchSubject extends AbstractEavSubject implements BunchSubjectInterface, CleanUpColumnsSubjectInterface
{

    /**
     * The attribute set that has been processed recently.
     *
     * @var array
     */
    protected $lastAttributeSet = array();

    /**
     * The array with the available entity types.
     *
     * @var array
     */
    protected $entityTypes = array();

    /**
     * The default entity type code.
     *
     * @var string
     */
    protected $defaultEntityTypeCode;

    /**
     * The array with the entity type code + attribute set name => ID mapping.
     *
     * @var array
     */
    protected $entityTypeCodeAndAttributeSetNameIdMapping = array();

    /**
     * Intializes the previously loaded global data for exactly one bunch.
     *
     * @param string $serial The serial of the actual import
     *
     * @return void
     */
    public function setUp($serial)
    {

        // load the status of the actual import
        $status = $this->getRegistryProcessor()->getAttribute(RegistryKeys::STATUS);

        // load the global data we've prepared initially
        $this->entityTypes = $status[RegistryKeys::GLOBAL_DATA][RegistryKeys::ENTITY_TYPES];

        // initialize the default entity type code with the value from the configuration
        $this->defaultEntityTypeCode = $this->getEntityTypeCode();

        // prepare the callbacks
        parent::setUp($serial);
    }

    /**
     * Returns the default entity type code.
     *
     * @return string The default entity type code
     */
    public function getDefaultEntityTypeCode()
    {
        return $this->defaultEntityTypeCode;
    }

    /**
     * Returns the entity type with the passed ID.
     *
     * @param integer $entityTypeId The ID of the entity type to return
     *
     * @return array|null The entity type
     */
    public function getEntityTypeByEntityTypeId($entityTypeId)
    {

        // try to find the entity type with the passed ID and return it, if available
        foreach ($this->entityTypes as $entityType) {
            if ($entityType[MemberNames::ENTITY_TYPE_ID] === $entityTypeId) {
                return $entityType;
            }
        }
    }

    /**
     * Return's the entity type code to be used.
     *
     * @return string The entity type code to be used
     */
    public function getEntityTypeCode()
    {

        // initialize the entity type
        $entityType = null;

        // query wether or not we already have an attribute set
        if ($this->lastAttributeSet) {

            $entityType = $this->getEntityTypeByEntityTypeId($this->lastAttributeSet[MemberNames::ENTITY_TYPE_ID]);
        }

        // load the entity type code from the configuration
        return  $entityType ? $entityType[MemberNames::ENTITY_TYPE_CODE] : parent::getEntityTypeCode();
    }

    /**
     * Return's the entity type for the passed code, of if no entity type code has
     * been passed, the default one from the configuration will be used.
     *
     * @param string|null $entityTypeCode The entity type code
     *
     * @return array The requested entity type
     * @throws \Exception Is thrown, if the entity type with the passed code is not available
     */
    public function getEntityType($entityTypeCode = null)
    {

        // set the default entity type code, if non has been passed
        if ($entityTypeCode === null) {
            $entityTypeCode = $this->getDefaultEntityTypeCode();
        }

        // query whether or not, the entity type with the passed code is available
        if (isset($this->entityTypes[$entityTypeCode])) {
            return $this->entityTypes[$entityTypeCode];
        }

        // throw an exception, if not
        throw new \Exception(
            sprintf(
                'Can\'t find entity type with code %s in file %s on line %d',
                $entityTypeCode,
                $this->getFilename(),
                $this->getLineNumber()
            )
        );
    }

    /**
     * Queries whether or not the attribute set with the passed entity type code and attribute set
     * name has already been processed.
     *
     * @param string $entityTypeCode   The entity type code to check
     * @param string $attributeSetName The attribute set name to check
     *
     * @return boolean TRUE if the attribute set has been processed, else FALSE
     */
    public function hasBeenProcessed($entityTypeCode, $attributeSetName)
    {
        return isset($this->entityTypeCodeAndAttributeSetNameIdMapping[$entityTypeCode][$attributeSetName]);
    }

    /**
     * Map's the passed entity type code and attribute set name to the attribute set ID that has been created recently.
     *
     * @param string $entityTypeCode   The entity type code to map
     * @param string $attributeSetName The attribute set name to map
     *
     * @return void
     */
    public function addEntityTypeCodeAndAttributeSetNameIdMapping($entityTypeCode, $attributeSetName)
    {
        $this->entityTypeCodeAndAttributeSetNameIdMapping[$entityTypeCode][$attributeSetName] = $this->getLastEntityId();
    }

    /**
     * Return's the ID of the attribute set that has been created recently.
     *
     * @return integer The attribute set ID
     * @see \TechDivision\Import\Attribute\Set\Subjects\BunchSubject::getLastAttributeSetId()
     */
    public function getLastEntityId()
    {
        return $this->getLastAttributeSetId();
    }

    /**
     * Return's the ID of the attribute set that has been created recently.
     *
     * @return integer The attribute set ID
     */
    public function getLastAttributeSetId()
    {
        return $this->lastAttributeSet[MemberNames::ATTRIBUTE_SET_ID];
    }

    /**
     * Set's the attribute set that has been created recently.
     *
     * @param array $lastAttributeSet The attribute set
     *
     * @return void
     */
    public function setLastAttributeSet(array $lastAttributeSet)
    {
        $this->lastAttributeSet = $lastAttributeSet;
    }

    /**
     * Return's the attribute set that has been created recently.
     *
     * @return array The attribute set
     */
    public function getLastAttributeSet()
    {
        return $this->lastAttributeSet;
    }

    /**
     * Merge the columns from the configuration with all image type columns to define which
     * columns should be cleaned-up.
     *
     * @return array The columns that has to be cleaned-up
     */
    public function getCleanUpColumns()
    {

        // initialize the array for the columns that has to be cleaned-up
        $cleanUpColumns = array();

        // query whether or not an array has been specified in the configuration
        if ($this->getConfiguration()->hasParam(ConfigurationKeys::CLEAN_UP_EMPTY_COLUMNS)) {
            $cleanUpColumns = $this->getConfiguration()->getParam(ConfigurationKeys::CLEAN_UP_EMPTY_COLUMNS);
        }

        // return the array with the column names
        return $cleanUpColumns;

    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Attribute\Set\Subjects\BunchSubject
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 Tim Wagner <[email protected]>
15			* @copyright 2019 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-attribute-set
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Attribute\Set\Subjects;
22
23			use TechDivision\Import\Subjects\AbstractEavSubject;
24			use TechDivision\Import\Attribute\Utils\RegistryKeys;
25			use TechDivision\Import\Attribute\Set\Utils\MemberNames;
26			use TechDivision\Import\Attribute\Set\Utils\ConfigurationKeys;
27			use TechDivision\Import\Subjects\CleanUpColumnsSubjectInterface;
			0 ignored issues – show Bug introduced 2020-08-05 09:21 UTC by Report Bug Copy Issue Report The type `TechDivision\Import\Subj...ColumnsSubjectInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
28
29			/**
30			* The subject implementation that handles the business logic to persist attribute sets.
31			*
32			* @author Tim Wagner <[email protected]>
33			* @copyright 2019 TechDivision GmbH <[email protected]>
34			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
35			* @link https://github.com/techdivision/import-attribute-set
36			* @link http://www.techdivision.com
37			*/
38			class BunchSubject extends AbstractEavSubject implements BunchSubjectInterface, CleanUpColumnsSubjectInterface
39			{
40
41			/**
42			* The attribute set that has been processed recently.
43			*
44			* @var array
45			*/
46			protected $lastAttributeSet = array();
47
48			/**
49			* The array with the available entity types.
50			*
51			* @var array
52			*/
53			protected $entityTypes = array();
54
55			/**
56			* The default entity type code.
57			*
58			* @var string
59			*/
60			protected $defaultEntityTypeCode;
61
62			/**
63			* The array with the entity type code + attribute set name => ID mapping.
64			*
65			* @var array
66			*/
67			protected $entityTypeCodeAndAttributeSetNameIdMapping = array();
68
69			/**
70			* Intializes the previously loaded global data for exactly one bunch.
71			*
72			* @param string $serial The serial of the actual import
73			*
74			* @return void
75			*/
76			public function setUp($serial)
77			{
78
79			// load the status of the actual import
80			$status = $this->getRegistryProcessor()->getAttribute(RegistryKeys::STATUS);
81
82			// load the global data we've prepared initially
83			$this->entityTypes = $status[RegistryKeys::GLOBAL_DATA][RegistryKeys::ENTITY_TYPES];
84
85			// initialize the default entity type code with the value from the configuration
86			$this->defaultEntityTypeCode = $this->getEntityTypeCode();
87
88			// prepare the callbacks
89			parent::setUp($serial);
90			}
91
92			/**
93			* Returns the default entity type code.
94			*
95			* @return string The default entity type code
96			*/
97			public function getDefaultEntityTypeCode()
98			{
99			return $this->defaultEntityTypeCode;
100			}
101
102			/**
103			* Returns the entity type with the passed ID.
104			*
105			* @param integer $entityTypeId The ID of the entity type to return
106			*
107			* @return array\|null The entity type
108			*/
109			public function getEntityTypeByEntityTypeId($entityTypeId)
110			{
111
112			// try to find the entity type with the passed ID and return it, if available
113			foreach ($this->entityTypes as $entityType) {
114			if ($entityType[MemberNames::ENTITY_TYPE_ID] === $entityTypeId) {
115			return $entityType;
116			}
117			}
118			}
119
120			/**
121			* Return's the entity type code to be used.
122			*
123			* @return string The entity type code to be used
124			*/
125			public function getEntityTypeCode()
126			{
127
128			// initialize the entity type
129			$entityType = null;
130
131			// query wether or not we already have an attribute set
132			if ($this->lastAttributeSet) {
			0 ignored issues – show Bug Best Practice introduced 2019-01-07 14:02 UTC by Report Bug Copy Issue Report The expression `$this->lastAttributeSet` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
133			$entityType = $this->getEntityTypeByEntityTypeId($this->lastAttributeSet[MemberNames::ENTITY_TYPE_ID]);
134			}
135
136			// load the entity type code from the configuration
137			return $entityType ? $entityType[MemberNames::ENTITY_TYPE_CODE] : parent::getEntityTypeCode();
138			}
139
140			/**
141			* Return's the entity type for the passed code, of if no entity type code has
142			* been passed, the default one from the configuration will be used.
143			*
144			* @param string\|null $entityTypeCode The entity type code
145			*
146			* @return array The requested entity type
147			* @throws \Exception Is thrown, if the entity type with the passed code is not available
148			*/
149			public function getEntityType($entityTypeCode = null)
150			{
151
152			// set the default entity type code, if non has been passed
153			if ($entityTypeCode === null) {
154			$entityTypeCode = $this->getDefaultEntityTypeCode();
155			}
156
157			// query whether or not, the entity type with the passed code is available
158			if (isset($this->entityTypes[$entityTypeCode])) {
159			return $this->entityTypes[$entityTypeCode];
160			}
161
162			// throw an exception, if not
163			throw new \Exception(
164			sprintf(
165			'Can\'t find entity type with code %s in file %s on line %d',
166			$entityTypeCode,
167			$this->getFilename(),
168			$this->getLineNumber()
169			)
170			);
171			}
172
173			/**
174			* Queries whether or not the attribute set with the passed entity type code and attribute set
175			* name has already been processed.
176			*
177			* @param string $entityTypeCode The entity type code to check
178			* @param string $attributeSetName The attribute set name to check
179			*
180			* @return boolean TRUE if the attribute set has been processed, else FALSE
181			*/
182			public function hasBeenProcessed($entityTypeCode, $attributeSetName)
183			{
184			return isset($this->entityTypeCodeAndAttributeSetNameIdMapping[$entityTypeCode][$attributeSetName]);
185			}
186
187			/**
188			* Map's the passed entity type code and attribute set name to the attribute set ID that has been created recently.
189			*
190			* @param string $entityTypeCode The entity type code to map
191			* @param string $attributeSetName The attribute set name to map
192			*
193			* @return void
194			*/
195			public function addEntityTypeCodeAndAttributeSetNameIdMapping($entityTypeCode, $attributeSetName)
196			{
197			$this->entityTypeCodeAndAttributeSetNameIdMapping[$entityTypeCode][$attributeSetName] = $this->getLastEntityId();
198			}
199
200			/**
201			* Return's the ID of the attribute set that has been created recently.
202			*
203			* @return integer The attribute set ID
204			* @see \TechDivision\Import\Attribute\Set\Subjects\BunchSubject::getLastAttributeSetId()
205			*/
206			public function getLastEntityId()
207			{
208			return $this->getLastAttributeSetId();
209			}
210
211			/**
212			* Return's the ID of the attribute set that has been created recently.
213			*
214			* @return integer The attribute set ID
215			*/
216			public function getLastAttributeSetId()
217			{
218			return $this->lastAttributeSet[MemberNames::ATTRIBUTE_SET_ID];
219			}
220
221			/**
222			* Set's the attribute set that has been created recently.
223			*
224			* @param array $lastAttributeSet The attribute set
225			*
226			* @return void
227			*/
228			public function setLastAttributeSet(array $lastAttributeSet)
229			{
230			$this->lastAttributeSet = $lastAttributeSet;
231			}
232
233			/**
234			* Return's the attribute set that has been created recently.
235			*
236			* @return array The attribute set
237			*/
238			public function getLastAttributeSet()
239			{
240			return $this->lastAttributeSet;
241			}
242
243			/**
244			* Merge the columns from the configuration with all image type columns to define which
245			* columns should be cleaned-up.
246			*
247			* @return array The columns that has to be cleaned-up
248			*/
249			public function getCleanUpColumns()
250			{
251
252			// initialize the array for the columns that has to be cleaned-up
253			$cleanUpColumns = array();
254
255			// query whether or not an array has been specified in the configuration
256			if ($this->getConfiguration()->hasParam(ConfigurationKeys::CLEAN_UP_EMPTY_COLUMNS)) {
257			$cleanUpColumns = $this->getConfiguration()->getParam(ConfigurationKeys::CLEAN_UP_EMPTY_COLUMNS);
258			}
259
260			// return the array with the column names
261			return $cleanUpColumns;
			0 ignored issues – show Bug Best Practice introduced 2020-05-15 16:45 UTC by Report Bug Copy Issue Report The expression `return $cleanUpColumns` also could return the type `string` which is incompatible with the documented return type `array`. Loading history...
262			}
263			}
264

techdivision / import-attribute-set

Push — master ( 7e2127...77c655 )

BunchSubject::getCleanUpColumns() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like