Details::toArray() - Code Metrics - BitBagCommerce/SyliusVueStorefrontPlugin - Measure and Improve Code Quality continuously with Scrutinizer

Details::toArray() A
last analyzed 2020-10-09 22:30 UTC

↳ Parent: Details

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	46
rs	9.1781
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

/*
 * This file has been created by developers from BitBag.
 * Feel free to contact us once you face any issues or want to start
 * another great project.
 * You can find more information about us on https://bitbag.io and write us
 * an email on [email protected].
 */

declare(strict_types=1);

namespace BitBag\SyliusVueStorefrontPlugin\Document\Product;

use BitBag\SyliusVueStorefrontPlugin\Helper\DateHelper;

class Details
{
    private const ENTITY_ID = 'id';

    private const ENTITY_TYPE_ID = 'entity_type_id';

    private const SKU = 'sku';

    private const NAME = 'name';

    private const ATTRIBUTE_SET_ID = 'attribute_set_id';

    private const STATUS = 'status';

    private const VISIBILITY = 'visibility';

    private const TYPE = 'type_id';

    private const CREATED_AT = 'created_at';

    private const UPDATED_AT = 'updated_at';

    private const EXTENSION_ATTRIBUTES = 'extension_attributes';

    private const PRODUCT_LINKS = 'product_links';

    private const TIER_PRICES = 'tier_prices';

    private const CUSTOM_ATTRIBUTES = 'custom_attributes';

    private const DESCRIPTION = 'description';

    private const IMAGE = 'image';

    private const SMALL_IMAGE = 'small_image';

    private const THUMBNAIL = 'thumbnail';

    private const REQUIRED_OPTIONS = 'required_options';

    private const HAS_OPTIONS = 'has_options';

    private const URL_KEY = 'url_key';

    private const TAX_CLASS_ID = 'tax_class_id';

    private const ERIN_RECOMMENDS = 'erin_recommends';

    private const NEW = 'new';

    private const SALE = 'sale';

    private const CHILDREN_DATA = 'children_data';

    // TODO DEMO APP ONLY
    private const SLUG = 'slug';

    private const PARENT_SKU = 'parentSku';

    private const IS_CONFIGURED = 'is_configured';

    // TODO PROPERTIES BELOW APPEAR ONLY IN CORESHOP VS BRIDGE

    private const AVAILABILITY = 'availability';

    private const TEXT_STATUS = 'option_text_status';

    private const TAX_CLASS_NAME = 'option_text_tax_class_id';

    private const SHORT_DESCRIPTION = 'short_description';

    private const COLOR_OPTIONS = 'color_options';

    private const SIZE_OPTIONS = 'size_options';

    //    INTEGRATION BOILERPLATE
    private const META_TITLE = 'meta_title';

    private const META_DESCRIPTION = 'meta_description';

    private const GIFT_MESSAGE_AVAILABLE = 'gift_message_available';

    private const SPECIAL_FROM_DATE = 'special_from_date';

    private const SPECIAL_TO_DATE = 'special_to_date';

    private const TYPE_SIMPLE = 'simple';

    private const TYPE_CONFIGURABLE = 'configurable';

    /** https://docs.magento.com/m2/ce/user_guide/system/data-attributes-product.html */
    private const TYPES_IN_MAGENTO2 = [self::TYPE_SIMPLE, self::TYPE_CONFIGURABLE, 'grouped', 'virtual', 'bundle'];

    private const DEFAULT_ENTITY_TYPE_ID = 4;

    private const DEFAULT_ATTRIBUTE_SET_ID = 11;

    private const DEFAULT_STATUS = 1;

    private const DEFAULT_VISIBILITY = 4;

    private const DEFAULT_TYPE = self::TYPE_SIMPLE;

    private const DEFAULT_CATEGORY_ID = 2;

    private const DEFAULT_AVAILABILITY = '1';

    private const DEFAULT_OPTION_STATUS = 'Enabled';

