#53 add extraColumns property

Author: ZAYEC77

CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## v1.1.1
+### Added
+- Add `extraColumns` property to `DataTable`, `DataTableColumn`, `DataTableAction`
+
 ## v1.1.0
 ### Added
 - Add `sClass` property for `DataTableColumn` class

README.md

@@ -214,18 +214,17 @@ It's possible to use custom styles and scripts:
 To enable server-side processing add `DataTableAction` to controller like this:
 
 ```php
- class SomeController extends Controller
- {
-     public function actions()
-     {
-         return [
-             'datatables' => [
-                 'class' => 'nullref\datatable\DataTableAction',
-                 'query' => Model::find(),
-             ],
-         ];
-     }
-     
+class SomeController extends Controller
+{
+    public function actions()
+    {
+        return [
+            'datatables' => [
+                'class' => 'nullref\datatable\DataTableAction',
+                'query' => Model::find(),
+            ],
+        ];
+    }
 }
 ```
 
@@ -260,17 +259,61 @@ public function actions()
          ],
     ];
 }
-
 ```
 
 If you need to get some relation data you can call `join` or similar methods from `$query` in `applyFilter` closure.
 
 And add options to widget: 
 
 ```php
-    <?= \nullref\datatable\DataTable::widget([
-        /** ... */
-        'serverSide' => true,
-        'ajax' => '/site/datatables',
-    ]) ?>
+<?= \nullref\datatable\DataTable::widget([
+    /** ... */
+    'serverSide' => true,
+    'ajax' => '/site/datatables',
+]) ?>
+```
+
+
+## Extra columns
+
+If need to use some custom fields from your model at your render function at column you could pass `extraColumns` param.
+
+It available at DataTable widget, column and server side action definition:
+
+```php
+<?= \nullref\datatable\DataTable::widget([
+    /** ... */
+    'data' => $dataProvider->getModels(),
+    'extraColumns' => ['customPrice'],
+    'columns' => [
+        [
+            'title' => 'Custom column',
+            'extraColumns' => ['customField'],
+            'render' => new JsExpression($customColumnRender),
+        ],
+    ],
+]) ?>
+```
+
+```php
+class SomeController extends Controller
+{
+    public function actions()
+    {
+        return [
+            'datatables' => [
+                'class' => 'nullref\datatable\DataTableAction',
+                'query' => Model::find(),
+                'extraColumns' => ['customPrice'],
+            ],
+        ];
+    }
+}
+```
+
+```php
+<?= \nullref\datatable\DataTable::widget([
+    /** ... */
+    'extraColumns' => ['customPrice'],
+]) ?>
 ```

src/DataTable.php

@@ -88,15 +88,23 @@ class DataTable extends Widget
     const PAGING_FULL = 'full';
     const PAGING_FULL_NUMBERS = 'full_numbers';
     public $id;
+
     /**
      * @var array Html options for table
      */
     public $tableOptions = [];
+
+    /**
+     * @var array
+     */
+    public $extraColumns = [];
+
     public $withColumnFilter;
     /** @var bool */
     public $globalVariable = false;
     protected $_options = [];
-    protected $_hiddenColumns = [];
+
+    protected $_extraColumns = [];
 
     public function init()
     {
@@ -108,6 +116,7 @@ public function init()
 
     protected function initColumns()
     {
+        $this->_extraColumns = $this->extraColumns;
         if (isset($this->_options['columns'])) {
             foreach ($this->_options['columns'] as $key => $value) {
                 if (!is_array($value)) {
@@ -128,8 +137,8 @@ protected function initColumns()
                 }
                 if (isset($value['class'])) {
                     $column = \Yii::createObject($value);
-                    if ($column instanceof LinkColumn) {
-                        $this->_hiddenColumns = array_merge($this->_hiddenColumns, $column->queryParams);
+                    if ($column instanceof DataTableColumn) {
+                        $this->_extraColumns = array_merge($this->_extraColumns, $column->getExtraColumns());
                     }
                     $this->_options['columns'][$key] = $column;
                 }
@@ -140,7 +149,7 @@ protected function initColumns()
 
     private function initData()
     {
-        $this->_hiddenColumns = array_unique($this->_hiddenColumns);
+        $this->_extraColumns = array_unique($this->_extraColumns);
         if (array_key_exists('data', $this->_options)) {
             $data = [];
 
@@ -163,7 +172,7 @@ private function initData()
                         }
                     }
                 }
-                foreach ($this->_hiddenColumns as $column) {
+                foreach ($this->_extraColumns as $column) {
                     $row[$column] = ArrayHelper::getValue($obj, $column);
                 }
                 if ($row) {

src/DataTableAction.php

@@ -73,6 +73,14 @@ class DataTableAction extends Action
      */
     public $formatResponse;
 
+    /**
+     * Add extra fields to dataset
+     * These fields could be used at render function
+     *
+     * @var array
+     */
+    public $extraColumns = [];
+
     /**
      * Check if query is configured
      * @throws InvalidConfigException
@@ -135,11 +143,12 @@ public function run()
         $dataProvider = new ActiveDataProvider(['query' => $filterQuery, 'pagination' => ['pageSize' => Yii::$app->request->getQueryParam('length', 10)]]);
         Yii::$app->response->format = Response::FORMAT_JSON;
         try {
+            $allColumns = array_merge($columns, $this->getExtraColumns());
             $response = [
                 'draw' => (int)$draw,
                 'recordsTotal' => (int)$originalQuery->count(),
                 'recordsFiltered' => (int)$dataProvider->getTotalCount(),
-                'data' => $this->formatData($filterQuery, $columns),
+                'data' => $this->formatData($filterQuery, $allColumns),
             ];
         } catch (\Exception $e) {
             return ['error' => $e->getMessage()];
@@ -208,6 +217,16 @@ public function applyOrder(ActiveQuery $query, $columns, $order)
         return $query;
     }
 
+    /**
+     * Prepare extraColumns for
+     */
+    protected function getExtraColumns()
+    {
+        return array_map(function ($column) {
+            return ['data' => $column];
+        }, $this->extraColumns);
+    }
+
     /**
      * @param ActiveQuery $query
      * @param array $columns

src/DataTableColumn.php

@@ -47,6 +47,16 @@ class DataTableColumn extends Widget
     /** @var string CSS class for column cell */
     public $sClass = '';
 
+    public $className = '';
+
+    /**
+     * Add extra fields to dataset
+     * These fields could be used at render function
+     *
+     * @var array
+     */
+    public $extraColumns = [];
+
     /**
      * @var array|null|false Indicating if a filter will be displayed or not.
      *
@@ -56,7 +66,7 @@ class DataTableColumn extends Widget
      *   the list options.
      * - If you don't want a filter for this data column, set this value to be false.
      */
-    private $filter;
+    protected $filter;
 
     /**
      * Check if all required properties is set
@@ -179,4 +189,12 @@ public function setFilter($filter)
         $this->filter = $filter;
     }
 
-}
+    /**
+     * @return array
+     */
+    public function getExtraColumns()
+    {
+        return $this->extraColumns;
+    }
+
+}

src/LinkColumn.php

@@ -20,6 +20,8 @@ class LinkColumn extends DataTableColumn
     public $searchable = false;
     public $orderable = false;
 
+    protected $filter = false;
+
     public function init()
     {
         if (empty($this->linkOptions['id'])) {
@@ -35,5 +37,15 @@ public function init()
             link.attr("id", link.attr("id") + meta.row);link.attr("href", link.attr("href") + paramPrefix + jQuery.param(q));
             return link.get()[0].outerHTML;}');
         }
+
+        parent::init();
+    }
+
+    /**
+     * @return array
+     */
+    public function getExtraColumns()
+    {
+        return array_unique(array_merge(parent::getExtraColumns(), $this->queryParams));
     }
 }