AbstractProductImportObserver::addHeader() - Code Metrics - Inspection of "Refactoring to use multiple field delimiter instea..." - techdivision/import-product - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#25)

by Tim

created 2017-01-12 12:57 UTC

AbstractProductImportObserver::addHeader() A

↳ Parent: AbstractProductImportObserver

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	2
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\AbstractProductImportObserver
 *
 * 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\EntityStatus;
use TechDivision\Import\Product\Utils\ColumnKeys;
use TechDivision\Import\Observers\AbstractObserver;

/**
 * A SLSB that handles the process to import product bunches.
 *
 * @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
 */
abstract class AbstractProductImportObserver extends AbstractObserver implements ProductImportObserverInterface
{

    /**
     * The actual row, that has to be processed.
     *
     * @var array
     */
    protected $row = array();

    /**
     * Set's the actual row, that has to be processed.
     *
     * @param array $row The row
     *
     * @return void
     */
    protected function setRow(array $row)
    {
        $this->row = $row;
    }

    /**
     * Return's the actual row, that has to be processed.
     *
     * @return array The row
     */
    protected function getRow()
    {
        return $this->row;
    }

    /**
     * Will be invoked by the action on the events the listener has been registered for.
     *
     * @param array $row The row to handle
     *
     * @return array The modified row
     * @see \TechDivision\Import\Product\Observers\ImportObserverInterface::handle()
     */
    public function handle(array $row)
    {

        // initialize the row
        $this->setRow($row);

        // process the functionality and return the row
        $this->process();

        // return the processed row
        return $this->getRow();
    }

    /**
     * Process the observer's business logic.
     *
     * @return array The processed row
     */
    protected function process()
    {
    }

    /**
     * Return's the multiple field delimiter character to use, default value is comma (,).
     *
     * @return string The multiple field delimiter character
     */
    protected function getMultipleFieldDelimiter()
    {
        return $this->getSubject()->getMultipleFieldDelimiter();
    }

    /**
     * Set's the array containing header row.
     *
     * @param array $headers The array with the header row
     *
     * @return void
     */
    public function setHeaders(array $headers)
    {
        $this->getSubject()->setHeaders($headers);
    }

    /**
     * Return's the array containing header row.
     *
     * @return array The array with the header row
     */
    protected function getHeaders()
    {
        return $this->getSubject()->getHeaders();
    }

    /**
     * Queries whether or not the header with the passed name is available.
     *
     * @param string $name The header name to query
     *
     * @return boolean TRUE if the header is available, else FALSE
     */
    protected function hasHeader($name)
    {
        return $this->getSubject()->hasHeader($name);
    }

    /**
     * Return's the header value for the passed name.
     *
     * @param string $name The name of the header to return the value for
     *
     * @return mixed The header value
     * \InvalidArgumentException Is thrown, if the header with the passed name is NOT available
     */
    protected function getHeader($name)
    {
        return $this->getSubject()->getHeader($name);
    }

    /**
     * Add's the header with the passed name and position, if not NULL.
     *
     * @param string $name The header name to add
     *
     * @return integer The new headers position
     */
    protected function addHeader($name)
    {
        return $this->getSubject()->addHeader($name);
    }

    /**
     * Return's TRUE if the passed SKU is the actual one.
     *
     * @param string $sku The SKU to check
     *
     * @return boolean TRUE if the passed SKU is the actual one
     */
    protected function isLastSku($sku)
    {
        return $this->getSubject()->getLastSku() === $sku;
    }

    /**
     * Return's the ID of the product that has been created recently.
     *
     * @return string The entity Id
     */
    protected function getLastEntityId()
    {
        return $this->getSubject()->getLastEntityId();
    }

    /**
     * Return's the source date format to use.
     *
     * @return string The source date format
     */
    protected function getSourceDateFormat()
    {
        return $this->getSubject()->getSourceDateFormat();
    }

