Bill::isFinished() - Code Metrics - hiqdev/php-billing - Measure and Improve Code Quality continuously with Scrutinizer

Bill::isFinished() A
last analyzed 2025-09-12 12:31 UTC

↳ Parent: Bill

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
eloc	1
nc	2
nop	0
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	6
rs	10
c	0
b	0
f	0

<?php
/**
 * PHP Billing Library
 *
 * @link      https://github.com/hiqdev/php-billing
 * @package   php-billing
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2017-2020, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\php\billing\bill;

use DateTimeImmutable;
use hiqdev\php\billing\action\UsageInterval;
use hiqdev\php\billing\charge\ChargeInterface;
use hiqdev\php\billing\customer\CustomerInterface;
use hiqdev\php\billing\Exception\CannotReassignException;
use hiqdev\php\billing\plan\PlanInterface;
use hiqdev\php\billing\target\TargetInterface;
use hiqdev\php\billing\type\TypeInterface;
filter:
    dependency_paths: ["lib/*"]
use hiqdev\php\units\QuantityInterface;
use Money\Money;

/**
 * Bill.
 *
 * @author Andrii Vasyliev <[email protected]>
 */
class Bill implements BillInterface
{
    /** @var int|string */
    protected $id;

    /** @var TypeInterface */
    protected $type;

    /** @var DateTimeImmutable */
    protected $time;

    /** @var Money */
    protected $sum;

    /** @var QuantityInterface */
    protected $quantity;

    /** @var CustomerInterface */
    protected $customer;

    /** @var TargetInterface */
    protected $target;

    /** @var BillRequisite */
    protected $requisite;

    /** @var PlanInterface */
    protected $plan;

    /** @var ChargeInterface[] */
    protected $charges = [];

    /** @var BillState */
    protected $state;

    /** @var string */
    protected $comment;

    /** @var UsageInterval */
    protected $usageInterval;

    public function __construct(
                            $id,
        TypeInterface $type,
        DateTimeImmutable $time,
        Money $sum,
        QuantityInterface $quantity,
        CustomerInterface $customer,
        TargetInterface $target = null,
        PlanInterface $plan = null,
        array $charges = [],
        BillState $state = null
    ) {
        $this->id           = $id;
        $this->type         = $type;
        $this->time         = $time;
        $this->sum          = $sum;
        $this->quantity     = $quantity;
        $this->customer     = $customer;
        $this->target       = $target;
        $this->plan         = $plan;
        $this->charges      = $charges;
        $this->state        = $state;
    }

    /**
     * Provides unique string.
     * Can be used to compare or aggregate bills.
     */
    public function getUniqueString(): string
    {
        $parts = [
            'currency'  => $this->sum->getCurrency()->getCode(),
            'buyer'     => $this->customer->getUniqueId(),
            'target'    => $this->target ? $this->target->getUniqueId() : null,
            'type'      => $this->type->getUniqueId(),
            'time'      => $this->time->format('c'),
        ];

        return implode('-', $parts);
    }

    public function getUsageInterval(): UsageInterval
    {
        if ($this->usageInterval === null) {
            $this->initializeWholeMonthUsageInterval();
        }

        return $this->usageInterval;
    }

    private function initializeWholeMonthUsageInterval(): void
    {
        $this->setUsageInterval(UsageInterval::wholeMonth($this->time));
    }

    public function calculatePrice()
    {
        $quantity = $this->quantity->getQuantity();

        return $quantity ? $this->sum->divide(sprintf('%.14F', $quantity)) : $this->sum;
    }

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

    public function setId($id)
    {
        if ($this->id === $id) {
            return;
        }
        if ($this->id !== null) {
            throw new CannotReassignException('bill id');
        }
        $this->id = $id;
    }

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

    public function getTime(): DateTimeImmutable
    {
        return $this->time;
    }

    public function getTarget(): ?TargetInterface
    {
        return $this->target;
    }

    public function getRequisite(): ?BillRequisite
    {
        return $this->requisite;
    }

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

