Transaction::getSubscription() - Code Metrics - Inspection of "Add Create and Update capabilities" - LauLamanApps/ecurring-api - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Retried Inspection

Push — master ( 5cdd3c...4f0c15 )

by Laurens

created 2018-10-15 21:51 UTC

Transaction::getSubscription() A

↳ Parent: Transaction

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

declare(strict_types=1);

namespace LauLamanApps\eCurring\Resource;

use DateTimeImmutable;
use LauLamanApps\eCurring\Http\Resource\Creatable;
use LauLamanApps\eCurring\Resource\Transaction\Event;
use LauLamanApps\eCurring\Resource\Transaction\PaymentMethod;
use LauLamanApps\eCurring\Resource\Transaction\Status;
use Money\Money;
use Ramsey\Uuid\UuidInterface;

final class Transaction implements TransactionInterface, Creatable
{
    /**
     * @var UuidInterface
     */
    private $id;

    /**
     * @var Status
     *
     * The current status of the transaction.
     */
    private $status;

    /**
     * @var DateTimeImmutable
     *
     * The date on which this transaction was scheduled
     * Generally this is the date on which the subscription was activated.
     */
    private $scheduledOn;

    /**
     * @var DateTimeImmutable|null
     *
     * The date on which the transaction will be, or was, executed.
     * Usually a transaction will be fulfilled within 3 days of this date
     * If a transaction was rescheduled after a charge back,
     * this attribute will reflect the date of the next attempt.
     */
    private $dueDate;

    /**
     * @var Money
     *
     * The amount of the transaction.
     */
    private $amount;

    /**
     * @var DateTimeImmutable|null
     *
     * The date on which the transaction was cancelled.
     * Only filled if $status is 'cancelled'
     */
    private $canceledOn;

    /**
     * @var string|null
     *
     * The webhook URL we will call when the status of this transaction changes,
     * inherited from the subscription.
     */
    private $webhookUrl;

    /**
     * @var PaymentMethod
     *
     * The payment method used for this transaction.
     * For fullfilled transactions this is the actual method used,
     * for future transactions this will be payment method used for the first attempt.
     * However, the method may change if the attempt fails and the transaction is
     * fulfilled through other means (a payment reminder, for example).
     */
    private $paymentMethod;

    /**
     * @var Event[]
     *
     * Collection of events with the full life cycle history of the transaction
     */
    private $history;

    /**
     * @var Subscription|null
     */
    private $subscription;

    private function __construct(Money $amount)
    {
        $this->amount = $amount;
        $this->history = [];
    }

    public static function new(
        Subscription $subscription,
        Money $amount,
        ?DateTimeImmutable $dueDate = null
    ): self {
        $self = new self($amount);
        $self->dueDate = $dueDate;
        $self->subscription = $subscription;

        return $self;
    }

    public static function fromData(
        UuidInterface $id,
        Status $status,
        DateTimeImmutable $scheduledOn,
        Money $amount,
        PaymentMethod $paymentMethod,
        ?DateTimeImmutable $dueDate = null,
        ?DateTimeImmutable $canceledOn = null,
        ?string $webhookUrl = null,
        ?Event ...$history
    ): self {
        $self = new self($amount);
        $self->id = $id;
        $self->status = $status;
        $self->scheduledOn = $scheduledOn;
        $self->dueDate = $dueDate;
        $self->amount = $amount;
        $self->canceledOn = $canceledOn;
        $self->webhookUrl = $webhookUrl;
        $self->paymentMethod = $paymentMethod;
        $self->history = $history;

        return $self;
    }

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

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

    public function getScheduledOn(): ?DateTimeImmutable
    {
        return $this->scheduledOn;
    }

    public function getDueDate(): ?DateTimeImmutable
    {
        return $this->dueDate;
    }

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

    public function getCanceledOn(): ?DateTimeImmutable
    {
        return $this->canceledOn;
    }

    public function getWebhookUrl(): ?string
    {
        return $this->webhookUrl;
    }

    public function getPaymentMethod(): PaymentMethod
    {
        return $this->paymentMethod;
    }

    public function getHistory(): array
    {
        return $this->history;
    }

