Price::getUsage() - Code Metrics - Inspection of "[Billing] Modify Price for usage pricing changes" - getparthenon/parthenon - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 3fb85e...d4cdd5 )

by Iain

created 2024-08-17 11:18 UTC

Price::getUsage() A

↳ Parent: Price

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?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;

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;

    private ?int $units = null;

    private ?bool $usage = false;

    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;
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
    }

    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 getUnits(): ?int
    {
        return $this->units;
    }

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

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

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


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* Copyright (C) 2020-2024 Iain Cambridge
7			*
8			* This program is free software: you can redistribute it and/or modify
9			* it under the terms of the GNU General Public License as published by
10			* the Free Software Foundation, either version 3 of the License, or
11			* (at your option) any later version.
12			*
13			* This program is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU General Public License for more details.
17			*
18			* You should have received a copy of the GNU General Public License
19			* along with this program. If not, see <https://www.gnu.org/licenses/>.
20			*/
21
22			namespace Parthenon\Billing\Entity;
23
24			use Brick\Money\Currency;
25			use Brick\Money\Money;
26			use Doctrine\Common\Collections\Collection;
27			use Parthenon\Athena\Entity\CrudEntityInterface;
28			use Parthenon\Athena\Entity\DeletableInterface;
29			use Parthenon\Billing\Enum\PriceType;
30
31			class Price implements CrudEntityInterface, DeletableInterface, PriceInterface
32			{
33			protected $id;
34
35			protected ?int $amount;
36
37			protected string $currency;
38
39			protected bool $recurring;
40
41			protected ?string $schedule = null;
42
43			protected ?string $externalReference = null;
44
45			protected bool $includingTax = true;
46
47			protected Product $product;
48
49			protected ?bool $public = true;
50
51			protected ?bool $isDeleted = false;
52
53			protected \DateTimeInterface $createdAt;
54
55			protected ?\DateTimeInterface $deletedAt = null;
56
57			protected ?string $paymentProviderDetailsUrl = null;
58
59			protected array\|Collection $tierComponents = [];
60
61			protected PriceType $type;
62
63			private ?int $units = null;
64
65			private ?bool $usage = false;
66
67			public function getId()
68			{
69			return $this->id;
70			}
71
72			public function setId($id): void
73			{
74			$this->id = $id;
75			}
76
77			public function getAmount(): ?int
78			{
79			return $this->amount;
80			}
81
82			public function setAmount(?int $amount): void
83			{
84			$this->amount = $amount;
85			}
86
87			public function getCurrency(): string
88			{
89			return strtoupper($this->currency);
90			}
91
92			public function setCurrency(string $currency): void
93			{
94			$this->currency = $currency;
95			}
96
97			public function getExternalReference(): ?string
98			{
99			return $this->externalReference;
100			}
101
102			public function setExternalReference(?string $externalReference): void
103			{
104			$this->externalReference = $externalReference;
105			}
106
107			public function hasExternalReference(): bool
108			{
109			return isset($this->externalReference);
110			}
111
112			public function isRecurring(): bool
113			{
114			return $this->recurring;
115			}
116
117			public function setRecurring(bool $recurring): void
118			{
119			$this->recurring = $recurring;
120			}
121
122			public function getSchedule(): ?string
123			{
124			return $this->schedule;
125			}
126
127			public function setSchedule(?string $schedule): void
128			{
129			$this->schedule = $schedule;
130			}
131
132			public function isIncludingTax(): bool
133			{
134			return $this->includingTax;
135			}
136
137			public function setIncludingTax(bool $includingTax): void
138			{
139			$this->includingTax = $includingTax;
140			}
141
142			public function getAsMoney(): Money
143			{
144			return Money::ofMinor($this->amount, Currency::of($this->currency));
145			}
146
147			public function getProduct(): Product
148			{
149			return $this->product;
150			}
151
152			public function setProduct(Product $product): void
153			{
154			$this->product = $product;
155			}
156
157			public function isPublic(): bool
158			{
159			return true === $this->public;
160			}
161
162			public function setPublic(?bool $public): void
163			{
164			$this->public = $public;
165			}
166
167			public function getPaymentProviderDetailsUrl(): ?string
168			{
169			return $this->paymentProviderDetailsUrl;
170			}
171
172			public function setPaymentProviderDetailsUrl(?string $paymentProviderDetailsUrl): void
173			{
174			$this->paymentProviderDetailsUrl = $paymentProviderDetailsUrl;
175			}
176
177			public function getDisplayName(): string
178			{
179			if ($this->recurring) {
180			$type = 'EmbeddedSubscription - '.$this->schedule;
181			} else {
182			$type = 'one-off';
183			}
184
185			return (string) $this->getAsMoney().' - '.$type.' - '.$this->getProduct()?->getName();
186			}
187
188			public function setDeletedAt(\DateTimeInterface $dateTime): DeletableInterface
189			{
190			$this->deletedAt = $dateTime;
			0 ignored issues – show Bug Best Practice introduced 2023-05-13 13:55 UTC by Report Bug Copy Issue Report 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. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history...
191			}
192
193			public function isDeleted(): bool
194			{
195			return true === $this->isDeleted;
196			}
197
198			public function markAsDeleted(): DeletableInterface
199			{
200			$this->deletedAt = new \DateTime('now');
201			$this->isDeleted = true;
202
203			return $this;
204			}
205
206			public function unmarkAsDeleted(): DeletableInterface
207			{
208			$this->deletedAt = null;
209			$this->isDeleted = false;
210
211			return $this;
212			}
213
214			public function getIsDeleted(): ?bool
215			{
216			return $this->isDeleted;
217			}
218
219			public function setIsDeleted(?bool $isDeleted): void
220			{
221			$this->isDeleted = $isDeleted;
222			}
223
224			public function getCreatedAt(): \DateTimeInterface
225			{
226			return $this->createdAt;
227			}
228
229			public function setCreatedAt(\DateTimeInterface $createdAt): void
230			{
231			$this->createdAt = $createdAt;
232			}
233
234			public function getTierComponents(): Collection\|array
235			{
236			return $this->tierComponents;
237			}
238
239			public function setTierComponents(Collection\|array $tierComponents): void
240			{
241			$this->tierComponents = $tierComponents;
242			}
243
244			public function getType(): PriceType
245			{
246			return $this->type;
247			}
248
249			public function setType(PriceType $type): void
250			{
251			$this->type = $type;
252			}
253
254			public function getUnits(): ?int
255			{
256			return $this->units;
257			}
258
259			public function setUnits(?int $units): void
260			{
261			$this->units = $units;
262			}
263
264			public function getUsage(): bool
265			{
266			return true === $this->usage;
267			}
268
269			public function setUsage(?bool $usage): void
270			{
271			$this->usage = $usage;
272			}
273			}
274

getparthenon / parthenon

Push — main ( 3fb85e...d4cdd5 )

Price::getUsage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like