    private const DEFAULT_TAX_CLASS_ID = 2;

    private const DEFAULT_TAX_CLASS_NAME = 'Taxable Goods';

    private const DEFAULT_CATEGORY = 'Default category';

    private const DEFAULT_MEDIA_TYPE = 'image';

    //   NODEAPP MAPPING COMPARISON
    private const URL_PATH = 'url_path';

    /** @var string */
    private $urlPath;

    //    END OF NODEAPP COMPARISON

    /** @var int */
    private $entityId;

    /** @var int */
    private $entityTypeId;

    /** @var int */
    private $attributeSetId;

    /** @var string */
    private $type;

    /** @var string */
    private $sku;

    /** @var string */
    private $urlKey;

    /** @var string */
    private $name;

    /** @var int */
    private $status;

    /** @var int */
    private $visibility;

    /** @var \DateTimeInterface */
    private $createdAt;

    /** @var \DateTimeInterface */
    private $updatedAt;

    /** @var string */
    private $image;

    /** @var bool */
    private $availability;

    /** @var string */
    private $textStatus;

    /** @var int */
    private $taxClassId;

    /** @var string */
    private $taxClassName;

    /** @var string */
    private $description;

    /** @var string */
    private $shortDescription;

    /** @var int */
    private $hasOptions;

    /** @var int */
    private $requiredOptions;

    /** @var array */
    private $productLinks;

    /** @var array */
    private $colorOptions;

    /** @var array */
    private $sizeOptions;

    //    TODO OPTIONAL STUFF FROM VARIOUS PLACES

    /** @var array */
    private $extensionAttributes = [];

    /** @var array */
    private $tierPrices = [];

    /** @var array|null */
    private $customAttributes;

    /** @var string */
    private $smallImage = '/a/b/small.jpg';

    /** @var string */
    private $thumbnail = '/a/b/small.jpg';

    /** @var bool */
    private $erinRecommends = true;

    /** @var bool */
    private $new = true;

    /** @var bool */
    private $sale = true;

    /** @var array */
    private $childrenData = [];

    /** @var string */
    private $slug;

    /** @var string */
    private $parentSku;

    /** @var bool */
    private $isConfigured = true;

    //    TODO INTEGRATION BOILERPLATE ONLY

    /** @var string|null */
    private $metaTitle;

    /** @var string|null */
    private $metaDescription;

    /** @var bool|null */
    private $giftMessageAvailable;

    /** @var \DateTime|null */
    private $specialFromDate;

    /** @var \DateTime|null */
    private $specialToDate;

    public function __construct(
        int $entityId,
        ?int $entityTypeId,
        ?int $attributeSetId,
        ?string $type,
        ?string $sku,
        string $urlKey,
        string $name,
        ?int $status,
        ?int $visibility,
        \DateTimeInterface $createdAt,
        \DateTimeInterface $updatedAt,
        ?string $image,
        bool $availability,
        ?string $textStatus,
        ?int $taxClassId,
        ?string $taxClassName,
        ?string $description,
        ?string $shortDescription,
        int $hasOptions,
        int $requiredOptions,
        array $productLinks,
        array $colorOptions,
        array $sizeOptions,
        string $parentSku
    ) {
        $this->entityId = $entityId;
        $this->entityTypeId = $entityTypeId ?? self::DEFAULT_ENTITY_TYPE_ID;
        $this->attributeSetId = $attributeSetId ?? self::DEFAULT_ATTRIBUTE_SET_ID;
        $this->type = $type ?? self::TYPE_SIMPLE;
        $this->sku = $sku;
        $this->urlKey = $urlKey;
        $this->name = $name;
        $this->status = $status ?? self::DEFAULT_STATUS;
        $this->visibility = $visibility ?? self::DEFAULT_VISIBILITY;
        $this->createdAt = $createdAt;
        $this->updatedAt = $updatedAt;
        $this->image = $image;
        $this->availability = $availability;
        $this->textStatus = $textStatus ?? self::DEFAULT_OPTION_STATUS;
        $this->taxClassId = $taxClassId ?? self::DEFAULT_TAX_CLASS_ID;
        $this->taxClassName = $taxClassName ?? self::DEFAULT_TAX_CLASS_NAME;
        $this->description = $description;
        $this->shortDescription = $shortDescription;
        $this->hasOptions = $hasOptions;
        $this->requiredOptions = $requiredOptions;
        $this->productLinks = $productLinks;
        $this->colorOptions = $colorOptions;
        $this->sizeOptions = $sizeOptions;
        $this->urlPath = $urlKey;
        $this->slug = $urlKey;
        $this->parentSku = $parentSku;
    }

