ProductAttributeObserver::persistProductDatetimeAttribute() - Code Metrics - Inspection of "Refactor + generalize observers" - techdivision/import-product - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#19)

by Tim

created 2017-01-07 14:24 UTC

persistProductDatetimeAttribute() A

↳ Parent: ProductAttributeObserver

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

/**
 * TechDivision\Import\Product\Observers\ProductAttributeObserver
 *
 * 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 2016 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-product
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Observers;

use TechDivision\Import\Utils\StoreViewCodes;
use TechDivision\Import\Product\Utils\MemberNames;
use TechDivision\Import\Product\Observers\AbstractProductImportObserver;

/**
 * Observer that creates/updates the product's attributes.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 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-product
 * @link      http://www.techdivision.com
 */
class ProductAttributeObserver extends AbstractProductImportObserver
{

    /**
     * The ID of the attribute to create the values for.
     *
     * @var integer
     */
    protected $attributeId;

    /**
     * The attribute code of the attribute to create the values for.
     *
     * @var string
     */
    protected $attributeCode;

    /**
     * The backend type of the attribute to create the values for.
     *
     * @var string
     */
    protected $backendType;

    /**
     * The attribute value to process.
     *
     * @var mixed
     */
    protected $attributeValue;

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

        // initialize the store view code
        $this->prepareStoreViewCode();

        // load the attributes by the found attribute set
        $attributes = $this->getAttributes();

