Passbook::voided() - Code Metrics - Inspection of "Update Code" - LauLamanApps/apple-passbook - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#6)

by Laurens

created 2020-12-22 14:50 UTC

Passbook::voided() A

↳ Parent: Passbook

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	2
Bugs	1	Features	0

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

<?php

declare(strict_types=1);

namespace LauLamanApps\ApplePassbook;

use DateTimeImmutable;
use DateTimeInterface;
use LauLamanApps\ApplePassbook\Exception\MissingRequiredDataException;
use LauLamanApps\ApplePassbook\MetaData\Barcode;
use LauLamanApps\ApplePassbook\MetaData\Field\Field;
use LauLamanApps\ApplePassbook\MetaData\Image;
use LauLamanApps\ApplePassbook\MetaData\Image\LocalImage;
use LauLamanApps\ApplePassbook\MetaData\Location;
use LauLamanApps\ApplePassbook\Style\Color;
use LogicException;
use Ramsey\Uuid\UuidInterface;

abstract class Passbook
{
    protected const TYPE = null;

    private int $formatVersion = 1;
    private string $passTypeIdentifier;
    private string $serialNumber;
    private string $teamIdentifier;
    private string $organizationName;
    private string$description;
    private string $logoText;
    /** @var Barcode[] */
    private array $barcodes = [];
    private DateTimeImmutable $relevantDate;
    private string $appLaunchURL;
    /** @var int[] */
    private array $associatedStoreIdentifiers = [];
    private string $userInfo;
    private DateTimeImmutable $expirationDate;
    private bool $voided;
    /** @var Location[] */
    private array $locations = [];
    private int $maxDistance;
    private string $webServiceURL;
    private string $authenticationToken;
    private Color $foregroundColor;
    private Color $backgroundColor;
    private Color $labelColor;
    /** @var Image[] */
    private array $images = [];
    /** @var Field[] */
    private array $headerFields = [];
    /** @var Field[]*/
    private array $primaryFields = [];
    /** @var Field[] */
    private array $auxiliaryFields = [];
    /** @var Field[]*/
    private array $secondaryFields = [];
    /** @var Field[] */
    private array $backFields = [];

    public function __construct(string $serialNumber)
    {
        $this->serialNumber = $serialNumber;
    }

    public function setOrganizationName(string $organizationName): void
    {
        $this->organizationName = $organizationName;
    }

    public function setDescription(string $description): void
    {
        $this->description = $description;
    }

    public function setPassTypeIdentifier(string $passTypeIdentifier): void
    {
        $this->passTypeIdentifier = $passTypeIdentifier;
    }

    public function setTeamIdentifier(string $teamIdentifier): void
    {
        $this->teamIdentifier = $teamIdentifier;
    }

    public function setLogoText(string $logoText): void
    {
        $this->logoText = $logoText;
    }

    public function setRelevantDate(DateTimeImmutable $relevantDate): void
    {
        $this->relevantDate = $relevantDate;
    }

    public function setBarcode(Barcode $barcode): void
    {
        $this->barcodes[] = $barcode;
    }

    public function addLocation(Location $location): void
    {
        $this->locations[] = $location;
    }

    public function setMaxDistance(int $maxDistance): void
    {
        $this->maxDistance = $maxDistance;
    }

    public function setWebService(string $url, string $authenticationToken): void
    {
        $this->webServiceURL = $url;
        $this->authenticationToken = $authenticationToken;
    }

    public function setForegroundColor(Color $foregroundColor): void
    {
        $this->foregroundColor = $foregroundColor;
    }

    public function setBackgroundColor(Color $backgroundColor): void
    {
        $this->backgroundColor = $backgroundColor;
    }

    public function setLabelColor(Color $labelColor): void
    {
        $this->labelColor = $labelColor;
    }

    public function addImage(Image $image): void
    {
        $this->images[] = $image;
    }

    public function addHeaderField(Field $field): void
    {
        $this->headerFields[] = $field;
    }

    public function addPrimaryField(Field $field): void
    {
        $this->primaryFields[] = $field;
    }

