Flugg\Responder\ResourceFactory

Complexity

Total Complexity

15

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	make()	0	12	3
A	getMakeMethod()	0	10	3
A	makeFromModel()	0	4	1
A	makeFromArray()	0	4	2
A	makeFromCollection()	0	4	1
A	makeFromBuilder()	0	4	1
A	makeFromPaginator()	0	10	2
A	makeFromPivot()	0	4	1
A	makeFromRelation()	0	4	1

<?php

namespace Flugg\Responder;

use Illuminate\Contracts\Pagination\LengthAwarePaginator as Paginator;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\Pivot;
use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Support\Collection;
use InvalidArgumentException;
use League\Fractal\Pagination\IlluminatePaginatorAdapter;
use League\Fractal\Resource\Collection as CollectionResource;
use League\Fractal\Resource\Item as ItemResource;
use League\Fractal\Resource\NullResource;
use League\Fractal\Resource\ResourceInterface;

/**
 * This class builds an instance of [\League\Fractal\Resource\ResourceInterface]. It
 * supports a variety of different types of data, and resolves the correct resource
 * automatically.
 *
 * @package flugger/laravel-responder
 * @author  Alexander Tømmerås <flugged@gmail.com>
 * @license The MIT License
 */
class ResourceFactory
{
    /**
     * Mappings of supported data types with corresponding make methods.
     *
     * @var array
     */
    const MAKE_METHODS = [
        Builder::class => 'makeFromBuilder',
        Collection::class => 'makeFromCollection',
        Pivot::class => 'makeFromPivot',
        Model::class => 'makeFromModel',
        Paginator::class => 'makeFromPaginator',
        Relation::class => 'makeFromRelation'
    ];

    /**
     * Build a resource instance from the given data.
     *
     * @param  mixed|null $data
     * @return \League\Fractal\Resource\ResourceInterface
     */
    public function make($data = null)
    {
        if (is_null($data)) {
            return new NullResource();
        } elseif (is_array($data)) {
            return static::makeFromArray($data);
        }

        $method = static::getMakeMethod($data);

        return static::$method($data);
    }

    /**
     * Resolve which make method to call from the given date type.
     *
     * @param  mixed $data
     * @return string
     * @throws \InvalidArgumentException
     */
    protected function getMakeMethod($data):string
    {
        foreach (static::MAKE_METHODS as $class => $method) {
            if ($data instanceof $class) {
                return $method;
            }
        }

        throw new InvalidArgumentException('Given data cannot be transformed.');
    }

    /**
     * Make resource from an Eloquent model.
     *
     * @param  \Illuminate\Database\Eloquent\Model $model
     * @return \League\Fractal\Resource\ResourceInterface
     */
    protected function makeFromModel(Model $model):ResourceInterface
    {
        return new ItemResource($model);
    }

    /**
     * Make resource from a collection of Eloquent models.
     *
     * @param  array $array
     * @return \League\Fractal\Resource\ResourceInterface
     */
    protected function makeFromArray(array $array):ResourceInterface
    {
        return empty($array) ? new NullResource() : new CollectionResource($array);
    }

    /**
     * Make resource from a collection.
     *
     * @param  \Illuminate\Support\Collection $collection
     * @return \League\Fractal\Resource\ResourceInterface
     */
    protected function makeFromCollection(Collection $collection):ResourceInterface
    {
        return static::makeFromArray($collection->all());
    }

    /**
     * Make resource from an Eloquent query builder.
     *
     * @param  \Illuminate\Database\Eloquent\Builder $query
     * @return \League\Fractal\Resource\ResourceInterface
     */
    protected function makeFromBuilder(Builder $query):ResourceInterface
    {
        return static::makeFromCollection($query->get());

It seems like $query->get() targeting Illuminate\Database\Eloquent\Builder::get() can also be of type array<integer,object<Illuminate\Database\Eloquent\Builder>>; however, Flugg\Responder\ResourceFactory::makeFromCollection() does only seem to accept object<Illuminate\Support\Collection>, maybe add an additional type check?

    }

    /**
     * Make resource from an Eloquent paginator.
     *
     * @param  \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
     * @return \League\Fractal\Resource\ResourceInterface
     */
    protected function makeFromPaginator(Paginator $paginator):ResourceInterface
    {
        $resource = static::makeFromCollection($paginator->getCollection());

        if ($resource instanceof CollectionResource) {
            $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
        }

        return $resource;
    }

    /**
     * Make resource from an Eloquent pivot table.
     *
     * @param  \Illuminate\Database\Eloquent\Relations\Pivot $pivot
     * @return \League\Fractal\Resource\ResourceInterface
     */
    protected function makeFromPivot(Pivot $pivot):ResourceInterface
    {
        return static::makeFromModel($pivot);
    }

    /**
     * Make resource from an Eloquent query builder.
     *
     * @param  \Illuminate\Database\Eloquent\Relations\Relation $relation
     * @return \League\Fractal\Resource\ResourceInterface
     */
    protected function makeFromRelation(Relation $relation):ResourceInterface
    {
        return static::makeFromCollection($relation->get());
    }
}