Subscription::isUnpaid() - Code Metrics - Inspection of "Add useful methods in Subscription class" - shapintv/stripe - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 77bf81...2c4a64 )

by Olivier

created 2019-02-14 13:10 UTC

Subscription::isUnpaid() A

↳ Parent: Subscription

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

declare(strict_types=1);

/*
 * This software may be modified and distributed under the terms
 * of the MIT license. See the LICENSE file for details.
 */

namespace Shapin\Stripe\Model\Subscription;

use Shapin\Stripe\Model\ContainsMetadata;
use Shapin\Stripe\Model\CreatableFromArray;
use Shapin\Stripe\Model\LivemodeTrait;
use Shapin\Stripe\Model\MetadataTrait;
use Shapin\Stripe\Model\MetadataCollection;
use Shapin\Stripe\Model\Plan\Plan;

final class Subscription implements CreatableFromArray, ContainsMetadata
{
    use LivemodeTrait, MetadataTrait;

    const BILLING_CHARGE_AUTOMATICALLY = 'charge_automatically';
    const BILLING_SEND_INVOICE = 'send_invoice';

    const STATUS_TRIALING = 'trialing';
    const STATUS_ACTIVE = 'active';
    const STATUS_PAST_DUE = 'past_due';
    const STATUS_CANCELED = 'canceled';
    const STATUS_UNPAID = 'unpaid';

    /**
     * @var string
     */
    private $id;

    /**
     * @var ?float
     */
    private $applicationFeePercent;

    /**
     * @var string
     */
    private $billing;

    /**
     * @var mixed
     */
    private $billingCycleAnchor;

    /**
     * @var bool
     */
    private $cancelAtPeriodEnd;

    /**
     * @var ?\DateTimeImmutable
     */
    private $canceledAt;

    /**
     * @var \DateTimeImmutable
     */
    private $createdAt;

    /**
     * @var \DateTimeImmutable
     */
    private $currentPeriodEndAt;

    /**
     * @var \DateTimeImmutable
     */
    private $currentPeriodStartAt;

    /**
     * @var string
     */
    private $customer;

    /**
     * @var ?int
     */
    private $daysUntilDue;

    /**
     * @var ?string
     */
    private $defaultSource;

    /**
     * @var ?\DateTimeImmutable
     */
    private $endedAt;

    /**
     * @var ItemCollection
     */
    private $items;

    /**
     * @var Plan
     */
    private $plan;

    /**
     * @var int
     */
    private $quantity;

    /**
     * @var \DateTimeImmutable
     */
    private $startAt;

    /**
     * @var string
     */
    private $status;

    /**
     * @var ?float
     */
    private $taxPercent;

    /**
     * @var ?\DateTimeImmutable
     */
    private $trialEndAt;

    /**
     * @var ?\DateTimeImmutable
     */
    private $trialStartAt;

    public static function createFromArray(array $data): self
    {
        $model = new self();
        $model->id = $data['id'];
        $model->applicationFeePercent = null !== $data['application_fee_percent'] ? (float) $data['application_fee_percent'] : null;
        $model->billing = $data['billing'];
        $model->billingCycleAnchor = $data['billing_cycle_anchor'];
        $model->cancelAtPeriodEnd = (bool) $data['cancel_at_period_end'];
        $model->canceledAt = null !== $data['canceled_at'] ? new \DateTimeImmutable('@'.$data['canceled_at']) : null;
        $model->createdAt = new \DateTimeImmutable('@'.$data['created']);
        $model->currentPeriodEndAt = new \DateTimeImmutable('@'.$data['current_period_end']);
        $model->currentPeriodStartAt = new \DateTimeImmutable('@'.$data['current_period_start']);
        $model->customer = $data['customer'];
        $model->daysUntilDue = null !== $data['days_until_due'] ? (int) $data['days_until_due'] : null;
        $model->defaultSource = $data['default_source'] ?? null;
        $model->endedAt = null !== $data['ended_at'] ? new \DateTimeImmutable('@'.$data['ended_at']) : null;
        $model->items = ItemCollection::createFromArray($data['items']);

        $model->live = $data['livemode'];
        $model->metadata = MetadataCollection::createFromArray($data['metadata']);

        $model->plan = Plan::createFromArray($data['plan']);

        $model->quantity = (int) $data['quantity'];
        $model->startAt = new \DateTimeImmutable('@'.$data['start']);
        $model->status = $data['status'];
        $model->taxPercent = null !== $data['tax_percent'] ? (float) $data['tax_percent'] : null;
        $model->trialEndAt = null !== $data['trial_end'] ? new \DateTimeImmutable('@'.$data['trial_end']) : null;
        $model->trialStartAt = null !== $data['trial_start'] ? new \DateTimeImmutable('@'.$data['trial_start']) : null;

        return $model;
    }

