League\JsonGuard\ValidationError

Complexity

Total Complexity

12

Size/Duplication

Total Lines	180
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

87.88%

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	getMessage()	0	4	1
A	getCode()	0	4	1
A	getPointer()	0	4	1
A	getValue()	0	4	1
A	getConstraints()	0	4	1
A	toArray()	0	10	1
A	offsetGet()	0	5	2
A	offsetSet()	0	5	1
A	offsetUnset()	0	5	1
A	offsetExists()	0	4	1

<?php

namespace League\JsonGuard;

class ValidationError implements \ArrayAccess
{
    /**
     * @var string
     */
    private $message;

    /**
     * @var int
     */
    private $code;

    /**
     * @var string|null
     */
    private $pointer;

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

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

    /**
     * @param string      $message
     * @param int         $code
     * @param mixed       $value
     * @param string|null $pointer
     * @param array       $constraints
     */
    public function __construct($message, $code, $value, $pointer = null, array $constraints = [])
    {
        $this->message     = $message;
        $this->code        = $code;
        $this->pointer     = $pointer;
        $this->value       = $value;
        $this->constraints = $constraints;
    }

    /**
     * Get the human readable error message for this error.
     *
     * @return string
     */
    public function getMessage()
    {
        return $this->message;
    }

    /**
     * Get the error code for this error.
     *
     * @return int
     */
    public function getCode()
    {
        return $this->code;
    }

    /**
     * Get the path to the property that failed validation.
     *
     * @return string|null
     */
    public function getPointer()
    {
        return $this->pointer;
    }

    /**
     * Get the value that caused the assertion to fail.
     *
     * @return mixed
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Get the constraints that applied to the failed assertion.
     *
     * @return array
     */
    public function getConstraints()
    {
        return $this->constraints;
    }

    /**
     * @return array
     */
    public function toArray()
    {
        return [
            'code'        => $this->getCode(),
            'message'     => $this->getMessage(),
            'pointer'     => $this->getPointer(),
            'value'       => $this->getValue(),
            'constraints' => $this->getConstraints(),
        ];
    }

    /**
     * Whether a offset exists
     * @link  http://php.net/manual/en/arrayaccess.offsetexists.php
     *
     * @param mixed $offset <p>
     *                      An offset to check for.
     *                      </p>
     *
     * @return boolean true on success or false on failure.
     * </p>
     * <p>
     * The return value will be casted to boolean if non-boolean was returned.
     * @since 5.0.0
     */
    public function offsetExists($offset)
    {
        return array_key_exists($offset, $this->toArray());
    }

    /**
     * Offset to retrieve
     * @link  http://php.net/manual/en/arrayaccess.offsetget.php
     *
     * @param mixed $offset <p>
     *                      The offset to retrieve.
     *                      </p>
     *
     * @return mixed Can return all value types.
     * @since 5.0.0
     */
    public function offsetGet($offset)
    {
        $errorArray = $this->toArray();
        return array_key_exists($offset, $errorArray) ? $errorArray[$offset] : null;
    }

    /**
     * Offset to set
     * @link  http://php.net/manual/en/arrayaccess.offsetset.php
     *
     * @param mixed $offset <p>
     *                      The offset to assign the value to.
     *                      </p>
     * @param mixed $value  <p>
     *                      The value to set.
     *                      </p>
     *
     * @return void
     * @since 5.0.0
     */
    public function offsetSet($offset, $value)
    {
        // A ValidationError is immutable.
        return null;
    }

    /**
     * Offset to unset
     * @link  http://php.net/manual/en/arrayaccess.offsetunset.php
     *
     * @param mixed $offset <p>
     *                      The offset to unset.
     *                      </p>
     *
     * @return void
     * @since 5.0.0
     */
    public function offsetUnset($offset)
    {
        // A ValidationError is immutable.
        return null;
    }
}