tequilarapido / api-response

src/FractalAdapter.php

<?php

namespace Tequilarapido\ApiResponse;

use Illuminate\Contracts\Pagination\LengthAwarePaginator;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Http\Request;
use League\Fractal\Manager;
use League\Fractal\Resource\Collection;
use League\Fractal\Resource\Item;
use League\Fractal\Serializer\SerializerAbstract;

class FractalAdapter
{
    /** @var \League\Fractal\Manager */
    protected $manager;

    /** @var Request */
    private $request;

    /**
     * FractalAdapter constructor.
     *
     * @param SerializerAbstract $serializer
     * @param Request $request
     */
    public function __construct(SerializerAbstract $serializer, Request $request)

You have injected the Request via parameter $request. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via getCurrentRequest().

    {
        $this->manager = new Manager();
        $this->manager->setSerializer($serializer);

        $this->request = $request;
    }

    /**
     * Return an item.
     *
     * @param $data
     * @param null $transformer
     * @param null $resourceKey
     * @return array
     */
    public function item($data, $transformer = null, $resourceKey = null)
    {
        $resource = new Item($data, $this->getTransformer($transformer), $resourceKey);

        return $this->manager->createData($resource)->toArray();
    }

    /**
     * Return a collection of items.
     *
     * @param $data
     * @param null $transformer
     * @param null $resourceKey
     * @return array
     */
    public function collection($data, $transformer = null, $resourceKey = null)
    {
        $resource = new Collection($data, $this->getTransformer($transformer), $resourceKey);

        return $this->manager->createData($resource)->toArray();
    }

    /**
     * @param LengthAwarePaginator $paginator
     * @param null $transformer
     * @param null $resourceKey
     * @return array
     */
    public function paginatedCollection(LengthAwarePaginator $paginator, $transformer = null, $resourceKey = null)
    {
        $paginator->appends($this->request->query());

It seems like $this->request->query() targeting Illuminate\Http\Concerns\InteractsWithInput::query() can also be of type null; however, Illuminate\Contracts\Pagination\Paginator::appends() does only seem to accept array|string, maybe add an additional type check?

        $resource = new Collection($paginator->items(), $this->getTransformer($transformer), $resourceKey);

        $resource->setPaginator(new PaginatorAdapter($paginator));

        return $this->manager->createData($resource)->toArray();
    }

    /**
     * Return transformer.
     *
     * @param $transformer
     * @return \Closure
     */
    protected function getTransformer($transformer)
    {
        return $transformer ?: function ($data) {
            if ($data instanceof Arrayable) {
                return $data->toArray();
            }

            return (array) $data;
        };
    }
}