Label - Code Metrics - Inspection of "coding" - loevgaard/pakkelabels-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 868741...562f60 )

by Joachim

created 2017-10-31 15:02 UTC

Label D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	1146
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

Metric	Value
wmc	79
lcom	2
cbo	0
dl	0
loc	1146
rs	4.9115
c	0
b	0
f	0

79 Methods

Rating	Name	Size	Complexity
A	__construct()	7	1
A	arrayForApi()	50	1
A	markAsError()	5	1
A	markAsSuccess()	5	1
A	getLabelFormats()	9	1
A	getId()	4	1
A	setId()	6	1
A	getExternalId()	4	1
A	setExternalId()	6	1
A	getStatus()	4	1
A	setStatus()	6	1
A	getError()	4	1
A	setError()	6	1
A	getShippingMethod()	4	1
A	setShippingMethod()	6	1
A	getOrderId()	4	1
A	setOrderId()	6	1
A	getReference()	4	1
A	setReference()	6	1
A	getSource()	4	1
A	setSource()	6	1
A	isOwnAgreement()	4	1
A	setOwnAgreement()	6	1
A	getLabelFormat()	4	1
A	setLabelFormat()	6	1
A	getProductCode()	4	1
A	setProductCode()	6	1
A	getServiceCodes()	4	1
A	setServiceCodes()	6	1
A	isAutomaticSelectServicePoint()	4	1
A	setAutomaticSelectServicePoint()	6	1
A	getServicePointId()	4	1
A	setServicePointId()	6	1
A	isSmsNotification()	4	1
A	setSmsNotification()	6	1
A	isEmailNotification()	4	1
A	setEmailNotification()	6	1
A	getSenderName()	4	1
A	setSenderName()	6	1
A	getSenderAddress1()	4	1
A	setSenderAddress1()	6	1
A	getSenderAddress2()	4	1
A	setSenderAddress2()	6	1
A	getSenderCountryCode()	4	1
A	setSenderCountryCode()	6	1
A	getSenderZipCode()	4	1
A	setSenderZipCode()	6	1
A	getSenderCity()	4	1
A	setSenderCity()	6	1
A	getSenderAttention()	4	1
A	setSenderAttention()	6	1
A	getSenderEmail()	4	1
A	setSenderEmail()	6	1
A	getSenderTelephone()	4	1
A	setSenderTelephone()	6	1
A	getSenderMobile()	4	1
A	setSenderMobile()	6	1
A	getReceiverName()	4	1
A	setReceiverName()	6	1
A	getReceiverAddress1()	4	1
A	setReceiverAddress1()	6	1
A	getReceiverAddress2()	4	1
A	setReceiverAddress2()	6	1
A	getReceiverCountryCode()	4	1
A	setReceiverCountryCode()	6	1
A	getReceiverZipCode()	4	1
A	setReceiverZipCode()	6	1
A	getReceiverCity()	4	1
A	setReceiverCity()	6	1
A	getReceiverAttention()	4	1
A	setReceiverAttention()	6	1
A	getReceiverEmail()	4	1
A	setReceiverEmail()	6	1
A	getReceiverTelephone()	4	1
A	setReceiverTelephone()	6	1
A	getReceiverMobile()	4	1
A	setReceiverMobile()	6	1
A	getReceiverInstruction()	4	1
A	setReceiverInstruction()	6	1

How to fix Complexity

<?php

namespace Loevgaard\PakkelabelsBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @ORM\Entity
 * @ORM\Table(name="pakkelabels_labels")
 */
class Label
{
    const STATUS_PENDING_NORMALIZATION = 'pending_normalization';
    const STATUS_PENDING_CREATION = 'pending_creation';
    const STATUS_ERROR = 'error';
    const STATUS_SUCCESS = 'success';

    const LABEL_FORMAT_A4_PDF = 'a4_pdf';
    const LABEL_FORMAT_10_X_19_PDF = '10x19_pdf';
    const LABEL_FORMAT_PNG = 'png';
    const LABEL_FORMAT_ZPL = 'zpl';

    /**
     * @var int
     *
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     */
    protected $id;

