Iris\Validator\AbstractValidator

Complexity

Total Complexity

6

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	2

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	isValid()	0	13	2
	validate()	0	1	?
A	getErrors()	0	8	2
A	getExpectedValidatorName()	0	10	1

<?php

namespace Iris\Validator;

use Iris\Transfer\Tracking\AbstractTracking;

abstract class AbstractValidator
{
    /**
     * @var array
     */
    protected $errors;

    /**
     * @var bool
     */
    protected $isValid;

    /**
     * @var bool
     */
    protected $isValidCalled;

    public function __construct()
    {
        $this->errors = [];
        $this->isValid = false;
        $this->isValidCalled = false;
    }

    /**
     * @param AbstractTracking $transfer
     * @throws \RuntimeException
     * @return bool
     */
    public function isValid(AbstractTracking $transfer)
    {
        $expectedTransferClass = $this->getExpectedValidatorName($this);

        if (!$transfer instanceof $expectedTransferClass) {
            throw new \RuntimeException(sprintf('Must be %s as parameter', $expectedTransferClass));
        }

        $this->isValid = $this->validate($transfer);
        $this->isValidCalled = true;

        return $this->isValid;
    }

    /**
     * The implementation must add the errors into the errors property. For example:
     *
     * $this->errors = [
     *    0 => 'error 1',
     *    1 => 'error 2',
     * ]
     *
     * @param $transfer
     * @return bool
     */
    protected abstract function validate($transfer);

The abstract declaration must precede the visibility declaration

    /**
     * @return array
     * @throws \RuntimeException
     */
    public function getErrors()
    {
        if (!$this->isValidCalled) {
            throw new \RuntimeException('You must call the isValid first');
        }

        return $this->errors;
    }

    /**
     * @param AbstractValidator $validator
     * @return string
     */
    protected function getExpectedValidatorName(AbstractValidator $validator)
    {
        $validatorClassName = get_class($validator);

        $path = explode('\\', $validatorClassName);

        $className = array_pop($path);

        return '\Iris\Transfer\Tracking\\' . $className;
    }
}