Payever\ExternalIntegration\Products\Http\RequestEntity\ProductRequestEntity

Complexity

Total Complexity

28

Size/Duplication

Total Lines	285
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	setCategories()	0	11	3
A	setUpdatedAt()	0	5	1
A	setSalePrice()	0	6	3
A	addVariant()	0	10	2
A	setCreatedAt()	0	5	1
A	setOptions()	0	9	3
A	setVariants()	0	7	2
A	getImagesUuid()	0	7	1
A	addOption()	0	5	1
A	setShipping()	0	5	1
A	isVariant()	0	3	3
A	getSku()	0	3	2
A	toArray()	0	10	3
A	load()	0	7	2

<?php

/**
 * PHP version 5.4 and 8
 *
 * @category  RequestEntity
 * @package   Payever\Products
 * @author    payever GmbH <service@payever.de>
 * @author    Hennadii.Shymanskyi <gendosua@gmail.com>
 * @copyright 2017-2021 payever GmbH
 * @license   MIT <https://opensource.org/licenses/MIT>
 * @link      https://docs.payever.org/shopsystems/api/getting-started
 */

namespace Payever\ExternalIntegration\Products\Http\RequestEntity;

use Payever\ExternalIntegration\Core\Http\RequestEntity;
use Payever\ExternalIntegration\Products\Http\MessageEntity\ProductCategoryEntity;
use Payever\ExternalIntegration\Products\Http\MessageEntity\ProductShippingEntity;
use Payever\ExternalIntegration\Products\Http\MessageEntity\ProductVariantOptionEntity;

/**
 * @method string getExternalId()
 * @method string[] getImages()
 * @method string[] getImagesUrl()
 * @method bool getActive()
 * @method string getUuid()
 * @method string getBusinessUuid()
 * @method ProductCategoryEntity[]|string[] getCategories()
 * @method string getCurrency()
 * @method string getTitle()
 * @method string getDescription()
 * @method float getPrice()
 * @method float|null getSalePrice()
 * @method bool getOnSales()
 * @method string getBarcode()
 * @method float getVatRate()
 * @method ProductVariantOptionEntity[]|array getOptions()
 * @method string getType()
 * @method self[]|array getVariants()
 * @method ProductShippingEntity|null getShipping()
 * @method \DateTime|false getCreatedAt()
 * @method \DateTime|false getUpdatedAt()
 * @method string|null getParent()
 * @method string|null getProduct()
 * @method self setExternalId(string $externalId)
 * @method self setImages(array $images)
 * @method self setImagesUrl(array $imagesUrl)
 * @method self setActive(bool $active)
 * @method self setUuid(string $uuid)
 * @method self setBusinessUuid(string $businessUuid)
 * @method self setCurrency(string $currency)
 * @method self setTitle(string $title)
 * @method self setDescription(string $description)
 * @method self setPrice(float $price)
 * @method self setOnSales(bool $onSales)
 * @method self setSku(string $sku)
 * @method self setBarcode(string $barcode)
 * @method self setVatRate(float $vatRate)
 * @method self setType(string $type)
 *
 * @SuppressWarnings(PHPMD.TooManyFields)
 */
class ProductRequestEntity extends RequestEntity
{
    const UNDERSCORE_ON_SERIALIZATION = false;

    const API_DATA_CONTAINER_NAME = 'product';

    /**
     * Subscription external id.
     * Required for all requests.
     *
     * @var string
     */
    protected $externalId;

    /** @var array */
    protected $images = [];

    /** @var array */
    protected $imagesUrl = [];

    /** @var bool */
    protected $active = true;

    /** @var string */
    protected $uuid;

    /** @var string */
    protected $businessUuid;

    /** @var ProductCategoryEntity[]|string[] */
    protected $categories = [];

    /** @var string */
    protected $currency;

    /** @var string */
    protected $title;

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

    /** @var float */
    protected $price;

    /** @var float|null */
    protected $salePrice;

    /** @var bool */
    protected $onSales = false;

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

    /** @var string */
    protected $barcode;

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

    /** @var float */
    protected $vatRate;

    /** @var self[]|array */
    protected $variants = [];

