Brazanation\Documents\AbstractDocument

Complexity

Total Complexity

14

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

91.89%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__get()	0	4	1
A	__set()	0	4	1
	createFromString()	0	1	?
A	__construct()	0	13	1
A	tryCreateFromString()	0	13	2
A	__toString()	0	4	1
A	assert()	0	9	3
A	isValid()	0	18	3
A	extractBaseNumber()	0	4	1
A	extractCheckerDigit()	0	4	1

<?php

namespace Brazanation\Documents;

/**
 * Class AbstractDocument
 *
 * @package Brazanation\Documents
 *
 * @property string $number
 * @property string $digit
 * @property int $length
 * @property int $numberOfDigits
 * @property string $type
 */
abstract class AbstractDocument implements DigitCalculable, Formattable
{
    /**
     * @var string
     */
    protected $number;

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

    /**
     * @var int
     */
    protected $length;

    /**
     * @var int
     */
    protected $numberOfDigits;

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

    /**
     * AbstractDocument constructor.
     *
     * @param string $number Numeric section with checker digit.
     * @param int $length Max length of document.
     * @param int $numberOfDigits Max length of checker digits.
     * @param string $type Document name/type.
     */
    public function __construct(
        string $number,
        int $length,
        int $numberOfDigits,
        string $type
    ) {
        $this->type = $type;
        $this->numberOfDigits = $numberOfDigits;
        $this->length = $length;
        $this->digit = $this->extractCheckerDigit($number);
        $this->assert($number);
        $this->number = $number;
    }

    public function __get(string $name)
    {
        return $this->$name;
    }

    public function __set(string $name, string $value)
    {
        throw Exception\Readonly::notAllowed(static::class, $name);
    }

    /**
     * Create a Document object from given number.
     *
     * @param string $number Numeric section with checker digit.
     *
     * @return AbstractDocument|boolean Returns a new Document instance or FALSE on failure.
     */
    abstract public static function createFromString(string $number);

    /**
     * Try to create a Document object from given number.
     *
     * @param string $number Numeric section with checker digit.
     * @param int $length Max length of document.
     * @param int $numberOfDigits Max length of checker digits.
     * @param string $type Document name/type.
     *
     * @return AbstractDocument|boolean Returns a new Document instance or FALSE on failure.
     */
    protected static function tryCreateFromString(
        string $class,
        string $number,
        int $length,
        int $numberOfDigits,
        string $type
    ) {
        try {
            return new $class($number, $length, $numberOfDigits, $type);
        } catch (Exception\InvalidDocument $exception) {
            return false;
        }
    }

    /**
     * Handle number to string.
     *
     * @return string
     */
    public function __toString() : string
    {
        return "{$this->number}";
    }

    /**
     * Check if document number is valid.
     *
     * @param string $number Numeric section with checker digit.
     *
     * @throws Exception\InvalidDocument when number is empty
     * @throws Exception\InvalidDocument when number is not valid
     */
    protected function assert(string $number)
    {
        if (empty($number)) {
            throw Exception\InvalidDocument::notEmpty($this->type);
        }
        if (!$this->isValid($number)) {
            throw Exception\InvalidDocument::isNotValid($this->type, $number);
        }
    }

    /**
     * Validates number is a valid.
     *
     * @param string $number Numeric section with checker digit.
     *
     * @return bool Returns true if it is a valid number, otherwise false.
     */
    protected function isValid(string $number) : bool
    {
        $baseNumber = $this->extractBaseNumber($number);

        if (!$baseNumber) {
            return false;
        }

        $isRepeated = preg_match("/^[{$baseNumber[0]}]+$/", $baseNumber);

        if ($isRepeated) {
            return false;
        }

        $digit = $this->calculateDigit($baseNumber);

        return "$digit" === "{$this->digit}";
    }

    /**
     * Extracts the base number document.
     *
     * @param string $number Number of document.
     *
     * @return string Returns only base number without checker digit.
     */
    protected function extractBaseNumber(string $number) : string
    {
        return substr($number, 0, -($this->numberOfDigits));
    }

    /**
     * Extracts the checker digit from document number.
     *
     * @param string $number Number of document.
     *
     * @return string Returns only checker digit.
     */
    protected function extractCheckerDigit(string $number) : string
    {
        return substr($number, -($this->numberOfDigits));
    }
}