Huntie\JsonApi\Serializers\JsonApiSerializer

Complexity

Total Complexity

11

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
	getPrimaryData()	0	1	?
A	__construct()	0	5	1
A	addMeta()	0	4	2
A	addLinks()	0	4	2
A	serializeToObject()	0	10	1
A	jsonSerialize()	0	4	1
A	serializeToJson()	0	4	1
A	getIncludedData()	0	4	1
A	getDocumentMeta()	0	6	2

<?php

namespace Huntie\JsonApi\Serializers;

use JsonSerializable;

abstract class JsonApiSerializer implements JsonSerializable
{
    /**
     * The JSON API version being implemented.
     *
     * @var string
     */
    const JSON_API_VERSION = '1.0';

    /**
     * Meta information to include.
     *
     * @var \Illuminate\Support\Collection
     */
    protected $meta;

    /**
     * Resource links to include.
     *
     * @var \Illuminate\Support\Collection
     */
    protected $links;

    /**
     * Create a new JSON API document serializer.
     */
    public function __construct()
    {
        $this->meta = collect([]);
        $this->links = collect([]);
    }

    /**
     * Return primary data for the JSON API document.
     *
     * @return mixed
     */
    abstract protected function getPrimaryData();

    /**
     * Add included meta information.
     *
     * @param string|array    $key
     * @param string|int|null $value
     */
    public function addMeta($key, $value = null)
    {
        $this->meta = $this->meta->merge(is_array($key) ? $key : [$key => $value]);
    }

    /**
     * Add one or more included links.
     *
     * @param string|array    $key
     * @param string|int|null $value
     */
    public function addLinks($key, $value = null)
    {
        $this->links = $this->links->merge(is_array($key) ? $key : [$key => $value]);
    }

    /**
     * Serialise JSON API document to an array.
     *
     * @return array
     */
    public function serializeToObject()
    {
        return array_filter([
            'data' => $this->getPrimaryData(),
            'links' => $this->links->toArray(),
            'meta' => $this->meta->toArray(),
            'included' => $this->getIncludedData(),
            'jsonapi' => $this->getDocumentMeta(),
        ]);
    }

    /**
     * Convert the object into something JSON serializable.
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return $this->serializeToObject();
    }

    /**
     * Serialise JSON API document to a JSON string.
     *
     * @return array
     */
    public function serializeToJson()
    {
        return json_encode($this->jsonSerialize());
    }

    /**
     * Return any secondary included resource data.
     *
     * @return array
     */
    protected function getIncludedData()
    {
        return [];
    }

    /**
     * Return JSON API implementation information.
     *
     * @return array
     */
    private function getDocumentMeta()
    {
        return array_filter([
            'version' => config('jsonapi.include_version') ? self::JSON_API_VERSION : null,
        ]);
    }
}