Huntie\JsonApi\Serializers\JsonApiSerializer

Complexity

Total Complexity

14

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	scopeIncludes()	0	4	1
A	addMeta()	0	4	2
A	addLinks()	0	4	2
A	toResourceObject()	0	6	1
A	toResourceIdentifier()	0	7	1
A	serialiseToObject()	0	9	4
A	serializeToJson()	0	4	1
A	getRecordType()	0	4	1

<?php

namespace Huntie\JsonApi\Serializers;

class JsonApiSerializer
{
    /**
     * The model instance to transform.
     *
     * @var \Illuminate\Database\Eloquent\Model
     */
    protected $record;

    /**
     * The subset of record attributes to return.
     *
     * @var array
     */
    protected $fields;

    /**
     * The record relations to include.
     *
     * @var array
     */
    protected $include;

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

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

    /**
     * The loaded records to include.
     *
     * @var \Illuminate\Support\Collection
     */
    protected $included;

    /**
     * Create a new JSON API resource serializer.
     *
     * @param Model      $record  The model instance to serialise
     * @param array|null $fields  Subset of fields to return
     * @param array|null $include Relations to include
     */
    public function __construct($record, array $fields = [], array $include = [])
    {
        $this->record = $record;

It seems like $record of type object<Huntie\JsonApi\Serializers\Model> is incompatible with the declared type object<Illuminate\Database\Eloquent\Model> of property $record.

        $this->fields = array_unique($fields);
        $this->include = array_unique(array_merge($record->getRelations(), $include));
        $this->meta = collect([]);
        $this->links = collect([]);
        $this->included = collect([]);
    }

    /**
     * Limit which relations can be included.
     *
     * @param array $include
     */
    public function scopeIncludes($include)
    {
        $this->include->intersect($include);

The method intersect cannot be called on $this->include (of type array).

    }

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

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

    /**
     * Return a JSON API resource object for the primary record.
     *
     * @return array
     */
    public function toResourceObject()
    {
        return array_merge($this->toResourceIdentifier(), [
            // TODO

Comment refers to a TODO task

        ]);
    }

    /**
     * Return a JSON API resource identifier object for the primary record.
     *
     * @return array
     */
    public function toResourceIdentifier()
    {
        return [
            'type' => $this->getRecordType(),
            'id' => $this->record->id,
        ];
    }

    /**
     * Serialise complete JSON API document to an array.
     *
     * @return array
     */
    public function serialiseToObject()
    {
        return array_filter([
            'data' => $this->toResourceObject(),
            'included' => $this->included->isEmpty() ? null : $this->included->toArray(),
            'links' => $this->links->isEmpty() ? null : $this->links->toArray(),
            'meta' => $this->meta->isEmpty() ? null : $this->meta->toArray(),
        ]);
    }

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

    /**
     * Return the primary record type name.
     *
     * @return string
     */
    protected function getRecordType()
    {
        return str_slug(str_plural(get_class($this->record)));
    }
}