CleanUpLinkObserver::hasColumn() - Code Metrics - Inspection of "Add cleanup functionality on product link to remov..." - techdivision/import-product-link - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#28)

by Tim

created 2020-12-23 10:48 UTC

CleanUpLinkObserver::hasColumn() A

↳ Parent: CleanUpLinkObserver

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	0
cts	7
cp	0
rs	9.8666
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	6

<?php

/**
 * TechDivision\Import\Product\Link\Observers\CleanUpLinkObserver
 *
 * 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 Eisenführer <[email protected]>
 * @copyright 2020 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-variant
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Link\Observers;

use TechDivision\Import\Subjects\SubjectInterface;
use TechDivision\Import\Observers\StateDetectorInterface;
use TechDivision\Import\Product\Link\Utils\ColumnKeys;
use TechDivision\Import\Product\Link\Utils\MemberNames;
use TechDivision\Import\Product\Link\Utils\ConfigurationKeys;
use TechDivision\Import\Product\Link\Services\ProductLinkProcessorInterface;
use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
use TechDivision\Import\Observers\ObserverFactoryInterface;

/**
 * Observer that cleans-up product link relation information.
 *
 * @author    Martin Eisenführer <[email protected]>
 * @copyright 2020 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-variant
 * @link      http://www.techdivision.com
 */
class CleanUpLinkObserver extends AbstractProductImportObserver implements ObserverFactoryInterface
{

    /**
     * The product link processor instance.
     *
     * @var \TechDivision\Import\Product\Link\Services\ProductLinkProcessorInterface
     */
    protected $productLinkProcessor;

    /**
     * The array with the link types.
     *
     * @var array
     */
    protected $linkTypes = array();

    /**
     * The flag to query whether or not the link types has to be cleaned-up.
     *
     * @var boolean
     */
    protected $cleanUpLinks = false;

    /**
     * Initialize the observer with the passed product link processor instance.
     *
     * @param \TechDivision\Import\Product\Link\Services\ProductLinkProcessorInterface $productLinkProcessor The
     *                                                                                                       product link processor instance
     * @param StateDetectorInterface|null                                              $stateDetector        The state detector instance to use
     */
    public function __construct(
        ProductLinkProcessorInterface $productLinkProcessor,
        StateDetectorInterface $stateDetector = null
    ) {

        // pass the state detector to the parent constructor
        parent::__construct($stateDetector);

        // initialize the product link processor instance
        $this->productLinkProcessor = $productLinkProcessor;
    }

    /**
     * Will be invoked by the observer visitor when a factory has been defined to create the observer instance.
     *
     * @param \TechDivision\Import\Subjects\SubjectInterface $subject The subject instance
     *
     * @return \TechDivision\Import\Observers\ObserverInterface The observer instance
     */
    public function createObserver(SubjectInterface $subject)
    {

        // load the link type mappings
        $this->linkTypes = $subject->getLinkTypeMappings();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        // query whether or not the product links has to be cleaned-up
        $this->cleanUpLinks = $subject->getConfiguration()->hasParam(ConfigurationKeys::CLEAN_UP_LINKS) &&
                              $subject->getConfiguration()->getParam(ConfigurationKeys::CLEAN_UP_LINKS, false);

        // return the initialized instance
        return $this;
    }

    /**
     * Return's the product variant processor instance.
     *
     * @return \TechDivision\Import\Product\Link\Services\ProductLinkProcessorInterface The product variant processor
     *     instance
     */
    protected function getProductLinkProcessor()
    {
        return $this->productLinkProcessor;
    }

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

        // load the row/entity ID of the parent product
        $parentId = $this->getLastPrimaryKey();