    public function getSubscription(): ?Subscription
    {
        return $this->subscription;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace LauLamanApps\eCurring\Resource;
6
7		use DateTimeImmutable;
8		use LauLamanApps\eCurring\Http\Resource\Creatable;
9		use LauLamanApps\eCurring\Resource\Transaction\Event;
10		use LauLamanApps\eCurring\Resource\Transaction\PaymentMethod;
11		use LauLamanApps\eCurring\Resource\Transaction\Status;
12		use Money\Money;
13		use Ramsey\Uuid\UuidInterface;
14
15		final class Transaction implements TransactionInterface, Creatable
16		{
17		/**
18		* @var UuidInterface
19		*/
20		private $id;
21
22		/**
23		* @var Status
24		*
25		* The current status of the transaction.
26		*/
27		private $status;
28
29		/**
30		* @var DateTimeImmutable
31		*
32		* The date on which this transaction was scheduled
33		* Generally this is the date on which the subscription was activated.
34		*/
35		private $scheduledOn;
36
37		/**
38		* @var DateTimeImmutable\|null
39		*
40		* The date on which the transaction will be, or was, executed.
41		* Usually a transaction will be fulfilled within 3 days of this date
42		* If a transaction was rescheduled after a charge back,
43		* this attribute will reflect the date of the next attempt.
44		*/
45		private $dueDate;
46
47		/**
48		* @var Money
49		*
50		* The amount of the transaction.
51		*/
52		private $amount;
53
54		/**
55		* @var DateTimeImmutable\|null
56		*
57		* The date on which the transaction was cancelled.
58		* Only filled if $status is 'cancelled'
59		*/
60		private $canceledOn;
61
62		/**
63		* @var string\|null
64		*
65		* The webhook URL we will call when the status of this transaction changes,
66		* inherited from the subscription.
67		*/
68		private $webhookUrl;
69
70		/**
71		* @var PaymentMethod
72		*
73		* The payment method used for this transaction.
74		* For fullfilled transactions this is the actual method used,
75		* for future transactions this will be payment method used for the first attempt.
76		* However, the method may change if the attempt fails and the transaction is
77		* fulfilled through other means (a payment reminder, for example).
78		*/
79		private $paymentMethod;
80
81		/**
82		* @var Event[]
83		*
84		* Collection of events with the full life cycle history of the transaction
85		*/
86		private $history;
87
88		/**
89		* @var Subscription\|null
90		*/
91		private $subscription;
92	1
93		private function __construct(Money $amount)
94	1	{
95	1	$this->amount = $amount;
96	1	$this->history = [];
97		}
98
99		public static function new(
100		Subscription $subscription,
101		Money $amount,
102		?DateTimeImmutable $dueDate = null
103		): self {
104		$self = new self($amount);
105		$self->dueDate = $dueDate;
106		$self->subscription = $subscription;
107
108		return $self;
109		}
110	1
111		public static function fromData(
112		UuidInterface $id,
113		Status $status,
114		DateTimeImmutable $scheduledOn,
115		Money $amount,
116		PaymentMethod $paymentMethod,
117		?DateTimeImmutable $dueDate = null,
118		?DateTimeImmutable $canceledOn = null,
119		?string $webhookUrl = null,
120		?Event ...$history
121	1	): self {
122	1	$self = new self($amount);
123	1	$self->id = $id;
124	1	$self->status = $status;
125	1	$self->scheduledOn = $scheduledOn;
126	1	$self->dueDate = $dueDate;
127	1	$self->amount = $amount;
128	1	$self->canceledOn = $canceledOn;
129	1	$self->webhookUrl = $webhookUrl;
130	1	$self->paymentMethod = $paymentMethod;
131		$self->history = $history;
132	1
133		return $self;
134		}
135	1
136		public function getId(): ?UuidInterface
137	1	{
138		return $this->id;
139		}
140	1
141		public function getStatus(): ?Status
142	1	{
143		return $this->status;
144		}
145	1
146		public function getScheduledOn(): ?DateTimeImmutable
147	1	{
148		return $this->scheduledOn;
149		}
150	1
151		public function getDueDate(): ?DateTimeImmutable
152	1	{
153		return $this->dueDate;
154		}
155	1
156		public function getAmount(): Money
157	1	{
158		return $this->amount;
159		}
160	1
161		public function getCanceledOn(): ?DateTimeImmutable
162	1	{
163		return $this->canceledOn;
164		}
165	1
166		public function getWebhookUrl(): ?string
167	1	{
168		return $this->webhookUrl;
169		}
170	1
171		public function getPaymentMethod(): PaymentMethod
172	1	{
173		return $this->paymentMethod;
174		}
175	1
176		public function getHistory(): array
177	1	{
178		return $this->history;
179		}
180
181		public function getSubscription(): ?Subscription
182		{
183		return $this->subscription;
184		}
185		}
186

LauLamanApps / ecurring-api

Push — master ( 5cdd3c...4f0c15 )

Transaction::getSubscription() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like