    public function isBilledAutomatically(): bool
    {
        return self::BILLING_CHARGE_AUTOMATICALLY === $this->billing;
    }

    public function isTrialing(): bool
    {
        return self::STATUS_TRIALING === $this->status;
    }

    public function isActive(): bool
    {
        return self::STATUS_ACTIVE === $this->status;
    }

    public function isPastDue(): bool
    {
        return self::STATUS_PAST_DUE === $this->status;
    }

    public function isCanceled(): bool
    {
        return self::STATUS_CANCELED === $this->status;
    }

    public function isUnpaid(): bool
    {
        return self::STATUS_UNPAID === $this->status;
    }

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

    public function getApplicationFeePercent(): ?float
    {
        return $this->applicationFeePercent;
    }

    public function getBilling(): string
    {
        return $this->billing;
    }

    public function getBillingCycleAnchor()
    {
        return $this->billingCycleAnchor;
    }

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

    public function getCanceledAt(): ?\DateTimeImmutable
    {
        return $this->canceledAt;
    }

    public function getCreatedAt(): \DateTimeImmutable
    {
        return $this->createdAt;
    }

    public function getCurrentPeriodEndAt(): \DateTimeImmutable
    {
        return $this->currentPeriodEndAt;
    }

    public function getCurrentPeriodStartAt(): \DateTimeImmutable
    {
        return $this->currentPeriodStartAt;
    }

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

    public function getDaysUntilDue(): ?int
    {
        return $this->daysUntilDue;
    }

    public function getDefaultSource(): ?string
    {
        return $this->defaultSource;
    }

    public function getEndedAt(): ?\DateTimeImmutable
    {
        return $this->endedAt;
    }

    public function getItems(): ItemCollection
    {
        return $this->items;
    }

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

    public function getStartAt(): \DateTimeImmutable
    {
        return $this->startAt;
    }

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

    public function getTaxPercent(): ?float
    {
        return $this->taxPercent;
    }

    public function getTrialEndAt(): ?\DateTimeImmutable
    {
        return $this->trialEndAt;
    }

