loevgaard / dandomain-stock-entities

src/Entity/OrderLineTrait.php

<?php

declare(strict_types = 1);

namespace Loevgaard\DandomainStock\Entity;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use Loevgaard\DandomainStock\Entity\Generated\StockMovementInterface;
use Loevgaard\DandomainStock\Exception\StockMovementProductMismatchException;

trait OrderLineTrait
{
    /**
     * @var StockMovement[]|ArrayCollection
     *
     * @ORM\OneToMany(targetEntity="Loevgaard\DandomainStock\Entity\StockMovement", mappedBy="orderLine", cascade={"persist"})
     */
    protected $stockMovements;

    /**
     * @param \Loevgaard\DandomainStock\Entity\Generated\StockMovementInterface $stockMovement
     *
     * @return OrderLineTrait

The return type OrderLineTrait is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     *
     * @throws \Loevgaard\DandomainStock\Exception\StockMovementProductMismatchException
     */
    public function addStockMovement(StockMovementInterface $stockMovement)
    {
        $this->initStockMovements();

        if ($this->stockMovements->count()) {
            /** @var StockMovement $firstStockMovement */
            $firstStockMovement = $this->stockMovements->first();
            if ($stockMovement->getProduct()->getId() !== $firstStockMovement->getProduct()->getId()) {
                throw new StockMovementProductMismatchException('The product id of the first product is `'.$firstStockMovement->getProduct()->getId().'` while the one you are adding has this id: `'.$stockMovement->getProduct()->getId().'`');
            }
        }

        if (!$this->stockMovements->contains($stockMovement)) {
            $this->stockMovements->add($stockMovement);
        }

        return $this;
    }

    /**
     * @return \Loevgaard\DandomainStock\Entity\StockMovement[]
     */
    public function getStockMovements()
    {
        $this->initStockMovements();

        return $this->stockMovements;
    }

    /**
     * @param \Loevgaard\DandomainStock\Entity\Generated\StockMovementInterface[] $stockMovements
     *
     * @return OrderLineTrait

The return type OrderLineTrait is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     *
     * @throws \Loevgaard\DandomainStock\Exception\StockMovementProductMismatchException
     */
    public function setStockMovements($stockMovements)
    {
        foreach ($stockMovements as $stockMovement) {
            $this->addStockMovement($stockMovement);
        }

        return $this;
    }

    /**
     * Say you have these two stock movements associated with this order line:.
     *
     * | qty | product |
     * -----------------
     * | 1   | Jeans   |
     * | -1  | Jeans   |
     *
     * Then the effective stock movement would be
     *
     * | qty | product |
     * -----------------
     * | 0   | Jeans   |
     *
     * And this is what we return in this method
     *
     * Returns null if the order line has 0 stock movements
     *
     * @return \Loevgaard\DandomainStock\Entity\Generated\StockMovementInterface|null
     *
     * @throws \Loevgaard\DandomainStock\Exception\CurrencyMismatchException
     * @throws \Loevgaard\DandomainStock\Exception\UnsetCurrencyException
     */
    public function computeEffectiveStockMovement(): ?StockMovementInterface
    {
        $this->initStockMovements();

        if (!$this->stockMovements->count()) {
            return null;
        }

        /** @var StockMovementInterface $lastStockMovement */
        $lastStockMovement = $this->stockMovements->last();

        $qty = 0;
        foreach ($this->stockMovements as $stockMovement) {
            $qty += $stockMovement->getQuantity();
        }

        $stockMovement = $lastStockMovement->copy();
        $stockMovement->setQuantity($qty);

        return $stockMovement;
    }

    protected function initStockMovements(): void
    {
        if (is_null($this->stockMovements)) {
            $this->stockMovements = new ArrayCollection();
        }
    }
}