Moved this to it's own package

Everything’s working!

Author: patricksamson

README.md

@@ -17,6 +17,21 @@ Via Composer
 composer require lykegenes/laravel-api-response
 ```
 
+Then, add this to your Service Providers :
+``` php
+Lykegenes\ApiResponse\ServiceProvider::class,
+```
+
+...and this to your Aliases :
+``` php
+'ApiResponse' => Lykegenes\ApiResponse\Facades\ApiResponse::class,
+```
+
+Optionally, you can publish and edit the configuration file :
+``` bash
+php artisan vendor:publish --provider="Lykegenes\ApiResponse\ServiceProvider" --tag=config
+```
+
 ## Usage
 
 ``` php

config/config.php

@@ -0,0 +1,16 @@
+<?php
+
+return [
+
+    'api' => [
+        'parameters' => [
+            'page'     => 'page',
+            'per_page' => 'per_page',
+            'sort'     => 'sort',
+            'order'    => 'order',
+            'search'   => 'search',
+            'include'  => 'include',
+        ],
+    ],
+
+];

src/ApiResponse.php

@@ -0,0 +1,175 @@
+<?php
+namespace Lykegenes\ApiResponse;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use League\Fractal\Manager;
+use League\Fractal\Pagination\IlluminatePaginatorAdapter;
+use League\Fractal\Resource\Collection;
+use League\Fractal\Resource\Item;
+
+class ApiResponse
+{
+
+    /**
+     * The Request instance
+     * @var Illuminate\Http\Request
+     */
+    protected $request;
+
+    /**
+     * The Fractal Manager instance
+     * @var League\Fractal\Manager
+     */
+    protected $fractal;
+
+    /**
+     * Various request parameters
+     * @var String
+     */
+    protected $page;
+    protected $perPage;
+    protected $sort;
+    protected $order;
+    protected $search;
+    protected $include;
+
+    /**
+     * Construct a new ApiResponse instance
+     * @param \Illuminate\Http\Request $request The current request instance
+     * @param \League\Fractal\Manager $fractal A Fractal manager instance
+     */
+    public function __construct(Request $request, Manager $fractal)
+    {
+        $this->request = $request;
+        $this->fractal = $fractal;
+
+        $this->parseRequest();
+    }
+
+    /**
+     * Parse the request parameters
+     */
+    protected function parseRequest()
+    {
+        $this->page    = $this->getRequestParameterValue('page', 1);
+        $this->perPage = $this->getRequestParameterValue('per_page', 10);
+        $this->sort    = $this->getRequestParameterValue('sort', null);
+        $this->order   = $this->getRequestParameterValue('order', 'asc');
+        $this->search  = $this->getRequestParameterValue('search', null);
+        $this->include = $this->getRequestParameterValue('include', null);
+    }
+
+    public function make($stuff, $transformer)
+    {
+        return JsonResponse::create($this->makeArray($stuff, $transformer));
+    }
+
+    /**
+     * Try to guess what to do with this stuff
+     * @param  mixed $stuff       A Class, a Model instance or a Query Builder instance
+     * @param  mixed $transformer The Fractal transformer to use
+     * @return array              [description]
+     */
+    public function makeArray($stuff, $transformer)
+    {
+        if ($stuff instanceof Model) {
+            $data = $this->fromModelInstance($stuff, $transformer);
+        } elseif ($stuff instanceof Builder) {
+            $data = $this->fromQuery($stuff, $transformer);
+        } elseif (is_subclass_of($stuff, Model::class)) {
+            $data = $this->fromModelClass($stuff, $transformer);
+        } elseif (method_exists($stuff, 'toArray')) {
+            $data = $stuff->toArray();
+        } else {
+            $data = array($stuff);
+        }
+
+        return $data;
+    }
+
+    /**
+     * Transform and serialize multiple models from its class
+     * @param  mixed $model       An Eloquent Model class
+     * @param  mixed $transformer A Fractal Transformer class
+     * @return array              The transformed and serialized models collection
+     */
+    public function fromModelClass($model, $transformer)
+    {
+        if (is_subclass_of($model, Model::class)) {
+            return $this->fromQuery($model::query(), $transformer);
+        }
+    }
+
+    /**
+     * Transform and serialize a single model instance
+     * @param  Model $model       An Eloquent Model instance
+     * @param  mixed $transformer A Fractal Transformer class
+     * @return array              The transformed and serialized model
+     */
+    public function fromModelInstance($model, $transformer)
+    {
+        $resource = new Item($model, new $transformer);
+
+        if ($this->include != null) {
+            $this->fractal->parseIncludes($this->include);
+        }
+
+        return $this->fractal->createData($resource)->toArray();
+    }
+
+    /**
+     * Transform and serialize the results of an Eloquent query
+     * @param  Builder $query       An Eloquent Query instance
+     * @param  mixed $transformer A Fractal Transformer class
+     * @return array              The transformed and serialized query results
+     */
+    public function fromQuery(Builder $query, $transformer)
+    {
+        if ($this->search != null && method_exists($query, 'search')) {
+            // apply search query
+            $query->search($this->search);
+        }
+
+        if ($this->sort != null) {
+            // apply sorting and ordering
+            $query->orderBy($this->sort, $this->order);
+        }
+
+        // paginate the results
+        $paginator = $query->paginate($this->perPage);
+
+        if ($this->include != null) {
+            $this->fractal->parseIncludes($this->include);
+        }
+
+        $resource = new Collection($paginator->getCollection(), new $transformer);
+        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
+
+        return $this->fractal->createData($resource)->toArray();
+    }
+
+    /**
+     * Get the name of a request parameter from the user's configuration
+     * @param  String $key This parameter's key
+     * @return String      This parameter's name
+     */
+    private function getRequestParameterName($key)
+    {
+        return config('api-response.api.parameters.' . $key, $key);
+    }
+
+    /**
+     * Get the value of a request parameter
+     * @param  String $key    This parameter's key
+     * @param  mixed $default The default value to return
+     * @return mixed          This paramter's value
+     */
+    private function getRequestParameterValue($key, $default = null)
+    {
+        return $this->request->input($this->getRequestParameterName($key), $default);
+    }
+
+}

src/Facades/ApiResponse.php

@@ -0,0 +1,12 @@
+<?php
+namespace Lykegenes\ApiResponse\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+class ApiResponse extends Facade
+{
+    public static function getFacadeAccessor()
+    {
+        return \Lykegenes\ApiResponse\ApiResponse::class;
+    }
+}

src/ServiceProvider.php

@@ -0,0 +1,48 @@
+<?php
+namespace Lykegenes\ApiResponse;
+
+class ServiceProvider extends \Illuminate\Support\ServiceProvider
+{
+
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $configPath = __DIR__ . '/../config/config.php';
+        $this->mergeConfigFrom($configPath, 'api-response');
+
+        /*$this->app->bindShared('datagrid-builder', function ($app) {
+
+    return new DatagridBuilder($app, $app['datagrid-helper']);
+    });*/
+    }
+
+    public function boot()
+    {
+        $configPath = __DIR__ . '/../config/config.php';
+
+        $this->publishes([$configPath => $this->getConfigPath()], 'config');
+    }
+
+    /**
+     * @return string[]
+     */
+    public function provides()
+    {
+        return ['api-response'];
+    }
+
+    /**
+     * Get the config path
+     *
+     * @return string
+     */
+    protected function getConfigPath()
+    {
+        return config_path('api-response.php');
+    }
+
+}