CopyParentAttributeSetObserver::shouldCopy() - Code Metrics - techdivision/import-attribute-set - Measure and Improve Code Quality continuously with Scrutinizer

CopyParentAttributeSetObserver::shouldCopy() A
last analyzed 2023-05-05 15:51 UTC

↳ Parent: CopyParentAttributeSetObserver

Complexity

Conditions	4
Paths	4

Size

Total Lines	10
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	4
c	1
b	0
f	0
nc	4
nop	0
dl	0
loc	10
ccs	0
cts	5
cp	0
crap	20
rs	10

<?php

/**
 * TechDivision\Import\Attribute\Set\Observers\CopyParentAttributeSetObserver
 *
 * PHP version 7
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2019 TechDivision GmbH <[email protected]>
 * @license   https://opensource.org/licenses/MIT
 * @link      https://github.com/techdivision/import-attribute-set
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Attribute\Set\Observers;

use TechDivision\Import\Attribute\Set\Utils\ColumnKeys;
use TechDivision\Import\Attribute\Set\Utils\MemberNames;
use TechDivision\Import\Dbal\Utils\EntityStatus;
use TechDivision\Import\Attribute\Set\Utils\ConfigurationKeys;

/**
 * Observer that copies the EAV attribute groups and attribute relations from the parent.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2019 TechDivision GmbH <[email protected]>
 * @license   https://opensource.org/licenses/MIT
 * @link      https://github.com/techdivision/import-attribute-set
 * @link      http://www.techdivision.com
 */
class CopyParentAttributeSetObserver extends AbstractAttributeSetObserver
{

    /**
     * Process the observer's business logic.
     *
     * @return void
     */
    protected function process()
    {

        // load the last attribute set
        $attributeSet = $this->getLastAttributeSet();

        // query whether or not the a given attribute set has to be extended
        if ($this->shouldCopy()) {
            // load the attribute set the new one is based on
            $basedOn = $this->loadAttributeSetByEntityTypeCodeAndAttributeSetName(
                $this->getValue(ColumnKeys::ENTITY_TYPE_CODE),
                $this->getValue(ColumnKeys::BASED_ON)
            );

            // load the attribute groups of the attribute set the new one should be based on
            $attributeGroupsBasedOn = $this->loadAttributeGroupsByAttributeSetId($basedOn[MemberNames::ATTRIBUTE_SET_ID]);

            // copy the attribute groups from the based on
            foreach ($attributeGroupsBasedOn as $attributeGroupBasedOn) {
                // create the attribute group
                $attributeGroupId = $this->persistAttributeGroup(
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
                    $attributeGroup = $this->initializeAttributeForAttributeGroup(
                        $this->prepareAttributesForAttributeGroup($attributeSet, $attributeGroupBasedOn)
                    )
                );

                // set the new attribute group ID
                $attributeGroup[MemberNames::ATTRIBUTE_GROUP_ID] = $attributeGroupId;

                // load the entity attributes of the attribute group
                $entityAttributes = $this->loadEntityAttributesByAttributeGroupId($attributeGroupBasedOn[MemberNames::ATTRIBUTE_GROUP_ID]);

                // copy the attribute group => attribute relation
                foreach ($entityAttributes as $entityAttribute) {
                    $this->persistEntityAttribute(
                        $this->initializeAttributeForEntityAttribute(
                            $this->prepareAttributesForEntityAttribute($attributeSet, $attributeGroup, $entityAttribute)
                        )
                    );
                }
            }
        }
    }

    /**
     * Queries whether or not the attribute groups and attribute relations of the attribute
     * set the actual one is based on, should be copied or not.
     *
     * They SHOULD be copied if the attribute set is new and has been created recently or
     * if the attribute set already exists and the `copy-parent-on-update` flag parameter
     * has been set to TRUE.
     *
     * @return boolean TRUE if the attribute groups and attribute relations should be copied, else FALSE
     */
    protected function shouldCopy()
    {

        // load the last attribute set
        $attributeSet = $this->getLastAttributeSet();

        // query whether or not the a given attribute set has to be extended
        return $this->hasValue(ColumnKeys::BASED_ON) && (
            $attributeSet[EntityStatus::MEMBER_NAME] === EntityStatus::STATUS_CREATE || (
                $attributeSet[EntityStatus::MEMBER_NAME] === EntityStatus::STATUS_UPDATE && $this->shouldCopyParentOnUpdate())
            );
    }