    public function addAuxiliaryField(Field $field): void
    {
        $this->auxiliaryFields[] = $field;
    }

    public function addSecondaryField(Field $field): void
    {
        $this->secondaryFields[] = $field;
    }

    public function addBackField(Field $field): void
    {
        $this->backFields[] = $field;
    }

    public function setAppLaunchURL(string $appLaunchURL): void
    {
        $this->appLaunchURL = $appLaunchURL;
    }

    public function addAssociatedStoreIdentifiers(int $associatedStoreIdentifiers): void
    {
        $this->associatedStoreIdentifiers[] = $associatedStoreIdentifiers;
    }

    public function setUserInfo(string $userInfo): void
    {
        $this->userInfo = $userInfo;
    }

    public function voided(): void
    {
        $this->voided = true;
    }

    public function isVoided(): bool
    {
        return isset($this->voided);
    }

    public function hasPassTypeIdentifier(): bool
    {
        return isset($this->passTypeIdentifier);
    }

    public function hasTeamIdentifier(): bool
    {
        return isset($this->teamIdentifier);
    }

    /**
     * @return array<int|string, mixed>
     * @throws MissingRequiredDataException
     */
    public function getData(): array
    {
        $this->validate();

        $data = $this->getGenericData();
        $data[static::TYPE] = $this->getFieldsData();

        return $data;
    }

    /**
     * @return array<int|string, mixed>
     */
    private function getGenericData(): array
    {
        $data = [
            'formatVersion' => $this->formatVersion,
            'passTypeIdentifier' => $this->passTypeIdentifier,
            'serialNumber' => $this->serialNumber,
            'teamIdentifier' => $this->teamIdentifier,
            'organizationName' => $this->organizationName,
            'description' => $this->description,
        ];

        if (isset($this->logoText)) {
            $data['logoText'] = $this->logoText;
        }

        if (count($this->barcodes) > 0) {
            $data['barcode'] = $this->barcodes[0]->toArray();

            foreach ($this->barcodes as $barcode) {
                $data['barcodes'][] = $barcode->toArray();
            }
        }

        if (isset($this->relevantDate)) {
            $data['relevantDate'] = $this->relevantDate->format(DateTimeInterface::W3C);
        }

        if (isset($this->expirationDate)) {
            $data['expirationDate'] = $this->expirationDate->format(DateTimeInterface::W3C);
        }

        if (isset($this->appLaunchURL)) {
            $data['appLaunchURL'] = $this->appLaunchURL;
        }

        if (count($this->associatedStoreIdentifiers) > 0) {
            $data['associatedStoreIdentifiers'] = $this->associatedStoreIdentifiers;
        }

        if (isset($this->userInfo)) {
            $data['userInfo'] = $this->userInfo;
        }

        if (isset($this->voided)) {
            $data['voided'] = true;
        }

        if (isset($this->locations)) {
            foreach ($this->locations as $location) {
                $data['locations'][] = $location->toArray();
            }
        }

        if (isset($this->maxDistance)) {
            $data['maxDistance'] = $this->maxDistance;
        }

        if (isset($this->webServiceURL) && isset($this->authenticationToken)) {
            $data['webServiceURL'] = $this->webServiceURL;
            $data['authenticationToken'] = $this->authenticationToken;
        }

        if (isset($this->foregroundColor)) {
            $data['foregroundColor'] = $this->foregroundColor->toString();
        }

        if (isset($this->backgroundColor)) {
            $data['backgroundColor'] = $this->backgroundColor->toString();
        }

        if (isset($this->labelColor)) {
            $data['labelColor'] = $this->labelColor->toString();
        }

        return $data;
    }

    /**
     * @return array<int|string, mixed>
     */
    private function getFieldsData(): array
    {
        $data = [];

        foreach ($this->headerFields as $field) {
            $data['headerFields'][] = $field->getMetaData();
        }
        foreach ($this->primaryFields as $field) {
            $data['primaryFields'][] = $field->getMetaData();
        }
        foreach ($this->auxiliaryFields as $field) {
            $data['auxiliaryFields'][] = $field->getMetaData();
        }
        foreach ($this->secondaryFields as $field) {
            $data['secondaryFields'][] = $field->getMetaData();
        }
        foreach ($this->backFields as $field) {
            $data['backFields'][] = $field->getMetaData();
        }

        return $data;
    }

