VasilDakov\Speedy\Service\Shipment\ShipmentSender

Complexity

Total Complexity

20

Size/Duplication

Total Lines	226
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	setAddress()	0	3	1
A	setContactName()	0	3	1
A	getAddress()	0	3	1
A	setPhone1()	0	3	1
A	getDropoffOfficeId()	0	3	1
A	getPhone1()	0	3	1
A	setPhone2()	0	3	1
A	getPhone3()	0	3	1
A	getClientName()	0	3	1
A	setPrivatePerson()	0	3	1
A	getEmail()	0	3	1
A	getContactName()	0	3	1
A	toArray()	0	9	1
A	setClientName()	0	3	1
A	isPrivatePerson()	0	3	1
A	setPhone3()	0	3	1
A	getPhone2()	0	3	1
A	__construct()	0	8	1
A	setDropoffOfficeId()	0	3	1
A	setEmail()	0	3	1

<?php

declare(strict_types=1);

namespace VasilDakov\Speedy\Service\Shipment;

use VasilDakov\Speedy\Speedy;
use JMS\Serializer\Annotation as Serializer;
use VasilDakov\Speedy\Traits\ToArray;

/**
 * Class ShipmentSender
 *
 * @author Valentin Valkanov <valentinvalkanof@gmail.com>
 * @author Vasil Dakov <vasildakov@gmail.com>
 * @copyright
 * @version
 * @Serializer\AccessType("public_method")
 */
class ShipmentSender
{
    use ToArray;

    /**
     * @var ShipmentPhoneNumber
     */
    private ShipmentPhoneNumber $phone1;

    /**
     * @var ShipmentPhoneNumber
     */
    private ShipmentPhoneNumber $phone2;

    /**
     * @var ShipmentPhoneNumber
     */
    private ShipmentPhoneNumber $phone3;

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

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

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

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

    /**
     * @var ShipmentAddress
     */
    private ShipmentAddress $address;

    /**
     * @var int
     * @Serializer\Type("integer")
     */
    private int $dropoffOfficeId;

    /**
     * @param ShipmentPhoneNumber $phone1
     * @param string $email
     * @param string $clientName
     */
    public function __construct(
        ShipmentPhoneNumber $phone1,
        string $email,
        string $clientName
    ) {
        $this->setPhone1($phone1);
        $this->setEmail($email);
        $this->setClientName($clientName);
    }

    /**
     * @return ShipmentPhoneNumber
     */
    public function getPhone1(): ShipmentPhoneNumber
    {
        return $this->phone1;
    }

    /**
     * @param ShipmentPhoneNumber $phone1
     */
    public function setPhone1(ShipmentPhoneNumber $phone1): void
    {
        $this->phone1 = $phone1;
    }

    /**
     * @return ShipmentPhoneNumber
     */
    public function getPhone2(): ShipmentPhoneNumber
    {
        return $this->phone2;
    }

    /**
     * @param ShipmentPhoneNumber $phone2
     */
    public function setPhone2(ShipmentPhoneNumber $phone2): void
    {
        $this->phone2 = $phone2;
    }

    /**
     * @return ShipmentPhoneNumber
     */
    public function getPhone3(): ShipmentPhoneNumber
    {
        return $this->phone3;
    }

    /**
     * @param ShipmentPhoneNumber $phone3
     */
    public function setPhone3(ShipmentPhoneNumber $phone3): void
    {
        $this->phone3 = $phone3;
    }

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

    /**
     * @param string $clientName
     */
    public function setClientName(string $clientName): void
    {
        $this->clientName = $clientName;
    }

    /**
     * @return string
     */
    public function getContactName(): string
    {
        return $this->contactName;

The expression return $this->contactName could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * @param string $contactName
     */
    public function setContactName(string $contactName): void
    {
        $this->contactName = $contactName;
    }

    /**
     * @return string
     */
    public function getEmail(): string
    {
        return $this->email;

The expression return $this->email could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * @param string $email
     */
    public function setEmail(string $email): void
    {
        $this->email = $email;
    }

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

    /**
     * @param bool $privatePerson
     */
    public function setPrivatePerson(bool $privatePerson): void
    {
        $this->privatePerson = $privatePerson;
    }

    /**
     * @return ShipmentAddress
     */
    public function getAddress(): ShipmentAddress
    {
        return $this->address;
    }

    /**
     * @param ShipmentAddress $address
     */
    public function setAddress(ShipmentAddress $address): void
    {
        $this->address = $address;
    }

    /**
     * @return int
     */
    public function getDropoffOfficeId(): int
    {
        return $this->dropoffOfficeId;
    }

    /**
     * @param int $dropoffOfficeId
     */
    public function setDropoffOfficeId(int $dropoffOfficeId): void
    {
        $this->dropoffOfficeId = $dropoffOfficeId;
    }


    /**
     * @return array
     */
    public function toArray(): array
    {
        return [
           Speedy::PHONE_1             => $this->phone1->toArray(),
           //Speedy::PHONE_2             => $this->phone2->toArray(),
           //Speedy::PHONE_3             => $this->phone3->toArray(),
           Speedy::CLIENT_NAME         => $this->getClientName(),
           //Speedy::CONTACT_NAME      => $this->getContactName(),
           Speedy::EMAIL               => $this->getEmail(),
           //Speedy::PRIVATE_PERSON    => $this->getPrivatePerson(),
           //Speedy::ADDRESS           => $this->getAddress(),
           //Speedy::PICKUP_OFFICE_ID  => $this->getPickupOfficeId(),
        ];
    }
}