loevgaard / dandomain-foundation-entities

src/Entity/OrderLine.php

<?php

declare(strict_types = 1);

namespace Loevgaard\DandomainFoundation\Entity;

use Brick\Math\BigDecimal;
use Doctrine\ORM\Mapping as ORM;
use Loevgaard\DandomainFoundation;
use Loevgaard\DandomainFoundation\Entity\Generated\OrderLineInterface;

The type Loevgaard\DandomainFoundation\Entity\Generated\OrderLineInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Loevgaard\DandomainFoundation\Entity\Generated\OrderLineTrait;

The type Loevgaard\DandomainFoundation\Entity\Generated\OrderLineTrait was not found. Maybe you did not declare it correctly or list all dependencies?

use Loevgaard\DandomainFoundation\Entity\Generated\ProductInterface;

The type Loevgaard\DandomainFoundation\Entity\Generated\ProductInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Money\Money;

/**
 * @ORM\Entity()
 * @ORM\Table(name="ldf_order_lines")
 */
class OrderLine extends AbstractEntity implements OrderLineInterface
{
    use OrderLineTrait;

    protected $hydrateConversions = [
        'id' => 'externalId',
        'productId' => 'productNumber',
    ];

    /**
     * @var int
     *
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     **/
    protected $id;

    /**
     * @var int
     *
     * @ORM\Column(type="integer", unique=true)
     */
    protected $externalId;

    /**
     * @var string|null
     *
     * @ORM\Column(nullable=true, type="string", length=191)
     */
    protected $fileUrl;

    /**
     * @var string|null
     *
     * @ORM\Column(nullable=true, type="string", length=191)
     */
    protected $productNumber;

    /**
     * @var string|null
     *
     * @ORM\Column(nullable=true, type="text")
     */
    protected $productName;

    /**
     * @var int|null
     *
     * @ORM\Column(nullable=true, type="integer")
     */
    protected $quantity;

    /**
     * This number is excl vat.
     *
     * @var int|null
     *
     * @ORM\Column(nullable=true, type="integer")
     */
    protected $unitPrice;

    /**
     * This number is excl vat.
     *
     * @var int|null
     *
     * @ORM\Column(nullable=true, type="integer")
     */
    protected $totalPrice;

    /**
     * @var float|null
     *
     * @ORM\Column(nullable=true, type="decimal", precision=5, scale=2)
     */
    protected $vatPct;

    /**
     * @var string|null
     *
     * @ORM\Column(nullable=true, type="string", length=191)
     */
    protected $variant;

    /**
     * @var string|null
     *
     * @ORM\Column(nullable=true, type="text")
     */
    protected $xmlParams;

    /**
     * @var Order
     *
     * @ORM\JoinColumn(onDelete="CASCADE", nullable=false)
     * @ORM\ManyToOne(inversedBy="orderLines", targetEntity="Order")
     */
    protected $order;

    /**
     * @var ProductInterface|null
     *
     * @ORM\JoinColumn(onDelete="SET NULL")
     * @ORM\ManyToOne(targetEntity="Product", cascade={"persist"})
     */
    protected $product;

    // @todo implement withVat and withoutVat methods

    public function hydrate(array $data, bool $useConversions = false, $scalarsOnly = true)
    {
        if (is_null($this->order)) {
            throw new \RuntimeException('Cannot hydrate order line without an associated order');
        }

        if (isset($data['unitPrice'])) {
            $data['unitPrice'] = DandomainFoundation\createMoneyFromFloat($this->getCurrencyCode(), $data['unitPrice']);

The function createMoneyFromFloat was not found. Maybe you did not declare it correctly or list all dependencies?

        }

        if (isset($data['totalPrice'])) {
            $data['totalPrice'] = DandomainFoundation\createMoneyFromFloat($this->getCurrencyCode(), $data['totalPrice']);
        }

        parent::hydrate($data, $useConversions, $scalarsOnly);
    }

    /**
     * This method copies properties from $orderLine onto this order line.
     *
     * @param OrderLineInterface $orderLine
     */
    public function copyProperties(OrderLineInterface $orderLine): void
    {
        $this->setExternalId($orderLine->getExternalId());
        $this->setFileUrl($orderLine->getFileUrl());
        $this->setProductNumber($orderLine->getProductNumber());
        $this->setProductName($orderLine->getProductName());
        $this->setQuantity($orderLine->getQuantity());
        $this->setUnitPrice($orderLine->getUnitPrice());
        $this->setTotalPrice($orderLine->getTotalPrice());
        $this->setVatPct($orderLine->getVatPct());
        $this->setVariant($orderLine->getVariant());
        $this->setXmlParams($orderLine->getXmlParams());
        $this->setOrder($orderLine->getOrder());
        $this->setProduct($orderLine->getProduct());
    }

    /*
     * Helper methods
     */
    public function getUnitPriceInclVat(): ?Money
    {
        $unitPrice = $this->getUnitPrice();
        if (!$unitPrice) {
            return null;
        }

        $multiplier = BigDecimal::of('100')->plus($this->vatPct)->exactlyDividedBy('100');

The method exactlyDividedBy() does not exist on Brick\Math\BigRational.

The method exactlyDividedBy() does not exist on Brick\Math\BigInteger.

        return $unitPrice->multiply((string) $multiplier);
    }