    /**
     * This is the shipment id from Pakkelabels.
     *
     * @var int
     *
     * @ORM\Column(type="integer", unique=true, nullable=true)
     */
    protected $externalId;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="string")
     */
    protected $status;

    /**
     * @var string
     *
     * @ORM\Column(type="text", nullable=true)
     */
    protected $error;

    /**
     * The shipping method property is used in normalization. We check the mappings table to see
     * if there is a shipping method matching this. If there is, we will populate the product code
     * and services codes properties.
     *
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $shippingMethod;

    /**************************
     * Pakkelabels properties *
     *************************/
    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $orderId;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $reference;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $source;

    /**
     * @var bool
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="boolean")
     */
    protected $ownAgreement;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $labelFormat;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $productCode;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $serviceCodes;

    /**
     * @var bool
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="boolean")
     */
    protected $automaticSelectServicePoint;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $servicePointId;

    /**
     * @var bool
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="boolean")
     */
    protected $smsNotification;

    /**
     * @var bool
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="boolean")
     */
    protected $emailNotification;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="string")
     */
    protected $senderName;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="string")
     */
    protected $senderAddress1;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $senderAddress2;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="string")
     */
    protected $senderCountryCode;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="string")
     */
    protected $senderZipCode;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="string")
     */
    protected $senderCity;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $senderAttention;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="string")
     */
    protected $senderEmail;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $senderTelephone;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $senderMobile;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="string")
     */
    protected $receiverName;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="string")
     */
    protected $receiverAddress1;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $receiverAddress2;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="string")
     */
    protected $receiverCountryCode;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="string")
     */
    protected $receiverZipCode;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="string")
     */
    protected $receiverCity;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $receiverAttention;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     *
     * @ORM\Column(type="string")
     */
    protected $receiverEmail;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $receiverTelephone;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $receiverMobile;

    /**
     * @var string
     *
     * @ORM\Column(type="text", nullable=true)
     */
    protected $receiverInstruction;

    public function __construct()
    {
        $this->status = static::STATUS_PENDING_NORMALIZATION;
        $this->smsNotification = false;
        $this->emailNotification = false;
        $this->automaticSelectServicePoint = true;
    }

    public function arrayForApi(): array
    {
        $data = [
            'order_id' => $this->orderId,
            'reference' => $this->reference,
            'source' => $this->source,
            'own_agreement' => $this->ownAgreement,
            'label_format' => $this->labelFormat,
            'product_code' => $this->productCode,
            'service_codes' => $this->serviceCodes,
            'automatic_select_service_point' => $this->automaticSelectServicePoint,
            'sms_notification' => $this->smsNotification,
            'email_notification' => $this->emailNotification,
            'service_point' => [
                'id' => $this->servicePointId,
            ],
            'sender' => [
                'name' => $this->senderName,
                'address1' => $this->senderAddress1,
                'address2' => $this->senderAddress2,
                'country_code' => $this->senderCountryCode,
                'zipcode' => $this->senderZipCode,
                'city' => $this->senderCity,
                'attention' => $this->senderAttention,
                'email' => $this->senderEmail,
                'telephone' => $this->senderTelephone,
                'mobile' => $this->senderMobile,
            ],
            'receiver' => [
                'name' => $this->receiverName,
                'address1' => $this->receiverAddress1,
                'address2' => $this->receiverAddress2,
                'country_code' => $this->receiverCountryCode,
                'zipcode' => $this->receiverZipCode,
                'city' => $this->receiverCity,
                'attention' => $this->receiverAttention,
                'email' => $this->receiverEmail,
                'telephone' => $this->receiverTelephone,
                'mobile' => $this->receiverMobile,
                'instruction' => $this->receiverInstruction,
            ],
            'parcels' => [
                [
                    'weight' => 1000,
                ],
            ],
        ];

        return $data;
    }

    public function markAsError(string $error)
    {
        $this->error = $error;
        $this->status = static::STATUS_ERROR;
    }

    public function markAsSuccess()
    {
        $this->error = null;
        $this->status = static::STATUS_SUCCESS;
    }

    /**
     * Returns the available label formats
     *
     * @return array
     */
    public static function getLabelFormats() : array
    {
        return [
            self::LABEL_FORMAT_10_X_19_PDF => self::LABEL_FORMAT_10_X_19_PDF,
            self::LABEL_FORMAT_A4_PDF => self::LABEL_FORMAT_A4_PDF,
            self::LABEL_FORMAT_PNG => self::LABEL_FORMAT_PNG,
            self::LABEL_FORMAT_ZPL => self::LABEL_FORMAT_ZPL,
        ];
    }

    /*********************
     * Getters / Setters *
     ********************/

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

    /**
     * @param int $id
     *
     * @return Label
     */
    public function setId(int $id)
    {
        $this->id = $id;

        return $this;
    }

    /**
     * @return int
     */
    public function getExternalId(): ?int
    {
        return $this->externalId;
    }

    /**
     * @param int $externalId
     *
     * @return Label
     */
    public function setExternalId(int $externalId)
    {
        $this->externalId = $externalId;

        return $this;
    }

    /**
     * @return string
     */
    public function getStatus(): string
    {
        return $this->status;
    }

    /**
     * @param string $status
     *
     * @return Label
     */
    public function setStatus(string $status)
    {
        $this->status = $status;

        return $this;
    }

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

    /**
     * @param string $error
     *
     * @return Label
     */
    public function setError(string $error)
    {
        $this->error = $error;

        return $this;
    }

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

    /**
     * @param string $shippingMethod
     *
     * @return Label
     */
    public function setShippingMethod(string $shippingMethod)
    {
        $this->shippingMethod = $shippingMethod;

        return $this;
    }

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

    /**
     * @param string $orderId
     *
     * @return Label
     */
    public function setOrderId(string $orderId)
    {
        $this->orderId = $orderId;

        return $this;
    }

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

    /**
     * @param string $reference
     *
     * @return Label
     */
    public function setReference(string $reference)
    {
        $this->reference = $reference;

        return $this;
    }

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

    /**
     * @param string $source
     *
     * @return Label
     */
    public function setSource(string $source)
    {
        $this->source = $source;

        return $this;
    }

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

    /**
     * @param bool $ownAgreement
     *
     * @return Label
     */
    public function setOwnAgreement(bool $ownAgreement)
    {
        $this->ownAgreement = $ownAgreement;

        return $this;
    }

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

    /**
     * @param string $labelFormat
     *
     * @return Label
     */
    public function setLabelFormat(string $labelFormat)
    {
        $this->labelFormat = $labelFormat;

        return $this;
    }

    /**
     * @return string
     */
    public function getProductCode(): string
    {
        return $this->productCode;
    }

    /**
     * @param string $productCode
     *
     * @return Label
     */
    public function setProductCode(string $productCode)
    {
        $this->productCode = $productCode;

        return $this;
    }

    /**
     * @return string
     */
    public function getServiceCodes(): string
    {
        return $this->serviceCodes;
    }

    /**
     * @param string $serviceCodes
     *
     * @return Label
     */
    public function setServiceCodes(string $serviceCodes)
    {
        $this->serviceCodes = $serviceCodes;

        return $this;
    }

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

    /**
     * @param bool $automaticSelectServicePoint
     *
     * @return Label
     */
    public function setAutomaticSelectServicePoint(bool $automaticSelectServicePoint)
    {
        $this->automaticSelectServicePoint = $automaticSelectServicePoint;

        return $this;
    }

    /**
     * @return string
     */
    public function getServicePointId(): string
    {
        return $this->servicePointId;
    }

    /**
     * @param string $servicePointId
     *
     * @return Label
     */
    public function setServicePointId(string $servicePointId)
    {
        $this->servicePointId = $servicePointId;

        return $this;
    }

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

    /**
     * @param bool $smsNotification
     *
     * @return Label
     */
    public function setSmsNotification(bool $smsNotification)
    {
        $this->smsNotification = $smsNotification;

        return $this;
    }

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

    /**
     * @param bool $emailNotification
     *
     * @return Label
     */
    public function setEmailNotification(bool $emailNotification)
    {
        $this->emailNotification = $emailNotification;

        return $this;
    }

    /**
     * @return string
     */
    public function getSenderName(): string
    {
        return $this->senderName;
    }

    /**
     * @param string $senderName
     *
     * @return Label
     */
    public function setSenderName(string $senderName)
    {
        $this->senderName = $senderName;

        return $this;
    }

    /**
     * @return string
     */
    public function getSenderAddress1(): string
    {
        return $this->senderAddress1;
    }

    /**
     * @param string $senderAddress1
     *
     * @return Label
     */
    public function setSenderAddress1(string $senderAddress1)
    {
        $this->senderAddress1 = $senderAddress1;

        return $this;
    }

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

    /**
     * @param string $senderAddress2
     *
     * @return Label
     */
    public function setSenderAddress2(string $senderAddress2)
    {
        $this->senderAddress2 = $senderAddress2;

        return $this;
    }

    /**
     * @return string
     */
    public function getSenderCountryCode(): string
    {
        return $this->senderCountryCode;
    }

    /**
     * @param string $senderCountryCode
     *
     * @return Label
     */
    public function setSenderCountryCode(string $senderCountryCode)
    {
        $this->senderCountryCode = $senderCountryCode;

        return $this;
    }

    /**
     * @return string
     */
    public function getSenderZipCode(): string
    {
        return $this->senderZipCode;
    }

    /**
     * @param string $senderZipCode
     *
     * @return Label
     */
    public function setSenderZipCode(string $senderZipCode)
    {
        $this->senderZipCode = $senderZipCode;

        return $this;
    }

    /**
     * @return string
     */
    public function getSenderCity(): string
    {
        return $this->senderCity;
    }

    /**
     * @param string $senderCity
     *
     * @return Label
     */
    public function setSenderCity(string $senderCity)
    {
        $this->senderCity = $senderCity;

        return $this;
    }

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

    /**
     * @param string $senderAttention
     *
     * @return Label
     */
    public function setSenderAttention(string $senderAttention)
    {
        $this->senderAttention = $senderAttention;

        return $this;
    }

    /**
     * @return string
     */
    public function getSenderEmail(): string
    {
        return $this->senderEmail;
    }

    /**
     * @param string $senderEmail
     *
     * @return Label
     */
    public function setSenderEmail(string $senderEmail)
    {
        $this->senderEmail = $senderEmail;

        return $this;
    }

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

    /**
     * @param string $senderTelephone
     *
     * @return Label
     */
    public function setSenderTelephone(string $senderTelephone)
    {
        $this->senderTelephone = $senderTelephone;

        return $this;
    }

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

    /**
     * @param string $senderMobile
     *
     * @return Label
     */
    public function setSenderMobile(string $senderMobile)
    {
        $this->senderMobile = $senderMobile;

        return $this;
    }

    /**
     * @return string
     */
    public function getReceiverName(): string
    {
        return $this->receiverName;
    }

    /**
     * @param string $receiverName
     *
     * @return Label
     */
    public function setReceiverName(string $receiverName)
    {
        $this->receiverName = $receiverName;

        return $this;
    }

    /**
     * @return string
     */
    public function getReceiverAddress1(): string
    {
        return $this->receiverAddress1;
    }

    /**
     * @param string $receiverAddress1
     *
     * @return Label
     */
    public function setReceiverAddress1(string $receiverAddress1)
    {
        $this->receiverAddress1 = $receiverAddress1;

        return $this;
    }

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

    /**
     * @param string $receiverAddress2
     *
     * @return Label
     */
    public function setReceiverAddress2(string $receiverAddress2)
    {
        $this->receiverAddress2 = $receiverAddress2;

        return $this;
    }

    /**
     * @return string
     */
    public function getReceiverCountryCode(): string
    {
        return $this->receiverCountryCode;
    }

    /**
     * @param string $receiverCountryCode
     *
     * @return Label
     */
    public function setReceiverCountryCode(string $receiverCountryCode)
    {
        $this->receiverCountryCode = $receiverCountryCode;

        return $this;
    }

    /**
     * @return string
     */
    public function getReceiverZipCode(): string
    {
        return $this->receiverZipCode;
    }

    /**
     * @param string $receiverZipCode
     *
     * @return Label
     */
    public function setReceiverZipCode(string $receiverZipCode)
    {
        $this->receiverZipCode = $receiverZipCode;

        return $this;
    }

    /**
     * @return string
     */
    public function getReceiverCity(): string
    {
        return $this->receiverCity;
    }

    /**
     * @param string $receiverCity
     *
     * @return Label
     */
    public function setReceiverCity(string $receiverCity)
    {
        $this->receiverCity = $receiverCity;

        return $this;
    }

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

    /**
     * @param string $receiverAttention
     *
     * @return Label
     */
    public function setReceiverAttention(string $receiverAttention)
    {
        $this->receiverAttention = $receiverAttention;

        return $this;
    }

    /**
     * @return string
     */
    public function getReceiverEmail(): string
    {
        return $this->receiverEmail;
    }

    /**
     * @param string $receiverEmail
     *
     * @return Label
     */
    public function setReceiverEmail(string $receiverEmail)
    {
        $this->receiverEmail = $receiverEmail;

        return $this;
    }

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

    /**
     * @param string $receiverTelephone
     *
     * @return Label
     */
    public function setReceiverTelephone(string $receiverTelephone)
    {
        $this->receiverTelephone = $receiverTelephone;

        return $this;
    }

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

    /**
     * @param string $receiverMobile
     *
     * @return Label
     */
    public function setReceiverMobile(string $receiverMobile)
    {
        $this->receiverMobile = $receiverMobile;

        return $this;
    }

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

    /**
     * @param string $receiverInstruction
     *
     * @return Label
     */
    public function setReceiverInstruction(string $receiverInstruction)
    {
        $this->receiverInstruction = $receiverInstruction;

        return $this;
    }
}


