Pulsar\Errors

Complexity

Total Complexity

26

Size/Duplication

Total Lines	206
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	setTranslator()	0	4	1
A	clearTranslator()	0	4	1
A	getTranslator()	0	8	2
A	add()	0	7	1
A	all()	0	9	2
A	find()	0	11	3
A	has()	0	13	3
A	clear()	0	6	1
A	__toString()	0	4	1
A	sanitize()	0	8	2
A	parse()	0	4	1
A	getIterator()	0	4	1
A	count()	0	4	1
A	offsetExists()	0	4	1
A	offsetGet()	0	8	2
A	offsetSet()	0	8	2
A	offsetUnset()	0	4	1

<?php

/**
 * @author Jared King <j@jaredtking.com>
 *
 * @see http://jaredtking.com
 *
 * @copyright 2015 Jared King
 * @license MIT
 */

namespace Pulsar;

use ArrayAccess;
use ArrayIterator;
use Countable;
use IteratorAggregate;
use Pulsar\Interfaces\TranslatorInterface;

/**
 * Holds error messages generated by models, like validation errors.
 */
final class Errors implements IteratorAggregate, Countable, ArrayAccess
{
    /**
     * @var TranslatorInterface|null
     */
    private static $translator;

    /**
     * @var Error[]
     */
    private $stack = [];

    /**
     * Sets the global translator instance.
     */
    public static function setTranslator(TranslatorInterface $translator)
    {
        self::$translator = $translator;
    }

    /**
     * Clears the global translator instance.
     */
    public static function clearTranslator(): void
    {
        self::$translator = null;
    }

    /**
     * Gets the translator.
     */
    public function getTranslator(): TranslatorInterface
    {
        if (!self::$translator) {
            self::$translator = new Translator();
        }

        return self::$translator;
    }

    /**
     * Adds an error message to the stack.
     *
     * @param $error
     *
     * @return $this
     */
    public function add(string $error, array $context = [])
    {
        $message = $this->parse($error, $context);
        $this->stack[] = new Error($error, $context, $message);

        return $this;
    }

    /**
     * Gets all of the error messages on the stack.
     *
     * @return string[]
     */
    public function all(): array
    {
        $messages = [];
        foreach ($this->stack as $error) {
            $messages[] = $error->getMessage();
        }

        return $messages;
    }

    /**
     * Gets an error for a specific parameter on the stack.
     *
     * @param string $value value we are searching for
     * @param string $param parameter name
     */
    public function find($value, $param = 'field'): ?Error
    {
        foreach ($this->stack as $error) {
            $stackValue = $error->getContext()[$param] ?? null;
            if ($stackValue === $value) {
                return $error;
            }
        }

        return null;
    }

    /**
     * Checks if an error exists with a specific parameter on the stack.
     *
     * @param string $value value we are searching for
     * @param string $param parameter name
     */
    public function has($value, $param = 'field'): bool
    {
        foreach ($this->stack as $error) {
            $stackValue = $error->getContext()[$param] ?? null;
            if ($stackValue !== $value) {
                continue;
            }

            return true;
        }

        return false;
    }

    /**
     * Clears the error stack.
     *
     * @return $this
     */
    public function clear()
    {
        $this->stack = [];

        return $this;
    }

    public function __toString()
    {
        return implode("\n", $this->all());
    }

    //////////////////////////
    // Helpers
    //////////////////////////

    /**
     * Formats an incoming error message.
     *
     * @param array|string $input
     */
    private function sanitize($input): Error
    {
        $error = is_array($input) ? $input['error'] : $input;
        $context = $input['context'] ?? [];
        $message = $this->parse($error, $context);

        return new Error($error, $context, $message);
    }

    /**
     * Parses an error message before displaying it.
     */
    private function parse(string $error, array $context): string
    {
        return $this->getTranslator()->translate($error, $context, null);
    }

    //////////////////////////
    // IteratorAggregate Interface
    //////////////////////////

    public function getIterator()
    {
        return new ArrayIterator($this->stack);
    }

    //////////////////////////
    // Countable Interface
    //////////////////////////

    /**
     * Get total number of models matching query.
     *
     * @return int
     */
    public function count()
    {
        return count($this->stack);
    }

    /////////////////////////////
    // ArrayAccess Interface
    /////////////////////////////

    public function offsetExists($offset)
    {
        return isset($this->stack[$offset]);
    }

    public function offsetGet($offset)
    {
        if (!$this->offsetExists($offset)) {
            throw new \OutOfBoundsException("$offset does not exist on this error stack");
        }

        return $this->stack[$offset];
    }

    public function offsetSet($offset, $error)
    {
        if (!is_numeric($offset)) {
            throw new \Exception('Can only perform set on numeric indices');
        }

        $this->stack[$offset] = $this->sanitize($error);
    }

    public function offsetUnset($offset)
    {
        unset($this->stack[$offset]);
    }
}