Gweb\SyliusProductDepositPlugin\Entity\ProductVariantDepositTrait

Complexity

Total Complexity

12

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getDepositTaxCategory()	0	3	1
A	hasChannelDepositForChannel()	0	3	1
A	removeChannelDeposit()	0	5	2
A	setDepositTaxCategory()	0	3	1
A	getChannelDeposits()	0	3	1
A	hasChannelDeposit()	0	3	1
A	addChannelDeposit()	0	5	2
A	initProductVariantDepositTrait()	0	3	1
A	getChannelDepositForChannel()	0	7	2

<?php

declare(strict_types=1);

namespace Gweb\SyliusProductDepositPlugin\Entity;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Sylius\Component\Core\Model\ChannelInterface;
use Sylius\Component\Taxation\Model\TaxCategoryInterface;

/**
 * Trait that implements the deposit functionality
 * Used in:
 * <li>@see ProductVariant</li>
 *
 * @author Gerd Weitenberg <gweitenb@gmail.com>
 */
trait ProductVariantDepositTrait
{
    public function initProductVariantDepositTrait()
    {
        $this->channelDeposits = new ArrayCollection();
    }

    /**
     * @var Collection
     *
     * @ORM\OneToMany(
     *     targetEntity="\Gweb\SyliusProductDepositPlugin\Entity\ChannelDepositInterface",
     *     mappedBy="productVariant",
     *     indexBy="channelCode",
     *     cascade={"all"},
     *     orphanRemoval=true
     * )
     */
    protected $channelDeposits;

    /**
     * @var TaxCategoryInterface
     *
     * @ORM\ManyToOne(targetEntity="\Sylius\Component\Taxation\Model\TaxCategoryInterface", cascade={"all"}, fetch="EAGER")
     * @ORM\JoinColumn(name="deposit_tax_category_id", referencedColumnName="id", onDelete="SET NULL")
     */
    protected $depositTaxCategory;

    /**
     * Returns all deposit elements for all channels
     * @return Collection
     */
    public function getChannelDeposits(): Collection
    {
        return $this->channelDeposits;
    }

    /**
     * Returns the deposit element for one channel
     * @param ChannelInterface $channel
     * @return ChannelDepositInterface|null
     */
    public function getChannelDepositForChannel(ChannelInterface $channel): ?ChannelDepositInterface
    {
        if ($this->channelDeposits->containsKey($channel->getCode())) {
            return $this->channelDeposits->get($channel->getCode());
        }

        return null;
    }

    /**
     * Check if channel has deposit element
     * @param ChannelInterface $channel
     * @return bool
     */
    public function hasChannelDepositForChannel(ChannelInterface $channel): bool
    {
        return null !== $this->getChannelDepositForChannel($channel);
    }

    /**
     * Check if has deposit element
     * @param ChannelDepositInterface $channelDeposit
     * @return bool
     */
    public function hasChannelDeposit(ChannelDepositInterface $channelDeposit): bool
    {
        return $this->channelDeposits->contains($channelDeposit);
    }

    /**
     * Adds an deposit element to the list
     * @param ChannelDepositInterface $channelDeposit
     * @return void
     */
    public function addChannelDeposit(ChannelDepositInterface $channelDeposit): void
    {
        if (!$this->hasChannelDeposit($channelDeposit)) {
            $channelDeposit->setProductVariant($this);

$this of type Gweb\SyliusProductDepositPlugin\Entity\ProductVariantDepositTrait is incompatible with the type Gweb\SyliusProductDepositPlugin\Entity\ProductVariantInterface|null expected by parameter $productVariants of Gweb\SyliusProductDepositPlugin\Entity\ChannelDepositInterface::setProductVariant().

            $this->channelDeposits->set($channelDeposit->getChannelCode(), $channelDeposit);
        }
    }

    /**
     * Removes a deposit element from the list
     * @param ChannelDepositInterface $channelDeposit
     * @return void
     */
    public function removeChannelDeposit(ChannelDepositInterface $channelDeposit): void
    {
        if ($this->hasChannelDeposit($channelDeposit)) {
            $channelDeposit->setProductVariant(null);
            $this->channelDeposits->remove($channelDeposit->getChannelCode());
        }
    }

    /**
     * @return TaxCategoryInterface
     */
    public function getDepositTaxCategory(): ?TaxCategoryInterface
    {
        return $this->depositTaxCategory;
    }

    /**
     * @param TaxCategoryInterface $depositTaxCategory
     */
    public function setDepositTaxCategory(?TaxCategoryInterface $depositTaxCategory): void
    {
        $this->depositTaxCategory = $depositTaxCategory;
    }
}