Parthenon\Billing\Entity\SubscriptionPlan

Complexity

Total Complexity

42

Size/Duplication

Total Lines	246
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

39 Methods

Rating	Name	Duplication	Size	Complexity
A	setUserCount()	0	3	1
A	removeLimit()	0	3	1
A	getUserCount()	0	3	1
A	isFree()	0	3	1
A	setPrices()	0	3	1
A	getHasTrial()	0	3	1
A	setTrialLengthDays()	0	3	1
A	getLimits()	0	3	1
A	setFeatures()	0	3	1
A	getId()	0	3	1
A	isPerSeat()	0	3	1
A	getProduct()	0	3	1
A	setPaymentProviderDetailsLink()	0	3	1
A	setPerSeat()	0	3	1
A	setName()	0	3	1
A	getCodeName()	0	3	1
A	addLimit()	0	5	2
A	removePrice()	0	3	1
A	hasExternalReference()	0	3	1
A	addPrice()	0	4	2
A	removeFeature()	0	3	1
A	setHasTrial()	0	3	1
A	setLimits()	0	3	1
A	getTrialLengthDays()	0	3	1
A	setExternalReference()	0	3	1
A	setId()	0	3	1
A	setFree()	0	3	1
A	addFeature()	0	4	2
A	getFeatures()	0	3	1
A	setPublic()	0	3	1
A	setProduct()	0	3	1
A	getPrices()	0	3	1
A	getDisplayName()	0	3	1
A	getName()	0	3	1
A	getPaymentProviderDetailsLink()	0	3	1
A	isPublic()	0	3	1
A	setCodeName()	0	3	1
A	getExternalReference()	0	3	1
A	__construct()	0	5	1

<?php

declare(strict_types=1);

/*
 * Copyright Humbly Arrogant Software Limited 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: 26.06.2026 ( 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 Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Parthenon\Athena\Entity\CrudEntityInterface;

class SubscriptionPlan implements CrudEntityInterface
{
    private $id;

    private bool $public = false;

    private string $name;

    private ?string $codeName = null;

    private ?string $externalReference = null;

    private ?string $paymentProviderDetailsLink = null;

    private array|Collection $limits;

    private bool $perSeat;

    private bool $free;

    private int $userCount;

    private ?bool $hasTrial = false;

    private ?int $trialLengthDays = 0;

    private array|Collection $features;

    private array|Collection $prices;

    private Product $product;

    public function __construct()
    {
        $this->limits = new ArrayCollection();
        $this->features = new ArrayCollection();
        $this->prices = new ArrayCollection();
    }

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

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

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

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

    public function getName(): string
    {
        return $this->name;
    }

    public function setName(string $name): void
    {
        $this->name = $name;
    }

    public function getCodeName(): ?string
    {
        return $this->codeName;
    }

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

    /**
     * @return string
     */
    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 getPaymentProviderDetailsLink(): ?string
    {
        return $this->paymentProviderDetailsLink;
    }

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

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

    /**
     * @param SubscriptionPlanLimit[]|Collection $limits
     */
    public function setLimits(Collection|array $limits): void
    {
        $this->limits = $limits;
    }

    public function addLimit(SubscriptionPlanLimit $limit): void
    {
        if (!$this->limits->contains($limit)) {
            $limit->setSubscriptionPlan($this);
            $this->limits->add($limit);
        }
    }

    public function removeLimit(SubscriptionPlanLimit $limit): void
    {
        $this->limits->removeElement($limit);
    }

    public function addFeature(SubscriptionFeature $subscriptionFeature): void
    {
        if (!$this->features->contains($subscriptionFeature)) {
            $this->features->add($subscriptionFeature);
        }
    }

    public function removeFeature(SubscriptionFeature $subscriptionFeature): void
    {
        $this->features->removeElement($subscriptionFeature);
    }

    public function addPrice(Price $price): void
    {
        if (!$this->prices->contains($price)) {
            $this->prices->add($price);
        }
    }

    public function removePrice(Price $price): void
    {
        $this->prices->removeElement($price);
    }

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

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

    public function getDisplayName(): string
    {
        return $this->name;
    }

    public function isPerSeat(): bool
    {
        return $this->perSeat;
    }

    public function setPerSeat(bool $perSeat): void
    {
        $this->perSeat = $perSeat;
    }

    public function isFree(): bool
    {
        return $this->free;
    }

    public function setFree(bool $free): void
    {
        $this->free = $free;
    }

    public function getUserCount(): int
    {
        return $this->userCount;
    }

    public function setUserCount(int $userCount): void
    {
        $this->userCount = $userCount;
    }

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

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

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

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

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

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

    public function getTrialLengthDays(): int
    {
        return (int) $this->trialLengthDays;
    }

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