    /**
     * @return Image[]
     */
    public function getImages(): array
    {
        return $this->images;
    }

    /**
     * @throws LogicException
     * @throws MissingRequiredDataException
     */
    public function validate(): void
    {
        if (static::TYPE === null) {

            throw new LogicException('Please implement protected const TYPE in class.');
        }

        if (!isset($this->passTypeIdentifier)) {
            throw new MissingRequiredDataException('Please specify the PassTypeIdentifier before requesting the manifest data.');
        }

        if (!isset($this->teamIdentifier)) {
            throw new MissingRequiredDataException('Please specify the TeamIdentifier before requesting the manifest data.');
        }

        if (!isset($this->organizationName)) {
            throw new MissingRequiredDataException('Please specify the OrganizationName before requesting the manifest data.');
        }

        if (!isset($this->description)) {
            throw new MissingRequiredDataException('Please specify the Description before requesting the manifest data.');
        }
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace LauLamanApps\ApplePassbook;
6
7		use DateTimeImmutable;
8		use DateTimeInterface;
9		use LauLamanApps\ApplePassbook\Exception\MissingRequiredDataException;
10		use LauLamanApps\ApplePassbook\MetaData\Barcode;
11		use LauLamanApps\ApplePassbook\MetaData\Field\Field;
12		use LauLamanApps\ApplePassbook\MetaData\Image;
13		use LauLamanApps\ApplePassbook\MetaData\Image\LocalImage;
14		use LauLamanApps\ApplePassbook\MetaData\Location;
15		use LauLamanApps\ApplePassbook\Style\Color;
16		use LogicException;
17		use Ramsey\Uuid\UuidInterface;
18
19		abstract class Passbook
20		{
21		protected const TYPE = null;
22
23		private int $formatVersion = 1;
24		private string $passTypeIdentifier;
25		private string $serialNumber;
26		private string $teamIdentifier;
27		private string $organizationName;
28		private string$description;
29		private string $logoText;
30		/** @var Barcode[] */
31		private array $barcodes = [];
32		private DateTimeImmutable $relevantDate;
33		private string $appLaunchURL;
34		/** @var int[] */
35		private array $associatedStoreIdentifiers = [];
36		private string $userInfo;
37		private DateTimeImmutable $expirationDate;
38		private bool $voided;
39		/** @var Location[] */
40		private array $locations = [];
41		private int $maxDistance;
42		private string $webServiceURL;
43		private string $authenticationToken;
44		private Color $foregroundColor;
45		private Color $backgroundColor;
46		private Color $labelColor;
47		/** @var Image[] */
48		private array $images = [];
49		/** @var Field[] */
50		private array $headerFields = [];
51		/** @var Field[]*/
52		private array $primaryFields = [];
53		/** @var Field[] */
54		private array $auxiliaryFields = [];
55		/** @var Field[]*/
56		private array $secondaryFields = [];
57		/** @var Field[] */
58		private array $backFields = [];
59
60		public function __construct(string $serialNumber)
61		{
62		$this->serialNumber = $serialNumber;
63		}
64
65		public function setOrganizationName(string $organizationName): void
66		{
67		$this->organizationName = $organizationName;
68		}
69
70		public function setDescription(string $description): void
71		{
72		$this->description = $description;
73		}
74
75		public function setPassTypeIdentifier(string $passTypeIdentifier): void
76		{
77		$this->passTypeIdentifier = $passTypeIdentifier;
78		}
79
80		public function setTeamIdentifier(string $teamIdentifier): void
81		{
82		$this->teamIdentifier = $teamIdentifier;
83		}
84
85		public function setLogoText(string $logoText): void
86		{
87		$this->logoText = $logoText;
88		}
89
90		public function setRelevantDate(DateTimeImmutable $relevantDate): void
91		{
92		$this->relevantDate = $relevantDate;
93		}
94
95		public function setBarcode(Barcode $barcode): void
96		{
97		$this->barcodes[] = $barcode;
98		}
99
100		public function addLocation(Location $location): void
101		{
102		$this->locations[] = $location;
103		}
104
105		public function setMaxDistance(int $maxDistance): void
106		{
107		$this->maxDistance = $maxDistance;
108		}
109
110		public function setWebService(string $url, string $authenticationToken): void
111		{
112		$this->webServiceURL = $url;
113		$this->authenticationToken = $authenticationToken;
114		}
115
116		public function setForegroundColor(Color $foregroundColor): void
117		{
118		$this->foregroundColor = $foregroundColor;
119		}
120
121		public function setBackgroundColor(Color $backgroundColor): void
122		{
123		$this->backgroundColor = $backgroundColor;
124		}
125
126		public function setLabelColor(Color $labelColor): void
127		{
128		$this->labelColor = $labelColor;
129		}
130
131		public function addImage(Image $image): void
132		{
133		$this->images[] = $image;
134		}
135
136		public function addHeaderField(Field $field): void
137		{
138		$this->headerFields[] = $field;
139		}
140
141		public function addPrimaryField(Field $field): void
142		{
143		$this->primaryFields[] = $field;
144		}
145
146		public function addAuxiliaryField(Field $field): void
147		{
148		$this->auxiliaryFields[] = $field;
149		}
150
151		public function addSecondaryField(Field $field): void
152		{
153		$this->secondaryFields[] = $field;
154		}
155
156		public function addBackField(Field $field): void
157		{
158	3	$this->backFields[] = $field;
159		}
160	3
161	3	public function setAppLaunchURL(string $appLaunchURL): void
162		{
163	3	$this->appLaunchURL = $appLaunchURL;
164		}
165	3
166	3	public function addAssociatedStoreIdentifiers(int $associatedStoreIdentifiers): void
167		{
168	3	$this->associatedStoreIdentifiers[] = $associatedStoreIdentifiers;
169		}
170	3
171	3	public function setUserInfo(string $userInfo): void
172		{
173	3	$this->userInfo = $userInfo;
174		}
175	3
176	3	public function voided(): void
177		{
178	3	$this->voided = true;
179		}
180	3
181	3	public function isVoided(): bool
182		{
183	7	return isset($this->voided);
184		}
185	7
186	7	public function hasPassTypeIdentifier(): bool
187		{
188	7	return isset($this->passTypeIdentifier);
189		}
190	7
191	7	public function hasTeamIdentifier(): bool
192		{
193	7	return isset($this->teamIdentifier);
194		}
195	7
196	7	/**
197		* @return array<int\|string, mixed>
198	7	* @throws MissingRequiredDataException
199		*/
200	7	public function getData(): array
201	7	{
202		$this->validate();
203	6
204		$data = $this->getGenericData();
205	6	$data[static::TYPE] = $this->getFieldsData();
206	6
207		return $data;
208	7	}
209
210	7	/**
211	7	* @return array<int\|string, mixed>
212	7	*/
213		private function getGenericData(): array
214	7	{
215		$data = [
216	7	'formatVersion' => $this->formatVersion,
217	7	'passTypeIdentifier' => $this->passTypeIdentifier,
218		'serialNumber' => $this->serialNumber,
219	7	'teamIdentifier' => $this->teamIdentifier,
220		'organizationName' => $this->organizationName,
221	7	'description' => $this->description,
222	7	];
223
224	6	if (isset($this->logoText)) {
225		$data['logoText'] = $this->logoText;
226	6	}
227	6
228		if (count($this->barcodes) > 0) {
229	6	$data['barcode'] = $this->barcodes[0]->toArray();
230
231	6	foreach ($this->barcodes as $barcode) {
232	6	$data['barcodes'][] = $barcode->toArray();
233		}
234	7	}
235
236	7	if (isset($this->relevantDate)) {
237	7	$data['relevantDate'] = $this->relevantDate->format(DateTimeInterface::W3C);
238		}
239	7
240		if (isset($this->expirationDate)) {
241	7	$data['expirationDate'] = $this->expirationDate->format(DateTimeInterface::W3C);
242	7	}
243
244	1	if (isset($this->appLaunchURL)) {
245		$data['appLaunchURL'] = $this->appLaunchURL;
246	1	}
247	1
248		if (count($this->associatedStoreIdentifiers) > 0) {
249	7	$data['associatedStoreIdentifiers'] = $this->associatedStoreIdentifiers;
250		}
251	7
252	7	if (isset($this->userInfo)) {
253		$data['userInfo'] = $this->userInfo;
254	7	}
255
256	7	if (isset($this->voided)) {
257	7	$data['voided'] = true;
258		}
259	1
260		if (isset($this->locations)) {
261	1	foreach ($this->locations as $location) {
262	1	$data['locations'][] = $location->toArray();
263		}
264	1	}
265
266	1	if (isset($this->maxDistance)) {
267	1	$data['maxDistance'] = $this->maxDistance;
268		}
269	1
270		if (isset($this->webServiceURL) && isset($this->authenticationToken)) {
271	1	$data['webServiceURL'] = $this->webServiceURL;
272	1	$data['authenticationToken'] = $this->authenticationToken;
273		}
274	6
275		if (isset($this->foregroundColor)) {
276	6	$data['foregroundColor'] = $this->foregroundColor->toString();
277	6	}
278
279	6	if (isset($this->backgroundColor)) {
280		$data['backgroundColor'] = $this->backgroundColor->toString();
281	6	}
282
283		if (isset($this->labelColor)) {
284	6	$data['labelColor'] = $this->labelColor->toString();
285		}
286	6
287		return $data;
288		}
289	3
290		/**
291	3	* @return array<int\|string, mixed>
292		*/
293	2	private function getFieldsData(): array
294	2	{
295		$data = [];
296	2
297		foreach ($this->headerFields as $field) {
298		$data['headerFields'][] = $field->getMetaData();
299	2	}
300		foreach ($this->primaryFields as $field) {
301		$data['primaryFields'][] = $field->getMetaData();
302	2	}
303	2	foreach ($this->auxiliaryFields as $field) {
304	2	$data['auxiliaryFields'][] = $field->getMetaData();
305	2	}
306	2	foreach ($this->secondaryFields as $field) {
307	2	$data['secondaryFields'][] = $field->getMetaData();
308		}
309		foreach ($this->backFields as $field) {
310	2	$data['backFields'][] = $field->getMetaData();
311	1	}
312
313		return $data;
314	2	}
315	1
316		/**
317	1	* @return Image[]
318	1	*/
319		public function getImages(): array
320		{
321		return $this->images;
322	2	}
323	1
324		/**
325		* @throws LogicException
326	2	* @throws MissingRequiredDataException
327		*/
328		public function validate(): void
329		{
330	2	if (static::TYPE === null) {
		0 ignored issues – show introduced 2020-12-22 14:51 UTC by Report Bug Copy Issue Report The condition `static::TYPE === null` is always `true`. Loading history...
331		throw new LogicException('Please implement protected const TYPE in class.');
332		}
333
334	2	if (!isset($this->passTypeIdentifier)) {
335		throw new MissingRequiredDataException('Please specify the PassTypeIdentifier before requesting the manifest data.');
336		}
337
338	2	if (!isset($this->teamIdentifier)) {
339		throw new MissingRequiredDataException('Please specify the TeamIdentifier before requesting the manifest data.');
340		}
341
342	2	if (!isset($this->organizationName)) {
343		throw new MissingRequiredDataException('Please specify the OrganizationName before requesting the manifest data.');
344		}
345
346	2	if (!isset($this->description)) {
347	1	throw new MissingRequiredDataException('Please specify the Description before requesting the manifest data.');
348	1	}
349		}
350		}
351

LauLamanApps / apple-passbook

Pull Request — master (#6)

Passbook::voided() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like