Parthenon\Billing\Entity\Price

Complexity

Total Complexity

38

Size/Duplication

Total Lines	229
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

37 Methods

Rating	Name	Duplication	Size	Complexity
A	getIsDeleted()	0	3	1
A	getCreatedAt()	0	3	1
A	setSchedule()	0	3	1
A	getPaymentProviderDetailsUrl()	0	3	1
A	setType()	0	3	1
A	setExternalReference()	0	3	1
A	getAmount()	0	3	1
A	getAsMoney()	0	3	1
A	hasExternalReference()	0	3	1
A	setCurrency()	0	3	1
A	setAmount()	0	3	1
A	setIsDeleted()	0	3	1
A	getUsageType()	0	3	1
A	setDeletedAt()	0	3	1
A	setIncludingTax()	0	3	1
A	getCurrency()	0	3	1
A	markAsDeleted()	0	6	1
A	getType()	0	3	1
A	setTierComponents()	0	3	1
A	setProduct()	0	3	1
A	setCreatedAt()	0	3	1
A	setId()	0	3	1
A	unmarkAsDeleted()	0	6	1
A	getId()	0	3	1
A	setUsageType()	0	3	1
A	getDisplayName()	0	9	2
A	isPublic()	0	3	1
A	isDeleted()	0	3	1
A	setPaymentProviderDetailsUrl()	0	3	1
A	setPublic()	0	3	1
A	isRecurring()	0	3	1
A	getSchedule()	0	3	1
A	getTierComponents()	0	3	1
A	setRecurring()	0	3	1
A	getExternalReference()	0	3	1
A	getProduct()	0	3	1
A	isIncludingTax()	0	3	1

<?php

declare(strict_types=1);

/*
 * Copyright (C) 2020-2024 Iain Cambridge
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU General Public License for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

namespace Parthenon\Billing\Entity;

use Brick\Money\Currency;
use Brick\Money\Money;
use Doctrine\Common\Collections\Collection;
use Parthenon\Athena\Entity\CrudEntityInterface;
use Parthenon\Athena\Entity\DeletableInterface;
use Parthenon\Billing\Enum\PriceType;
use Parthenon\Billing\Enum\UsageType;

class Price implements CrudEntityInterface, DeletableInterface, PriceInterface
{
    protected $id;

    protected int $amount;

    protected string $currency;

    protected bool $recurring;

    protected ?string $schedule = null;

    protected ?string $externalReference = null;

    protected bool $includingTax = true;

    protected Product $product;

    protected ?bool $public = true;

    protected ?bool $isDeleted = false;

    protected \DateTimeInterface $createdAt;

    protected ?\DateTimeInterface $deletedAt = null;

    protected ?string $paymentProviderDetailsUrl = null;

    protected array|Collection $tierComponents = [];

    protected PriceType $type;

    protected ?UsageType $usageType = null;

    public function getId()
    {
        return $this->id;
    }

    public function setId($id): void
    {
        $this->id = $id;
    }

    public function getAmount(): int
    {
        return $this->amount;
    }

    public function setAmount(int $amount): void
    {
        $this->amount = $amount;
    }

    public function getCurrency(): string
    {
        return strtoupper($this->currency);
    }

    public function setCurrency(string $currency): void
    {
        $this->currency = $currency;
    }

    public function getExternalReference(): ?string
    {
        return $this->externalReference;
    }

    public function setExternalReference(?string $externalReference): void
    {
        $this->externalReference = $externalReference;
    }

    public function hasExternalReference(): bool
    {
        return isset($this->externalReference);
    }

    public function isRecurring(): bool
    {
        return $this->recurring;
    }

    public function setRecurring(bool $recurring): void
    {
        $this->recurring = $recurring;
    }

    public function getSchedule(): ?string
    {
        return $this->schedule;
    }

    public function setSchedule(?string $schedule): void
    {
        $this->schedule = $schedule;
    }

    public function isIncludingTax(): bool
    {
        return $this->includingTax;
    }

    public function setIncludingTax(bool $includingTax): void
    {
        $this->includingTax = $includingTax;
    }

    public function getAsMoney(): Money
    {
        return Money::ofMinor($this->amount, Currency::of($this->currency));
    }

    public function getProduct(): Product
    {
        return $this->product;
    }

    public function setProduct(Product $product): void
    {
        $this->product = $product;
    }

    public function isPublic(): bool
    {
        return true === $this->public;
    }

    public function setPublic(?bool $public): void
    {
        $this->public = $public;
    }

    public function getPaymentProviderDetailsUrl(): ?string
    {
        return $this->paymentProviderDetailsUrl;
    }

    public function setPaymentProviderDetailsUrl(?string $paymentProviderDetailsUrl): void
    {
        $this->paymentProviderDetailsUrl = $paymentProviderDetailsUrl;
    }

    public function getDisplayName(): string
    {
        if ($this->recurring) {
            $type = 'EmbeddedSubscription - '.$this->schedule;
        } else {
            $type = 'one-off';
        }

        return (string) $this->getAsMoney().' - '.$type.' - '.$this->getProduct()?->getName();
    }

    public function setDeletedAt(\DateTimeInterface $dateTime): DeletableInterface
    {
        $this->deletedAt = $dateTime;

In this branch, the function will implicitly return null which is incompatible with the type-hinted return Parthenon\Athena\Entity\DeletableInterface. Consider adding a return statement or allowing null as return value.

    }

    public function isDeleted(): bool
    {
        return true === $this->isDeleted;
    }

    public function markAsDeleted(): DeletableInterface
    {
        $this->deletedAt = new \DateTime('now');
        $this->isDeleted = true;

        return $this;
    }

    public function unmarkAsDeleted(): DeletableInterface
    {
        $this->deletedAt = null;
        $this->isDeleted = false;

        return $this;
    }

    public function getIsDeleted(): ?bool
    {
        return $this->isDeleted;
    }

    public function setIsDeleted(?bool $isDeleted): void
    {
        $this->isDeleted = $isDeleted;
    }

    public function getCreatedAt(): \DateTimeInterface
    {
        return $this->createdAt;
    }

    public function setCreatedAt(\DateTimeInterface $createdAt): void
    {
        $this->createdAt = $createdAt;
    }

    public function getTierComponents(): Collection|array
    {
        return $this->tierComponents;
    }

    public function setTierComponents(Collection|array $tierComponents): void
    {
        $this->tierComponents = $tierComponents;
    }

    public function getType(): PriceType
    {
        return $this->type;
    }

    public function setType(PriceType $type): void
    {
        $this->type = $type;
    }

    public function getUsageType(): ?UsageType
    {
        return $this->usageType;
    }

    public function setUsageType(?UsageType $usageType): void
    {
        $this->usageType = $usageType;
    }
}