Respect\Validation\Result

Complexity

Total Complexity

10

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

85.71%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	isValid()	0	4	1
A	getInput()	0	4	1
A	getRule()	0	4	1
A	getChildren()	0	4	1
A	getProperties()	0	4	1
A	isInverted()	0	4	1
A	invert()	0	8	1
A	getIterator()	0	4	1
A	hasChildren()	0	4	1

<?php

/*
 * This file is part of Respect/Validation.
 *
 * (c) Alexandre Gomes Gaigalas <alexandre@gaigalas.net>
 *
 * For the full copyright and license information, please view the "LICENSE.md"
 * file that was distributed with this source code.
 */

namespace Respect\Validation;

use IteratorAggregate;

/**
 * Handles validation's results.
 *
 * @author Henrique Moody <henriquemoody@gmail.com>
 *
 * @since 2.0.0
 */
final class Result implements IteratorAggregate
{
    /**
     * @var bool
     */
    private $isValid;

    /**
     * @var mixed
     */
    private $input;

    /**
     * @var Rule
     */
    private $rule;

    /**
     * @var Result[]
     */
    private $children;

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

    /**
     * @var bool
     */
    private $isInverted = false;

    /**
     * Initializes the object.
     *
     * @param bool   $isValid
     * @param mixed  $input
     * @param Rule   $rule
     * @param array  $properties
     * @param Result $child
     * @param Result ...$child2
     */
    public function __construct(bool $isValid, $input, Rule $rule, array $properties = [], Result ...$child)
    {
        $this->isValid = $isValid;
        $this->input = $input;
        $this->rule = $rule;
        $this->properties = $properties;
        $this->children = $child;
    }

    /**
     * Returns whether the result is valid or not.
     *
     * @return bool
     */
    public function isValid(): bool
    {
        return $this->isValid;
    }

    /**
     * Returns the input that was used on the validation.
     *
     * @return mixed
     */
    public function getInput()
    {
        return $this->input;
    }

    /**
     * Returns the rule that performed the validation.
     *
     * @return Rule
     */
    public function getRule(): Rule
    {
        return $this->rule;
    }

    /**
     * Returns the children of the result.
     *
     * @return Result[]
     */
    public function getChildren(): array
    {
        return $this->children;
    }

    /**
     * Returns the properties of the result.
     *
     * @return array
     */
    public function getProperties(): array
    {
        return $this->properties;
    }

    /**
     * Returns whether the result is inverted or not.
     *
     * @return bool
     */
    public function isInverted(): bool
    {
        return $this->isInverted;
    }

    /**
     * Creates a new object with the inverted validation.
     *
     * @return Result
     */
    public function invert(): Result
    {
        $result = clone $this;
        $result->isValid = !$result->isValid;
        $result->isInverted = !$result->isInverted;

        return $result;
    }

    public function getIterator(): ResultIterator
    {
        return new ResultIterator($this);
    }

    public function hasChildren(): bool
    {
        return count($this->children) > 0;
    }
}