    /**
     * Cast's the passed value based on the backend type information.
     *
     * @param string $backendType The backend type to cast to
     * @param mixed  $value       The value to be casted
     *
     * @return mixed The casted value
     */
    protected function castValueByBackendType($backendType, $value)
    {
        return $this->getSubject()->castValueByBackendType($backendType, $value);
    }

    /**
     * Set's the store view code the create the product/attributes for.
     *
     * @param string $storeViewCode The store view code
     *
     * @return void
     */
    protected function setStoreViewCode($storeViewCode)
    {
        $this->getSubject()->setStoreViewCode($storeViewCode);
    }

    /**
     * Return's the store view code the create the product/attributes for.
     *
     * @param string|null $default The default value to return, if the store view code has not been set
     *
     * @return string The store view code
     */
    protected function getStoreViewCode($default = null)
    {
        return $this->getSubject()->getStoreViewCode($default);
    }

    /**
     * Prepare's the store view code in the subject.
     *
     * @return void
     */
    protected function prepareStoreViewCode()
    {

        // re-set the store view code
        $this->setStoreViewCode(null);

        // initialize the store view code
        if ($storeViewCode = $this->getValue(ColumnKeys::STORE_VIEW_CODE)) {
            $this->setStoreViewCode($storeViewCode);
        }
    }

    /**
     * Tries to format the passed value to a valid date with format 'Y-m-d H:i:s'.
     * If the passed value is NOT a valid date, NULL will be returned.
     *
     * @param string|null $value The value to format
     *
     * @return string The formatted date
     */
    protected function formatDate($value)
    {

        // create a DateTime instance from the passed value
        if ($dateTime = \DateTime::createFromFormat($this->getSourceDateFormat(), $value)) {
            return $dateTime->format('Y-m-d H:i:s');
        }

        // return NULL, if the passed value is NOT a valid date
        return null;
    }

    /**
     * Extracts the elements of the passed value by exploding them
     * with the also passed delimiter.
     *
     * @param string      $value     The value to extract
     * @param string|null $delimiter The delimiter used to extrace the elements
     *
     * @return array The exploded values
     */
    protected function explode($value, $delimiter = null)
    {

        // load the default multiple field delimiter
        if ($delimiter === null) {
            $delimiter = $this->getMultipleFieldDelimiter();
        }

        // explode and return the array with the values, by using the delimiter
        return explode($delimiter, $value);
    }

    /**
     * Query whether or not a value for the column with the passed name exists.
     *
     * @param string $name The column name to query for a valid value
     *
     * @return boolean TRUE if the value is set, else FALSE
     */
    protected function hasValue($name)
    {

        // query whether or not the header is available
        if ($this->hasHeader($name)) {
            // load the key for the row
            $headerValue = $this->getHeader($name);

            // query whether the rows column has a vaild value
            return (isset($this->row[$headerValue]) && $this->row[$headerValue] != '');
        }

        // return FALSE if not
        return false;
    }

    /**
     * Set the value in the passed column name.
     *
     * @param string $name  The column name to set the value for
     * @param mixed  $value The value to set
     *
     * @return void
     */
    protected function setValue($name, $value)
    {
        $this->row[$this->getHeader($name)] = $value;
    }

    /**
     * Resolve's the value with the passed colum name from the actual row. If a callback will
     * be passed, the callback will be invoked with the found value as parameter. If
     * the value is NULL or empty, the default value will be returned.
     *
     * @param string        $name     The name of the column to return the value for
     * @param mixed|null    $default  The default value, that has to be returned, if the row's value is empty
     * @param callable|null $callback The callback that has to be invoked on the value, e. g. to format it
     *
     * @return mixed|null The, almost formatted, value
     */
    protected function getValue($name, $default = null, callable $callback = null)
    {

        // initialize the value
        $value = null;

        // query whether or not the header is available
        if ($this->hasHeader($name)) {
            // load the header value
            $headerValue = $this->getHeader($name);
            // query wheter or not, the value with the requested key is available
            if ((isset($this->row[$headerValue]) && $this->row[$headerValue] != '')) {
                $value = $this->row[$headerValue];
            }
        }

        // query whether or not, a callback has been passed
        if ($value != null && is_callable($callback)) {
            $value = call_user_func($callback, $value);
        }

        // query whether or not
        if ($value == null && $default !== null) {
            $value = $default;
        }

        // return the value
        return $value;
    }

