WebServCo\Api\JsonApi\Document

Complexity

Total Complexity

14

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setMeta()	0	4	1
A	setData()	0	4	1
A	setStatusCode()	0	4	1
A	setError()	0	5	1
A	toJson()	0	4	1
A	__construct()	0	8	1
A	getStatusCode()	0	3	1
B	toArray()	0	25	7

<?php

declare(strict_types=1);

namespace WebServCo\Api\JsonApi;

use WebServCo\Api\JsonApi\Interfaces\ResourceObjectInterface;

class Document implements \WebServCo\Framework\Interfaces\JsonInterface
{
    public const CONTENT_TYPE = 'application/vnd.api+json';
    public const VERSION = '1.0';

    /**
     * Meta.
     *
     * @var array<string,mixed>
     */
    protected array $meta;

    /**
     * JSON API
     *
     * @var array<string,string>
     */
    protected array $jsonapi;

    /**
    * Data.
    *
    * @var array<int,\WebServCo\Api\JsonApi\Interfaces\ResourceObjectInterface>
    */
    protected array $data;

    /**
    * Errors.
    *
    * @var array<int,\WebServCo\Api\JsonApi\Error>
    */
    protected array $errors;

    protected int $statusCode;

    protected bool $useDataItemCollection;

    /**
     * https://jsonapi.org/format/#document-top-level
     *
     * Primary data MUST be either:
     * - a single resource object, a single resource identifier object, or null,
     * for requests that target single resources
     * - an array of resource objects, an array of resource identifier objects, or an empty array ([]),
     * for requests that target resource collections
     */
    public function __construct(bool $useDataItemCollection = false)
    {
        $this->meta = [];
        $this->jsonapi = ['version' => self::VERSION];
        $this->data = [];
        $this->errors = [];
        $this->statusCode = 200;
        $this->useDataItemCollection = $useDataItemCollection;
    }

    public function getStatusCode(): int
    {
        return $this->statusCode;
    }

    public function setData(ResourceObjectInterface $resourceObject): bool
    {
        $this->data[] = $resourceObject;
        return true;
    }

    public function setError(Error $error): bool
    {
        $this->errors[] = $error;
        $this->statusCode = $error->getStatus(); // set status code of last error.
        return true;
    }

    /**
    * @param mixed $value
    */
    public function setMeta(string $key, $value): bool
    {
        $this->meta[$key] = $value;
        return true;
    }

    public function setStatusCode(int $statusCode): bool
    {
        $this->statusCode = $statusCode;
        return true;
    }

    /**
    * @return array<string,mixed>
    */
    public function toArray(): array
    {
        $array = [
            'jsonapi' => $this->jsonapi,
        ];
        if (!empty($this->errors)) {
            foreach ($this->errors as $error) {
                $array['errors'][] = $error->toArray();
            }
        } else {
            if ($this->useDataItemCollection) {
                $array['data'] = [];
                foreach ($this->data as $item) {
                    $array['data'][] = $item->toArray();
                }
            } else {
                $array['data'] = \array_key_exists(0, $this->data)
                    ? $this->data[0]->toArray() // one item
                    : null; // no data
            }
        }
        if ($this->meta) {

The expression $this->meta of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            $array['meta'] = $this->meta;
        }
        return $array;
    }

    public function toJson(int $flags = 0): string
    {
        $array = $this->toArray();
        return (string) \json_encode($array, $flags);
    }
}