    public function toArray(): array
    {
        return [
            self::ENTITY_ID => $this->entityId,
            self::ENTITY_TYPE_ID => $this->entityTypeId,
            self::ATTRIBUTE_SET_ID => $this->attributeSetId,
            self::TYPE => $this->type,
            self::SKU => $this->sku,
            self::URL_KEY => $this->urlKey,
            self::NAME => $this->name,
            self::STATUS => $this->status,
            self::VISIBILITY => $this->visibility,
            self::CREATED_AT => $this->createdAt->format(DateHelper::DATE_FORMAT),
            self::UPDATED_AT => $this->updatedAt->format(DateHelper::DATE_FORMAT),
            self::IMAGE => $this->image,
            self::AVAILABILITY => (string) $this->availability,
            self::TEXT_STATUS => $this->textStatus,
            self::TAX_CLASS_ID => (string) $this->taxClassId,
            self::TAX_CLASS_NAME => $this->taxClassName,
            self::DESCRIPTION => $this->description,
            self::SHORT_DESCRIPTION => $this->shortDescription,
            self::HAS_OPTIONS => $this->hasOptions,
            self::REQUIRED_OPTIONS => $this->requiredOptions,
            self::PRODUCT_LINKS => $this->productLinks,
            self::COLOR_OPTIONS => $this->colorOptions,
            self::SIZE_OPTIONS => $this->sizeOptions,
            self::EXTENSION_ATTRIBUTES => $this->extensionAttributes,
            self::TIER_PRICES => $this->tierPrices,
            self::CUSTOM_ATTRIBUTES => $this->customAttributes,
            self::SMALL_IMAGE => $this->smallImage,
            self::THUMBNAIL => $this->thumbnail,
            self::ERIN_RECOMMENDS => (string) (int) $this->erinRecommends,
            self::NEW => (string) (int) $this->new,
            self::SALE => (string) (int) $this->sale,
            self::CHILDREN_DATA => $this->childrenData,
            self::SLUG => $this->slug,
            self::PARENT_SKU => $this->parentSku,
            self::IS_CONFIGURED => $this->isConfigured,
            self::META_TITLE => $this->metaTitle,
            self::META_DESCRIPTION => $this->metaDescription,
            self::GIFT_MESSAGE_AVAILABLE => (int) $this->giftMessageAvailable,
            self::SPECIAL_FROM_DATE => $this->specialFromDate,
            self::SPECIAL_TO_DATE => $this->specialToDate,
            self::URL_PATH => $this->urlPath,
        ];
    }

    public function isConfigurableProduct(): bool
    {
        return $this->type === self::TYPE_CONFIGURABLE;
    }
}