    public function getQuantity(): QuantityInterface
    {
        return $this->quantity;
    }

    public function setQuantity(QuantityInterface $quantity): BillInterface
    {
        $this->quantity = $quantity;

        return $this;
    }

    public function getSum(): Money
    {
        return $this->sum;
    }

    public function getPlan(): ?PlanInterface
    {
        return $this->plan;
    }

    public function hasCharges(): bool
    {
        return $this->charges !== [];
    }

    /**
     * @return ChargeInterface[]
     */
    public function getCharges(): array
    {
        return $this->charges;
    }

    /**
     * @param ChargeInterface[] $prices
     * @throws \Exception
     */
    public function setCharges(array $charges): self
    {
        if ($this->hasCharges()) {
            throw new CannotReassignException('bill charges');
        }
        $this->charges = $charges;

        return $this;
    }

    public function getState(): ?BillState
    {
        return $this->state;
    }

    public function setFinished(): void
    {
        $this->state = BillState::finished();
    }

    public function isFinished(): ?bool
    {
        return $this->state === null ? null : $this->state->isFinished();
    }

    public function getComment()
    {
        return $this->comment;
    }

    public function setComment(string $comment)
    {
        $this->comment = $comment;
    }

    public function jsonSerialize(): array
    {
        return array_filter(get_object_vars($this));
    }

    public function setUsageInterval(UsageInterval $usageInterval): void
    {
        $this->usageInterval = $usageInterval;
    }
}