    public function getUnitPriceExclVat(): ?Money
    {
        return $this->getUnitPrice();
    }

    public function getTotalPriceInclVat(): ?Money
    {
        $totalPrice = $this->getTotalPrice();
        if (!$totalPrice) {
            return null;
        }

        $multiplier = BigDecimal::of('100')->plus($this->vatPct)->exactlyDividedBy('100');

        return $totalPrice->multiply((string) $multiplier);
    }

    public function getTotalPriceExclVat(): ?Money
    {
        return $this->getTotalPrice();
    }

    /**
     * @return int
     */
    public function getId(): int
    {
        return (int) $this->id;
    }

    /**
     * @param int $id
     *
     * @return OrderLineInterface
     */
    public function setId(int $id)
    {
        $this->id = $id;

        return $this;
    }

    /**
     * @return int
     */
    public function getExternalId(): int
    {
        return (int) $this->externalId;
    }

    /**
     * @param int $externalId
     *
     * @return OrderLineInterface
     */
    public function setExternalId(int $externalId)
    {
        $this->externalId = $externalId;

        return $this;
    }

    /**
     * @return null|string
     */
    public function getFileUrl()
    {
        return $this->fileUrl;
    }

    /**
     * @param null|string $fileUrl
     *
     * @return OrderLineInterface
     */
    public function setFileUrl($fileUrl)
    {
        $this->fileUrl = $fileUrl;

        return $this;
    }

    /**
     * @return string|null
     */
    public function getProductNumber()
    {
        return $this->productNumber;
    }

    /**
     * @param string|null $productNumber
     *
     * @return OrderLineInterface
     */
    public function setProductNumber($productNumber)
    {
        $this->productNumber = $productNumber;

        return $this;
    }

    /**
     * @return null|string
     */
    public function getProductName()
    {
        return $this->productName;
    }

    /**
     * @param null|string $productName
     *
     * @return OrderLineInterface
     */
    public function setProductName($productName)
    {
        $this->productName = $productName;

        return $this;
    }

    /**
     * @return int|null
     */
    public function getQuantity()
    {
        return $this->quantity;
    }

    /**
     * @param int|null $quantity
     *
     * @return OrderLineInterface
     */
    public function setQuantity($quantity)
    {
        $this->quantity = $quantity;

        return $this;
    }

    /**
     * @return Money|null
     */
    public function getTotalPrice()
    {
        return DandomainFoundation\createMoney($this->getCurrencyCode(), (int) $this->totalPrice);

The function createMoney was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * @param Money|null $totalPrice
     *
     * @return OrderLineInterface
     */
    public function setTotalPrice(Money $totalPrice = null)
    {
        $this->totalPrice = $totalPrice ? $totalPrice->getAmount() : $totalPrice;

It seems like $totalPrice ? $totalPrice->getAmount() : $totalPrice can also be of type string. However, the property $totalPrice is declared as type integer|null. Maybe add an additional type check?

        return $this;
    }

    /**
     * @return Money|null
     */
    public function getUnitPrice()
    {
        return DandomainFoundation\createMoney($this->getCurrencyCode(), (int) $this->unitPrice);

The function createMoney was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * @param Money|null $unitPrice
     *
     * @return OrderLineInterface
     */
    public function setUnitPrice(Money $unitPrice = null)
    {
        $this->unitPrice = $unitPrice ? $unitPrice->getAmount() : $unitPrice;

It seems like $unitPrice ? $unitPrice->getAmount() : $unitPrice can also be of type string. However, the property $unitPrice is declared as type integer|null. Maybe add an additional type check?

        return $this;
    }

    /**
     * @return float
     */
    public function getVatPct() : float
    {
        return (float)$this->vatPct;
    }

    /**
     * @param float|null $vatPct
     *
     * @return OrderLineInterface
     */
    public function setVatPct($vatPct)
    {
        $this->vatPct = $vatPct;

        return $this;
    }

    /**
     * @return null|string
     */
    public function getVariant()
    {
        return $this->variant;
    }

    /**
     * @param null|string $variant
     *
     * @return OrderLineInterface
     */
    public function setVariant($variant)
    {
        $this->variant = $variant;

        return $this;
    }

    /**
     * @return null|string
     */
    public function getXmlParams()
    {
        return $this->xmlParams;
    }

    /**
     * @param null|string $xmlParams
     *
     * @return OrderLineInterface
     */
    public function setXmlParams($xmlParams)
    {
        $this->xmlParams = $xmlParams;

        return $this;
    }

    /**
     * @return Order
     */
    public function getOrder(): ?Order
    {
        return $this->order;
    }

    /**
     * @param Order|null $order
     *
     * @return OrderLineInterface
     */
    public function setOrder(?Order $order)
    {
        $this->order = $order;

        return $this;
    }

    /**
     * @return ProductInterface|null
     */
    public function getProduct()
    {
        return $this->product;
    }

    /**
     * @param ProductInterface|null $product
     *
     * @return OrderLineInterface
     */
    public function setProduct(ProductInterface $product = null)
    {
        $this->product = $product;

        return $this;
    }

    protected function getCurrencyCode(): string
    {
        return $this->getOrder()->getCurrency()->getIsoCodeAlpha();
    }
}