1			<?php
2
3			/*
4			* This file has been created by developers from BitBag.
5			* Feel free to contact us once you face any issues or want to start
6			* another great project.
7			* You can find more information about us on https://bitbag.io and write us
8			* an email on [email protected].
9			*/
10
11			declare(strict_types=1);
12
13			namespace BitBag\SyliusVueStorefrontPlugin\Document\Product;
14
15			use BitBag\SyliusVueStorefrontPlugin\Helper\DateHelper;
16
17			class Details
18			{
19			private const ENTITY_ID = 'id';
20
21			private const ENTITY_TYPE_ID = 'entity_type_id';
22
23			private const SKU = 'sku';
24
25			private const NAME = 'name';
26
27			private const ATTRIBUTE_SET_ID = 'attribute_set_id';
28
29			private const STATUS = 'status';
30
31			private const VISIBILITY = 'visibility';
32
33			private const TYPE = 'type_id';
34
35			private const CREATED_AT = 'created_at';
36
37			private const UPDATED_AT = 'updated_at';
38
39			private const EXTENSION_ATTRIBUTES = 'extension_attributes';
40
41			private const PRODUCT_LINKS = 'product_links';
42
43			private const TIER_PRICES = 'tier_prices';
44
45			private const CUSTOM_ATTRIBUTES = 'custom_attributes';
46
47			private const DESCRIPTION = 'description';
48
49			private const IMAGE = 'image';
50
51			private const SMALL_IMAGE = 'small_image';
52
53			private const THUMBNAIL = 'thumbnail';
54
55			private const REQUIRED_OPTIONS = 'required_options';
56
57			private const HAS_OPTIONS = 'has_options';
58
59			private const URL_KEY = 'url_key';
60
61			private const TAX_CLASS_ID = 'tax_class_id';
62
63			private const ERIN_RECOMMENDS = 'erin_recommends';
64
65			private const NEW = 'new';
66
67			private const SALE = 'sale';
68
69			private const CHILDREN_DATA = 'children_data';
70
71			// TODO DEMO APP ONLY
72			private const SLUG = 'slug';
73
74			private const PARENT_SKU = 'parentSku';
75
76			private const IS_CONFIGURED = 'is_configured';
77
78			// TODO PROPERTIES BELOW APPEAR ONLY IN CORESHOP VS BRIDGE
79
80			private const AVAILABILITY = 'availability';
81
82			private const TEXT_STATUS = 'option_text_status';
83
84			private const TAX_CLASS_NAME = 'option_text_tax_class_id';
85
86			private const SHORT_DESCRIPTION = 'short_description';
87
88			private const COLOR_OPTIONS = 'color_options';
89
90			private const SIZE_OPTIONS = 'size_options';
91
92			// INTEGRATION BOILERPLATE
93			private const META_TITLE = 'meta_title';
94
95			private const META_DESCRIPTION = 'meta_description';
96
97			private const GIFT_MESSAGE_AVAILABLE = 'gift_message_available';
98
99			private const SPECIAL_FROM_DATE = 'special_from_date';
100
101			private const SPECIAL_TO_DATE = 'special_to_date';
102
103			private const TYPE_SIMPLE = 'simple';
104
105			private const TYPE_CONFIGURABLE = 'configurable';
106
107			/** https://docs.magento.com/m2/ce/user_guide/system/data-attributes-product.html */
108			private const TYPES_IN_MAGENTO2 = [self::TYPE_SIMPLE, self::TYPE_CONFIGURABLE, 'grouped', 'virtual', 'bundle'];
109
110			private const DEFAULT_ENTITY_TYPE_ID = 4;
111
112			private const DEFAULT_ATTRIBUTE_SET_ID = 11;
113
114			private const DEFAULT_STATUS = 1;
115
116			private const DEFAULT_VISIBILITY = 4;
117
118			private const DEFAULT_TYPE = self::TYPE_SIMPLE;
119
120			private const DEFAULT_CATEGORY_ID = 2;
121
122			private const DEFAULT_AVAILABILITY = '1';
123
124			private const DEFAULT_OPTION_STATUS = 'Enabled';
125
126			private const DEFAULT_TAX_CLASS_ID = 2;
127
128			private const DEFAULT_TAX_CLASS_NAME = 'Taxable Goods';
129
130			private const DEFAULT_CATEGORY = 'Default category';
131
132			private const DEFAULT_MEDIA_TYPE = 'image';
133
134			// NODEAPP MAPPING COMPARISON
135			private const URL_PATH = 'url_path';
136
137			/** @var string */
138			private $urlPath;
139
140			// END OF NODEAPP COMPARISON
141
142			/** @var int */
143			private $entityId;
144
145			/** @var int */
146			private $entityTypeId;
147
148			/** @var int */
149			private $attributeSetId;
150
151			/** @var string */
152			private $type;
153
154			/** @var string */
155			private $sku;
156
157			/** @var string */
158			private $urlKey;
159
160			/** @var string */
161			private $name;
162
163			/** @var int */
164			private $status;
165
166			/** @var int */
167			private $visibility;
168
169			/** @var \DateTimeInterface */
170			private $createdAt;
171
172			/** @var \DateTimeInterface */
173			private $updatedAt;
174
175			/** @var string */
176			private $image;
177
178			/** @var bool */
179			private $availability;
180
181			/** @var string */
182			private $textStatus;
183
184			/** @var int */
185			private $taxClassId;
186
187			/** @var string */
188			private $taxClassName;
189
190			/** @var string */
191			private $description;
192
193			/** @var string */
194			private $shortDescription;
195
196			/** @var int */
197			private $hasOptions;
198
199			/** @var int */
200			private $requiredOptions;
201
202			/** @var array */
203			private $productLinks;
204
205			/** @var array */
206			private $colorOptions;
207
208			/** @var array */
209			private $sizeOptions;
210
211			// TODO OPTIONAL STUFF FROM VARIOUS PLACES
212
213			/** @var array */
214			private $extensionAttributes = [];
215
216			/** @var array */
217			private $tierPrices = [];
218
219			/** @var array\|null */
220			private $customAttributes;
221
222			/** @var string */
223			private $smallImage = '/a/b/small.jpg';
224
225			/** @var string */
226			private $thumbnail = '/a/b/small.jpg';
227
228			/** @var bool */
229			private $erinRecommends = true;
230
231			/** @var bool */
232			private $new = true;
233
234			/** @var bool */
235			private $sale = true;
236
237			/** @var array */
238			private $childrenData = [];
239
240			/** @var string */
241			private $slug;
242
243			/** @var string */
244			private $parentSku;
245
246			/** @var bool */
247			private $isConfigured = true;
248
249			// TODO INTEGRATION BOILERPLATE ONLY
250
251			/** @var string\|null */
252			private $metaTitle;
253
254			/** @var string\|null */
255			private $metaDescription;
256
257			/** @var bool\|null */
258			private $giftMessageAvailable;
259
260			/** @var \DateTime\|null */
261			private $specialFromDate;
262
263			/** @var \DateTime\|null */
264			private $specialToDate;
265
266			public function __construct(
267			int $entityId,
268			?int $entityTypeId,
269			?int $attributeSetId,
270			?string $type,
271			?string $sku,
272			string $urlKey,
273			string $name,
274			?int $status,
275			?int $visibility,
276			\DateTimeInterface $createdAt,
277			\DateTimeInterface $updatedAt,
278			?string $image,
279			bool $availability,
280			?string $textStatus,
281			?int $taxClassId,
282			?string $taxClassName,
283			?string $description,
284			?string $shortDescription,
285			int $hasOptions,
286			int $requiredOptions,
287			array $productLinks,
288			array $colorOptions,
289			array $sizeOptions,
290			string $parentSku
291			) {
292			$this->entityId = $entityId;
293			$this->entityTypeId = $entityTypeId ?? self::DEFAULT_ENTITY_TYPE_ID;
294			$this->attributeSetId = $attributeSetId ?? self::DEFAULT_ATTRIBUTE_SET_ID;
295			$this->type = $type ?? self::TYPE_SIMPLE;
296			$this->sku = $sku;
297			$this->urlKey = $urlKey;
298			$this->name = $name;
299			$this->status = $status ?? self::DEFAULT_STATUS;
300			$this->visibility = $visibility ?? self::DEFAULT_VISIBILITY;
301			$this->createdAt = $createdAt;
302			$this->updatedAt = $updatedAt;
303			$this->image = $image;
304			$this->availability = $availability;
305			$this->textStatus = $textStatus ?? self::DEFAULT_OPTION_STATUS;
306			$this->taxClassId = $taxClassId ?? self::DEFAULT_TAX_CLASS_ID;
307			$this->taxClassName = $taxClassName ?? self::DEFAULT_TAX_CLASS_NAME;
308			$this->description = $description;
309			$this->shortDescription = $shortDescription;
310			$this->hasOptions = $hasOptions;
311			$this->requiredOptions = $requiredOptions;
312			$this->productLinks = $productLinks;
313			$this->colorOptions = $colorOptions;
314			$this->sizeOptions = $sizeOptions;
315			$this->urlPath = $urlKey;
316			$this->slug = $urlKey;
317			$this->parentSku = $parentSku;
318			}
319
320			public function toArray(): array
321			{
322			return [
323			self::ENTITY_ID => $this->entityId,
324			self::ENTITY_TYPE_ID => $this->entityTypeId,
325			self::ATTRIBUTE_SET_ID => $this->attributeSetId,
326			self::TYPE => $this->type,
327			self::SKU => $this->sku,
328			self::URL_KEY => $this->urlKey,
329			self::NAME => $this->name,
330			self::STATUS => $this->status,
331			self::VISIBILITY => $this->visibility,
332			self::CREATED_AT => $this->createdAt->format(DateHelper::DATE_FORMAT),
333			self::UPDATED_AT => $this->updatedAt->format(DateHelper::DATE_FORMAT),
334			self::IMAGE => $this->image,
335			self::AVAILABILITY => (string) $this->availability,
336			self::TEXT_STATUS => $this->textStatus,
337			self::TAX_CLASS_ID => (string) $this->taxClassId,
338			self::TAX_CLASS_NAME => $this->taxClassName,
339			self::DESCRIPTION => $this->description,
340			self::SHORT_DESCRIPTION => $this->shortDescription,
341			self::HAS_OPTIONS => $this->hasOptions,
342			self::REQUIRED_OPTIONS => $this->requiredOptions,
343			self::PRODUCT_LINKS => $this->productLinks,
344			self::COLOR_OPTIONS => $this->colorOptions,
345			self::SIZE_OPTIONS => $this->sizeOptions,
346			self::EXTENSION_ATTRIBUTES => $this->extensionAttributes,
347			self::TIER_PRICES => $this->tierPrices,
348			self::CUSTOM_ATTRIBUTES => $this->customAttributes,
349			self::SMALL_IMAGE => $this->smallImage,
350			self::THUMBNAIL => $this->thumbnail,
351			self::ERIN_RECOMMENDS => (string) (int) $this->erinRecommends,
352			self::NEW => (string) (int) $this->new,
353			self::SALE => (string) (int) $this->sale,
354			self::CHILDREN_DATA => $this->childrenData,
355			self::SLUG => $this->slug,
356			self::PARENT_SKU => $this->parentSku,
357			self::IS_CONFIGURED => $this->isConfigured,
358			self::META_TITLE => $this->metaTitle,
359			self::META_DESCRIPTION => $this->metaDescription,
360			self::GIFT_MESSAGE_AVAILABLE => (int) $this->giftMessageAvailable,
361			self::SPECIAL_FROM_DATE => $this->specialFromDate,
362			self::SPECIAL_TO_DATE => $this->specialToDate,
363			self::URL_PATH => $this->urlPath,
364			];
365			}
366
367			public function isConfigurableProduct(): bool
368			{
369			return $this->type === self::TYPE_CONFIGURABLE;
370			}
371			}
372

BitBagCommerce / SyliusVueStorefrontPlugin

Details::toArray() A last analyzed 2020-10-09 22:30 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Details::toArray() A
last analyzed 2020-10-09 22:30 UTC