BunchSubject::tearDown() - Code Metrics - Inspection of "Add listener to reload EAV attribute option values..." - techdivision/import-product - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 19.x ( e6b277...972430 )

by Tim

created 2019-12-12 13:20 UTC

BunchSubject::tearDown() A

↳ Parent: BunchSubject

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	17
ccs	0
cts	7
cp	0
rs	9.7
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

/**
 * TechDivision\Import\Product\Subjects\BunchSubject
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 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\Subjects;

use TechDivision\Import\Utils\StoreViewCodes;
use TechDivision\Import\Product\Utils\MemberNames;
use TechDivision\Import\Product\Utils\RegistryKeys;
use TechDivision\Import\Product\Utils\VisibilityKeys;
use TechDivision\Import\Product\Utils\ConfigurationKeys;
use TechDivision\Import\Subjects\ExportableTrait;
use TechDivision\Import\Subjects\FileUploadTrait;
use TechDivision\Import\Subjects\ExportableSubjectInterface;
use TechDivision\Import\Subjects\FileUploadSubjectInterface;
use TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface;

/**
 * The subject implementation that handles the business logic to persist products.
 *
 * @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 BunchSubject extends AbstractProductSubject implements ExportableSubjectInterface, FileUploadSubjectInterface, UrlKeyAwareSubjectInterface
{

    /**
     * The trait that implements the export functionality.
     *
     * @var \TechDivision\Import\Subjects\ExportableTrait
     */
    use ExportableTrait;

    /**
     * The trait that provides file upload functionality.
     *
     * @var \TechDivision\Import\Subjects\FileUploadTrait
     */
    use FileUploadTrait;

    /**
     * The array with the pre-loaded entity IDs.
     *
     * @var array
     */
    protected $preLoadedEntityIds = array();

    /**
     * Mappings for the table column => CSV column header.
     *
     * @var array
     */
    protected $headerStockMappings = array(
        'qty'                         => array('qty', 'float'),
        'min_qty'                     => array('out_of_stock_qty', 'float'),
        'use_config_min_qty'          => array('use_config_min_qty', 'int'),
        'is_qty_decimal'              => array('is_qty_decimal', 'int'),
        'backorders'                  => array('allow_backorders', 'int'),
        'use_config_backorders'       => array('use_config_backorders', 'int'),
        'min_sale_qty'                => array('min_cart_qty', 'float'),
        'use_config_min_sale_qty'     => array('use_config_min_sale_qty', 'int'),
        'max_sale_qty'                => array('max_cart_qty', 'float'),
        'use_config_max_sale_qty'     => array('use_config_max_sale_qty', 'int'),
        'is_in_stock'                 => array('is_in_stock', 'int'),
        'notify_stock_qty'            => array('notify_on_stock_below', 'float'),
        'use_config_notify_stock_qty' => array('use_config_notify_stock_qty', 'int'),
        'manage_stock'                => array('manage_stock', 'int'),
        'use_config_manage_stock'     => array('use_config_manage_stock', 'int'),
        'use_config_qty_increments'   => array('use_config_qty_increments', 'int'),
        'qty_increments'              => array('qty_increments', 'float'),
        'use_config_enable_qty_inc'   => array('use_config_enable_qty_inc', 'int'),
        'enable_qty_increments'       => array('enable_qty_increments', 'int'),
        'is_decimal_divided'          => array('is_decimal_divided', 'int'),
    );

    /**
     * The array with the available visibility keys.
     *
     * @var array
     */
    protected $availableVisibilities = array(
        'Not Visible Individually' => VisibilityKeys::VISIBILITY_NOT_VISIBLE,
        'Catalog'                  => VisibilityKeys::VISIBILITY_IN_CATALOG,
        'Search'                   => VisibilityKeys::VISIBILITY_IN_SEARCH,
        'Catalog, Search'          => VisibilityKeys::VISIBILITY_BOTH
    );

    /**
     * The default callback mappings for the Magento standard product attributes.
     *
     * @var array
     */
    protected $defaultCallbackMappings = array(
        'visibility'           => array('import_product.callback.visibility'),
        'tax_class_id'         => array('import_product.callback.tax.class'),
        'bundle_price_type'    => array('import_product_bundle.callback.bundle.type'),
        'bundle_sku_type'      => array('import_product_bundle.callback.bundle.type'),
        'bundle_weight_type'   => array('import_product_bundle.callback.bundle.type'),
        'bundle_price_view'    => array('import_product_bundle.callback.bundle.price.view'),
        'bundle_shipment_type' => array('import_product_bundle.callback.bundle.shipment.type')
    );

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

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

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

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

        // initialize the flag whether to copy images or not
        if ($this->getConfiguration()->hasParam(ConfigurationKeys::COPY_IMAGES)) {
            $this->setCopyImages($this->getConfiguration()->getParam(ConfigurationKeys::COPY_IMAGES));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        // initialize media directory => can be absolute or relative
        if ($this->getConfiguration()->hasParam(ConfigurationKeys::MEDIA_DIRECTORY)) {
            $this->setMediaDir(
                $this->resolvePath(
                    $this->getConfiguration()->getParam(ConfigurationKeys::MEDIA_DIRECTORY)
                )
            );
        }

        // initialize images directory => can be absolute or relative
        if ($this->getConfiguration()->hasParam(ConfigurationKeys::IMAGES_FILE_DIRECTORY)) {
            $this->setImagesFileDir(
                $this->resolvePath(
                    $this->getConfiguration()->getParam(ConfigurationKeys::IMAGES_FILE_DIRECTORY)
                )
            );
        }

        // invoke the parent method
        parent::setUp($serial);
    }

    /**
     * Clean up the global data after importing the bunch.
     *
     * @param string $serial The serial of the actual import
     *
     * @return void
     */
    public function tearDown($serial)
    {

        // invoke the parent method
        parent::tearDown($serial);

        // load the registry processor
        $registryProcessor = $this->getRegistryProcessor();

        // update the status
        $registryProcessor->mergeAttributesRecursive(
            RegistryKeys::STATUS,
            array(
                RegistryKeys::PRE_LOADED_ENTITY_IDS => $this->preLoadedEntityIds,
            )
        );
    }

    /**
     * Return's the default callback mappings.
     *
     * @return array The default callback mappings
     */
    public function getDefaultCallbackMappings()
    {
        return $this->defaultCallbackMappings;
    }

    /**
     * Return's the mappings for the table column => CSV column header.
     *
     * @return array The header stock mappings
     */
    public function getHeaderStockMappings()
    {
        return $this->headerStockMappings;
    }

    /**
     * Return's the visibility key for the passed visibility string.
     *
     * @param string $visibility The visibility string to return the key for
     *
     * @return integer The requested visibility key
     * @throws \Exception Is thrown, if the requested visibility is not available
     */
    public function getVisibilityIdByValue($visibility)
    {

        // query whether or not, the requested visibility is available
        if (isset($this->availableVisibilities[$visibility])) {
            // load the visibility ID, add the mapping and return the ID
            return $this->availableVisibilities[$visibility];
        }

        // throw an exception, if not
        throw new \Exception(
            $this->appendExceptionSuffix(
                sprintf('Found invalid visibility %s', $visibility)
            )
        );
    }

    /**
     * Pre-load the entity ID for the passed product.
     *
     * @param array $product The product to be pre-loaded
     *
     * @return void
     */
    public function preLoadEntityId(array $product)
    {
        $this->preLoadedEntityIds[$product[MemberNames::SKU]] = $product[MemberNames::ENTITY_ID];
    }

    /**
     * Return's the entity type for the configured entity type code.
     *
     * @return array The requested entity type
     * @throws \Exception Is thrown, if the requested entity type is not available
     */
    public function getEntityType()

    {

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

        // throw a new exception
        throw new \Exception(
            $this->appendExceptionSuffix(
                sprintf('Requested entity type "%s" is not available', $entityTypeCode)
            )
        );
    }

    /**
     * Return's TRUE, if the passed URL key varchar value IS related with the actual PK.
     *
     * @param array $productVarcharAttribute The varchar value to check
     *
     * @return boolean TRUE if the URL key is related, else FALSE
     */
    public function isUrlKeyOf(array $productVarcharAttribute)
    {
        return ((integer) $productVarcharAttribute[MemberNames::ENTITY_ID] === (integer) $this->getLastEntityId()) &&
               ((integer) $productVarcharAttribute[MemberNames::STORE_ID] === (integer) $this->getRowStoreId(StoreViewCodes::ADMIN));
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Product\Subjects\BunchSubject
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 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\Subjects;
22
23			use TechDivision\Import\Utils\StoreViewCodes;
24			use TechDivision\Import\Product\Utils\MemberNames;
25			use TechDivision\Import\Product\Utils\RegistryKeys;
26			use TechDivision\Import\Product\Utils\VisibilityKeys;
27			use TechDivision\Import\Product\Utils\ConfigurationKeys;
28			use TechDivision\Import\Subjects\ExportableTrait;
29			use TechDivision\Import\Subjects\FileUploadTrait;
30			use TechDivision\Import\Subjects\ExportableSubjectInterface;
31			use TechDivision\Import\Subjects\FileUploadSubjectInterface;
32			use TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface;
33
34			/**
35			* The subject implementation that handles the business logic to persist products.
36			*
37			* @author Tim Wagner <[email protected]>
38			* @copyright 2016 TechDivision GmbH <[email protected]>
39			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
40			* @link https://github.com/techdivision/import-product
41			* @link http://www.techdivision.com
42			*/
43			class BunchSubject extends AbstractProductSubject implements ExportableSubjectInterface, FileUploadSubjectInterface, UrlKeyAwareSubjectInterface
44			{
45
46			/**
47			* The trait that implements the export functionality.
48			*
49			* @var \TechDivision\Import\Subjects\ExportableTrait
50			*/
51			use ExportableTrait;
52
53			/**
54			* The trait that provides file upload functionality.
55			*
56			* @var \TechDivision\Import\Subjects\FileUploadTrait
57			*/
58			use FileUploadTrait;
59
60			/**
61			* The array with the pre-loaded entity IDs.
62			*
63			* @var array
64			*/
65			protected $preLoadedEntityIds = array();
66
67			/**
68			* Mappings for the table column => CSV column header.
69			*
70			* @var array
71			*/
72			protected $headerStockMappings = array(
73			'qty' => array('qty', 'float'),
74			'min_qty' => array('out_of_stock_qty', 'float'),
75			'use_config_min_qty' => array('use_config_min_qty', 'int'),
76			'is_qty_decimal' => array('is_qty_decimal', 'int'),
77			'backorders' => array('allow_backorders', 'int'),
78			'use_config_backorders' => array('use_config_backorders', 'int'),
79			'min_sale_qty' => array('min_cart_qty', 'float'),
80			'use_config_min_sale_qty' => array('use_config_min_sale_qty', 'int'),
81			'max_sale_qty' => array('max_cart_qty', 'float'),
82			'use_config_max_sale_qty' => array('use_config_max_sale_qty', 'int'),
83			'is_in_stock' => array('is_in_stock', 'int'),
84			'notify_stock_qty' => array('notify_on_stock_below', 'float'),
85			'use_config_notify_stock_qty' => array('use_config_notify_stock_qty', 'int'),
86			'manage_stock' => array('manage_stock', 'int'),
87			'use_config_manage_stock' => array('use_config_manage_stock', 'int'),
88			'use_config_qty_increments' => array('use_config_qty_increments', 'int'),
89			'qty_increments' => array('qty_increments', 'float'),
90			'use_config_enable_qty_inc' => array('use_config_enable_qty_inc', 'int'),
91			'enable_qty_increments' => array('enable_qty_increments', 'int'),
92			'is_decimal_divided' => array('is_decimal_divided', 'int'),
93			);
94
95			/**
96			* The array with the available visibility keys.
97			*
98			* @var array
99			*/
100			protected $availableVisibilities = array(
101			'Not Visible Individually' => VisibilityKeys::VISIBILITY_NOT_VISIBLE,
102			'Catalog' => VisibilityKeys::VISIBILITY_IN_CATALOG,
103			'Search' => VisibilityKeys::VISIBILITY_IN_SEARCH,
104			'Catalog, Search' => VisibilityKeys::VISIBILITY_BOTH
105			);
106
107			/**
108			* The default callback mappings for the Magento standard product attributes.
109			*
110			* @var array
111			*/
112			protected $defaultCallbackMappings = array(
113			'visibility' => array('import_product.callback.visibility'),
114			'tax_class_id' => array('import_product.callback.tax.class'),
115			'bundle_price_type' => array('import_product_bundle.callback.bundle.type'),
116			'bundle_sku_type' => array('import_product_bundle.callback.bundle.type'),
117			'bundle_weight_type' => array('import_product_bundle.callback.bundle.type'),
118			'bundle_price_view' => array('import_product_bundle.callback.bundle.price.view'),
119			'bundle_shipment_type' => array('import_product_bundle.callback.bundle.shipment.type')
120			);
121
122			/**
123			* The available entity types.
124			*
125			* @var array
126			*/
127			protected $entityTypes = array();
128
129			/**
130			* Intializes the previously loaded global data for exactly one bunch.
131			*
132			* @param string $serial The serial of the actual import
133			*
134			* @return void
135			*/
136	18		public function setUp($serial)
137			{
138
139			// load the status of the actual import
140	18		$status = $this->getRegistryProcessor()->getAttribute(RegistryKeys::STATUS);
141
142			// load the global data we've prepared initially
143	18		$this->entityTypes = $status[RegistryKeys::GLOBAL_DATA][RegistryKeys::ENTITY_TYPES];
144
145			// initialize the flag whether to copy images or not
146	18		if ($this->getConfiguration()->hasParam(ConfigurationKeys::COPY_IMAGES)) {
147			$this->setCopyImages($this->getConfiguration()->getParam(ConfigurationKeys::COPY_IMAGES));
			0 ignored issues – show Documentation introduced 2017-09-02 10:43 UTC by Report Bug Copy Issue Report `$this->getConfiguration(...ationKeys::COPY_IMAGES)` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
148			}
149
150			// initialize media directory => can be absolute or relative
151	18		if ($this->getConfiguration()->hasParam(ConfigurationKeys::MEDIA_DIRECTORY)) {
152			$this->setMediaDir(
153			$this->resolvePath(
154			$this->getConfiguration()->getParam(ConfigurationKeys::MEDIA_DIRECTORY)
155			)
156			);
157			}
158
159			// initialize images directory => can be absolute or relative
160	18		if ($this->getConfiguration()->hasParam(ConfigurationKeys::IMAGES_FILE_DIRECTORY)) {
161			$this->setImagesFileDir(
162			$this->resolvePath(
163			$this->getConfiguration()->getParam(ConfigurationKeys::IMAGES_FILE_DIRECTORY)
164			)
165			);
166			}
167
168			// invoke the parent method
169	18		parent::setUp($serial);
170	18		}
171
172			/**
173			* Clean up the global data after importing the bunch.
174			*
175			* @param string $serial The serial of the actual import
176			*
177			* @return void
178			*/
179			public function tearDown($serial)
180			{
181
182			// invoke the parent method
183			parent::tearDown($serial);
184
185			// load the registry processor
186			$registryProcessor = $this->getRegistryProcessor();
187
188			// update the status
189			$registryProcessor->mergeAttributesRecursive(
190			RegistryKeys::STATUS,
191			array(
192			RegistryKeys::PRE_LOADED_ENTITY_IDS => $this->preLoadedEntityIds,
193			)
194			);
195			}
196
197			/**
198			* Return's the default callback mappings.
199			*
200			* @return array The default callback mappings
201			*/
202			public function getDefaultCallbackMappings()
203			{
204			return $this->defaultCallbackMappings;
205			}
206
207			/**
208			* Return's the mappings for the table column => CSV column header.
209			*
210			* @return array The header stock mappings
211			*/
212	1		public function getHeaderStockMappings()
213			{
214	1		return $this->headerStockMappings;
215			}
216
217			/**
218			* Return's the visibility key for the passed visibility string.
219			*
220			* @param string $visibility The visibility string to return the key for
221			*
222			* @return integer The requested visibility key
223			* @throws \Exception Is thrown, if the requested visibility is not available
224			*/
225			public function getVisibilityIdByValue($visibility)
226			{
227
228			// query whether or not, the requested visibility is available
229			if (isset($this->availableVisibilities[$visibility])) {
230			// load the visibility ID, add the mapping and return the ID
231			return $this->availableVisibilities[$visibility];
232			}
233
234			// throw an exception, if not
235			throw new \Exception(
236			$this->appendExceptionSuffix(
237			sprintf('Found invalid visibility %s', $visibility)
238			)
239			);
240			}
241
242			/**
243			* Pre-load the entity ID for the passed product.
244			*
245			* @param array $product The product to be pre-loaded
246			*
247			* @return void
248			*/
249			public function preLoadEntityId(array $product)
250			{
251			$this->preLoadedEntityIds[$product[MemberNames::SKU]] = $product[MemberNames::ENTITY_ID];
252			}
253
254			/**
255			* Return's the entity type for the configured entity type code.
256			*
257			* @return array The requested entity type
258			* @throws \Exception Is thrown, if the requested entity type is not available
259			*/
260	1	View Code Duplication	public function getEntityType()
			0 ignored issues – show Duplication introduced 2017-08-07 17:20 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
261			{
262
263			// query whether or not the entity type with the passed code is available
264	1		if (isset($this->entityTypes[$entityTypeCode = $this->getEntityTypeCode()])) {
265	1		return $this->entityTypes[$entityTypeCode];
266			}
267
268			// throw a new exception
269			throw new \Exception(
270			$this->appendExceptionSuffix(
271			sprintf('Requested entity type "%s" is not available', $entityTypeCode)
272			)
273			);
274			}
275
276			/**
277			* Return's TRUE, if the passed URL key varchar value IS related with the actual PK.
278			*
279			* @param array $productVarcharAttribute The varchar value to check
280			*
281			* @return boolean TRUE if the URL key is related, else FALSE
282			*/
283			public function isUrlKeyOf(array $productVarcharAttribute)
284			{
285			return ((integer) $productVarcharAttribute[MemberNames::ENTITY_ID] === (integer) $this->getLastEntityId()) &&
286			((integer) $productVarcharAttribute[MemberNames::STORE_ID] === (integer) $this->getRowStoreId(StoreViewCodes::ADMIN));
287			}
288			}
289

techdivision / import-product

Push — 19.x ( e6b277...972430 )

BunchSubject::tearDown() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like