    /**
     * Queries whether or not the configuration param `copy-parent-on-update` has been set,
     * if yes it returns the value.
     *
     * @return boolean TRUE if the param is set and the value is TRUE, else FALSE
     */
    protected function shouldCopyParentOnUpdate()
    {

        // load the subject's configuration
        $configuration = $this->getSubject()->getConfiguration();

        // return the configuration value
        if ($configuration->hasParam(ConfigurationKeys::COPY_PARENT_ON_UPDATE)) {
            return $configuration->getParam(ConfigurationKeys::COPY_PARENT_ON_UPDATE);
        }

        // return FALSE
        return false;
    }

    /**
     * Prepare the attributes of the entity that has to be persisted.
     *
     * @param array $attributeSet    The attribute set with the data used to prepare the entity attribute
     * @param array $attributeGroup  The attribute group with the data used to prepare the entity attribute
     * @param array $entityAttribute The entity attribute with the data used to prepare the entity attribute
     *
     * @return array The prepared attributes
     */
    protected function prepareAttributesForEntityAttribute(array $attributeSet, array $attributeGroup, array $entityAttribute)
    {

        // return the prepared product
        return $this->initializeEntity(
            array(
                MemberNames::ATTRIBUTE_SET_ID   => $attributeSet[MemberNames::ATTRIBUTE_SET_ID],
                MemberNames::ATTRIBUTE_GROUP_ID => $attributeGroup[MemberNames::ATTRIBUTE_GROUP_ID],
                MemberNames::ATTRIBUTE_ID       => $entityAttribute[MemberNames::ATTRIBUTE_ID],
                MemberNames::ENTITY_TYPE_ID     => $entityAttribute[MemberNames::ENTITY_TYPE_ID],
                MemberNames::SORT_ORDER         => $entityAttribute[MemberNames::SORT_ORDER]
            )
        );
    }

    /**
     * Prepare the attributes of the entity that has to be persisted.
     *
     * @param array $attributeSet   The attribute set with the data used to prepare the attribute group
     * @param array $attributeGroup The attribute group with the data used to prepare the attribute group
     *
     * @return array The prepared attributes
     */
    protected function prepareAttributesForAttributeGroup(array $attributeSet, array $attributeGroup)
    {

        // return the prepared product
        return $this->initializeEntity(
            array(
                MemberNames::ATTRIBUTE_SET_ID     => $attributeSet[MemberNames::ATTRIBUTE_SET_ID],
                MemberNames::ATTRIBUTE_GROUP_NAME => $attributeGroup[MemberNames::ATTRIBUTE_GROUP_NAME],
                MemberNames::SORT_ORDER           => $attributeGroup[MemberNames::SORT_ORDER],
                MemberNames::DEFAULT_ID           => $attributeGroup[MemberNames::DEFAULT_ID],
                MemberNames::ATTRIBUTE_GROUP_CODE => $attributeGroup[MemberNames::ATTRIBUTE_GROUP_CODE],
                MemberNames::TAB_GROUP_CODE       => $attributeGroup[MemberNames::TAB_GROUP_CODE]
            )
        );
    }

    /**
     * Initialize the attribute with the passed attributes and returns an instance.
     *
     * @param array $attr The attribute attributes
     *
     * @return array The initialized attribute
     */
    protected function initializeAttributeForAttributeGroup(array $attr)
    {
        return $attr;
    }

    /**
     * Initialize the attribute with the passed attributes and returns an instance.
     *
     * @param array $attr The attribute attributes
     *
     * @return array The initialized attribute
     */
    protected function initializeAttributeForEntityAttribute(array $attr)
    {
        return $attr;
    }

    /**
     * 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
     */
    protected function getEntityType($entityTypeCode = null)
    {
        return $this->getSubject()->getEntityType($entityTypeCode);
    }

    /**
     * Load's and return's the EAV attribute set with the passed entity type code and attribute set name.
     *
     * @param string $entityTypeCode   The entity type code of the EAV attribute set to load
     * @param string $attributeSetName The attribute set name of the EAV attribute set to return
     *
     * @return array The EAV attribute set
     */
    protected function loadAttributeSetByEntityTypeCodeAndAttributeSetName($entityTypeCode, $attributeSetName)
    {
        return $this->getAttributeSetBunchProcessor()->loadAttributeSetByEntityTypeCodeAndAttributeSetName($entityTypeCode, $attributeSetName);
    }