    public function getTrialStartAt(): ?\DateTimeImmutable
    {
        return $this->trialStartAt;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/*
6		* This software may be modified and distributed under the terms
7		* of the MIT license. See the LICENSE file for details.
8		*/
9
10		namespace Shapin\Stripe\Model\Subscription;
11
12		use Shapin\Stripe\Model\ContainsMetadata;
13		use Shapin\Stripe\Model\CreatableFromArray;
14		use Shapin\Stripe\Model\LivemodeTrait;
15		use Shapin\Stripe\Model\MetadataTrait;
16		use Shapin\Stripe\Model\MetadataCollection;
17		use Shapin\Stripe\Model\Plan\Plan;
18
19		final class Subscription implements CreatableFromArray, ContainsMetadata
20		{
21		use LivemodeTrait, MetadataTrait;
22
23		const BILLING_CHARGE_AUTOMATICALLY = 'charge_automatically';
24		const BILLING_SEND_INVOICE = 'send_invoice';
25
26		const STATUS_TRIALING = 'trialing';
27		const STATUS_ACTIVE = 'active';
28		const STATUS_PAST_DUE = 'past_due';
29		const STATUS_CANCELED = 'canceled';
30		const STATUS_UNPAID = 'unpaid';
31
32		/**
33		* @var string
34		*/
35		private $id;
36
37		/**
38		* @var ?float
39		*/
40		private $applicationFeePercent;
41
42		/**
43		* @var string
44		*/
45		private $billing;
46
47		/**
48		* @var mixed
49		*/
50		private $billingCycleAnchor;
51
52		/**
53		* @var bool
54		*/
55		private $cancelAtPeriodEnd;
56
57		/**
58		* @var ?\DateTimeImmutable
59		*/
60		private $canceledAt;
61
62		/**
63		* @var \DateTimeImmutable
64		*/
65		private $createdAt;
66
67		/**
68		* @var \DateTimeImmutable
69		*/
70		private $currentPeriodEndAt;
71
72		/**
73		* @var \DateTimeImmutable
74		*/
75		private $currentPeriodStartAt;
76
77		/**
78		* @var string
79		*/
80		private $customer;
81
82		/**
83		* @var ?int
84		*/
85		private $daysUntilDue;
86
87		/**
88		* @var ?string
89		*/
90		private $defaultSource;
91
92		/**
93		* @var ?\DateTimeImmutable
94		*/
95		private $endedAt;
96
97		/**
98		* @var ItemCollection
99		*/
100		private $items;
101
102		/**
103		* @var Plan
104		*/
105		private $plan;
106
107		/**
108		* @var int
109		*/
110		private $quantity;
111
112		/**
113		* @var \DateTimeImmutable
114		*/
115		private $startAt;
116
117		/**
118		* @var string
119		*/
120		private $status;
121
122		/**
123		* @var ?float
124		*/
125		private $taxPercent;
126
127		/**
128		* @var ?\DateTimeImmutable
129		*/
130		private $trialEndAt;
131
132		/**
133		* @var ?\DateTimeImmutable
134		*/
135		private $trialStartAt;
136
137	8	public static function createFromArray(array $data): self
138		{
139	8	$model = new self();
140	8	$model->id = $data['id'];
141	8	$model->applicationFeePercent = null !== $data['application_fee_percent'] ? (float) $data['application_fee_percent'] : null;
142	8	$model->billing = $data['billing'];
143	8	$model->billingCycleAnchor = $data['billing_cycle_anchor'];
144	8	$model->cancelAtPeriodEnd = (bool) $data['cancel_at_period_end'];
145	8	$model->canceledAt = null !== $data['canceled_at'] ? new \DateTimeImmutable('@'.$data['canceled_at']) : null;
146	8	$model->createdAt = new \DateTimeImmutable('@'.$data['created']);
147	8	$model->currentPeriodEndAt = new \DateTimeImmutable('@'.$data['current_period_end']);
148	8	$model->currentPeriodStartAt = new \DateTimeImmutable('@'.$data['current_period_start']);
149	8	$model->customer = $data['customer'];
150	8	$model->daysUntilDue = null !== $data['days_until_due'] ? (int) $data['days_until_due'] : null;
151	8	$model->defaultSource = $data['default_source'] ?? null;
152	8	$model->endedAt = null !== $data['ended_at'] ? new \DateTimeImmutable('@'.$data['ended_at']) : null;
153	8	$model->items = ItemCollection::createFromArray($data['items']);
		0 ignored issues – show Documentation Bug introduced 2019-02-07 11:52 UTC by Report Bug Copy Issue Report It seems like `\Shapin\Stripe\Model\Sub...omArray($data['items'])` of type `object<self>` is incompatible with the declared type `object<Shapin\Stripe\Mod...ription\ItemCollection>` of property `$items`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
154	8	$model->live = $data['livemode'];
155	8	$model->metadata = MetadataCollection::createFromArray($data['metadata']);
		0 ignored issues – show Documentation Bug introduced 2019-02-07 11:52 UTC by Report Bug Copy Issue Report It seems like `\Shapin\Stripe\Model\Met...rray($data['metadata'])` of type `object<self>` is incompatible with the declared type `object<Shapin\Stripe\Model\MetadataCollection>` of property `$metadata`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
156	8	$model->plan = Plan::createFromArray($data['plan']);
		0 ignored issues – show Documentation Bug introduced 2019-02-07 11:52 UTC by Report Bug Copy Issue Report It seems like `\Shapin\Stripe\Model\Pla...romArray($data['plan'])` of type `object<self>` is incompatible with the declared type `object<Shapin\Stripe\Model\Plan\Plan>` of property `$plan`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
157	8	$model->quantity = (int) $data['quantity'];
158	8	$model->startAt = new \DateTimeImmutable('@'.$data['start']);
159	8	$model->status = $data['status'];
160	8	$model->taxPercent = null !== $data['tax_percent'] ? (float) $data['tax_percent'] : null;
161	8	$model->trialEndAt = null !== $data['trial_end'] ? new \DateTimeImmutable('@'.$data['trial_end']) : null;
162	8	$model->trialStartAt = null !== $data['trial_start'] ? new \DateTimeImmutable('@'.$data['trial_start']) : null;
163
164	8	return $model;
165		}
166
167	1	public function isBilledAutomatically(): bool
168		{
169	1	return self::BILLING_CHARGE_AUTOMATICALLY === $this->billing;
170		}
171
172		public function isTrialing(): bool
173		{
174		return self::STATUS_TRIALING === $this->status;
175		}
176
177		public function isActive(): bool
178		{
179		return self::STATUS_ACTIVE === $this->status;
180		}
181
182		public function isPastDue(): bool
183		{
184		return self::STATUS_PAST_DUE === $this->status;
185		}
186
187		public function isCanceled(): bool
188		{
189		return self::STATUS_CANCELED === $this->status;
190		}
191
192		public function isUnpaid(): bool
193		{
194		return self::STATUS_UNPAID === $this->status;
195		}
196
197	1	public function getId(): string
198		{
199	1	return $this->id;
200		}
201
202	1	public function getApplicationFeePercent(): ?float
203		{
204	1	return $this->applicationFeePercent;
205		}
206
207	1	public function getBilling(): string
208		{
209	1	return $this->billing;
210		}
211
212	1	public function getBillingCycleAnchor()
213		{
214	1	return $this->billingCycleAnchor;
215		}
216
217	1	public function willBeCanceledAtPeriodEnd(): bool
218		{
219	1	return $this->cancelAtPeriodEnd;
220		}
221
222	1	public function getCanceledAt(): ?\DateTimeImmutable
223		{
224	1	return $this->canceledAt;
225		}
226
227	1	public function getCreatedAt(): \DateTimeImmutable
228		{
229	1	return $this->createdAt;
230		}
231
232	1	public function getCurrentPeriodEndAt(): \DateTimeImmutable
233		{
234	1	return $this->currentPeriodEndAt;
235		}
236
237	1	public function getCurrentPeriodStartAt(): \DateTimeImmutable
238		{
239	1	return $this->currentPeriodStartAt;
240		}
241
242	1	public function getCustomer(): string
243		{
244	1	return $this->customer;
245		}
246
247	1	public function getDaysUntilDue(): ?int
248		{
249	1	return $this->daysUntilDue;
250		}
251
252	1	public function getDefaultSource(): ?string
253		{
254	1	return $this->defaultSource;
255		}
256
257	1	public function getEndedAt(): ?\DateTimeImmutable
258		{
259	1	return $this->endedAt;
260		}
261
262	1	public function getItems(): ItemCollection
263		{
264	1	return $this->items;
265		}
266
267	1	public function getQuantity(): int
268		{
269	1	return $this->quantity;
270		}
271
272	1	public function getStartAt(): \DateTimeImmutable
273		{
274	1	return $this->startAt;
275		}
276
277	1	public function getStatus(): string
278		{
279	1	return $this->status;
280		}
281
282	1	public function getTaxPercent(): ?float
283		{
284	1	return $this->taxPercent;
285		}
286
287	1	public function getTrialEndAt(): ?\DateTimeImmutable
288		{
289	1	return $this->trialEndAt;
290		}
291
292	1	public function getTrialStartAt(): ?\DateTimeImmutable
293		{
294	1	return $this->trialStartAt;
295		}
296		}
297

shapintv / stripe

Push — master ( 77bf81...2c4a64 )

Subscription::isUnpaid() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like