        // iterate over the attribute related by the found attribute set
        foreach ($attributes as $attribute) {
            // load the attribute code/ID
            $attributeCode = $attribute[MemberNames::ATTRIBUTE_CODE];
            $attributeId = (integer) $attribute[MemberNames::ATTRIBUTE_ID];

            // query weather or not we've a mapping, if yes, map the attribute code
            $attributeCode = $this->mapAttributeCodeByHeaderMapping($attributeCode);

            // query whether or not we've a attribute value found
            $attributeValue = $this->getValue($attributeCode);
            if ($attributeValue == null) {
                continue;
            }

            // load the backend type => to find the apropriate entity
            $backendType = $attribute[MemberNames::BACKEND_TYPE];
            if ($backendType == null) {
                $this->getSystemLogger()
                     ->warning(sprintf('Found EMTPY backend type for attribute %s', $attributeCode));
                continue;
            }

            // load the supported backend types
            $backendTypes = $this->getBackendTypes();

            // query whether or not we've found a supported backend type
            if (isset($backendTypes[$backendType])) {
                // initialize attribute ID/code and backend type
                $this->setAttributeId($attributeId);
                $this->setAttributeCode($attributeCode);
                $this->setBackendType($backendType);

                // initialize the persist method for the found backend type
                list ($persistMethod, ) = $backendTypes[$backendType];

                // set the attribute value
                $this->setAttributeValue($attributeValue);

                // load the prepared values
                $entity = $this->initializeAttribute($this->prepareAttributes());

                // persist the attribute
                $this->$persistMethod($entity);


            } else {
                // log the debug message
                $this->getSystemLogger()->debug(
                    sprintf('Found invalid backend type %s for attribute %s', $backendType, $attributeCode)
                );
            }
        }
    }

    /**
     * Prepare the attributes of the entity that has to be persisted.
     *
     * @return array The prepared attributes
     */
    protected function prepareAttributes()
    {

        // load the attribute value
        $attributeValue = $this->getAttributeValue();

        // laod the callbacks for the actual attribute code
        $callbacks = $this->getCallbacksByType($this->getAttributeCode());

        // invoke the pre-cast callbacks
        foreach ($callbacks as $callback) {
            $attributeValue = $callback->handle($attributeValue);
        }

        // load the ID of the product that has been created recently
        $lastEntityId = $this->getPrimaryKey();

        // load the ID of the attribute to create the values for
        $attributeId = $this->getAttributeId();

        // load the store ID
        $storeId = $this->getRowStoreId(StoreViewCodes::ADMIN);

        // load the backend type of the actual attribute
        $backendType = $this->getBackendType();

        // cast the value based on the backend type
        $castedValue = $this->castValueByBackendType($backendType, $attributeValue);

        // prepare the attribute values
        return $this->initializeEntity(
            array(
                MemberNames::ENTITY_ID    => $lastEntityId,
                MemberNames::ATTRIBUTE_ID => $attributeId,
                MemberNames::STORE_ID     => $storeId,
                MemberNames::VALUE        => $castedValue
            )
        );
    }

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

    /**
     * Return's the PK to create the product => attribute relation.
     *
     * @return integer The PK to create the relation with
     */
    protected function getPrimaryKey()
    {
        return $this->getLastEntityId();
    }

    /**
     * Set's the attribute value to process.
     *
     * @param mixed $attributeValue The attribute value
     *
     * @return void
     */
    protected function setAttributeValue($attributeValue)
    {
        $this->attributeValue = $attributeValue;
    }

    /**
     * Return's the attribute value to process.
     *
     * @return mixed The attribute value
     */
    protected function getAttributeValue()
    {
        return $this->attributeValue;
    }

    /**
     * Set's the backend type of the attribute to create the values for.
     *
     * @param string $backendType The backend type
     *
     * @return void
     */
    protected function setBackendType($backendType)
    {
        $this->backendType = $backendType;
    }

    /**
     * Return's the backend type of the attribute to create the values for.
     *
     * @return string The backend type
     */
    protected function getBackendType()
    {
        return $this->backendType;
    }

    /**
     * Set's the attribute code of the attribute to create the values for.
     *
     * @param string $attributeCode The attribute code
     *
     * @return void
     */
    protected function setAttributeCode($attributeCode)
    {
        $this->attributeCode = $attributeCode;
    }

    /**
     * Return's the attribute code of the attribute to create the values for.
     *
     * @return string The attribute code
     */
    protected function getAttributeCode()
    {
        return $this->attributeCode;
    }

    /**
     * Set's the ID of the attribute to create the values for.
     *
     * @param integer $attributeId The attribute ID
     *
     * @return void
     */
    protected function setAttributeId($attributeId)
    {
        $this->attributeId = $attributeId;
    }

    /**
     * Return's the ID of the attribute to create the values for.
     *
     * @return integer The attribute ID
     */
    protected function getAttributeId()
    {
        return $this->attributeId;
    }

    /**
     * Map the passed attribute code, if a header mapping exists and return the
     * mapped mapping.
     *
     * @param string $attributeCode The attribute code to map
     *
     * @return string The mapped attribute code, or the original one
     */
    protected function mapAttributeCodeByHeaderMapping($attributeCode)
    {
        return $this->getSubject()->mapAttributeCodeByHeaderMapping($attributeCode);
    }

    /**
     * Return's the array with callbacks for the passed type.
     *
     * @param string $type The type of the callbacks to return
     *
     * @return array The callbacks
     */
    protected function getCallbacksByType($type)
    {
        return $this->getSubject()->getCallbacksByType($type);
    }

    /**
     * Return's mapping for the supported backend types (for the product entity) => persist methods.
     *
     * @return array The mapping for the supported backend types
     */
    protected function getBackendTypes()
    {
        return $this->getSubject()->getBackendTypes();
    }

    /**
     * Return's the attributes for the attribute set of the product that has to be created.
     *
     * @return array The attributes
     * @throws \Exception
     */
    protected function getAttributes()
    {
        return $this->getSubject()->getAttributes();
    }

    /**
     * Return's the store ID of the actual row, or of the default store
     * if no store view code is set in the CSV file.
     *
     * @param string|null $default The default store view code to use, if no store view code is set in the CSV file
     *
     * @return integer The ID of the actual store
     * @throws \Exception Is thrown, if the store with the actual code is not available
     */
    protected function getRowStoreId($default = null)
    {
        return $this->getSubject()->getRowStoreId($default);
    }

    /**
     * Persist's the passed product varchar attribute.
     *
     * @param array $attribute The attribute to persist
     *
     * @return void
     */
    protected function persistProductVarcharAttribute($attribute)
    {
        $this->getSubject()->persistProductVarcharAttribute($attribute);
    }

    /**
     * Persist's the passed product integer attribute.
     *
     * @param array $attribute The attribute to persist
     *
     * @return void
     */
    protected function persistProductIntAttribute($attribute)
    {
        $this->getSubject()->persistProductIntAttribute($attribute);
    }

    /**
     * Persist's the passed product decimal attribute.
     *
     * @param array $attribute The attribute to persist
     *
     * @return void
     */
    protected function persistProductDecimalAttribute($attribute)
    {
        $this->getSubject()->persistProductDecimalAttribute($attribute);
    }

    /**
     * Persist's the passed product datetime attribute.
     *
     * @param array $attribute The attribute to persist
     *
     * @return void
     */
    protected function persistProductDatetimeAttribute($attribute)
    {
        $this->getSubject()->persistProductDatetimeAttribute($attribute);
    }

    /**
     * Persist's the passed product text attribute.
     *
     * @param array $attribute The attribute to persist
     *
     * @return void
     */
    protected function persistProductTextAttribute($attribute)
    {
        $this->getSubject()->persistProductTextAttribute($attribute);
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Product\Observers\ProductAttributeObserver
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 2016 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-product
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Product\Observers;
22
23			use TechDivision\Import\Utils\StoreViewCodes;
24			use TechDivision\Import\Product\Utils\MemberNames;
25			use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
26
27			/**
28			* Observer that creates/updates the product's attributes.
29			*
30			* @author Tim Wagner <[email protected]>
31			* @copyright 2016 TechDivision GmbH <[email protected]>
32			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
33			* @link https://github.com/techdivision/import-product
34			* @link http://www.techdivision.com
35			*/
36			class ProductAttributeObserver extends AbstractProductImportObserver
37			{
38
39			/**
40			* The ID of the attribute to create the values for.
41			*
42			* @var integer
43			*/
44			protected $attributeId;
45
46			/**
47			* The attribute code of the attribute to create the values for.
48			*
49			* @var string
50			*/
51			protected $attributeCode;
52
53			/**
54			* The backend type of the attribute to create the values for.
55			*
56			* @var string
57			*/
58			protected $backendType;
59
60			/**
61			* The attribute value to process.
62			*
63			* @var mixed
64			*/
65			protected $attributeValue;
66
67			/**
68			* Process the observer's business logic.
69			*
70			* @return void
71			*/
72			protected function process()
73			{
74
75			// initialize the store view code
76			$this->prepareStoreViewCode();
77
78			// load the attributes by the found attribute set
79			$attributes = $this->getAttributes();
80
81			// iterate over the attribute related by the found attribute set
82			foreach ($attributes as $attribute) {
83			// load the attribute code/ID
84			$attributeCode = $attribute[MemberNames::ATTRIBUTE_CODE];
85			$attributeId = (integer) $attribute[MemberNames::ATTRIBUTE_ID];
86
87			// query weather or not we've a mapping, if yes, map the attribute code
88			$attributeCode = $this->mapAttributeCodeByHeaderMapping($attributeCode);
89
90			// query whether or not we've a attribute value found
91			$attributeValue = $this->getValue($attributeCode);
92			if ($attributeValue == null) {
93			continue;
94			}
95
96			// load the backend type => to find the apropriate entity
97			$backendType = $attribute[MemberNames::BACKEND_TYPE];
98			if ($backendType == null) {
99			$this->getSystemLogger()
100			->warning(sprintf('Found EMTPY backend type for attribute %s', $attributeCode));
101			continue;
102			}
103
104			// load the supported backend types
105			$backendTypes = $this->getBackendTypes();
106
107			// query whether or not we've found a supported backend type
108			if (isset($backendTypes[$backendType])) {
109			// initialize attribute ID/code and backend type
110			$this->setAttributeId($attributeId);
111			$this->setAttributeCode($attributeCode);
112			$this->setBackendType($backendType);
113
114			// initialize the persist method for the found backend type
115			list ($persistMethod, ) = $backendTypes[$backendType];
116
117			// set the attribute value
118			$this->setAttributeValue($attributeValue);
119
120			// load the prepared values
121			$entity = $this->initializeAttribute($this->prepareAttributes());
122
123			// persist the attribute
124			$this->$persistMethod($entity);
125
			0 ignored issues – show Coding Style introduced 2016-12-09 11:20 UTC by Report Bug Copy Issue Report Blank line found at end of control structure Loading history...
126			} else {
127			// log the debug message
128			$this->getSystemLogger()->debug(
129			sprintf('Found invalid backend type %s for attribute %s', $backendType, $attributeCode)
130			);
131			}
132			}
133			}
134
135			/**
136			* Prepare the attributes of the entity that has to be persisted.
137			*
138			* @return array The prepared attributes
139			*/
140			protected function prepareAttributes()
141			{
142
143			// load the attribute value
144			$attributeValue = $this->getAttributeValue();
145
146			// laod the callbacks for the actual attribute code
147			$callbacks = $this->getCallbacksByType($this->getAttributeCode());
148
149			// invoke the pre-cast callbacks
150			foreach ($callbacks as $callback) {
151			$attributeValue = $callback->handle($attributeValue);
152			}
153
154			// load the ID of the product that has been created recently
155			$lastEntityId = $this->getPrimaryKey();
156
157			// load the ID of the attribute to create the values for
158			$attributeId = $this->getAttributeId();
159
160			// load the store ID
161			$storeId = $this->getRowStoreId(StoreViewCodes::ADMIN);
162
163			// load the backend type of the actual attribute
164			$backendType = $this->getBackendType();
165
166			// cast the value based on the backend type
167			$castedValue = $this->castValueByBackendType($backendType, $attributeValue);
168
169			// prepare the attribute values
170			return $this->initializeEntity(
171			array(
172			MemberNames::ENTITY_ID => $lastEntityId,
173			MemberNames::ATTRIBUTE_ID => $attributeId,
174			MemberNames::STORE_ID => $storeId,
175			MemberNames::VALUE => $castedValue
176			)
177			);
178			}
179
180			/**
181			* Initialize the category product with the passed attributes and returns an instance.
182			*
183			* @param array $attr The category product attributes
184			*
185			* @return array The initialized category product
186			*/
187			protected function initializeAttribute(array $attr)
188			{
189			return $attr;
190			}
191
192			/**
193			* Return's the PK to create the product => attribute relation.
194			*
195			* @return integer The PK to create the relation with
196			*/
197			protected function getPrimaryKey()
198			{
199			return $this->getLastEntityId();
200			}
201
202			/**
203			* Set's the attribute value to process.
204			*
205			* @param mixed $attributeValue The attribute value
206			*
207			* @return void
208			*/
209			protected function setAttributeValue($attributeValue)
210			{
211			$this->attributeValue = $attributeValue;
212			}
213
214			/**
215			* Return's the attribute value to process.
216			*
217			* @return mixed The attribute value
218			*/
219			protected function getAttributeValue()
220			{
221			return $this->attributeValue;
222			}
223
224			/**
225			* Set's the backend type of the attribute to create the values for.
226			*
227			* @param string $backendType The backend type
228			*
229			* @return void
230			*/
231			protected function setBackendType($backendType)
232			{
233			$this->backendType = $backendType;
234			}
235
236			/**
237			* Return's the backend type of the attribute to create the values for.
238			*
239			* @return string The backend type
240			*/
241			protected function getBackendType()
242			{
243			return $this->backendType;
244			}
245
246			/**
247			* Set's the attribute code of the attribute to create the values for.
248			*
249			* @param string $attributeCode The attribute code
250			*
251			* @return void
252			*/
253			protected function setAttributeCode($attributeCode)
254			{
255			$this->attributeCode = $attributeCode;
256			}
257
258			/**
259			* Return's the attribute code of the attribute to create the values for.
260			*
261			* @return string The attribute code
262			*/
263			protected function getAttributeCode()
264			{
265			return $this->attributeCode;
266			}
267
268			/**
269			* Set's the ID of the attribute to create the values for.
270			*
271			* @param integer $attributeId The attribute ID
272			*
273			* @return void
274			*/
275			protected function setAttributeId($attributeId)
276			{
277			$this->attributeId = $attributeId;
278			}
279
280			/**
281			* Return's the ID of the attribute to create the values for.
282			*
283			* @return integer The attribute ID
284			*/
285			protected function getAttributeId()
286			{
287			return $this->attributeId;
288			}
289
290			/**
291			* Map the passed attribute code, if a header mapping exists and return the
292			* mapped mapping.
293			*
294			* @param string $attributeCode The attribute code to map
295			*
296			* @return string The mapped attribute code, or the original one
297			*/
298			protected function mapAttributeCodeByHeaderMapping($attributeCode)
299			{
300			return $this->getSubject()->mapAttributeCodeByHeaderMapping($attributeCode);
301			}
302
303			/**
304			* Return's the array with callbacks for the passed type.
305			*
306			* @param string $type The type of the callbacks to return
307			*
308			* @return array The callbacks
309			*/
310			protected function getCallbacksByType($type)
311			{
312			return $this->getSubject()->getCallbacksByType($type);
313			}
314
315			/**
316			* Return's mapping for the supported backend types (for the product entity) => persist methods.
317			*
318			* @return array The mapping for the supported backend types
319			*/
320			protected function getBackendTypes()
321			{
322			return $this->getSubject()->getBackendTypes();
323			}
324
325			/**
326			* Return's the attributes for the attribute set of the product that has to be created.
327			*
328			* @return array The attributes
329			* @throws \Exception
330			*/
331			protected function getAttributes()
332			{
333			return $this->getSubject()->getAttributes();
334			}
335
336			/**
337			* Return's the store ID of the actual row, or of the default store
338			* if no store view code is set in the CSV file.
339			*
340			* @param string\|null $default The default store view code to use, if no store view code is set in the CSV file
341			*
342			* @return integer The ID of the actual store
343			* @throws \Exception Is thrown, if the store with the actual code is not available
344			*/
345			protected function getRowStoreId($default = null)
346			{
347			return $this->getSubject()->getRowStoreId($default);
348			}
349
350			/**
351			* Persist's the passed product varchar attribute.
352			*
353			* @param array $attribute The attribute to persist
354			*
355			* @return void
356			*/
357			protected function persistProductVarcharAttribute($attribute)
358			{
359			$this->getSubject()->persistProductVarcharAttribute($attribute);
360			}
361
362			/**
363			* Persist's the passed product integer attribute.
364			*
365			* @param array $attribute The attribute to persist
366			*
367			* @return void
368			*/
369			protected function persistProductIntAttribute($attribute)
370			{
371			$this->getSubject()->persistProductIntAttribute($attribute);
372			}
373
374			/**
375			* Persist's the passed product decimal attribute.
376			*
377			* @param array $attribute The attribute to persist
378			*
379			* @return void
380			*/
381			protected function persistProductDecimalAttribute($attribute)
382			{
383			$this->getSubject()->persistProductDecimalAttribute($attribute);
384			}
385
386			/**
387			* Persist's the passed product datetime attribute.
388			*
389			* @param array $attribute The attribute to persist
390			*
391			* @return void
392			*/
393			protected function persistProductDatetimeAttribute($attribute)
394			{
395			$this->getSubject()->persistProductDatetimeAttribute($attribute);
396			}
397
398			/**
399			* Persist's the passed product text attribute.
400			*
401			* @param array $attribute The attribute to persist
402			*
403			* @return void
404			*/
405			protected function persistProductTextAttribute($attribute)
406			{
407			$this->getSubject()->persistProductTextAttribute($attribute);
408			}
409			}
410

techdivision / import-product

Pull Request — master (#19)

persistProductDatetimeAttribute() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like