Appwilio\RussianPostSDK\Dispatching\Endpoints\Services\Entities\NormalizedAddress

Complexity

Total Complexity

21

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	getArea()	0	3	1
A	getRoom()	0	3	1
A	getValidationCode()	0	3	1
A	getAddressType()	0	3	1
A	getStreet()	0	3	1
A	getLocation()	0	3	1
A	getHotel()	0	3	1
A	getLetter()	0	3	1
A	getBuilding()	0	3	1
A	getPlace()	0	3	1
A	getQualityCode()	0	3	1
A	getOriginalAddress()	0	3	1
A	getSlash()	0	3	1
A	getId()	0	3	1
A	getNumAddressType()	0	3	1
A	getHouse()	0	3	1
A	getCorpus()	0	3	1
A	isUseful()	0	11	2
A	getIndex()	0	3	1
A	getRegion()	0	3	1

<?php

/**
 * This file is part of RussianPost SDK package.
 *
 * © Appwilio (http://appwilio.com), JhaoDa (https://github.com/jhaoda)
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Appwilio\RussianPostSDK\Dispatching\Endpoints\Services\Entities;

use Appwilio\RussianPostSDK\Dispatching\DataAware;
use Appwilio\RussianPostSDK\Dispatching\Contracts\Arrayable;

final class NormalizedAddress implements Arrayable
{
    use DataAware;

    /**
     * Коды качества нормализации адреса.
     *
     * @see https://otpravka.pochta.ru/specification#/enums-clean-address-quality
     */
    public const QUALITY_GOOD = 'GOOD';
    public const QUALITY_ON_DEMAND = 'ON_DEMAND';
    public const QUALITY_POSTAL_BOX = 'POSTAL_BOX';
    public const QUALITY_UNDEF_01 = 'UNDEF_01';
    public const QUALITY_UNDEF_02 = 'UNDEF_02';
    public const QUALITY_UNDEF_03 = 'UNDEF_03';
    public const QUALITY_UNDEF_04 = 'UNDEF_04';
    public const QUALITY_UNDEF_05 = 'UNDEF_05';
    public const QUALITY_UNDEF_06 = 'UNDEF_06';
    public const QUALITY_UNDEF_07 = 'UNDEF_07';

    /**
     * Коды проверки нормализации адреса.
     *
     * @https://otpravka.pochta.ru/specification#/enums-clean-address-validation
     */
    public const VALIDATION_VALIDATED = 'VALIDATED';
    public const VALIDATION_OVERRIDDEN = 'OVERRIDDEN';
    public const VALIDATION_CONFIRMED_MANUALLY = 'CONFIRMED_MANUALLY';

    public function getId(): string
    {
        return $this->get('id');
    }

    public function getIndex(): ?string
    {
        return $this->get('index');
    }

    public function getArea(): ?string
    {
        return $this->get('area');
    }

    public function getPlace(): ?string
    {
        return $this->get('place');
    }

    public function getRegion(): ?string
    {
        return $this->get('region');
    }

    public function getLocation(): ?string
    {
        return $this->get('location');
    }

    public function getStreet(): ?string
    {
        return $this->get('street');
    }

    public function getHouse(): ?string
    {
        return $this->get('house');
    }

    public function getRoom(): ?string
    {
        return $this->get('room');
    }

    public function getSlash(): ?string
    {
        return $this->get('slash');
    }

    public function getBuilding(): ?string
    {
        return $this->get('building');
    }

    public function getCorpus(): ?string
    {
        return $this->get('corpus');
    }

    public function getLetter(): ?string
    {
        return $this->get('letter');
    }

    public function getHotel(): ?string
    {
        return $this->get('hotel');
    }

    public function getNumAddressType(): ?string
    {
        return $this->get('num-address-type');
    }

    public function getOriginalAddress(): string
    {
        return $this->get('original-address');
    }

    public function getAddressType(): string
    {
        return $this->get('address-type');
    }

    public function getQualityCode(): string
    {
        return $this->get('quality-code');
    }

    public function getValidationCode(): string
    {
        return $this->get('validation-code');
    }

    public function isUseful(): bool
    {
        $quality = \in_array($this->getQualityCode(), [
            self::QUALITY_GOOD, self::QUALITY_POSTAL_BOX, self::QUALITY_ON_DEMAND, self::QUALITY_UNDEF_05,
        ]);

        $validity = \in_array($this->getValidationCode(), [
            self::VALIDATION_VALIDATED, self::VALIDATION_OVERRIDDEN, self::VALIDATION_CONFIRMED_MANUALLY,
        ]);

        return $quality && $validity;
    }
}