Mikemirten\Component\JsonApi\Document\Behaviour\ErrorsContainer

Complexity

Total Complexity

5

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	addError()	0	4	1
A	hasErrors()	0	4	1
A	getErrors()	0	4	1
A	errorsToArray()	0	11	2

<?php
declare(strict_types = 1);

namespace Mikemirten\Component\JsonApi\Document\Behaviour;

use Mikemirten\Component\JsonApi\Document\ErrorObject;

/**
 * Errors-container behaviour
 *
 * @see http://jsonapi.org/format/#errors
 *
 * @package Mikemirten\Component\JsonApi\Document\Behaviour
 */
trait ErrorsContainer
{
    /**
     * @var ErrorObject[];
     */
    protected $errors = [];

    /**
     * Add error
     *
     * @param ErrorObject $error
     */
    public function addError(ErrorObject $error)
    {
        $this->errors[] = $error;
    }

    /**
     * Contains any errors ?
     *
     * @return bool
     */
    public function hasErrors(): bool
    {
        return count($this->errors) > 0;
    }

    /**
     * Get all errors
     *
     * @return ErrorObject[]
     */
    public function getErrors(): array
    {
        return $this->errors;
    }

    /**
     * Cast errors to an array
     *
     * @return array
     */
    protected function errorsToArray(): array
    {
        $errors = [];

        foreach ($this->errors as $error)
        {
            $errors[] = $error->toArray();
        }

        return $errors;
    }
}