    /**
     * Return's the attribute groups for the passed attribute set ID, whereas the array
     * is prepared with the attribute group names as keys.
     *
     * @param mixed $attributeSetId The EAV attribute set ID to return the attribute groups for
     *
     * @return array|boolean The EAV attribute groups for the passed attribute ID
     */
    protected function loadAttributeGroupsByAttributeSetId($attributeSetId)
    {
        return $this->getAttributeSetBunchProcessor()->loadAttributeGroupsByAttributeSetId($attributeSetId);
    }

    /**
     * Returns the EAV entity attributes for the attribute group with the passed ID.
     *
     * @param integer $attributeGroupId The attribute group ID to load the EAV entity attributes for
     *
     * @return array|null The EAV attributes with for the passed attribute group ID
     */
    protected function loadEntityAttributesByAttributeGroupId($attributeGroupId)
    {
        return $this->getAttributeSetBunchProcessor()->loadEntityAttributesByAttributeGroupId($attributeGroupId);
    }

    /**
     * Persist the passed attribute group.
     *
     * @param array $attributeGroup The attribute group to persist
     *
     * @return void
     */
    protected function persistAttributeGroup(array $attributeGroup)
    {
        return $this->getAttributeSetBunchProcessor()->persistAttributeGroup($attributeGroup);

    }