        // prepare the links for the found link types and clean-up
        foreach ($this->linkTypes as $linkTypeCode => $columns) {
            // shift the column with the header information from the stack
            list ($columnNameChildSkus, $callbackChildSkus) = array_shift($columns);

            // start the clean-up process, if the appropriate flag has been
            // activated, otherwise we've to figure out if the column value
            // contains the `__EMPTY__VALUE__` constant
            if ($this->cleanUpLinks === true) {
                // query whether or not, we've up sell, cross sell or relation products
                $links = $this->getValue($columnNameChildSkus, array(), $callbackChildSkus);
                // clean-up the links in the database
                $this->doCleanUp($parentId, $linkTypeCode, $links);
            } else {
                // query whether or not, we've up sell, cross sell or relation products
                $links = $this->getValue($columnNameChildSkus, array(), $callbackChildSkus);
                // This handles the case with the `__EMPTY__VALUE__` constant
                // when the directive `clean-up-links` has been deactivated.
                // In that case, the clean-up columns functionality in the
                // AttributeObserverTrait::clearRow() method has NOT unset the
                // column which indicates the column has to be cleaned-up.
                if ($this->hasColumn($columnNameChildSkus) && sizeof($links) === 0) {
                    $this->doCleanUp($parentId, $linkTypeCode, $links);
                }
            }
        }
    }

    /**
     * This method queries whether or not  the column with the passed name is available or
     * not. This  method uses the `isset()` function to make sure the column is available
     * and has not been removed somehow before, because it has an empty value for example.
     *
     * @param string $name The name of the column to query for
     *
     * @return boolean TRUE if the columen is available, FALSE otherwise
     */
    protected function hasColumn(string $name) : bool
    {

        // query whether or not the header is available, if yes try
        // to load the key and query whether the column is available
        if ($this->hasHeader($name)) {
            return isset($this->row[$this->getHeader($name)]);
        }

        // return FALSE if not
        return false;
    }

    /**
     * Delete not exists import links from database.
     *
     * @param int    $parentProductId The ID of the parent product
     * @param string $linkTypeCode    The link type code to prepare the artefacts for
     * @param array  $childData       The array of variants
     *
     * @return void
     */
    protected function doCleanUp($parentProductId, $linkTypeCode, array $childData)
    {

        // load the SKU of the parent product
        $parentSku = $this->getValue(ColumnKeys::SKU);

        // extract the link type code from the row
        $linkTypeId = $this->mapLinkTypeCodeToLinkTypeId($linkTypeCode);

        // remove the old variantes from the database
        $this->getProductLinkProcessor()
            ->deleteProductLink(
                array(
                    MemberNames::PRODUCT_ID   => $parentProductId,
                    MemberNames::SKU          => $childData,
                    MemberNames::LINK_TYPE_ID => $linkTypeId,
                )
            );

        // log a debug message that the image has been removed
        $this->getSubject()
            ->getSystemLogger()
            ->debug(
                $this->getSubject()->appendExceptionSuffix(
                    sprintf(
                        'Successfully clean up links for product with SKU "%s" except "%s"',
                        $parentSku,
                        implode(', ', $childData)
                    )
                )
            );
    }

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

    /**
     * Return the link type ID for the passed link type code.
     *
     * @param string $linkTypeCode The link type code to return the link type ID for
     *
     * @return integer The mapped link type ID
     * @throws \TechDivision\Import\Product\Exceptions\MapLinkTypeCodeToIdException Is thrown if the link type code is
     *     not mapped yet
     */
    protected function mapLinkTypeCodeToLinkTypeId($linkTypeCode)
    {
        return $this->getSubject()->mapLinkTypeCodeToLinkTypeId($linkTypeCode);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
}


