LauLamanApps\ApplePassbook\Passbook

Complexity

Total Complexity

52

Size/Duplication

Total Lines	373
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Test Coverage

Coverage

97.01%

Importance

Changes

0

28 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setOrganizationName()	0	4	1
A	setDescription()	0	4	1
A	setPassTypeIdentifier()	0	4	1
A	setTeamIdentifier()	0	4	1
A	setLogoText()	0	4	1
A	setRelevantDate()	0	4	1
A	setBarcode()	0	4	1
A	addLocation()	0	4	1
A	setMaxDistance()	0	4	1
A	setWebService()	0	5	1
A	setForegroundColor()	0	4	1
A	setBackgroundColor()	0	4	1
A	setLabelColor()	0	4	1
A	addImage()	0	4	1
A	addHeaderField()	0	4	1
A	addPrimaryField()	0	4	1
A	addAuxiliaryField()	0	4	1
A	addSecondaryField()	0	4	1
A	addBackField()	0	4	1
A	voided()	0	4	1
A	hasPassTypeIdentifier()	0	4	1
A	hasTeamIdentifier()	0	4	1
A	getData()	0	9	1
F	getGenericData()	0	64	15
A	getImages()	0	4	1
B	validate()	0	22	6
B	getFieldsData()	0	22	6

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

    /**
     * @var int
     */
    private $formatVersion = 1;

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

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

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

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

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

    /**
     * @var string|null
     */
    private $logoText;

    /**
     * @var Barcode[]
     */
    private $barcodes = [];

    /**
     * @var DateTimeImmutable|null
     */
    private $relevantDate;

    /**
     * @var DateTimeImmutable|null
     */
    private $expirationDate;

    /**
     * @var boolean|null
     */
    private $voided;

    /**
     * @var Location[]|null
     */
    private $locations;

    /**
     * @var int|null
     */
    private $maxDistance;

    /**
     * @var string|null
     */
    private $webServiceURL;

    /**
     * @var string|null
     */
    private $authenticationToken;

    /**
     * @var Color|null
     */
    private $foregroundColor;

    /**
     * @var Color|null
     */
    private $backgroundColor;

    /**
     * @var Color|null
     */
    private $labelColor;

    /**
     * @var LocalImage[]
     */
    private $images = [];

    /**
     * @var Field[]
     */
    private $headerFields = [];

    /**
     * @var Field[]
     */
    private $primaryFields = [];

    /**
     * @var Field[]
     */
    private $auxiliaryFields = [];

    /**
     * @var Field[]
     */
    private $secondaryFields = [];

    /**
     * @var Field[]
     */
    private $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($url, $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 voided(): void
    {
        $this->voided = true;
    }

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

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

    public function getData(): array
    {
        $this->validate();

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

        return $data;
    }

    private function getGenericData(): array
    {
        $data = [
            'formatVersion' => $this->formatVersion,
            'passTypeIdentifier' => $this->passTypeIdentifier,
            'serialNumber' => $this->serialNumber,
            'teamIdentifier' => $this->teamIdentifier,
            'organizationName' => $this->organizationName,
            'description' => $this->description,
        ];

        if ($this->logoText !== null) {
            $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 ($this->relevantDate !== null) {
            $data['relevantDate'] = $this->relevantDate->format(DateTimeInterface::W3C);
        }

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

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

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

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

        if ($this->webServiceURL && $this->authenticationToken) {

The expression $this->webServiceURL of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

The expression $this->authenticationToken of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $data['webServiceURL'] = $this->webServiceURL;
            $data['authenticationToken'] = $this->authenticationToken;
        }

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

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

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

        return $data;
    }

    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 ($this->passTypeIdentifier === null) {
            throw new MissingRequiredDataException('Please specify the PassTypeIdentifier before requesting the manifest data.');
        }

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

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

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