    /**
     * Initialize's and return's a new entity with the status 'create'.
     *
     * @param array $attr The attributes to merge into the new entity
     *
     * @return array The initialized entity
     */
    protected function initializeEntity(array $attr = array())
    {
        return array_merge(array(EntityStatus::MEMBER_NAME => EntityStatus::STATUS_CREATE), $attr);
    }

    /**
     * Merge's and return's the entity with the passed attributes and set's the
     * status to 'update'.
     *
     * @param array $entity The entity to merge the attributes into
     * @param array $attr   The attributes to be merged
     *
     * @return array The merged entity
     */
    protected function mergeEntity(array $entity, array $attr)
    {
        return array_merge($entity, $attr, array(EntityStatus::MEMBER_NAME => EntityStatus::STATUS_UPDATE));
    }
}


1		<?php
2
3		/**
4		* TechDivision\Import\Product\Observers\AbstractProductImportObserver
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\EntityStatus;
24		use TechDivision\Import\Product\Utils\ColumnKeys;
25		use TechDivision\Import\Observers\AbstractObserver;
26
27		/**
28		* A SLSB that handles the process to import product bunches.
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		abstract class AbstractProductImportObserver extends AbstractObserver implements ProductImportObserverInterface
37		{
38
39		/**
40		* The actual row, that has to be processed.
41		*
42		* @var array
43		*/
44		protected $row = array();
45
46		/**
47		* Set's the actual row, that has to be processed.
48		*
49		* @param array $row The row
50		*
51		* @return void
52		*/
53	8	protected function setRow(array $row)
54		{
55	8	$this->row = $row;
56	8	}
57
58		/**
59		* Return's the actual row, that has to be processed.
60		*
61		* @return array The row
62		*/
63	8	protected function getRow()
64		{
65	8	return $this->row;
66		}
67
68		/**
69		* Will be invoked by the action on the events the listener has been registered for.
70		*
71		* @param array $row The row to handle
72		*
73		* @return array The modified row
74		* @see \TechDivision\Import\Product\Observers\ImportObserverInterface::handle()
75		*/
76	8	public function handle(array $row)
77		{
78
79		// initialize the row
80	8	$this->setRow($row);
81
82		// process the functionality and return the row
83	8	$this->process();
84
85		// return the processed row
86	8	return $this->getRow();
87		}
88
89		/**
90		* Process the observer's business logic.
91		*
92		* @return array The processed row
93		*/
94		protected function process()
95		{
96		}
97
98		/**
99		* Return's the multiple field delimiter character to use, default value is comma (,).
100		*
101		* @return string The multiple field delimiter character
102		*/
103		protected function getMultipleFieldDelimiter()
104		{
105		return $this->getSubject()->getMultipleFieldDelimiter();
106		}
107
108		/**
109		* Set's the array containing header row.
110		*
111		* @param array $headers The array with the header row
112		*
113		* @return void
114		*/
115		public function setHeaders(array $headers)
116		{
117		$this->getSubject()->setHeaders($headers);
118		}
119
120		/**
121		* Return's the array containing header row.
122		*
123		* @return array The array with the header row
124		*/
125		protected function getHeaders()
126		{
127		return $this->getSubject()->getHeaders();
128		}
129
130		/**
131		* Queries whether or not the header with the passed name is available.
132		*
133		* @param string $name The header name to query
134		*
135		* @return boolean TRUE if the header is available, else FALSE
136		*/
137	8	protected function hasHeader($name)
138		{
139	8	return $this->getSubject()->hasHeader($name);
140		}
141
142		/**
143		* Return's the header value for the passed name.
144		*
145		* @param string $name The name of the header to return the value for
146		*
147		* @return mixed The header value
148		* \InvalidArgumentException Is thrown, if the header with the passed name is NOT available
149		*/
150	8	protected function getHeader($name)
151		{
152	8	return $this->getSubject()->getHeader($name);
153		}
154
155		/**
156		* Add's the header with the passed name and position, if not NULL.
157		*
158		* @param string $name The header name to add
159		*
160		* @return integer The new headers position
161		*/
162		protected function addHeader($name)
163		{
164		return $this->getSubject()->addHeader($name);
165		}
166
167		/**
168		* Return's TRUE if the passed SKU is the actual one.
169		*
170		* @param string $sku The SKU to check
171		*
172		* @return boolean TRUE if the passed SKU is the actual one
173		*/
174	8	protected function isLastSku($sku)
175		{
176	8	return $this->getSubject()->getLastSku() === $sku;
177		}
178
179		/**
180		* Return's the ID of the product that has been created recently.
181		*
182		* @return string The entity Id
183		*/
184	4	protected function getLastEntityId()
185		{
186	4	return $this->getSubject()->getLastEntityId();
187		}
188
189		/**
190		* Return's the source date format to use.
191		*
192		* @return string The source date format
193		*/
194	1	protected function getSourceDateFormat()
195		{
196	1	return $this->getSubject()->getSourceDateFormat();
197		}
198
199		/**
200		* Cast's the passed value based on the backend type information.
201		*
202		* @param string $backendType The backend type to cast to
203		* @param mixed $value The value to be casted
204		*
205		* @return mixed The casted value
206		*/
207	1	protected function castValueByBackendType($backendType, $value)
208		{
209	1	return $this->getSubject()->castValueByBackendType($backendType, $value);
210		}
211
212		/**
213		* Set's the store view code the create the product/attributes for.
214		*
215		* @param string $storeViewCode The store view code
216		*
217		* @return void
218		*/
219	3	protected function setStoreViewCode($storeViewCode)
220		{
221	3	$this->getSubject()->setStoreViewCode($storeViewCode);
222	3	}
223
224		/**
225		* Return's the store view code the create the product/attributes for.
226		*
227		* @param string\|null $default The default value to return, if the store view code has not been set
228		*
229		* @return string The store view code
230		*/
231		protected function getStoreViewCode($default = null)
232		{
233		return $this->getSubject()->getStoreViewCode($default);
234		}
235
236		/**
237		* Prepare's the store view code in the subject.
238		*
239		* @return void
240		*/
241	3	protected function prepareStoreViewCode()
242		{
243
244		// re-set the store view code
245	3	$this->setStoreViewCode(null);
246
247		// initialize the store view code
248	3	if ($storeViewCode = $this->getValue(ColumnKeys::STORE_VIEW_CODE)) {
249	2	$this->setStoreViewCode($storeViewCode);
250	2	}
251	3	}
252
253		/**
254		* Tries to format the passed value to a valid date with format 'Y-m-d H:i:s'.
255		* If the passed value is NOT a valid date, NULL will be returned.
256		*
257		* @param string\|null $value The value to format
258		*
259		* @return string The formatted date
260		*/
261	1	protected function formatDate($value)
262		{
263
264		// create a DateTime instance from the passed value
265	1	if ($dateTime = \DateTime::createFromFormat($this->getSourceDateFormat(), $value)) {
266	1	return $dateTime->format('Y-m-d H:i:s');
267		}
268
269		// return NULL, if the passed value is NOT a valid date
270		return null;
271		}
272
273		/**
274		* Extracts the elements of the passed value by exploding them
275		* with the also passed delimiter.
276		*
277		* @param string $value The value to extract
278		* @param string\|null $delimiter The delimiter used to extrace the elements
279		*
280		* @return array The exploded values
281		*/
282		protected function explode($value, $delimiter = null)
283		{
284
285		// load the default multiple field delimiter
286		if ($delimiter === null) {
287		$delimiter = $this->getMultipleFieldDelimiter();
288		}
289
290		// explode and return the array with the values, by using the delimiter
291		return explode($delimiter, $value);
292		}
293
294		/**
295		* Query whether or not a value for the column with the passed name exists.
296		*
297		* @param string $name The column name to query for a valid value
298		*
299		* @return boolean TRUE if the value is set, else FALSE
300		*/
301	2	protected function hasValue($name)
302		{
303
304		// query whether or not the header is available
305	2	if ($this->hasHeader($name)) {
306		// load the key for the row
307	1	$headerValue = $this->getHeader($name);
308
309		// query whether the rows column has a vaild value
310	1	return (isset($this->row[$headerValue]) && $this->row[$headerValue] != '');
311		}
312
313		// return FALSE if not
314	1	return false;
315		}
316
317		/**
318		* Set the value in the passed column name.
319		*
320		* @param string $name The column name to set the value for
321		* @param mixed $value The value to set
322		*
323		* @return void
324		*/
325		protected function setValue($name, $value)
326		{
327		$this->row[$this->getHeader($name)] = $value;
328		}
329
330		/**
331		* Resolve's the value with the passed colum name from the actual row. If a callback will
332		* be passed, the callback will be invoked with the found value as parameter. If
333		* the value is NULL or empty, the default value will be returned.
334		*
335		* @param string $name The name of the column to return the value for
336		* @param mixed\|null $default The default value, that has to be returned, if the row's value is empty
337		* @param callable\|null $callback The callback that has to be invoked on the value, e. g. to format it
338		*
339		* @return mixed\|null The, almost formatted, value
340		*/
341	8	protected function getValue($name, $default = null, callable $callback = null)
342		{
343
344		// initialize the value
345	8	$value = null;
346
347		// query whether or not the header is available
348	8	if ($this->hasHeader($name)) {
349		// load the header value
350	8	$headerValue = $this->getHeader($name);
351		// query wheter or not, the value with the requested key is available
352	8	if ((isset($this->row[$headerValue]) && $this->row[$headerValue] != '')) {
353	8	$value = $this->row[$headerValue];
354	8	}
355	8	}
356
357		// query whether or not, a callback has been passed
358	8	if ($value != null && is_callable($callback)) {
359	1	$value = call_user_func($callback, $value);
360	1	}
361
362		// query whether or not
363	8	if ($value == null && $default !== null) {
364	1	$value = $default;
365	1	}
366
367		// return the value
368	8	return $value;
369		}
370
371		/**
372		* Initialize's and return's a new entity with the status 'create'.
373		*
374		* @param array $attr The attributes to merge into the new entity
375		*
376		* @return array The initialized entity
377		*/
378	5	protected function initializeEntity(array $attr = array())
379		{
380	5	return array_merge(array(EntityStatus::MEMBER_NAME => EntityStatus::STATUS_CREATE), $attr);
381		}
382
383		/**
384		* Merge's and return's the entity with the passed attributes and set's the
385		* status to 'update'.
386		*
387		* @param array $entity The entity to merge the attributes into
388		* @param array $attr The attributes to be merged
389		*
390		* @return array The merged entity
391		*/
392	2	protected function mergeEntity(array $entity, array $attr)
393		{
394	2	return array_merge($entity, $attr, array(EntityStatus::MEMBER_NAME => EntityStatus::STATUS_UPDATE));
395		}
396		}
397

techdivision / import-product

Pull Request — master (#25)

AbstractProductImportObserver::addHeader() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like