Limoncello\Application\FormValidation\Validator

Complexity

Total Complexity

22

Size/Duplication

Total Lines	269
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

100%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	validate()	0	16	3
A	resetAggregators()	0	8	1
A	getContextStorage()	0	4	1
A	createContextStorage()	0	4	1
A	validateAttributes()	0	18	3
A	executeBlock()	0	11	1
A	executeStarts()	0	9	1
A	executeEnds()	0	9	1
A	setAttributeRules()	0	8	1
A	getAttributeRules()	0	4	1
A	getBlocks()	0	4	1
A	setBlocks()	0	6	1
A	getAttributeIndex()	0	7	1
A	debugCheckIndexesExist()	0	16	4

<?php namespace Limoncello\Application\FormValidation;

/**
 * Copyright 2015-2017 info@neomerx.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Limoncello\Application\Contracts\Validation\FormValidatorInterface;
use Limoncello\Application\Exceptions\InvalidArgumentException;
use Limoncello\Application\FormValidation\Execution\ContextStorage;
use Limoncello\Application\FormValidation\Execution\FormRuleSerializer;
use Limoncello\Container\Traits\HasContainerTrait;
use Limoncello\Validation\Contracts\Errors\ErrorCodes;
use Limoncello\Validation\Contracts\Execution\ContextStorageInterface;
use Limoncello\Validation\Errors\Error;
use Limoncello\Validation\Execution\BlockInterpreter;
use Limoncello\Validation\Validator\BaseValidator;
use Psr\Container\ContainerInterface;

/**
 * @package Limoncello\Flute
 *
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
 */
class Validator extends BaseValidator implements FormValidatorInterface
{
    use HasContainerTrait;

    /**
     * Namespace for string resources.
     */
    const RESOURCES_NAMESPACE = 'Limoncello.Flute.Validation';

    /** Rule description index */
    const RULE_INDEX = 0;

    /** Rule description index */
    const RULE_ATTRIBUTES = self::RULE_INDEX + 1;

    /** Rule description index */
    const RULE_TO_ONE = self::RULE_ATTRIBUTES + 1;

    /** Rule description index */
    const RULE_TO_MANY = self::RULE_TO_ONE + 1;

    /** Rule description index */
    const RULE_UNLISTED_ATTRIBUTE = self::RULE_TO_MANY + 1;

    /** Rule description index */
    const RULE_UNLISTED_RELATIONSHIP = self::RULE_UNLISTED_ATTRIBUTE + 1;

    /**
     * @var ContextStorageInterface
     */
    private $contextStorage;

    /**
     * @var array
     */
    private $blocks;

    /**
     * @var int[]
     */
    private $attributeRules;

    /**
     * @param string             $name
     * @param array              $data
     * @param ContainerInterface $container
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    public function __construct(string $name, array $data, ContainerInterface $container)
    {
        $this
            ->setContainer($container)
            ->setBlocks(FormRuleSerializer::extractBlocks($data))
            ->setAttributeRules(FormRuleSerializer::getAttributeRules($name, $data));

        parent::__construct();
    }

    /**
     * @inheritdoc
     *
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    public function validate($input): bool
    {
        if (is_array($input) === false) {
            throw new InvalidArgumentException();
        }

        if ($this->areAggregatorsDirty() === true) {
            $this->resetAggregators();
        }

        $this->validateAttributes($input)->markAggregatorsAsDirty();

        $hasNoErrors = $this->getErrorAggregator()->count() <= 0;

The method getErrorAggregator() does not seem to exist on object<Limoncello\Application\FormValidation\Validator>.

        return $hasNoErrors;
    }

    /**
     * @return BaseValidator

Consider making the return type a bit more specific; maybe use Validator.

     */
    protected function resetAggregators(): BaseValidator
    {
        $self = parent::resetAggregators();

        $this->contextStorage = $this->createContextStorage();

        return $self;
    }

