Parthenon\Billing\Entity\Subscription

Complexity

Total Complexity

44

Size/Duplication

Total Lines	268
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

44 Methods

Rating	Name	Duplication	Size	Complexity
A	getMoneyAmount()	0	3	1
A	getValidUntil()	0	3	1
A	setCurrency()	0	3	1
A	setPaymentExternalReference()	0	3	1
A	getEndedAt()	0	3	1
A	setCreatedAt()	0	3	1
A	setPrice()	0	3	1
A	getUpdatedAt()	0	3	1
A	getPaymentSchedule()	0	3	1
A	setStartOfCurrentPeriod()	0	3	1
A	setUpdatedAt()	0	3	1
A	setValidUntil()	0	3	1
A	getAmount()	0	3	1
A	setMainExternalReference()	0	3	1
A	getPaymentExternalReference()	0	3	1
A	getStatus()	0	3	1
A	setStatus()	0	3	1
A	getPrice()	0	3	1
A	getSeats()	0	3	1
A	setMainExternalReferenceDetailsUrl()	0	3	1
A	getCreatedAt()	0	3	1
A	getStartOfCurrentPeriod()	0	3	1
A	setCustomer()	0	3	1
A	getMainExternalReferenceDetailsUrl()	0	3	1
A	setMoneyAmount()	0	4	1
A	getSubscriptionPlan()	0	3	1
A	setId()	0	3	1
A	setPlanName()	0	3	1
A	setEndedAt()	0	3	1
A	getPlanName()	0	3	1
A	getCurrency()	0	3	1
A	isActive()	0	3	1
A	setSeats()	0	3	1
A	setActive()	0	3	1
A	setChildExternalReference()	0	3	1
A	setAmount()	0	3	1
A	endAtEndOfPeriod()	0	3	1
A	getCustomer()	0	3	1
A	setPaymentSchedule()	0	3	1
A	getId()	0	3	1
A	getMainExternalReference()	0	3	1
A	getChildExternalReference()	0	3	1
A	setSubscriptionPlan()	0	3	1
A	endNow()	0	4	1

<?php

declare(strict_types=1);

/*
 * Copyright Iain Cambridge 2020-2023.
 *
 * Use of this software is governed by the Business Source License included in the LICENSE file and at https://getparthenon.com/docs/next/license.
 *
 * Change Date: TBD ( 3 years after 2.2.0 release )
 *
 * On the date above, in accordance with the Business Source License, use of this software will be governed by the open source license specified in the LICENSE file.
 */

namespace Parthenon\Billing\Entity;

use Brick\Money\Currency;
use Brick\Money\Money;

class Subscription
{
    private $id;

    private CustomerInterface $customer;

    private string $planName;

    private string $paymentSchedule;

    private ?int $seats = 1;

    private bool $active;

    private string $status;

    private ?int $amount = null;

    private ?string $currency = null;

    private string $mainExternalReference;

    private ?string $mainExternalReferenceDetailsUrl = null;

    private string $childExternalReference;

    private string $paymentExternalReference;

    private ?SubscriptionPlan $subscriptionPlan = null;

    private ?Price $price = null;

    private \DateTimeInterface $createdAt;

    private ?\DateTimeInterface $startOfCurrentPeriod = null;

    private ?\DateTimeInterface $validUntil = null;

    private \DateTimeInterface $updatedAt;

    private ?\DateTimeInterface $endedAt = null;

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

    /**
     * @param mixed $id
     */
    public function setId($id): void
    {
        $this->id = $id;
    }

    public function getPlanName(): string
    {
        return $this->planName;
    }

    public function setPlanName(string $planName): void
    {
        $this->planName = $planName;
    }

    public function getPaymentSchedule(): string
    {
        return $this->paymentSchedule;
    }

    public function setPaymentSchedule(string $paymentSchedule): void
    {
        $this->paymentSchedule = $paymentSchedule;
    }

    public function getSeats(): ?int
    {
        return $this->seats;
    }

    public function setSeats(?int $seats): void
    {
        $this->seats = $seats;
    }

    public function getStatus(): string
    {
        return $this->status;
    }

    public function setStatus(string $status): void
    {
        $this->status = $status;
    }

    public function getSubscriptionPlan(): ?SubscriptionPlan
    {
        return $this->subscriptionPlan;
    }

    public function setSubscriptionPlan(?SubscriptionPlan $subscriptionPlan): void
    {
        $this->subscriptionPlan = $subscriptionPlan;
    }

    public function getMainExternalReference(): string
    {
        return $this->mainExternalReference;
    }

    public function setMainExternalReference(string $mainExternalReference): void
    {
        $this->mainExternalReference = $mainExternalReference;
    }

    public function getChildExternalReference(): string
    {
        return $this->childExternalReference;
    }

    public function setChildExternalReference(string $childExternalReference): void
    {
        $this->childExternalReference = $childExternalReference;
    }

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

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

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

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

    public function getPrice(): ?Price
    {
        return $this->price;
    }

    public function setPrice(?Price $price): void
    {
        $this->price = $price;
    }

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

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

    public function getUpdatedAt(): \DateTimeInterface
    {
        return $this->updatedAt;
    }

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

    public function getEndedAt(): ?\DateTimeInterface
    {
        return $this->endedAt;
    }

    public function setEndedAt(?\DateTimeInterface $endedAt): void
    {
        $this->endedAt = $endedAt;
    }

    public function endAtEndOfPeriod(): void
    {
        $this->endedAt = clone $this->validUntil;
    }

    public function endNow(): void
    {
        $this->endedAt = new \DateTime('now');
        $this->validUntil = new \DateTime('now');
    }

    public function isActive(): bool
    {
        return $this->active;
    }

    public function setActive(bool $active): void
    {
        $this->active = $active;
    }

    public function getValidUntil(): \DateTimeInterface
    {
        return $this->validUntil;

The expression return $this->validUntil could return the type null which is incompatible with the type-hinted return DateTimeInterface. Consider adding an additional type-check to rule them out.

    }

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

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

    public function setMoneyAmount(Money $money)
    {
        $this->amount = $money->getAmount()->getUnscaledValue()->toInt();
        $this->currency = $money->getCurrency()->getCurrencyCode();
    }

    public function getCustomer(): CustomerInterface
    {
        return $this->customer;
    }

    public function setCustomer(CustomerInterface $customer): void
    {
        $this->customer = $customer;
    }

    public function getMainExternalReferenceDetailsUrl(): ?string
    {
        return $this->mainExternalReferenceDetailsUrl;
    }

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

    public function getPaymentExternalReference(): string
    {
        return $this->paymentExternalReference;
    }

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

    public function getStartOfCurrentPeriod(): ?\DateTimeInterface
    {
        return $this->startOfCurrentPeriod;
    }

    public function setStartOfCurrentPeriod(?\DateTimeInterface $startOfCurrentPeriod): void
    {
        $this->startOfCurrentPeriod = $startOfCurrentPeriod;
    }
}