1		<?php
2		/**
3		* PHP Billing Library
4		*
5		* @link https://github.com/hiqdev/php-billing
6		* @package php-billing
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2017-2020, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hiqdev\php\billing\bill;
12
13		use DateTimeImmutable;
14		use hiqdev\php\billing\action\UsageInterval;
15		use hiqdev\php\billing\charge\ChargeInterface;
16		use hiqdev\php\billing\customer\CustomerInterface;
17		use hiqdev\php\billing\Exception\CannotReassignException;
18		use hiqdev\php\billing\plan\PlanInterface;
19		use hiqdev\php\billing\target\TargetInterface;
20		use hiqdev\php\billing\type\TypeInterface;
		0 ignored issues – show Bug introduced 2024-09-12 00:19 UTC by Report Bug Copy Issue Report The type `hiqdev\php\billing\type\TypeInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
21		use hiqdev\php\units\QuantityInterface;
22		use Money\Money;
23
24		/**
25		* Bill.
26		*
27		* @author Andrii Vasyliev <[email protected]>
28		*/
29		class Bill implements BillInterface
30		{
31		/** @var int\|string */
32		protected $id;
33
34		/** @var TypeInterface */
35		protected $type;
36
37		/** @var DateTimeImmutable */
38		protected $time;
39
40		/** @var Money */
41		protected $sum;
42
43		/** @var QuantityInterface */
44		protected $quantity;
45
46		/** @var CustomerInterface */
47		protected $customer;
48
49		/** @var TargetInterface */
50		protected $target;
51
52		/** @var BillRequisite */
53		protected $requisite;
54
55		/** @var PlanInterface */
56		protected $plan;
57
58		/** @var ChargeInterface[] */
59		protected $charges = [];
60
61		/** @var BillState */
62		protected $state;
63	3
64		/** @var string */
65		protected $comment;
66
67		/** @var UsageInterval */
68		protected $usageInterval;
69
70		public function __construct(
71		$id,
72		TypeInterface $type,
73		DateTimeImmutable $time,
74		Money $sum,
75	3	QuantityInterface $quantity,
76	3	CustomerInterface $customer,
77	3	TargetInterface $target = null,
78	3	PlanInterface $plan = null,
79	3	array $charges = [],
80	3	BillState $state = null
81	3	) {
82	3	$this->id = $id;
83	3	$this->type = $type;
84	3	$this->time = $time;
85	3	$this->sum = $sum;
86		$this->quantity = $quantity;
87		$this->customer = $customer;
88		$this->target = $target;
89		$this->plan = $plan;
90		$this->charges = $charges;
91	1	$this->state = $state;
92		}
93
94	1	/**
95	1	* Provides unique string.
96	1	* Can be used to compare or aggregate bills.
97	1	*/
98	1	public function getUniqueString(): string
99		{
100		$parts = [
101	1	'currency' => $this->sum->getCurrency()->getCode(),
102		'buyer' => $this->customer->getUniqueId(),
103		'target' => $this->target ? $this->target->getUniqueId() : null,
104		'type' => $this->type->getUniqueId(),
105		'time' => $this->time->format('c'),
106		];
107
108		return implode('-', $parts);
109		}
110
111		public function getUsageInterval(): UsageInterval
112		{
113		if ($this->usageInterval === null) {
114	3	$this->initializeWholeMonthUsageInterval();
115		}
116	3
117		return $this->usageInterval;
118		}
119
120		private function initializeWholeMonthUsageInterval(): void
121		{
122		$this->setUsageInterval(UsageInterval::wholeMonth($this->time));
123		}
124
125		public function calculatePrice()
126		{
127		$quantity = $this->quantity->getQuantity();
128
129		return $quantity ? $this->sum->divide(sprintf('%.14F', $quantity)) : $this->sum;
130	1	}
131
132	1	/**
133		* @return int\|string
134		*/
135	3	public function getId()
136		{
137	3	return $this->id;
138		}
139
140		public function setId($id)
141		{
142		if ($this->id === $id) {
143	3	return;
144		}
145	3	if ($this->id !== null) {
146		throw new CannotReassignException('bill id');
147		}
148		$this->id = $id;
149		}
150
151	3	public function getType(): TypeInterface
152		{
153	3	return $this->type;
154		}
155
156		public function getTime(): DateTimeImmutable
157		{
158		return $this->time;
159	3	}
160
161	3	public function getTarget(): ?TargetInterface
162		{
163		return $this->target;
164		}
165
166		public function getRequisite(): ?BillRequisite
167		{
168		return $this->requisite;
169		}
170
171		public function getCustomer(): CustomerInterface
172		{
173		return $this->customer;
174	3	}
175
176	3	public function getQuantity(): QuantityInterface
177		{
178		return $this->quantity;
179		}
180
181		public function setQuantity(QuantityInterface $quantity): BillInterface
182	3	{
183		$this->quantity = $quantity;
184	3
185		return $this;
186		}
187
188		public function getSum(): Money
189		{
190		return $this->sum;
191		}
192
193		public function getPlan(): ?PlanInterface
194		{
195	1	return $this->plan;
196		}
197	1
198		public function hasCharges(): bool
199		{
200		return $this->charges !== [];
201		}
202
203		/**
204		* @return ChargeInterface[]
205		*/
206		public function getCharges(): array
207		{
208		return $this->charges;
209		}
210
211		/**
212		* @param ChargeInterface[] $prices
213		* @throws \Exception
214		*/
215		public function setCharges(array $charges): self
216		{
217		if ($this->hasCharges()) {
218		throw new CannotReassignException('bill charges');
219		}
220		$this->charges = $charges;
221
222		return $this;
223		}
224
225		public function getState(): ?BillState
226		{
227		return $this->state;
228		}
229
230		public function setFinished(): void
231		{
232		$this->state = BillState::finished();
233		}
234
235		public function isFinished(): ?bool
236		{
237		return $this->state === null ? null : $this->state->isFinished();
238		}
239
240		public function getComment()
241		{
242		return $this->comment;
243		}
244
245		public function setComment(string $comment)
246		{
247		$this->comment = $comment;
248		}
249
250		public function jsonSerialize(): array
251		{
252		return array_filter(get_object_vars($this));
253		}
254
255		public function setUsageInterval(UsageInterval $usageInterval): void
256		{
257		$this->usageInterval = $usageInterval;
258		}
259		}
260

hiqdev / php-billing

Bill::isFinished() A last analyzed 2025-09-12 12:31 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Bill::isFinished() A
last analyzed 2025-09-12 12:31 UTC