BitBag\SyliusVueStorefrontPlugin\Document\Product\Details

Complexity

Total Complexity

3

Size/Duplication

Total Lines	355
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	53	1
A	toArray()	0	46	1
A	isConfigurableProduct()	0	4	1

<?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 hello@bitbag.io.
 */

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