    /**
     * Persist the passed entity attribute.
     *
     * @param array $entityAttribute The entity attribute to persist
     *
     * @return void
     */
    protected function persistEntityAttribute(array $entityAttribute)
    {
        return $this->getAttributeSetBunchProcessor()->persistEntityAttribute($entityAttribute);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Attribute\Set\Observers\CopyParentAttributeSetObserver
5			*
6			* PHP version 7
7			*
8			* @author Tim Wagner <[email protected]>
9			* @copyright 2019 TechDivision GmbH <[email protected]>
10			* @license https://opensource.org/licenses/MIT
11			* @link https://github.com/techdivision/import-attribute-set
12			* @link http://www.techdivision.com
13			*/
14
15			namespace TechDivision\Import\Attribute\Set\Observers;
16
17			use TechDivision\Import\Attribute\Set\Utils\ColumnKeys;
18			use TechDivision\Import\Attribute\Set\Utils\MemberNames;
19			use TechDivision\Import\Dbal\Utils\EntityStatus;
20			use TechDivision\Import\Attribute\Set\Utils\ConfigurationKeys;
21
22			/**
23			* Observer that copies the EAV attribute groups and attribute relations from the parent.
24			*
25			* @author Tim Wagner <[email protected]>
26			* @copyright 2019 TechDivision GmbH <[email protected]>
27			* @license https://opensource.org/licenses/MIT
28			* @link https://github.com/techdivision/import-attribute-set
29			* @link http://www.techdivision.com
30			*/
31			class CopyParentAttributeSetObserver extends AbstractAttributeSetObserver
32			{
33
34			/**
35			* Process the observer's business logic.
36			*
37			* @return void
38			*/
39			protected function process()
40			{
41
42			// load the last attribute set
43			$attributeSet = $this->getLastAttributeSet();
44
45			// query whether or not the a given attribute set has to be extended
46			if ($this->shouldCopy()) {
47			// load the attribute set the new one is based on
48			$basedOn = $this->loadAttributeSetByEntityTypeCodeAndAttributeSetName(
49			$this->getValue(ColumnKeys::ENTITY_TYPE_CODE),
50			$this->getValue(ColumnKeys::BASED_ON)
51			);
52
53			// load the attribute groups of the attribute set the new one should be based on
54			$attributeGroupsBasedOn = $this->loadAttributeGroupsByAttributeSetId($basedOn[MemberNames::ATTRIBUTE_SET_ID]);
55
56			// copy the attribute groups from the based on
57			foreach ($attributeGroupsBasedOn as $attributeGroupBasedOn) {
58			// create the attribute group
59			$attributeGroupId = $this->persistAttributeGroup(
			0 ignored issues – show Bug introduced 2019-03-14 19:20 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$attributeGroupId` is correct as `$this->persistAttributeG...ttributeGroupBasedOn)))` targeting `TechDivision\Import\Attr...persistAttributeGroup()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
60			$attributeGroup = $this->initializeAttributeForAttributeGroup(
61			$this->prepareAttributesForAttributeGroup($attributeSet, $attributeGroupBasedOn)
62			)
63			);
64
65			// set the new attribute group ID
66			$attributeGroup[MemberNames::ATTRIBUTE_GROUP_ID] = $attributeGroupId;
67
68			// load the entity attributes of the attribute group
69			$entityAttributes = $this->loadEntityAttributesByAttributeGroupId($attributeGroupBasedOn[MemberNames::ATTRIBUTE_GROUP_ID]);
70
71			// copy the attribute group => attribute relation
72			foreach ($entityAttributes as $entityAttribute) {
73			$this->persistEntityAttribute(
74			$this->initializeAttributeForEntityAttribute(
75			$this->prepareAttributesForEntityAttribute($attributeSet, $attributeGroup, $entityAttribute)
76			)
77			);
78			}
79			}
80			}
81			}
82
83			/**
84			* Queries whether or not the attribute groups and attribute relations of the attribute
85			* set the actual one is based on, should be copied or not.
86			*
87			* They SHOULD be copied if the attribute set is new and has been created recently or
88			* if the attribute set already exists and the `copy-parent-on-update` flag parameter
89			* has been set to TRUE.
90			*
91			* @return boolean TRUE if the attribute groups and attribute relations should be copied, else FALSE
92			*/
93			protected function shouldCopy()
94			{
95
96			// load the last attribute set
97			$attributeSet = $this->getLastAttributeSet();
98
99			// query whether or not the a given attribute set has to be extended
100			return $this->hasValue(ColumnKeys::BASED_ON) && (
101			$attributeSet[EntityStatus::MEMBER_NAME] === EntityStatus::STATUS_CREATE \|\| (
102			$attributeSet[EntityStatus::MEMBER_NAME] === EntityStatus::STATUS_UPDATE && $this->shouldCopyParentOnUpdate())
103			);
104			}
105
106			/**
107			* Queries whether or not the configuration param `copy-parent-on-update` has been set,
108			* if yes it returns the value.
109			*
110			* @return boolean TRUE if the param is set and the value is TRUE, else FALSE
111			*/
112			protected function shouldCopyParentOnUpdate()
113			{
114
115			// load the subject's configuration
116			$configuration = $this->getSubject()->getConfiguration();
117
118			// return the configuration value
119			if ($configuration->hasParam(ConfigurationKeys::COPY_PARENT_ON_UPDATE)) {
120			return $configuration->getParam(ConfigurationKeys::COPY_PARENT_ON_UPDATE);
121			}
122
123			// return FALSE
124			return false;
125			}
126
127			/**
128			* Prepare the attributes of the entity that has to be persisted.
129			*
130			* @param array $attributeSet The attribute set with the data used to prepare the entity attribute
131			* @param array $attributeGroup The attribute group with the data used to prepare the entity attribute
132			* @param array $entityAttribute The entity attribute with the data used to prepare the entity attribute
133			*
134			* @return array The prepared attributes
135			*/
136			protected function prepareAttributesForEntityAttribute(array $attributeSet, array $attributeGroup, array $entityAttribute)
137			{
138
139			// return the prepared product
140			return $this->initializeEntity(
141			array(
142			MemberNames::ATTRIBUTE_SET_ID => $attributeSet[MemberNames::ATTRIBUTE_SET_ID],
143			MemberNames::ATTRIBUTE_GROUP_ID => $attributeGroup[MemberNames::ATTRIBUTE_GROUP_ID],
144			MemberNames::ATTRIBUTE_ID => $entityAttribute[MemberNames::ATTRIBUTE_ID],
145			MemberNames::ENTITY_TYPE_ID => $entityAttribute[MemberNames::ENTITY_TYPE_ID],
146			MemberNames::SORT_ORDER => $entityAttribute[MemberNames::SORT_ORDER]
147			)
148			);
149			}
150
151			/**
152			* Prepare the attributes of the entity that has to be persisted.
153			*
154			* @param array $attributeSet The attribute set with the data used to prepare the attribute group
155			* @param array $attributeGroup The attribute group with the data used to prepare the attribute group
156			*
157			* @return array The prepared attributes
158			*/
159			protected function prepareAttributesForAttributeGroup(array $attributeSet, array $attributeGroup)
160			{
161
162			// return the prepared product
163			return $this->initializeEntity(
164			array(
165			MemberNames::ATTRIBUTE_SET_ID => $attributeSet[MemberNames::ATTRIBUTE_SET_ID],
166			MemberNames::ATTRIBUTE_GROUP_NAME => $attributeGroup[MemberNames::ATTRIBUTE_GROUP_NAME],
167			MemberNames::SORT_ORDER => $attributeGroup[MemberNames::SORT_ORDER],
168			MemberNames::DEFAULT_ID => $attributeGroup[MemberNames::DEFAULT_ID],
169			MemberNames::ATTRIBUTE_GROUP_CODE => $attributeGroup[MemberNames::ATTRIBUTE_GROUP_CODE],
170			MemberNames::TAB_GROUP_CODE => $attributeGroup[MemberNames::TAB_GROUP_CODE]
171			)
172			);
173			}
174
175			/**
176			* Initialize the attribute with the passed attributes and returns an instance.
177			*
178			* @param array $attr The attribute attributes
179			*
180			* @return array The initialized attribute
181			*/
182			protected function initializeAttributeForAttributeGroup(array $attr)
183			{
184			return $attr;
185			}
186
187			/**
188			* Initialize the attribute with the passed attributes and returns an instance.
189			*
190			* @param array $attr The attribute attributes
191			*
192			* @return array The initialized attribute
193			*/
194			protected function initializeAttributeForEntityAttribute(array $attr)
195			{
196			return $attr;
197			}
198
199			/**
200			* Return's the entity type for the passed code, of if no entity type code has
201			* been passed, the default one from the configuration will be used.
202			*
203			* @param string\|null $entityTypeCode The entity type code
204			*
205			* @return array The requested entity type
206			* @throws \Exception Is thrown, if the entity type with the passed code is not available
207			*/
208			protected function getEntityType($entityTypeCode = null)
209			{
210			return $this->getSubject()->getEntityType($entityTypeCode);
211			}
212
213			/**
214			* Load's and return's the EAV attribute set with the passed entity type code and attribute set name.
215			*
216			* @param string $entityTypeCode The entity type code of the EAV attribute set to load
217			* @param string $attributeSetName The attribute set name of the EAV attribute set to return
218			*
219			* @return array The EAV attribute set
220			*/
221			protected function loadAttributeSetByEntityTypeCodeAndAttributeSetName($entityTypeCode, $attributeSetName)
222			{
223			return $this->getAttributeSetBunchProcessor()->loadAttributeSetByEntityTypeCodeAndAttributeSetName($entityTypeCode, $attributeSetName);
224			}
225
226			/**
227			* Return's the attribute groups for the passed attribute set ID, whereas the array
228			* is prepared with the attribute group names as keys.
229			*
230			* @param mixed $attributeSetId The EAV attribute set ID to return the attribute groups for
231			*
232			* @return array\|boolean The EAV attribute groups for the passed attribute ID
233			*/
234			protected function loadAttributeGroupsByAttributeSetId($attributeSetId)
235			{
236			return $this->getAttributeSetBunchProcessor()->loadAttributeGroupsByAttributeSetId($attributeSetId);
237			}
238
239			/**
240			* Returns the EAV entity attributes for the attribute group with the passed ID.
241			*
242			* @param integer $attributeGroupId The attribute group ID to load the EAV entity attributes for
243			*
244			* @return array\|null The EAV attributes with for the passed attribute group ID
245			*/
246			protected function loadEntityAttributesByAttributeGroupId($attributeGroupId)
247			{
248			return $this->getAttributeSetBunchProcessor()->loadEntityAttributesByAttributeGroupId($attributeGroupId);
249			}
250
251			/**
252			* Persist the passed attribute group.
253			*
254			* @param array $attributeGroup The attribute group to persist
255			*
256			* @return void
257			*/
258			protected function persistAttributeGroup(array $attributeGroup)
259			{
260			return $this->getAttributeSetBunchProcessor()->persistAttributeGroup($attributeGroup);
			0 ignored issues – show Bug Best Practice introduced 2019-03-14 19:20 UTC by Report Bug Copy Issue Report The expression `return $this->getAttribu...eGroup($attributeGroup)` returns the type `string` which is incompatible with the documented return type `void`. Loading history...
261			}
262
263			/**
264			* Persist the passed entity attribute.
265			*
266			* @param array $entityAttribute The entity attribute to persist
267			*
268			* @return void
269			*/
270			protected function persistEntityAttribute(array $entityAttribute)
271			{
272			return $this->getAttributeSetBunchProcessor()->persistEntityAttribute($entityAttribute);
			0 ignored issues – show Bug introduced 2019-03-14 19:20 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->getAttributeSetBu...ibute($entityAttribute)` targeting `TechDivision\Import\Attr...ersistEntityAttribute()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
273			}
274			}
275

techdivision / import-attribute-set

CopyParentAttributeSetObserver::shouldCopy() A last analyzed 2023-05-05 15:51 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

CopyParentAttributeSetObserver::shouldCopy() A
last analyzed 2023-05-05 15:51 UTC