BunchSubject::getVisibilityIdByValue() - Code Metrics - Inspection of "Remove unnecessary pre-import observer from defaul..." - techdivision/import-product - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 13.x ( aea664...416f31 )

by Tim

created 2019-07-18 17:13 UTC

BunchSubject::getVisibilityIdByValue() A

↳ Parent: BunchSubject

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	16
ccs	0
cts	6
cp	0
rs	9.7333
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	6

<?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;

/**
 * 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
{

    /**
     * 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 category IDs the product is related with.
     *
     * @var array
     */
    protected $productCategoryIds = array();

    /**
     * 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 used URL keys.
     *
     * @var array
     */
    protected $usedUrlKeys = array();

    /**
     * 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)
            )
        );
    }

    /**
     * Add the passed category ID to the product's category list.
     *
     * @param integer $categoryId The category ID to add
     *
     * @return void
     */
    public function addProductCategoryId($categoryId)
    {
        $this->productCategoryIds[$this->getLastEntityId()][$categoryId] = $this->getLastEntityId();
    }

    /**
     * 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 list with category IDs the product is related with.
     *
     * @return array The product's category IDs
     */
    public function getProductCategoryIds()
    {

        // initialize the array with the product's category IDs
        $categoryIds = array();

        // query whether or not category IDs are available for the actual product entity
        if (isset($this->productCategoryIds[$lastEntityId = $this->getLastEntityId()])) {
            $categoryIds = $this->productCategoryIds[$lastEntityId];
        }

        // return the array with the product's category IDs
        return $categoryIds;
    }

    /**
     * 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
33			/**
34			* The subject implementation that handles the business logic to persist products.
35			*
36			* @author Tim Wagner <[email protected]>
37			* @copyright 2016 TechDivision GmbH <[email protected]>
38			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
39			* @link https://github.com/techdivision/import-product
40			* @link http://www.techdivision.com
41			*/
42			class BunchSubject extends AbstractProductSubject implements ExportableSubjectInterface, FileUploadSubjectInterface
43			{
44
45			/**
46			* The trait that implements the export functionality.
47			*
48			* @var \TechDivision\Import\Subjects\ExportableTrait
49			*/
50			use ExportableTrait;
51
52			/**
53			* The trait that provides file upload functionality.
54			*
55			* @var \TechDivision\Import\Subjects\FileUploadTrait
56			*/
57			use FileUploadTrait;
58
59			/**
60			* The array with the pre-loaded entity IDs.
61			*
62			* @var array
63			*/
64			protected $preLoadedEntityIds = array();
65
66			/**
67			* Mappings for the table column => CSV column header.
68			*
69			* @var array
70			*/
71			protected $headerStockMappings = array(
72			'qty' => array('qty', 'float'),
73			'min_qty' => array('out_of_stock_qty', 'float'),
74			'use_config_min_qty' => array('use_config_min_qty', 'int'),
75			'is_qty_decimal' => array('is_qty_decimal', 'int'),
76			'backorders' => array('allow_backorders', 'int'),
77			'use_config_backorders' => array('use_config_backorders', 'int'),
78			'min_sale_qty' => array('min_cart_qty', 'float'),
79			'use_config_min_sale_qty' => array('use_config_min_sale_qty', 'int'),
80			'max_sale_qty' => array('max_cart_qty', 'float'),
81			'use_config_max_sale_qty' => array('use_config_max_sale_qty', 'int'),
82			'is_in_stock' => array('is_in_stock', 'int'),
83			'notify_stock_qty' => array('notify_on_stock_below', 'float'),
84			'use_config_notify_stock_qty' => array('use_config_notify_stock_qty', 'int'),
85			'manage_stock' => array('manage_stock', 'int'),
86			'use_config_manage_stock' => array('use_config_manage_stock', 'int'),
87			'use_config_qty_increments' => array('use_config_qty_increments', 'int'),
88			'qty_increments' => array('qty_increments', 'float'),
89			'use_config_enable_qty_inc' => array('use_config_enable_qty_inc', 'int'),
90			'enable_qty_increments' => array('enable_qty_increments', 'int'),
91			'is_decimal_divided' => array('is_decimal_divided', 'int'),
92			);
93
94			/**
95			* The array with the available visibility keys.
96			*
97			* @var array
98			*/
99			protected $availableVisibilities = array(
100			'Not Visible Individually' => VisibilityKeys::VISIBILITY_NOT_VISIBLE,
101			'Catalog' => VisibilityKeys::VISIBILITY_IN_CATALOG,
102			'Search' => VisibilityKeys::VISIBILITY_IN_SEARCH,
103			'Catalog, Search' => VisibilityKeys::VISIBILITY_BOTH
104			);
105
106			/**
107			* The category IDs the product is related with.
108			*
109			* @var array
110			*/
111			protected $productCategoryIds = array();
112
113			/**
114			* The default callback mappings for the Magento standard product attributes.
115			*
116			* @var array
117			*/
118			protected $defaultCallbackMappings = array(
119			'visibility' => array('import_product.callback.visibility'),
120			'tax_class_id' => array('import_product.callback.tax.class'),
121			'bundle_price_type' => array('import_product_bundle.callback.bundle.type'),
122			'bundle_sku_type' => array('import_product_bundle.callback.bundle.type'),
123			'bundle_weight_type' => array('import_product_bundle.callback.bundle.type'),
124			'bundle_price_view' => array('import_product_bundle.callback.bundle.price.view'),
125			'bundle_shipment_type' => array('import_product_bundle.callback.bundle.shipment.type')
126			);
127
128			/**
129			* The used URL keys.
130			*
131			* @var array
132			*/
133			protected $usedUrlKeys = array();
134
135			/**
136			* The available entity types.
137			*
138			* @var array
139			*/
140			protected $entityTypes = array();
141
142			/**
143			* Intializes the previously loaded global data for exactly one bunch.
144			*
145			* @param string $serial The serial of the actual import
146			*
147			* @return void
148			*/
149	18		public function setUp($serial)
150			{
151
152			// load the status of the actual import
153	18		$status = $this->getRegistryProcessor()->getAttribute(RegistryKeys::STATUS);
154
155			// load the global data we've prepared initially
156	18		$this->entityTypes = $status[RegistryKeys::GLOBAL_DATA][RegistryKeys::ENTITY_TYPES];
157
158			// initialize the flag whether to copy images or not
159	18		if ($this->getConfiguration()->hasParam(ConfigurationKeys::COPY_IMAGES)) {
160			$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...
161			}
162
163			// initialize media directory => can be absolute or relative
164	18		if ($this->getConfiguration()->hasParam(ConfigurationKeys::MEDIA_DIRECTORY)) {
165			$this->setMediaDir(
166			$this->resolvePath(
167			$this->getConfiguration()->getParam(ConfigurationKeys::MEDIA_DIRECTORY)
168			)
169			);
170			}
171
172			// initialize images directory => can be absolute or relative
173	18		if ($this->getConfiguration()->hasParam(ConfigurationKeys::IMAGES_FILE_DIRECTORY)) {
174			$this->setImagesFileDir(
175			$this->resolvePath(
176			$this->getConfiguration()->getParam(ConfigurationKeys::IMAGES_FILE_DIRECTORY)
177			)
178			);
179			}
180
181			// invoke the parent method
182	18		parent::setUp($serial);
183	18		}
184
185			/**
186			* Clean up the global data after importing the bunch.
187			*
188			* @param string $serial The serial of the actual import
189			*
190			* @return void
191			*/
192			public function tearDown($serial)
193			{
194
195			// invoke the parent method
196			parent::tearDown($serial);
197
198			// load the registry processor
199			$registryProcessor = $this->getRegistryProcessor();
200
201			// update the status
202			$registryProcessor->mergeAttributesRecursive(
203			RegistryKeys::STATUS,
204			array(
205			RegistryKeys::PRE_LOADED_ENTITY_IDS => $this->preLoadedEntityIds,
206			)
207			);
208			}
209
210			/**
211			* Return's the default callback mappings.
212			*
213			* @return array The default callback mappings
214			*/
215	18		public function getDefaultCallbackMappings()
216			{
217	18		return $this->defaultCallbackMappings;
218			}
219
220			/**
221			* Return's the mappings for the table column => CSV column header.
222			*
223			* @return array The header stock mappings
224			*/
225	1		public function getHeaderStockMappings()
226			{
227	1		return $this->headerStockMappings;
228			}
229
230			/**
231			* Return's the visibility key for the passed visibility string.
232			*
233			* @param string $visibility The visibility string to return the key for
234			*
235			* @return integer The requested visibility key
236			* @throws \Exception Is thrown, if the requested visibility is not available
237			*/
238			public function getVisibilityIdByValue($visibility)
239			{
240
241			// query whether or not, the requested visibility is available
242			if (isset($this->availableVisibilities[$visibility])) {
243			// load the visibility ID, add the mapping and return the ID
244			return $this->availableVisibilities[$visibility];
245			}
246
247			// throw an exception, if not
248			throw new \Exception(
249			$this->appendExceptionSuffix(
250			sprintf('Found invalid visibility %s', $visibility)
251			)
252			);
253			}
254
255			/**
256			* Add the passed category ID to the product's category list.
257			*
258			* @param integer $categoryId The category ID to add
259			*
260			* @return void
261			*/
262			public function addProductCategoryId($categoryId)
263			{
264			$this->productCategoryIds[$this->getLastEntityId()][$categoryId] = $this->getLastEntityId();
265			}
266
267			/**
268			* Pre-load the entity ID for the passed product.
269			*
270			* @param array $product The product to be pre-loaded
271			*
272			* @return void
273			*/
274			public function preLoadEntityId(array $product)
275			{
276			$this->preLoadedEntityIds[$product[MemberNames::SKU]] = $product[MemberNames::ENTITY_ID];
277			}
278
279			/**
280			* Return's the list with category IDs the product is related with.
281			*
282			* @return array The product's category IDs
283			*/
284			public function getProductCategoryIds()
285			{
286
287			// initialize the array with the product's category IDs
288			$categoryIds = array();
289
290			// query whether or not category IDs are available for the actual product entity
291			if (isset($this->productCategoryIds[$lastEntityId = $this->getLastEntityId()])) {
292			$categoryIds = $this->productCategoryIds[$lastEntityId];
293			}
294
295			// return the array with the product's category IDs
296			return $categoryIds;
297			}
298
299			/**
300			* Return's the entity type for the configured entity type code.
301			*
302			* @return array The requested entity type
303			* @throws \Exception Is thrown, if the requested entity type is not available
304			*/
305	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...
306			{
307
308			// query whether or not the entity type with the passed code is available
309	1		if (isset($this->entityTypes[$entityTypeCode = $this->getEntityTypeCode()])) {
310	1		return $this->entityTypes[$entityTypeCode];
311			}
312
313			// throw a new exception
314			throw new \Exception(
315			$this->appendExceptionSuffix(
316			sprintf('Requested entity type "%s" is not available', $entityTypeCode)
317			)
318			);
319			}
320
321			/**
322			* Return's TRUE, if the passed URL key varchar value IS related with the actual PK.
323			*
324			* @param array $productVarcharAttribute The varchar value to check
325			*
326			* @return boolean TRUE if the URL key is related, else FALSE
327			*/
328			public function isUrlKeyOf(array $productVarcharAttribute)
329			{
330			return ((integer) $productVarcharAttribute[MemberNames::ENTITY_ID] === (integer) $this->getLastEntityId()) &&
331			((integer) $productVarcharAttribute[MemberNames::STORE_ID] === (integer) $this->getRowStoreId(StoreViewCodes::ADMIN));
332			}
333			}
334

techdivision / import-product

Push — 13.x ( aea664...416f31 )

BunchSubject::getVisibilityIdByValue() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like