1			<?php
2
3			namespace Loevgaard\PakkelabelsBundle\Entity;
4
5			use Doctrine\ORM\Mapping as ORM;
6			use Symfony\Component\Validator\Constraints as Assert;
7
8			/**
9			* @ORM\Entity
10			* @ORM\Table(name="pakkelabels_labels")
11			*/
12			class Label
13			{
14			const STATUS_PENDING_NORMALIZATION = 'pending_normalization';
15			const STATUS_PENDING_CREATION = 'pending_creation';
16			const STATUS_ERROR = 'error';
17			const STATUS_SUCCESS = 'success';
18
19			const LABEL_FORMAT_A4_PDF = 'a4_pdf';
20			const LABEL_FORMAT_10_X_19_PDF = '10x19_pdf';
21			const LABEL_FORMAT_PNG = 'png';
22			const LABEL_FORMAT_ZPL = 'zpl';
23
24			/**
25			* @var int
26			*
27			* @ORM\Id
28			* @ORM\GeneratedValue
29			* @ORM\Column(type="integer")
30			*/
31			protected $id;
32
33			/**
34			* This is the shipment id from Pakkelabels.
35			*
36			* @var int
37			*
38			* @ORM\Column(type="integer", unique=true, nullable=true)
39			*/
40			protected $externalId;
41
42			/**
43			* @var string
44			*
45			* @Assert\NotBlank()
46			*
47			* @ORM\Column(type="string")
48			*/
49			protected $status;
50
51			/**
52			* @var string
53			*
54			* @ORM\Column(type="text", nullable=true)
55			*/
56			protected $error;
57
58			/**
59			* The shipping method property is used in normalization. We check the mappings table to see
60			* if there is a shipping method matching this. If there is, we will populate the product code
61			* and services codes properties.
62			*
63			* @var string
64			*
65			* @ORM\Column(type="string", nullable=true)
66			*/
67			protected $shippingMethod;
68
69			/**************************
70			* Pakkelabels properties *
71			*************************/
72			/**
73			* @var string
74			*
75			* @ORM\Column(type="string", nullable=true)
76			*/
77			protected $orderId;
78
79			/**
80			* @var string
81			*
82			* @ORM\Column(type="string", nullable=true)
83			*/
84			protected $reference;
85
86			/**
87			* @var string
88			*
89			* @ORM\Column(type="string", nullable=true)
90			*/
91			protected $source;
92
93			/**
94			* @var bool
95			*
96			* @Assert\NotBlank()
97			*
98			* @ORM\Column(type="boolean")
99			*/
100			protected $ownAgreement;
101
102			/**
103			* @var string
104			*
105			* @ORM\Column(type="string", nullable=true)
106			*/
107			protected $labelFormat;
108
109			/**
110			* @var string
111			*
112			* @ORM\Column(type="string", nullable=true)
113			*/
114			protected $productCode;
115
116			/**
117			* @var string
118			*
119			* @ORM\Column(type="string", nullable=true)
120			*/
121			protected $serviceCodes;
122
123			/**
124			* @var bool
125			*
126			* @Assert\NotBlank()
127			*
128			* @ORM\Column(type="boolean")
129			*/
130			protected $automaticSelectServicePoint;
131
132			/**
133			* @var string
134			*
135			* @ORM\Column(type="string", nullable=true)
136			*/
137			protected $servicePointId;
138
139			/**
140			* @var bool
141			*
142			* @Assert\NotBlank()
143			*
144			* @ORM\Column(type="boolean")
145			*/
146			protected $smsNotification;
147
148			/**
149			* @var bool
150			*
151			* @Assert\NotBlank()
152			*
153			* @ORM\Column(type="boolean")
154			*/
155			protected $emailNotification;
156
157			/**
158			* @var string
159			*
160			* @Assert\NotBlank()
161			*
162			* @ORM\Column(type="string")
163			*/
164			protected $senderName;
165
166			/**
167			* @var string
168			*
169			* @Assert\NotBlank()
170			*
171			* @ORM\Column(type="string")
172			*/
173			protected $senderAddress1;
174
175			/**
176			* @var string
177			*
178			* @ORM\Column(type="string", nullable=true)
179			*/
180			protected $senderAddress2;
181
182			/**
183			* @var string
184			*
185			* @Assert\NotBlank()
186			*
187			* @ORM\Column(type="string")
188			*/
189			protected $senderCountryCode;
190
191			/**
192			* @var string
193			*
194			* @Assert\NotBlank()
195			*
196			* @ORM\Column(type="string")
197			*/
198			protected $senderZipCode;
199
200			/**
201			* @var string
202			*
203			* @Assert\NotBlank()
204			*
205			* @ORM\Column(type="string")
206			*/
207			protected $senderCity;
208
209			/**
210			* @var string
211			*
212			* @ORM\Column(type="string", nullable=true)
213			*/
214			protected $senderAttention;
215
216			/**
217			* @var string
218			*
219			* @Assert\NotBlank()
220			*
221			* @ORM\Column(type="string")
222			*/
223			protected $senderEmail;
224
225			/**
226			* @var string
227			*
228			* @ORM\Column(type="string", nullable=true)
229			*/
230			protected $senderTelephone;
231
232			/**
233			* @var string
234			*
235			* @ORM\Column(type="string", nullable=true)
236			*/
237			protected $senderMobile;
238
239			/**
240			* @var string
241			*
242			* @Assert\NotBlank()
243			*
244			* @ORM\Column(type="string")
245			*/
246			protected $receiverName;
247
248			/**
249			* @var string
250			*
251			* @Assert\NotBlank()
252			*
253			* @ORM\Column(type="string")
254			*/
255			protected $receiverAddress1;
256
257			/**
258			* @var string
259			*
260			* @ORM\Column(type="string", nullable=true)
261			*/
262			protected $receiverAddress2;
263
264			/**
265			* @var string
266			*
267			* @Assert\NotBlank()
268			*
269			* @ORM\Column(type="string")
270			*/
271			protected $receiverCountryCode;
272
273			/**
274			* @var string
275			*
276			* @Assert\NotBlank()
277			*
278			* @ORM\Column(type="string")
279			*/
280			protected $receiverZipCode;
281
282			/**
283			* @var string
284			*
285			* @Assert\NotBlank()
286			*
287			* @ORM\Column(type="string")
288			*/
289			protected $receiverCity;
290
291			/**
292			* @var string
293			*
294			* @ORM\Column(type="string", nullable=true)
295			*/
296			protected $receiverAttention;
297
298			/**
299			* @var string
300			*
301			* @Assert\NotBlank()
302			*
303			* @ORM\Column(type="string")
304			*/
305			protected $receiverEmail;
306
307			/**
308			* @var string
309			*
310			* @ORM\Column(type="string", nullable=true)
311			*/
312			protected $receiverTelephone;
313
314			/**
315			* @var string
316			*
317			* @ORM\Column(type="string", nullable=true)
318			*/
319			protected $receiverMobile;
320
321			/**
322			* @var string
323			*
324			* @ORM\Column(type="text", nullable=true)
325			*/
326			protected $receiverInstruction;
327
328			public function __construct()
329			{
330			$this->status = static::STATUS_PENDING_NORMALIZATION;
331			$this->smsNotification = false;
332			$this->emailNotification = false;
333			$this->automaticSelectServicePoint = true;
334			}
335
336			public function arrayForApi(): array
337			{
338			$data = [
339			'order_id' => $this->orderId,
340			'reference' => $this->reference,
341			'source' => $this->source,
342			'own_agreement' => $this->ownAgreement,
343			'label_format' => $this->labelFormat,
344			'product_code' => $this->productCode,
345			'service_codes' => $this->serviceCodes,
346			'automatic_select_service_point' => $this->automaticSelectServicePoint,
347			'sms_notification' => $this->smsNotification,
348			'email_notification' => $this->emailNotification,
349			'service_point' => [
350			'id' => $this->servicePointId,
351			],
352			'sender' => [
353			'name' => $this->senderName,
354			'address1' => $this->senderAddress1,
355			'address2' => $this->senderAddress2,
356			'country_code' => $this->senderCountryCode,
357			'zipcode' => $this->senderZipCode,
358			'city' => $this->senderCity,
359			'attention' => $this->senderAttention,
360			'email' => $this->senderEmail,
361			'telephone' => $this->senderTelephone,
362			'mobile' => $this->senderMobile,
363			],
364			'receiver' => [
365			'name' => $this->receiverName,
366			'address1' => $this->receiverAddress1,
367			'address2' => $this->receiverAddress2,
368			'country_code' => $this->receiverCountryCode,
369			'zipcode' => $this->receiverZipCode,
370			'city' => $this->receiverCity,
371			'attention' => $this->receiverAttention,
372			'email' => $this->receiverEmail,
373			'telephone' => $this->receiverTelephone,
374			'mobile' => $this->receiverMobile,
375			'instruction' => $this->receiverInstruction,
376			],
377			'parcels' => [
378			[
379			'weight' => 1000,
380			],
381			],
382			];
383
384			return $data;
385			}
386
387			public function markAsError(string $error)
388			{
389			$this->error = $error;
390			$this->status = static::STATUS_ERROR;
391			}
392
393			public function markAsSuccess()
394			{
395			$this->error = null;
396			$this->status = static::STATUS_SUCCESS;
397			}
398
399			/**
400			* Returns the available label formats
401			*
402			* @return array
403			*/
404			public static function getLabelFormats() : array
405			{
406			return [
407			self::LABEL_FORMAT_10_X_19_PDF => self::LABEL_FORMAT_10_X_19_PDF,
408			self::LABEL_FORMAT_A4_PDF => self::LABEL_FORMAT_A4_PDF,
409			self::LABEL_FORMAT_PNG => self::LABEL_FORMAT_PNG,
410			self::LABEL_FORMAT_ZPL => self::LABEL_FORMAT_ZPL,
411			];
412			}
413
414			/*********************
415			* Getters / Setters *
416			********************/
417
418			/**
419			* @return int
420			*/
421			public function getId(): int
422			{
423			return $this->id;
424			}
425
426			/**
427			* @param int $id
428			*
429			* @return Label
430			*/
431			public function setId(int $id)
432			{
433			$this->id = $id;
434
435			return $this;
436			}
437
438			/**
439			* @return int
440			*/
441			public function getExternalId(): ?int
442			{
443			return $this->externalId;
444			}
445
446			/**
447			* @param int $externalId
448			*
449			* @return Label
450			*/
451			public function setExternalId(int $externalId)
452			{
453			$this->externalId = $externalId;
454
455			return $this;
456			}
457
458			/**
459			* @return string
460			*/
461			public function getStatus(): string
462			{
463			return $this->status;
464			}
465
466			/**
467			* @param string $status
468			*
469			* @return Label
470			*/
471			public function setStatus(string $status)
472			{
473			$this->status = $status;
474
475			return $this;
476			}
477
478			/**
479			* @return string
480			*/
481			public function getError(): ?string
482			{
483			return $this->error;
484			}
485
486			/**
487			* @param string $error
488			*
489			* @return Label
490			*/
491			public function setError(string $error)
492			{
493			$this->error = $error;
494
495			return $this;
496			}
497
498			/**
499			* @return string
500			*/
501			public function getShippingMethod(): ?string
502			{
503			return $this->shippingMethod;
504			}
505
506			/**
507			* @param string $shippingMethod
508			*
509			* @return Label
510			*/
511			public function setShippingMethod(string $shippingMethod)
512			{
513			$this->shippingMethod = $shippingMethod;
514
515			return $this;
516			}
517
518			/**
519			* @return string
520			*/
521			public function getOrderId(): ?string
522			{
523			return $this->orderId;
524			}
525
526			/**
527			* @param string $orderId
528			*
529			* @return Label
530			*/
531			public function setOrderId(string $orderId)
532			{
533			$this->orderId = $orderId;
534
535			return $this;
536			}
537
538			/**
539			* @return string
540			*/
541			public function getReference(): ?string
542			{
543			return $this->reference;
544			}
545
546			/**
547			* @param string $reference
548			*
549			* @return Label
550			*/
551			public function setReference(string $reference)
552			{
553			$this->reference = $reference;
554
555			return $this;
556			}
557
558			/**
559			* @return string
560			*/
561			public function getSource(): ?string
562			{
563			return $this->source;
564			}
565
566			/**
567			* @param string $source
568			*
569			* @return Label
570			*/
571			public function setSource(string $source)
572			{
573			$this->source = $source;
574
575			return $this;
576			}
577
578			/**
579			* @return bool
580			*/
581			public function isOwnAgreement(): bool
582			{
583			return $this->ownAgreement;
584			}
585
586			/**
587			* @param bool $ownAgreement
588			*
589			* @return Label
590			*/
591			public function setOwnAgreement(bool $ownAgreement)
592			{
593			$this->ownAgreement = $ownAgreement;
594
595			return $this;
596			}
597
598			/**
599			* @return string
600			*/
601			public function getLabelFormat(): ?string
602			{
603			return $this->labelFormat;
604			}
605
606			/**
607			* @param string $labelFormat
608			*
609			* @return Label
610			*/
611			public function setLabelFormat(string $labelFormat)
612			{
613			$this->labelFormat = $labelFormat;
614
615			return $this;
616			}
617
618			/**
619			* @return string
620			*/
621			public function getProductCode(): string
622			{
623			return $this->productCode;
624			}
625
626			/**
627			* @param string $productCode
628			*
629			* @return Label
630			*/
631			public function setProductCode(string $productCode)
632			{
633			$this->productCode = $productCode;
634
635			return $this;
636			}
637
638			/**
639			* @return string
640			*/
641			public function getServiceCodes(): string
642			{
643			return $this->serviceCodes;
644			}
645
646			/**
647			* @param string $serviceCodes
648			*
649			* @return Label
650			*/
651			public function setServiceCodes(string $serviceCodes)
652			{
653			$this->serviceCodes = $serviceCodes;
654
655			return $this;
656			}
657
658			/**
659			* @return bool
660			*/
661			public function isAutomaticSelectServicePoint(): bool
662			{
663			return $this->automaticSelectServicePoint;
664			}
665
666			/**
667			* @param bool $automaticSelectServicePoint
668			*
669			* @return Label
670			*/
671			public function setAutomaticSelectServicePoint(bool $automaticSelectServicePoint)
672			{
673			$this->automaticSelectServicePoint = $automaticSelectServicePoint;
674
675			return $this;
676			}
677
678			/**
679			* @return string
680			*/
681			public function getServicePointId(): string
682			{
683			return $this->servicePointId;
684			}
685
686			/**
687			* @param string $servicePointId
688			*
689			* @return Label
690			*/
691			public function setServicePointId(string $servicePointId)
692			{
693			$this->servicePointId = $servicePointId;
694
695			return $this;
696			}
697
698			/**
699			* @return bool
700			*/
701			public function isSmsNotification(): bool
702			{
703			return $this->smsNotification;
704			}
705
706			/**
707			* @param bool $smsNotification
708			*
709			* @return Label
710			*/
711			public function setSmsNotification(bool $smsNotification)
712			{
713			$this->smsNotification = $smsNotification;
714
715			return $this;
716			}
717
718			/**
719			* @return bool
720			*/
721			public function isEmailNotification(): bool
722			{
723			return $this->emailNotification;
724			}
725
726			/**
727			* @param bool $emailNotification
728			*
729			* @return Label
730			*/
731			public function setEmailNotification(bool $emailNotification)
732			{
733			$this->emailNotification = $emailNotification;
734
735			return $this;
736			}
737
738			/**
739			* @return string
740			*/
741			public function getSenderName(): string
742			{
743			return $this->senderName;
744			}
745
746			/**
747			* @param string $senderName
748			*
749			* @return Label
750			*/
751			public function setSenderName(string $senderName)
752			{
753			$this->senderName = $senderName;
754
755			return $this;
756			}
757
758			/**
759			* @return string
760			*/
761			public function getSenderAddress1(): string
762			{
763			return $this->senderAddress1;
764			}
765
766			/**
767			* @param string $senderAddress1
768			*
769			* @return Label
770			*/
771			public function setSenderAddress1(string $senderAddress1)
772			{
773			$this->senderAddress1 = $senderAddress1;
774
775			return $this;
776			}
777
778			/**
779			* @return string
780			*/
781			public function getSenderAddress2(): ?string
782			{
783			return $this->senderAddress2;
784			}
785
786			/**
787			* @param string $senderAddress2
788			*
789			* @return Label
790			*/
791			public function setSenderAddress2(string $senderAddress2)
792			{
793			$this->senderAddress2 = $senderAddress2;
794
795			return $this;
796			}
797
798			/**
799			* @return string
800			*/
801			public function getSenderCountryCode(): string
802			{
803			return $this->senderCountryCode;
804			}
805
806			/**
807			* @param string $senderCountryCode
808			*
809			* @return Label
810			*/
811			public function setSenderCountryCode(string $senderCountryCode)
812			{
813			$this->senderCountryCode = $senderCountryCode;
814
815			return $this;
816			}
817
818			/**
819			* @return string
820			*/
821			public function getSenderZipCode(): string
822			{
823			return $this->senderZipCode;
824			}
825
826			/**
827			* @param string $senderZipCode
828			*
829			* @return Label
830			*/
831			public function setSenderZipCode(string $senderZipCode)
832			{
833			$this->senderZipCode = $senderZipCode;
834
835			return $this;
836			}
837
838			/**
839			* @return string
840			*/
841			public function getSenderCity(): string
842			{
843			return $this->senderCity;
844			}
845
846			/**
847			* @param string $senderCity
848			*
849			* @return Label
850			*/
851			public function setSenderCity(string $senderCity)
852			{
853			$this->senderCity = $senderCity;
854
855			return $this;
856			}
857
858			/**
859			* @return string
860			*/
861			public function getSenderAttention(): ?string
862			{
863			return $this->senderAttention;
864			}
865
866			/**
867			* @param string $senderAttention
868			*
869			* @return Label
870			*/
871			public function setSenderAttention(string $senderAttention)
872			{
873			$this->senderAttention = $senderAttention;
874
875			return $this;
876			}
877
878			/**
879			* @return string
880			*/
881			public function getSenderEmail(): string
882			{
883			return $this->senderEmail;
884			}
885
886			/**
887			* @param string $senderEmail
888			*
889			* @return Label
890			*/
891			public function setSenderEmail(string $senderEmail)
892			{
893			$this->senderEmail = $senderEmail;
894
895			return $this;
896			}
897
898			/**
899			* @return string
900			*/
901			public function getSenderTelephone(): ?string
902			{
903			return $this->senderTelephone;
904			}
905
906			/**
907			* @param string $senderTelephone
908			*
909			* @return Label
910			*/
911			public function setSenderTelephone(string $senderTelephone)
912			{
913			$this->senderTelephone = $senderTelephone;
914
915			return $this;
916			}
917
918			/**
919			* @return string
920			*/
921			public function getSenderMobile(): ?string
922			{
923			return $this->senderMobile;
924			}
925
926			/**
927			* @param string $senderMobile
928			*
929			* @return Label
930			*/
931			public function setSenderMobile(string $senderMobile)
932			{
933			$this->senderMobile = $senderMobile;
934
935			return $this;
936			}
937
938			/**
939			* @return string
940			*/
941			public function getReceiverName(): string
942			{
943			return $this->receiverName;
944			}
945
946			/**
947			* @param string $receiverName
948			*
949			* @return Label
950			*/
951			public function setReceiverName(string $receiverName)
952			{
953			$this->receiverName = $receiverName;
954
955			return $this;
956			}
957
958			/**
959			* @return string
960			*/
961			public function getReceiverAddress1(): string
962			{
963			return $this->receiverAddress1;
964			}
965
966			/**
967			* @param string $receiverAddress1
968			*
969			* @return Label
970			*/
971			public function setReceiverAddress1(string $receiverAddress1)
972			{
973			$this->receiverAddress1 = $receiverAddress1;
974
975			return $this;
976			}
977
978			/**
979			* @return string
980			*/
981			public function getReceiverAddress2(): ?string
982			{
983			return $this->receiverAddress2;
984			}
985
986			/**
987			* @param string $receiverAddress2
988			*
989			* @return Label
990			*/
991			public function setReceiverAddress2(string $receiverAddress2)
992			{
993			$this->receiverAddress2 = $receiverAddress2;
994
995			return $this;
996			}
997
998			/**
999			* @return string
1000			*/
1001			public function getReceiverCountryCode(): string
1002			{
1003			return $this->receiverCountryCode;
1004			}
1005
1006			/**
1007			* @param string $receiverCountryCode
1008			*
1009			* @return Label
1010			*/
1011			public function setReceiverCountryCode(string $receiverCountryCode)
1012			{
1013			$this->receiverCountryCode = $receiverCountryCode;
1014
1015			return $this;
1016			}
1017
1018			/**
1019			* @return string
1020			*/
1021			public function getReceiverZipCode(): string
1022			{
1023			return $this->receiverZipCode;
1024			}
1025
1026			/**
1027			* @param string $receiverZipCode
1028			*
1029			* @return Label
1030			*/
1031			public function setReceiverZipCode(string $receiverZipCode)
1032			{
1033			$this->receiverZipCode = $receiverZipCode;
1034
1035			return $this;
1036			}
1037
1038			/**
1039			* @return string
1040			*/
1041			public function getReceiverCity(): string
1042			{
1043			return $this->receiverCity;
1044			}
1045
1046			/**
1047			* @param string $receiverCity
1048			*
1049			* @return Label
1050			*/
1051			public function setReceiverCity(string $receiverCity)
1052			{
1053			$this->receiverCity = $receiverCity;
1054
1055			return $this;
1056			}
1057
1058			/**
1059			* @return string
1060			*/
1061			public function getReceiverAttention(): ?string
1062			{
1063			return $this->receiverAttention;
1064			}
1065
1066			/**
1067			* @param string $receiverAttention
1068			*
1069			* @return Label
1070			*/
1071			public function setReceiverAttention(string $receiverAttention)
1072			{
1073			$this->receiverAttention = $receiverAttention;
1074
1075			return $this;
1076			}
1077
1078			/**
1079			* @return string
1080			*/
1081			public function getReceiverEmail(): string
1082			{
1083			return $this->receiverEmail;
1084			}
1085
1086			/**
1087			* @param string $receiverEmail
1088			*
1089			* @return Label
1090			*/
1091			public function setReceiverEmail(string $receiverEmail)
1092			{
1093			$this->receiverEmail = $receiverEmail;
1094
1095			return $this;
1096			}
1097
1098			/**
1099			* @return string
1100			*/
1101			public function getReceiverTelephone(): ?string
1102			{
1103			return $this->receiverTelephone;
1104			}
1105
1106			/**
1107			* @param string $receiverTelephone
1108			*
1109			* @return Label
1110			*/
1111			public function setReceiverTelephone(string $receiverTelephone)
1112			{
1113			$this->receiverTelephone = $receiverTelephone;
1114
1115			return $this;
1116			}
1117
1118			/**
1119			* @return string
1120			*/
1121			public function getReceiverMobile(): ?string
1122			{
1123			return $this->receiverMobile;
1124			}
1125
1126			/**
1127			* @param string $receiverMobile
1128			*
1129			* @return Label
1130			*/
1131			public function setReceiverMobile(string $receiverMobile)
1132			{
1133			$this->receiverMobile = $receiverMobile;
1134
1135			return $this;
1136			}
1137
1138			/**
1139			* @return string
1140			*/
1141			public function getReceiverInstruction(): ?string
1142			{
1143			return $this->receiverInstruction;
1144			}
1145
1146			/**
1147			* @param string $receiverInstruction
1148			*
1149			* @return Label
1150			*/
1151			public function setReceiverInstruction(string $receiverInstruction)
1152			{
1153			$this->receiverInstruction = $receiverInstruction;
1154
1155			return $this;
1156			}
1157			}
1158

loevgaard / pakkelabels-bundle

Push — master ( 868741...562f60 )

Label D

Complexity

Size/Duplication

Coupling/Cohesion

Importance

79 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like