Chanmix51\ParameterJuicer\Exception\ValidationException

Complexity

Total Complexity

9

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	addException()	0	6	1
A	hasExceptions()	0	4	1
A	getExceptions()	0	4	1
A	getFancyMessage()	0	4	1
A	getSubFancyMessage()	0	28	4
A	__toString()	0	4	1

<?php
/*
 * This file is part of Chanmix51’s ParameterJuicer package.
 *
 * (c) 2017 Grégoire HUBERT <hubert.greg@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Chanmix51\ParameterJuicer\Exception;

/**
 * ValidationException
 *
 * Store exceptions from the validation process.
 *
 * @package     ParameterJuicer
 * @copyright   2017 Grégoire HUBERT
 * @author      Grégoire HUBERT <hubert.greg@gmail.com>
 * @license     X11 {@link http://opensource.org/licenses/mit-license.php}
 *
 * @see         \Exception
 */
class ValidationException extends ParameterJuicerException
{
    /** @var  array contains all the set’s exceptions */
    private $exceptions = [];

    /**
     * addMessage
     *
     * Add a new message to the exception.
     */
    public function addException(string $field, ValidationException $exception): self
    {
        $this->exceptions[$field][] = $exception;

        return $this;
    }

    /**
     * hasExceptions
     *
     * Indicates if yes or no some exceptions have been set.
     */
    public function hasExceptions(): bool
    {
        return count($this->exceptions) > 0;
    }

    /**
     * getExceptions
     *
     * Return the list of exceptions.
     */
    public function getExceptions(): array
    {
        return $this->exceptions;
    }

    /**
     * getFancyMessage
     *
     * Output a nicely formatted validation error messages.
     */
    public function getFancyMessage(): string
    {
        return sprintf("%s\n", $this->getMessage()) . $this->getSubFancyMessage();
    }

    /**
     * getSubFancyMessage
     *
     * Subrouting to display validation errors.
     */
    public function getSubFancyMessage(int $level = 0): string
    {
        $output = '';

        foreach ($this->exceptions as $field => $exceptions) {
            $output .= sprintf(
                "%s[%s] - %s\n",
                str_repeat(' ', $level * 4 + 2),
                $field,
                join(
                    ' | ',
                    array_map(
                        function (ValidationException $e) {
                            return $e->getMessage();
                        },
                        $exceptions
                    )
                )
            );
            foreach ($exceptions as $exception) {
                if ($exception->hasExceptions()) {
                    $output .= $exception->getSubFancyMessage($level + 1);
                }
            }
        }

        return $output;
    }

    /**
     * __toString
     *
     * String representation of this exception.
     */
    public function __toString(): string
    {
        return $this->getFancyMessage();
    }
}