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

Charge::setFinished() A
last analyzed 2025-06-06 10:44 UTC

↳ Parent: Charge

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	5
ccs	0
cts	3
cp	0
crap	2
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\charge;

use hiqdev\php\billing\action\ActionInterface;
use hiqdev\php\billing\bill\BillInterface;
use hiqdev\php\billing\event\EventAwareTrait;
use hiqdev\php\billing\Exception\CannotReassignException;
use hiqdev\php\billing\price\PriceInterface;
use hiqdev\php\billing\target\TargetInterface;
use hiqdev\php\billing\type\TypeInterface;
filter:
    dependency_paths: ["lib/*"]
use hiqdev\php\units\QuantityInterface;
use Money\Money;

/**
 * Charge.
 *
 * [[Action]] is charged with a number of [[Charge]]s.
 *
 * @author Andrii Vasyliev <[email protected]>
 */
class Charge implements ChargeInterface
{
    use EventAwareTrait;

    /** @var int */
    protected $id;

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

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

    /** @var ActionInterface */
    protected $action;

    /** @var PriceInterface */
    protected $price;

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

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

    /** @var BillInterface */
    protected $bill;

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

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

    /** @var ChargeInterface|null */
    protected $parent;

    public function __construct(
                            $id,
        TypeInterface $type,
        TargetInterface $target,
        ActionInterface $action,
        ?PriceInterface $price,
        QuantityInterface $usage,
        Money $sum,
        BillInterface $bill = null
    ) {
        $this->id       = $id;
        $this->type     = $type;
        $this->target   = $target;
        $this->action   = $action;
        $this->price    = $price;
        $this->usage    = $usage;
        $this->sum      = $sum;
        $this->bill     = $bill;
    }

    /**
     * {@inheritdoc}
     */
    public function getUniqueString(): string
    {
        return implode('-', [
            'currency'  => $this->sum->getCurrency()->getCode(),
            'buyer'     => $this->action->getCustomer()->getUniqueId(),
            'target'    => $this->target->getUniqueId(),
            'type'      => $this->type->getUniqueId(),
            'time'      => $this->action->getTime()->format('c'),
            'parent'    => '(' . ($this->parent !== null ? $this->parent->getUniqueString() : null) . ')',
        ]);
    }

    public function hasId(): bool
    {
        return $this->id !== null;
    }

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

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

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

    public function getAction(): ActionInterface
    {
        return $this->action;
    }

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

    public function getUsage(): QuantityInterface
    {
        return $this->usage;
    }

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

    public function calculatePrice(): Money
    {
        $usage = $this->usage->getQuantity();

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

    public function getBill(): ?BillInterface
    {
        return $this->bill;
    }

    public function hasBill()
    {
        return $this->bill !== null;
    }

    public function setBill(BillInterface $bill): ChargeInterface
    {
        /*if ($this->hasBill()) {
            throw new CannotReassignException('sale bill');
        }*/
        $this->bill = $bill;

        return $this;
    }

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

    public function setFinished(): ChargeInterface
    {
        $this->state = ChargeState::finished();

        return $this;
    }

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

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

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

        return $this;
    }

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

