Kerox\Messenger\Model\Message\Attachment\Template\Airline\BoardingPass

Complexity

Total Complexity

16

Size/Duplication

Total Lines	247
Duplicated Lines	2.83 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	1
A	create()	0	10	1
A	setTravelClass()	0	8	1
A	setSeat()	0	6	1
A	addAuxiliaryFields()	0	8	1
A	addSecondaryFields()	0	8	1
A	setHeaderImageUrl()	0	8	1
A	setHeaderTextField()	0	6	1
A	setLabelValue()	0	7	1
A	setCode()	0	9	2
A	isValidTravelClass()	7	7	2
A	getAllowedTravelClass()	0	8	1
A	toArray()	0	20	1
A	jsonSerialize()	0	4	1

<?php

declare(strict_types=1);

namespace Kerox\Messenger\Model\Message\Attachment\Template\Airline;

use Kerox\Messenger\Exception\InvalidKeyException;
use Kerox\Messenger\Helper\ValidatorTrait;

class BoardingPass implements \JsonSerializable, TravelClassInterface
{
    use ValidatorTrait;

    /**
     * @var string
     */
    protected $passengerName;

    /**
     * @var string
     */
    protected $pnrNumber;

    /**
     * @var string|null
     */
    protected $travelClass;

    /**
     * @var string|null
     */
    protected $seat;

    /**
     * @var array
     */
    protected $auxiliaryFields = [];

    /**
     * @var array
     */
    protected $secondaryFields = [];

    /**
     * @var string
     */
    protected $logoImageUrl;

    /**
     * @var string|null
     */
    protected $headerImageUrl;

    /**
     * @var string|null
     */
    protected $headerTextField;

    /**
     * @var string|null
     */
    protected $qrCode;

    /**
     * @var string|null
     */
    protected $barcodeImageUrl;

    /**
     * @var string
     */
    protected $aboveBarcodeImageUrl;

    /**
     * @var FlightInfo;
     */
    protected $flightInfo;

    /**
     * BoardingPass constructor.
     *
     * @param \Kerox\Messenger\Model\Message\Attachment\Template\Airline\FlightInfo $flightInfo
     */
    public function __construct(
        string $passengerName,
        string $pnrNumber,
        string $logoImageUrl,
        string $code,
        string $aboveBarcodeImageUrl,
        FlightInfo $flightInfo
    ) {
        $this->passengerName = $passengerName;
        $this->pnrNumber = $pnrNumber;
        $this->logoImageUrl = $logoImageUrl;
        $this->aboveBarcodeImageUrl = $aboveBarcodeImageUrl;
        $this->flightInfo = $flightInfo;

        $this->setCode($code);
    }

    /**
     * @param \Kerox\Messenger\Model\Message\Attachment\Template\Airline\FlightInfo $flightInfo
     *
     * @return \Kerox\Messenger\Model\Message\Attachment\Template\Airline\BoardingPass
     */
    public static function create(
        string $passengerName,
        string $pnrNumber,
        string $logoImageUrl,
        string $code,
        string $aboveBarcodeImageUrl,
        FlightInfo $flightInfo
    ): self {
        return new self($passengerName, $pnrNumber, $logoImageUrl, $code, $aboveBarcodeImageUrl, $flightInfo);
    }

    /**
     * @throws \Kerox\Messenger\Exception\MessengerException
     *
     * @return \Kerox\Messenger\Model\Message\Attachment\Template\Airline\BoardingPass
     */
    public function setTravelClass(string $travelClass): self
    {
        $this->isValidTravelClass($travelClass);

        $this->travelClass = $travelClass;

        return $this;
    }

    /**
     * @return \Kerox\Messenger\Model\Message\Attachment\Template\Airline\BoardingPass
     */
    public function setSeat(string $seat): self
    {
        $this->seat = $seat;

        return $this;
    }

    /**
     * @throws \Kerox\Messenger\Exception\MessengerException
     *
     * @return \Kerox\Messenger\Model\Message\Attachment\Template\Airline\BoardingPass
     */
    public function addAuxiliaryFields(string $label, string $value): self
    {
        $this->auxiliaryFields[] = $this->setLabelValue($label, $value);

        $this->isValidArray($this->auxiliaryFields, 5);

        return $this;
    }

    /**
     * @throws \Kerox\Messenger\Exception\MessengerException
     *
     * @return \Kerox\Messenger\Model\Message\Attachment\Template\Airline\BoardingPass
     */
    public function addSecondaryFields(string $label, string $value): self
    {
        $this->secondaryFields[] = $this->setLabelValue($label, $value);

        $this->isValidArray($this->secondaryFields, 5);

        return $this;
    }

    /**
     * @throws \Kerox\Messenger\Exception\MessengerException
     *
     * @return \Kerox\Messenger\Model\Message\Attachment\Template\Airline\BoardingPass
     */
    public function setHeaderImageUrl(string $headerImageUrl): self
    {
        $this->isValidUrl($headerImageUrl);

        $this->headerImageUrl = $headerImageUrl;

        return $this;
    }

    /**
     * @return \Kerox\Messenger\Model\Message\Attachment\Template\Airline\BoardingPass
     */
    public function setHeaderTextField(string $headerTextField): self
    {
        $this->headerTextField = $headerTextField;

        return $this;
    }

    private function setLabelValue(string $label, string $value): array
    {
        return [
            'label' => $label,
            'value' => $value,
        ];
    }

    private function setCode(string $code): void
    {
        if (filter_var($code, FILTER_VALIDATE_URL)) {
            $this->barcodeImageUrl = $code;

            return;
        }
        $this->qrCode = $code;
    }

    /**
     * @throws \Kerox\Messenger\Exception\MessengerException
     */
    public function isValidTravelClass(string $travelClass): void

This method seems to be duplicated in your project.

    {
        $allowedTravelClass = $this->getAllowedTravelClass();
        if (!\in_array($travelClass, $allowedTravelClass, true)) {
            throw new InvalidKeyException(sprintf('travelClass must be either "%s".', implode(', ', $allowedTravelClass)));
        }
    }

    public function getAllowedTravelClass(): array
    {
        return [
            self::ECONOMY,
            self::BUSINESS,
            self::FIRST_CLASS,
        ];
    }

    public function toArray(): array
    {
        $array = [
            'passenger_name' => $this->passengerName,
            'pnr_number' => $this->pnrNumber,
            'travel_class' => $this->travelClass,
            'seat' => $this->seat,
            'auxiliary_fields' => $this->auxiliaryFields,
            'secondary_fields' => $this->secondaryFields,
            'logo_image_url' => $this->logoImageUrl,
            'header_image_url' => $this->headerImageUrl,
            'header_text_field' => $this->headerTextField,
            'qr_code' => $this->qrCode,
            'barcode_image_url' => $this->barcodeImageUrl,
            'above_bar_code_image_url' => $this->aboveBarcodeImageUrl,
            'flight_info' => $this->flightInfo,
        ];

        return array_filter($array);
    }

    public function jsonSerialize(): array
    {
        return $this->toArray();
    }
}