    /**
     * Parent product id for variants.
     * Present only in request with a single variant data inside.
     *
     * @var string|null
     */
    protected $parent;

    /**
     * Parent product id for variants.
     * Present only in request with parent product with variants.
     *
     * @var string|null
     */
    protected $product;

    /** @var ProductShippingEntity|null */
    protected $shipping;

    /** @var \DateTime|bool */
    protected $createdAt;

    /** @var \DateTime|bool */
    protected $updatedAt;

    /**
     * Available only for product variants
     *
     * @var ProductVariantOptionEntity[]|array
     */
    protected $options = [];

    /**
     * @param string $updatedAt
     *
     * @return static
     */
    public function setUpdatedAt($updatedAt)
    {
        $this->updatedAt = date_create($updatedAt);

        return $this;
    }

    /**
     * @param string $createdAt
     *
     * @return static
     */
    public function setCreatedAt($createdAt)
    {
        $this->createdAt = date_create($createdAt);

        return $this;
    }

    /**
     * @param array $data
     *
     * @return static
     */
    public function setShipping($data)
    {
        $this->shipping = new ProductShippingEntity($data);

        return $this;
    }

    /**
     * @param array $data
     *
     * @return static
     */
    public function setCategories($data)
    {
        foreach ($data as $plainCategory) {
            /** Both ProductCategoryEntity fields array and simple title are possible */
            $this->categories[] = is_array($plainCategory)
                ? new ProductCategoryEntity($plainCategory)
                : $plainCategory
            ;
        }

        return $this;
    }

    /**
     * @param array[]|static[] $data
     *
     * @return static
     */
    public function setVariants($data)
    {
        foreach ($data as $variant) {
            $this->addVariant($variant);
        }

        return $this;
    }

    /**
     * @param array|static $variant
     *
     * @return self
     */
    public function addVariant($variant)
    {
        if (is_array($variant)) {
            $variant = new static($variant);
            $variant->setCurrency($this->getCurrency());
        }

        $this->variants[] = $variant;

        return $this;
    }

    /**
     * Set product variant option
     *
     * @param array $options
     *
     * @return self
     */
    public function setOptions($options)
    {
        if (is_array($options)) {

The condition is_array($options) is always true.

            foreach ($options as $option) {
                $this->options[] = new ProductVariantOptionEntity($option);
            }
        }

        return $this;
    }

    /**
     * Add product variant option
     *
     * @param string $name
     * @param string $value
     *
     * @return self
     */
    public function addOption($name, $value)
    {
        $this->options[] = new ProductVariantOptionEntity(compact('name', 'value'));

        return $this;
    }

    /**
     * @return array
     */
    public function getImagesUuid()
    {
        return array_map(
            function ($imageName) {
                return substr($imageName, 0, strpos($imageName, '.'));
            },
            $this->getImages()
        );
    }

    /**
     * @param float $salePrice
     *
     * @return self
     */
    public function setSalePrice($salePrice)
    {
        $this->salePrice = $salePrice;
        $this->onSales = $salePrice > 0 && (!$this->getPrice() || $this->getPrice() > $salePrice);

        return $this;
    }

    /**
     * Whether this product entity represents product variant and should be linked to a product
     *
     * @return bool
     */
    public function isVariant()
    {
        return $this->getParent() || $this->getProduct() || count($this->getOptions());
    }

    /**
     * @return string
     */
    public function getSku()
    {
        return $this->sku ? $this->sku : $this->uuid;
    }

    /**
     * @inheritDoc
     */
    public function toArray($object = null)
    {
        $isRootObject = $object === null;
        $result = parent::toArray($object);
        if ($result && $isRootObject) {
            $result['salePrice'] = $this->salePrice;
            $result = array(self::API_DATA_CONTAINER_NAME => $result);
        }

        return $result;
    }

    /**
     * @param $data
     * @return mixed
     */
    public function load($data)
    {
        if (array_key_exists(self::API_DATA_CONTAINER_NAME, $data)) {
            $data = $data[self::API_DATA_CONTAINER_NAME];
        }

        return parent::load($data);
    }
}