LauLamanApps\ApplePassbook\Passbook

Complexity

Total Complexity

74

Size/Duplication

Total Lines	403
Duplicated Lines	0 %

Test Coverage

Coverage

95.14%

Importance

Changes	5
Bugs	1	Features	0

39 Methods

Rating	Name	Duplication	Size	Complexity
A	setDescription()	0	3	1
A	getData()	0	8	1
A	setGroupingIdentifier()	0	3	1
A	addHeaderField()	0	3	1
A	setNfc()	0	6	2
A	hasPassTypeIdentifier()	0	3	1
A	addSemanticTag()	0	3	1
A	setPassTypeIdentifier()	0	3	1
A	setMaxDistance()	0	3	1
A	validate()	0	20	6
A	addBackField()	0	3	1
A	setLabelColor()	0	3	1
A	setBarcode()	0	3	1
A	addSecondaryField()	0	3	1
A	addAuxiliaryField()	0	3	1
A	setBackgroundColor()	0	3	1
A	getFieldsData()	0	21	6
A	setWebService()	0	4	1
A	suppressStripShine()	0	3	1
A	addLocation()	0	3	1
A	setExpirationDate()	0	3	1
A	hasTeamIdentifier()	0	3	1
A	setForegroundColor()	0	3	1
A	voided()	0	3	1
A	setRelevantDate()	0	3	1
A	prohibitSharing()	0	3	1
A	setOrganizationName()	0	3	1
A	setTeamIdentifier()	0	3	1
A	setLogoText()	0	3	1
A	addAssociatedStoreIdentifiers()	0	3	1
A	setUserInfo()	0	3	1
A	addBeacon()	0	3	1
A	setAppLaunchURL()	0	3	1
A	getImages()	0	3	1
A	addPrimaryField()	0	3	1
A	isVoided()	0	3	1
A	__construct()	0	3	1
A	addImage()	0	3	1
F	getGenericData()	0	101	25

<?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\Beacon;
use LauLamanApps\ApplePassbook\MetaData\Field\Field;
use LauLamanApps\ApplePassbook\MetaData\Image;
use LauLamanApps\ApplePassbook\MetaData\Location;
use LauLamanApps\ApplePassbook\MetaData\Nfc;
use LauLamanApps\ApplePassbook\MetaData\SemanticTag;
use LauLamanApps\ApplePassbook\Style\Color;
use LogicException;

abstract class Passbook
{
    protected const TYPE = null;

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

    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 setExpirationDate(DateTimeImmutable $expirationDate): void
    {
        $this->expirationDate = $expirationDate;
    }

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

    public function addBeacon(Beacon $beacon): void
    {
        $this->beacons[] = $beacon;
    }

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

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

    public function setNfc(Nfc $nfc): void
    {
        $this->nfc = $nfc;

        if ($nfc->requiresAuthentication()) {
            $this->prohibitSharing();
        }
    }

    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 setGroupingIdentifier(string $groupingIdentifier): void
    {
        $this->groupingIdentifier = $groupingIdentifier;
    }

    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 addSemanticTag(SemanticTag $semanticTag): void
    {
        $this->semantics[] = $semanticTag;
    }

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

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

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

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

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

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

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

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

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

        return $data;
    }

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

The condition static::TYPE === null is always true.

            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.');
        }
    }

    /**
     * @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();
            }
        }

        foreach ($this->beacons as $beacon) {
            $data['beacons'][] = $beacon->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 ($this->voided) {
            $data['voided'] = $this->voided;
        }

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

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

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

        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->groupingIdentifier)) {
            $data['groupingIdentifier'] = $this->groupingIdentifier;
        }

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

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

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

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

        if (isset($this->semantics)) {
            foreach ($this->semantics as $tag) {
                $data['semantics'][$tag->getKey()] = $tag->getValue();
            }
        }

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