Merge branch 'hotfix/v5.12.0'

Author: yajra

change-log.md

@@ -8,6 +8,16 @@
 
 ##Change Log
 
+###v5.12.0
+    - Added support for Fractal Serializer.
+    - Added config for default serializer.
+    - Note: Should be used along with setTransformer method.
+    - Usage: 
+        return Datatables::of($model)
+            ->setTransformer(ModelTransformer::class)
+            ->setSerializer(ModelSerializer::class)
+            ->make(true);
+    
 ###v5.11.14
     - Sort by a multi-line 'select as' query. PR #245
 

readme.md

@@ -25,7 +25,7 @@ This package is created to handle [server-side](https://www.datatables.net/manua
 - Extended column filtering via [`filterColumn`](http://yajra.github.io/laravel-datatables/api/source-class-yajra.Datatables.Engines.BaseEngine.html#489-503) API.
 - Extended column ordering via [`orderColumn`](http://yajra.github.io/laravel-datatables/api/source-class-yajra.Datatables.Engines.BaseEngine.html#505-519) API.
 - Extended Query Builder functionality allowing you to filter using Datatables class directly.
-- Decorate your data output using [`league\fractal`](https://github.com/thephpleague/fractal) Transformer.
+- Decorate your data output using [`league\fractal`](https://github.com/thephpleague/fractal) Transformer with Serializer support.
 - Works with Laravel Dependency Injection and IoC Container.
 - Provides a [DataTable Html Builder](http://datatables.yajrabox.com/html) to help you use the package with less code.
 - Provides XSS filtering function to optionally escape all or specified column values using `escapeColumns('*'\['column'])` method.

src/yajra/Datatables/Engines/BaseEngine.php

@@ -15,14 +15,14 @@
 use Illuminate\Support\Str;
 use League\Fractal\Manager;
 use League\Fractal\Resource\Collection;
-use League\Fractal\TransformerAbstract;
+use League\Fractal\Serializer\DataArraySerializer;
+use League\Fractal\Serializer\SerializerAbstract;
 use yajra\Datatables\Contracts\DataTableEngine;
 use yajra\Datatables\Helper;
 use yajra\Datatables\Processors\DataProcessor;
 
 abstract class BaseEngine implements DataTableEngine
 {
-
     /**
      * Datatables Request object.
      *
@@ -79,7 +79,6 @@ abstract class BaseEngine implements DataTableEngine
      */
     protected $query_type;
 
-
     /**
      * Extra/Added columns.
      *
@@ -109,21 +108,21 @@ abstract class BaseEngine implements DataTableEngine
     protected $autoFilter = true;
 
     /**
-     * Callback to override global search
+     * Callback to override global search.
      *
      * @var \Closure
      */
     protected $filterCallback;
 
     /**
-     * Parameters to passed on filterCallback
+     * Parameters to passed on filterCallback.
      *
      * @var mixed
      */
     protected $filterCallbackParameters;
 
     /**
-     * DT row templates container
+     * DT row templates container.
      *
      * @var array
      */
@@ -149,7 +148,7 @@ abstract class BaseEngine implements DataTableEngine
     protected $prefix;
 
     /**
-     * Database driver used
+     * Database driver used.
      *
      * @var string
      */
@@ -162,6 +161,13 @@ abstract class BaseEngine implements DataTableEngine
      */
     protected $isFilterApplied = false;
 
+    /**
+     * Fractal serializer.
+     *
+     * @var SerializerAbstract
+     */
+    protected $serializer;
+
     /**
      * Setup search keyword.
      *
@@ -545,6 +551,19 @@ public function setTransformer($transformer)
         return $this;
     }
 
+    /**
+     * Set fractal serializer class.
+     *
+     * @param string $serializer
+     * @return $this
+     */
+    public function setSerializer($serializer)
+    {
+        $this->serializer = $serializer;
+
+        return $this;
+    }
+
     /**
      * Organizes works.
      *
@@ -665,6 +684,9 @@ public function render($object = false)
                 $fractal->parseIncludes($this->request->get('include'));
             }
 
+            $serializer = $this->serializer ?: Config::get('datatables.fractal.serializer', DataArraySerializer::class);
+            $fractal->setSerializer(new $serializer);
+
             //Get transformer reflection
             //Firs method parameter should be data/object to transform
             $reflection = new \ReflectionMethod($this->transformer, 'transform');

src/yajra/Datatables/config/config.php

@@ -2,9 +2,12 @@
 
 return [
 
-    'search' => [
+    'search'  => [
         'case_insensitive' => true,
         'use_wildcards'    => false,
-    ]
+    ],
 
+    'fractal' => [
+        'serializer' => League\Fractal\Serializer\DataArraySerializer::class,
+    ],
 ];