VasilDakov\Speedy\Shipment\CreateShipmentRequest

Complexity

Total Complexity

22

Size/Duplication

Total Lines	274
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	getContent()	0	3	1
A	setContent()	0	3	1
A	getSender()	0	3	1
A	setRecipient()	0	3	1
A	getRecipient()	0	3	1
A	getPayment()	0	3	1
A	setService()	0	3	1
A	setSender()	0	5	1
A	getService()	0	3	1
A	getShipmentNote()	0	3	1
A	setPayment()	0	3	1
A	__construct()	0	12	1
A	setRef1()	0	5	1
A	setConsolidationRef()	0	3	1
A	setRequireUnsuccessfulDeliveryStickerImage()	0	5	1
A	getConsolidationRef()	0	3	1
A	setRef2()	0	5	1
A	getRef2()	0	3	1
A	toArray()	0	8	1
A	getRef1()	0	3	1
A	setShipmentNote()	0	5	1
A	getRequireUnsuccessfulDeliveryStickerImage()	0	3	1

<?php

declare(strict_types=1);

namespace VasilDakov\Speedy\Shipment;

use VasilDakov\Speedy\Speedy;
use InvalidArgumentException;
use JMS\Serializer\Annotation as Serializer;

use function strlen;

/**
 * Class CreateShipmentRequest
 *
 * @Serializer\AccessType("public_method")
 * @author Valentin Valkanov <valentinvalkanof@gmail.com>
 * @author Vasil Dakov <vasildakov@gmail.com>
 * @copyright
 * @version
 */
class CreateShipmentRequest
{
    /**
     * @var ShipmentRecipient
     * @Serializer\Type("VasilDakov\Speedy\Shipment\ShipmentRecipient")
     */
    private ShipmentRecipient $recipient;

    /**
     * @var ShipmentService
     * @Serializer\Type("VasilDakov\Speedy\Shipment\ShipmentService")
     */
    private ShipmentService $service;

    /**
     * @var ShipmentContent
     * @Serializer\Type("VasilDakov\Speedy\Shipment\ShipmentContent")
     */
    private ShipmentContent $content;

    /**
     * @var ShipmentPayment
     * @Serializer\Type("VasilDakov\Speedy\Shipment\ShipmentPayment")
     */
    private ShipmentPayment $payment;

    /**
     * @var ShipmentSender
     * @Serializer\Type("VasilDakov\Speedy\Shipment\ShipmentSender")
     */
    private ShipmentSender $sender;

    /**
     * @var string|null
     * @Serializer\Type("string")
     */
    private ?string $shipmentNote;

    /**
     * @var string|null
     * @Serializer\Type("string")
     */
    private ?string $ref1;

    /**
     * @var string|null
     * @Serializer\Type("string")
     */
    private ?string $ref2;

    /**
     * @var string|null
     * @Serializer\Type("string")
     */
    private ?string $consolidationRef;

    /**
     * @var bool
     * @Serializer\Type("bool")
     */
    private bool $requireUnsuccessfulDeliveryStickerImage = false;

    /**
     * @param ShipmentSender $sender
     * @param ShipmentRecipient $recipient
     * @param ShipmentService $service
     * @param ShipmentContent $content
     * @param ShipmentPayment $payment
     */
    public function __construct(
        ShipmentSender $sender,
        ShipmentRecipient $recipient,
        ShipmentService $service,
        ShipmentContent $content,
        ShipmentPayment $payment
    ) {
        $this->setSender($sender);
        $this->setRecipient($recipient);
        $this->setService($service);
        $this->setContent($content);
        $this->setPayment($payment);
    }

    /**
     * @return ShipmentRecipient
     */
    public function getRecipient(): ShipmentRecipient
    {
        return $this->recipient;
    }

    /**
     * @param ShipmentRecipient $recipient
     * @return void
     */
    public function setRecipient(ShipmentRecipient $recipient): void
    {
        $this->recipient = $recipient;
    }

    /**
     * @return ShipmentService
     */
    public function getService(): ShipmentService
    {
        return $this->service;
    }

    /**
     * @param ShipmentService $service
     * @return void
     */
    public function setService(ShipmentService $service): void
    {
        $this->service = $service;
    }

    /**
     * @return ShipmentContent
     */
    public function getContent(): ShipmentContent
    {
        return $this->content;
    }

    /**
     * @param ShipmentContent $content
     * @return void
     */
    public function setContent(ShipmentContent $content): void
    {
        $this->content = $content;
    }

    /**
     * @return ShipmentPayment
     */
    public function getPayment(): ShipmentPayment
    {
        return $this->payment;
    }

    /**
     * @param ShipmentPayment $payment
     * @return void
     */
    public function setPayment(ShipmentPayment $payment): void
    {
        $this->payment = $payment;
    }

    /**
     * @return ShipmentSender
     */
    public function getSender(): ShipmentSender
    {
        return $this->sender;
    }

    /**
     * @param ShipmentSender $sender
     * @return $this
     */
    public function setSender(ShipmentSender $sender): self
    {
        $this->sender = $sender;

        return $this;
    }

    /**
     * @return string|null
     */
    public function getShipmentNote(): ?string
    {
        return $this->shipmentNote;
    }

    /**
     * @param string $shipmentNote
     * @return $this
     */
    public function setShipmentNote(string $shipmentNote): self
    {
        $this->shipmentNote = $shipmentNote;

        return $this;
    }

    /**
     * @return string|null
     */
    public function getRef1(): ?string
    {
        return $this->ref1;
    }

    /**
     * @param string $ref1
     * @return $this
     */
    public function setRef1(string $ref1): self
    {
        $this->ref1 = $ref1;

        return $this;
    }

    /**
     * @return string
     */
    public function getRef2(): ?string
    {
        return $this->ref2;
    }

    /**
     * @param string $ref2
     * @return $this
     */
    public function setRef2(string $ref2): ?self
    {
        $this->ref2 = $ref2;

        return $this;
    }

    /**
     * @return string|null
     */
    public function getConsolidationRef(): ?string
    {
        return $this->consolidationRef;
    }

    /**
     * @param ?string $consolidationRef
     * @return $this
     */
    public function setConsolidationRef(string $consolidationRef): void
    {
        $this->consolidationRef = $consolidationRef;
    }

    /**
     * @return bool
     */
    public function getRequireUnsuccessfulDeliveryStickerImage(): bool
    {
        return $this->requireUnsuccessfulDeliveryStickerImage;
    }

    /**
     * @param bool $requireUnsuccessfulDeliveryStickerImage
     * @return $this
     */
    public function setRequireUnsuccessfulDeliveryStickerImage(bool $requireUnsuccessfulDeliveryStickerImage): self
    {
        $this->requireUnsuccessfulDeliveryStickerImage = $requireUnsuccessfulDeliveryStickerImage;

        return $this;
    }

    /**
     * @return array
     */
    public function toArray(): array
    {
        return [
            Speedy::SENDER        => $this->sender->toArray(),
            Speedy::RECIPIENT     => $this->recipient->toArray(),
            Speedy::SERVICE       => $this->service->toArray(),
            Speedy::CONTENT       => $this->content->toArray(),
            Speedy::PAYMENT       => $this->payment->toArray(),
            //Speedy::SHIPMENT_NOTE => $this->getShipmentNote(),
            //Speedy::REF_1         => $this->getRef1(),
            //Speedy::REF_2         => $this->getRef2(),
            //Speedy::CONSOLIDATION_REF => '',
            //Speedy::REQUIRE_UNSUCCESSFUL_DELIVERY_STICKER_IMAGE => '',
        ];
    }
}