Pull Request — master (#28)

CleanUpLinkObserver::hasColumn() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1			<?php
2
3			/**
4			* TechDivision\Import\Product\Link\Observers\CleanUpLinkObserver
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 Eisenführer <[email protected]>
15			* @copyright 2020 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-variant
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Product\Link\Observers;
22
23			use TechDivision\Import\Subjects\SubjectInterface;
24			use TechDivision\Import\Observers\StateDetectorInterface;
25			use TechDivision\Import\Product\Link\Utils\ColumnKeys;
26			use TechDivision\Import\Product\Link\Utils\MemberNames;
27			use TechDivision\Import\Product\Link\Utils\ConfigurationKeys;
28			use TechDivision\Import\Product\Link\Services\ProductLinkProcessorInterface;
29			use TechDivision\Import\Product\Observers\AbstractProductImportObserver;
30			use TechDivision\Import\Observers\ObserverFactoryInterface;
31
32			/**
33			* Observer that cleans-up product link relation information.
34			*
35			* @author Martin Eisenführer <[email protected]>
36			* @copyright 2020 TechDivision GmbH <[email protected]>
37			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
38			* @link https://github.com/techdivision/import-product-variant
39			* @link http://www.techdivision.com
40			*/
41			class CleanUpLinkObserver extends AbstractProductImportObserver implements ObserverFactoryInterface
42			{
43
44			/**
45			* The product link processor instance.
46			*
47			* @var \TechDivision\Import\Product\Link\Services\ProductLinkProcessorInterface
48			*/
49			protected $productLinkProcessor;
50
51			/**
52			* The array with the link types.
53			*
54			* @var array
55			*/
56			protected $linkTypes = array();
57
58			/**
59			* The flag to query whether or not the link types has to be cleaned-up.
60			*
61			* @var boolean
62			*/
63			protected $cleanUpLinks = false;
64
65			/**
66			* Initialize the observer with the passed product link processor instance.
67			*
68			* @param \TechDivision\Import\Product\Link\Services\ProductLinkProcessorInterface $productLinkProcessor The
69			* product link processor instance
70			* @param StateDetectorInterface\|null $stateDetector The state detector instance to use
71			*/
72			public function __construct(
73			ProductLinkProcessorInterface $productLinkProcessor,
74			StateDetectorInterface $stateDetector = null
75			) {
76
77			// pass the state detector to the parent constructor
78			parent::__construct($stateDetector);
79
80			// initialize the product link processor instance
81			$this->productLinkProcessor = $productLinkProcessor;
82			}
83
84			/**
85			* Will be invoked by the observer visitor when a factory has been defined to create the observer instance.
86			*
87			* @param \TechDivision\Import\Subjects\SubjectInterface $subject The subject instance
88			*
89			* @return \TechDivision\Import\Observers\ObserverInterface The observer instance
90			*/
91			public function createObserver(SubjectInterface $subject)
92			{
93
94			// load the link type mappings
95			$this->linkTypes = $subject->getLinkTypeMappings();
			0 ignored issues – show Bug introduced 2020-12-23 10:50 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TechDivision\Import\Subjects\SubjectInterface` as the method `getLinkTypeMappings()` does only exist in the following implementations of said interface: `TechDivision\Import\Prod...nk\Subjects\LinkSubject`, `TechDivision\Import\Prod...\AbstractProductSubject`, `TechDivision\Import\Product\Subjects\BunchSubject`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
96
97			// query whether or not the product links has to be cleaned-up
98			$this->cleanUpLinks = $subject->getConfiguration()->hasParam(ConfigurationKeys::CLEAN_UP_LINKS) &&
99			$subject->getConfiguration()->getParam(ConfigurationKeys::CLEAN_UP_LINKS, false);
100
101			// return the initialized instance
102			return $this;
103			}
104
105			/**
106			* Return's the product variant processor instance.
107			*
108			* @return \TechDivision\Import\Product\Link\Services\ProductLinkProcessorInterface The product variant processor
109			* instance
110			*/
111			protected function getProductLinkProcessor()
112			{
113			return $this->productLinkProcessor;
114			}
115
116			/**
117			* Process the observer's business logic.
118			*
119			* @return void
120			*/
121			protected function process()
122			{
123
124			// load the row/entity ID of the parent product
125			$parentId = $this->getLastPrimaryKey();
126
127			// prepare the links for the found link types and clean-up
128			foreach ($this->linkTypes as $linkTypeCode => $columns) {
129			// shift the column with the header information from the stack
130			list ($columnNameChildSkus, $callbackChildSkus) = array_shift($columns);
131
132			// start the clean-up process, if the appropriate flag has been
133			// activated, otherwise we've to figure out if the column value
134			// contains the `__EMPTY__VALUE__` constant
135			if ($this->cleanUpLinks === true) {
136			// query whether or not, we've up sell, cross sell or relation products
137			$links = $this->getValue($columnNameChildSkus, array(), $callbackChildSkus);
138			// clean-up the links in the database
139			$this->doCleanUp($parentId, $linkTypeCode, $links);
140			} else {
141			// query whether or not, we've up sell, cross sell or relation products
142			$links = $this->getValue($columnNameChildSkus, array(), $callbackChildSkus);
143			// This handles the case with the `__EMPTY__VALUE__` constant
144			// when the directive `clean-up-links` has been deactivated.
145			// In that case, the clean-up columns functionality in the
146			// AttributeObserverTrait::clearRow() method has NOT unset the
147			// column which indicates the column has to be cleaned-up.
148			if ($this->hasColumn($columnNameChildSkus) && sizeof($links) === 0) {
149			$this->doCleanUp($parentId, $linkTypeCode, $links);
150			}
151			}
152			}
153			}
154
155			/**
156			* This method queries whether or not the column with the passed name is available or
157			* not. This method uses the `isset()` function to make sure the column is available
158			* and has not been removed somehow before, because it has an empty value for example.
159			*
160			* @param string $name The name of the column to query for
161			*
162			* @return boolean TRUE if the columen is available, FALSE otherwise
163			*/
164			protected function hasColumn(string $name) : bool
165			{
166
167			// query whether or not the header is available, if yes try
168			// to load the key and query whether the column is available
169			if ($this->hasHeader($name)) {
170			return isset($this->row[$this->getHeader($name)]);
171			}
172
173			// return FALSE if not
174			return false;
175			}
176
177			/**
178			* Delete not exists import links from database.
179			*
180			* @param int $parentProductId The ID of the parent product
181			* @param string $linkTypeCode The link type code to prepare the artefacts for
182			* @param array $childData The array of variants
183			*
184			* @return void
185			*/
186			protected function doCleanUp($parentProductId, $linkTypeCode, array $childData)
187			{
188
189			// load the SKU of the parent product
190			$parentSku = $this->getValue(ColumnKeys::SKU);
191
192			// extract the link type code from the row
193			$linkTypeId = $this->mapLinkTypeCodeToLinkTypeId($linkTypeCode);
194
195			// remove the old variantes from the database
196			$this->getProductLinkProcessor()
197			->deleteProductLink(
198			array(
199			MemberNames::PRODUCT_ID => $parentProductId,
200			MemberNames::SKU => $childData,
201			MemberNames::LINK_TYPE_ID => $linkTypeId,
202			)
203			);
204
205			// log a debug message that the image has been removed
206			$this->getSubject()
207			->getSystemLogger()
208			->debug(
209			$this->getSubject()->appendExceptionSuffix(
210			sprintf(
211			'Successfully clean up links for product with SKU "%s" except "%s"',
212			$parentSku,
213			implode(', ', $childData)
214			)
215			)
216			);
217			}
218
219			/**
220			* Return's the PK to create the product => variant relation.
221			*
222			* @return integer The PK to create the relation with
223			*/
224			protected function getLastPrimaryKey()
225			{
226			return $this->getLastEntityId();
227			}
228
229			/**
230			* Return the link type ID for the passed link type code.
231			*
232			* @param string $linkTypeCode The link type code to return the link type ID for
233			*
234			* @return integer The mapped link type ID
235			* @throws \TechDivision\Import\Product\Exceptions\MapLinkTypeCodeToIdException Is thrown if the link type code is
236			* not mapped yet
237			*/
238			protected function mapLinkTypeCodeToLinkTypeId($linkTypeCode)
239			{
240			return $this->getSubject()->mapLinkTypeCodeToLinkTypeId($linkTypeCode);
			0 ignored issues – show Bug introduced 2020-12-08 21:43 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TechDivision\Import\Subjects\SubjectInterface` as the method `mapLinkTypeCodeToLinkTypeId()` does only exist in the following implementations of said interface: `TechDivision\Import\Prod...nk\Subjects\LinkSubject`, `TechDivision\Import\Prod...\AbstractProductSubject`, `TechDivision\Import\Product\Subjects\BunchSubject`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
241			}
242			}
243

techdivision / import-product-link

Pull Request — master (#28)

CleanUpLinkObserver::hasColumn() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like