huntie / laravel-simple-jsonapi

src/Serializers/ResourceSerializer.php

<?php

namespace Huntie\JsonApi\Serializers;

use Illuminate\Support\Collection;

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

    /**
     * The subset of attributes to return on each resource type.
     *
     * @var array
     */
    protected $fields;

    /**
     * The relationship paths to match for included resources.
     *
     * @var array
     */
    protected $include;

    /**
     * The named relationships to list against this resource.
     *
     * @var array
     */
    protected $relationships;

    /**
     * Create a new JSON API resource serializer.
     *
     * @param \Illuminate\Database\Eloquent\Model $record        The model instance to serialise
     * @param array|null                          $fields        The subset of fields to return on each resource type
     * @param array|null                          $include       The paths of relationships to include
     * @param array|null                          $relationships Additional named relationships to list
     */
    public function __construct($record, array $fields = [], array $include = [], array $relationships = [])
    {
        parent::__construct();

        $this->record = $record;
        $this->fields = array_unique($fields);
        $this->include = array_unique($include);

        $this->relationships = array_unique(
            array_merge(
                $relationships,
                array_keys($record->getRelations()),
                array_map(function ($path) {
                    return explode('.', $path, 2)[0];
                }, $include)
            )
        );
    }

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

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

    /**
     * Return a base JSON API resource object for the primary record containing
     * only immediate attributes.
     *
     * @return array
     */
    public function toBaseResourceObject()
    {
        return array_merge($this->toResourceIdentifier(), [
            'attributes' => $this->transformRecordAttributes(),
        ]);
    }

    /**
     * Return a full JSON API resource object for the primary record.
     *
     * @return array
     */
    public function toResourceObject()
    {
        return array_filter(array_merge($this->toBaseResourceObject(), [
            'relationships' => $this->transformRecordRelations()->toArray(),
        ]));
    }

    /**
     * Return primary data for the JSON API document.
     *
     * @return mixed
     */
    protected function getPrimaryData()
    {
        return $this->toResourceObject();
    }

    /**
     * Return any secondary included resource objects.
     *
     * @throws \Huntie\JsonApi\Exceptions\InvalidRelationPathException
     *
     * @return \Illuminate\Support\Collection
     */
    public function getIncluded()
    {
        $included = collect();

        foreach ($this->getIncludePaths() as $path) {
            $resolved = $this->record;

            if (!($resolved instanceof Collection)) {
                $resolved = collect([$resolved])->filter();
            }

            while (!empty($path)) {
                list($relation, $path) = array_pad(explode('.', $path, 2), 2, null);
                $nextRelation = preg_replace('/\..*/', '', $path);

                foreach ($resolved as $record) {
                    $records = (new RelationshipSerializer($record, $relation, $this->fields, array_filter([$nextRelation])))

This line exceeds maximum limit of 120 characters; contains 125 characters

                        ->toResourceCollection();

                    if ($records instanceof Collection) {
                        $included = $included->merge($records);
                    } else if (!empty($records)) {
                        $included->push($records);
                    }
                }

                $resolved = $resolved
                    ->map(function ($record) use ($relation) {
                        return $record->{$relation};
                    })
                    ->flatten()
                    ->filter();
            }
        }

        return $this->filterUnique($included);
    }

    /**
     * Return the primary resource type name.
     */
    protected function getResourceType(): string
    {
        $modelName = collect(explode('\\', get_class($this->record)))->last();

        if (config('jsonapi.singular_type_names') !== true) {
            $modelName = str_plural($modelName);
        }

        return snake_case($modelName, '-');
    }

    /**
     * Return the primary key value for the resource.
     *
     * @return int|string
     */
    protected function getPrimaryKey()
    {
        $value = $this->record->getKey();

        return is_int($value) ? $value : (string) $value;
    }

    /**
     * Return the attribute subset requested for the primary resource type.
     */
    protected function getRequestedFields(): array
    {
        $fields = array_get($this->fields, $this->getResourceType());

        return is_array($fields) ? $fields : preg_split('/,/', $fields, null, PREG_SPLIT_NO_EMPTY);
    }

    /**
     * Return the deepest relationship paths that should be used to resolve
     * all included relations.
     */
    protected function getIncludePaths(): array
    {
        return array_diff(
            $this->include,
            array_filter(array_map(function ($path) {
                preg_match('/(.*)\..+$/', $path, $matches);

                return $matches[1] ?? null;
            }, $this->include))
        );
    }

    /**
     * Return the attribute object data for the primary record.
     */
    protected function transformRecordAttributes(): array
    {
        $attributes = array_except($this->record->attributesToArray(), ['id']);
        $fields = $this->getRequestedFields();

        if (!empty($fields)) {
            $attributes = array_only($attributes, $fields);
        }

        return $attributes;
    }

    /**
     * Return a collection of JSON API resource identifier objects by each
     * relation on the primary record.
     *
     * @throws \Huntie\JsonApi\Exceptions\InvalidRelationPathException
     *
     * @return \Illuminate\Support\Collection
     */
    protected function transformRecordRelations()
    {
        return collect($this->relationships)->combine(array_map(function ($relation) {
            return [
                'data' => (new RelationshipSerializer($this->record, $relation))->toResourceLinkage(),
            ];
        }, $this->relationships));
    }
}