    /**
     * @return ContextStorageInterface
     */
    protected function getContextStorage(): ContextStorageInterface
    {
        return $this->contextStorage;
    }

    /**
     * @return ContextStorageInterface
     */
    protected function createContextStorage(): ContextStorageInterface
    {
        return new ContextStorage($this->getContainer(), $this->getBlocks());
    }

    /**
     * @param array $attributes
     *
     * @return self
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    private function validateAttributes(array $attributes): self
    {
        // execute start(s)
        $this->executeStarts(FormRuleSerializer::getRulesStartIndexes($this->getAttributeRules()));

        foreach ($attributes as $name => $value) {
            if (($index = $this->getAttributeIndex($name)) !== null) {
                $this->executeBlock($value, $index);
            } else {
                $this->getErrorAggregator()->add(new Error($name, $value, ErrorCodes::INVALID_VALUE, null));

The method getErrorAggregator() does not seem to exist on object<Limoncello\Application\FormValidation\Validator>.

            }
        }

        // execute end(s)
        $this->executeEnds(FormRuleSerializer::getRulesEndIndexes($this->getAttributeRules()));

        return $this;
    }

    /**
     * @param mixed $input
     * @param int   $index
     *
     * @return void
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    private function executeBlock($input, int $index): void
    {
        BlockInterpreter::executeBlock(
            $input,
            $index,
            $this->getBlocks(),
            $this->getContextStorage(),
            $this->getCaptureAggregator(),

The method getCaptureAggregator() does not seem to exist on object<Limoncello\Application\FormValidation\Validator>.

            $this->getErrorAggregator()

The method getErrorAggregator() does not seem to exist on object<Limoncello\Application\FormValidation\Validator>.

        );
    }

    /**
     * @param array $indexes
     *
     * @return void
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    private function executeStarts(array $indexes): void
    {
        BlockInterpreter::executeStarts(
            $indexes,
            $this->getBlocks(),
            $this->getContextStorage(),
            $this->getErrorAggregator()

The method getErrorAggregator() does not seem to exist on object<Limoncello\Application\FormValidation\Validator>.

        );
    }

    /**
     * @param array $indexes
     *
     * @return void
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    private function executeEnds(array $indexes): void
    {
        BlockInterpreter::executeEnds(
            $indexes,
            $this->getBlocks(),
            $this->getContextStorage(),
            $this->getErrorAggregator()

The method getErrorAggregator() does not seem to exist on object<Limoncello\Application\FormValidation\Validator>.

        );
    }

    /**
     * @param array $rules
     *
     * @return self
     */
    private function setAttributeRules(array $rules): self
    {
        assert($this->debugCheckIndexesExist($rules));

        $this->attributeRules = $rules;

        return $this;
    }

    /**
     * @return int[]
     */
    private function getAttributeRules(): array
    {
        return $this->attributeRules;
    }

    /**
     * @return array
     */
    private function getBlocks(): array
    {
        return $this->blocks;
    }

    /**
     * @param array $blocks
     *
     * @return self
     */
    private function setBlocks(array $blocks): self
    {
        $this->blocks = $blocks;

        return $this;
    }

    /**
     * @param string $name
     *
     * @return int|null
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    private function getAttributeIndex(string $name): ?int
    {
        $indexes = FormRuleSerializer::getRulesIndexes($this->getAttributeRules());
        $index   = $indexes[$name] ?? null;

        return $index;
    }

    /**
     * @param array $rules
     *
     * @return bool
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    private function debugCheckIndexesExist(array $rules): bool
    {
        $allOk = true;

        $indexes = array_merge(
            FormRuleSerializer::getRulesIndexes($rules),
            FormRuleSerializer::getRulesStartIndexes($rules),
            FormRuleSerializer::getRulesEndIndexes($rules)
        );

        foreach ($indexes as $index) {
            $allOk = $allOk && is_int($index) && FormRuleSerializer::isRuleExist($index, $this->getBlocks());
        }

        return $allOk;
    }
}