        return $this;
    }

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

    public function getParent(): ?ChargeInterface
    {
        return $this->parent;
    }

    /**
     * @throws CannotReassignException if parent is already set
     */
    public function setParent(ChargeInterface $parent): self
    {
        if ($this->parent !== null) {
            throw new CannotReassignException('charge parent');
        }

        $this->parent = $parent;

        return $this;
    }

    /**
     * Forcefully changes parent charge
     */
    public function overwriteParent(?ChargeInterface $parent): ChargeInterface
    {
        $this->parent = $parent;

        return $this;
    }
}


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\charge;
12
13		use hiqdev\php\billing\action\ActionInterface;
14		use hiqdev\php\billing\bill\BillInterface;
15		use hiqdev\php\billing\event\EventAwareTrait;
16		use hiqdev\php\billing\Exception\CannotReassignException;
17		use hiqdev\php\billing\price\PriceInterface;
18		use hiqdev\php\billing\target\TargetInterface;
19		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...
20		use hiqdev\php\units\QuantityInterface;
21		use Money\Money;
22
23		/**
24		* Charge.
25		*
26		* [[Action]] is charged with a number of [[Charge]]s.
27		*
28		* @author Andrii Vasyliev <[email protected]>
29		*/
30		class Charge implements ChargeInterface
31		{
32		use EventAwareTrait;
33
34		/** @var int */
35		protected $id;
36
37		/** @var TypeInterface */
38		protected $type;
39
40		/** @var TargetInterface */
41		protected $target;
42
43		/** @var ActionInterface */
44		protected $action;
45
46		/** @var PriceInterface */
47		protected $price;
48
49		/** @var QuantityInterface */
50		protected $usage;
51
52		/** @var Money */
53		protected $sum;
54
55		/** @var BillInterface */
56		protected $bill;
57
58		/** @var ChargeState */
59		protected $state;
60
61		/** @var string */
62		protected $comment;
63
64		/** @var ChargeInterface\|null */
65		protected $parent;
66
67	18	public function __construct(
68		$id,
69		TypeInterface $type,
70		TargetInterface $target,
71		ActionInterface $action,
72		?PriceInterface $price,
73		QuantityInterface $usage,
74		Money $sum,
75		BillInterface $bill = null
76		) {
77	18	$this->id = $id;
78	18	$this->type = $type;
79	18	$this->target = $target;
80	18	$this->action = $action;
81	18	$this->price = $price;
82	18	$this->usage = $usage;
83	18	$this->sum = $sum;
84	18	$this->bill = $bill;
85	18	}
86
87		/**
88		* {@inheritdoc}
89		*/
90		public function getUniqueString(): string
91		{
92		return implode('-', [
93		'currency' => $this->sum->getCurrency()->getCode(),
94		'buyer' => $this->action->getCustomer()->getUniqueId(),
95		'target' => $this->target->getUniqueId(),
96		'type' => $this->type->getUniqueId(),
97		'time' => $this->action->getTime()->format('c'),
98		'parent' => '(' . ($this->parent !== null ? $this->parent->getUniqueString() : null) . ')',
99		]);
100		}
101
102		public function hasId(): bool
103		{
104		return $this->id !== null;
105		}
106
107	1	public function getId()
108		{
109	1	return $this->id;
110		}
111
112	9	public function getType(): TypeInterface
113		{
114	9	return $this->type;
115		}
116
117	7	public function getTarget(): TargetInterface
118		{
119	7	return $this->target;
120		}
121
122	12	public function getAction(): ActionInterface
123		{
124	12	return $this->action;
125		}
126
127	7	public function getPrice(): ?PriceInterface
128		{
129	7	return $this->price;
130		}
131
132	14	public function getUsage(): QuantityInterface
133		{
134	14	return $this->usage;
135		}
136
137	14	public function getSum(): Money
138		{
139	14	return $this->sum;
140		}
141
142		public function calculatePrice(): Money
143		{
144		$usage = $this->usage->getQuantity();
145
146		return $usage ? $this->sum->divide(sprintf('%.14F', $usage)) : $this->sum;
147		}
148
149	1	public function getBill(): ?BillInterface
150		{
151	1	return $this->bill;
152		}
153
154		public function hasBill()
155		{
156		return $this->bill !== null;
157		}
158
159		public function setBill(BillInterface $bill): ChargeInterface
160		{
161		/*if ($this->hasBill()) {
162		throw new CannotReassignException('sale bill');
163		}*/
164		$this->bill = $bill;
165
166		return $this;
167		}
168
169		public function getState(): ?ChargeState
170		{
171		return $this->state;
172		}
173
174		public function setFinished(): ChargeInterface
175		{
176		$this->state = ChargeState::finished();
177
178		return $this;
179		}
180
181		public function isFinished(): ?bool
182		{
183		return $this->state === null ? null : $this->state->isFinished();
184		}
185
186	1	public function getComment(): ?string
187		{
188	1	return $this->comment;
189		}
190
191		public function setComment(string $comment): ChargeInterface
192		{
193		$this->comment = $comment;
194
195		return $this;
196		}
197
198		public function setId($id): ChargeInterface
199		{
200		if ((string) $this->id === (string) $id) {
201		return $this;
202		}
203		if ($this->id !== null) {
204		throw new CannotReassignException('charge id');
205		}
206		$this->id = $id;
207
208		return $this;
209		}
210
211		public function jsonSerialize(): array
212		{
213		return array_filter(get_object_vars($this));
214		}
215
216		public function getParent(): ?ChargeInterface
217		{
218		return $this->parent;
219		}
220
221		/**
222		* @throws CannotReassignException if parent is already set
223		*/
224		public function setParent(ChargeInterface $parent): self
225		{
226		if ($this->parent !== null) {
227	4	throw new CannotReassignException('charge parent');
228		}
229	4
230		$this->parent = $parent;
231
232		return $this;
233	4	}
234
235	4	/**
236		* Forcefully changes parent charge
237		*/
238		public function overwriteParent(?ChargeInterface $parent): ChargeInterface
239		{
240		$this->parent = $parent;
241
242		return $this;
243		}
244		}
245

hiqdev / php-billing

Charge::setFinished() A last analyzed 2025-06-06 10:44 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Charge::setFinished() A
last analyzed 2025-06-06 10:44 UTC