VGirol\JsonApiFaker\Factory\HasErrors

Complexity

Total Complexity

7

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setErrors()	0	11	3
A	getErrors()	0	3	1
A	fakeErrors()	0	10	2
A	addError()	0	5	1

<?php

declare(strict_types=1);

namespace VGirol\JsonApiFaker\Factory;

use VGirol\JsonApiFaker\Contract\ErrorContract;
use VGirol\JsonApiFaker\Exception\JsonApiFakerException;
use VGirol\JsonApiFaker\Messages;

/**
 * Add "errors" member
 */
trait HasErrors
{
    /**
     * The "errors" member
     *
     * @var array An array of objects implementing ErrorContract
     */
    protected $errors;

    /**
     * Set the "errors" member
     *
     * @param array $errors An array of objects implementing ErrorContract
     *
     * @return static
     * @throws JsonApiFakerException
     */
    public function setErrors(array $errors)
    {
        foreach ($errors as $error) {
            if (is_a($error, ErrorContract::class) === false) {
                throw new JsonApiFakerException(Messages::SET_ERRORS_BAD_TYPE);
            }
        }

        $this->errors = $errors;

        return $this;
    }

    /**
     * Get the "errors" member
     *
     * An array of ErrorContract objects
     *
     * @return array|null
     */
    public function getErrors(): ?array
    {
        return $this->errors;
    }

    /**
     * Add a single error to the "errors" member
     *
     * @param ErrorContract $error
     *
     * @return static
     */
    public function addError(ErrorContract $error)
    {
        $this->addToArray('errors', $error);

It seems like addToArray() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    /**
     * Fill the "errors" member with fake values
     *
     * @param integer $count
     *
     * @return static
     * @throws JsonApiFakerException
     */
    public function fakeErrors(int $count = 2)
    {
        $collection = [];
        for ($i = 0; $i < $count; $i++) {
            $collection[] = $this->generator
                ->error()
                ->fake();
        }

        return $this->setErrors($collection);
    }
}