refactoring and prepare v1.1.0

Author: ZAYEC77

CHANGELOG.md

@@ -2,20 +2,33 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## v1.0.0
-### Changed 
-- Move DataTable options to protected array. Add __set and __get methods.
-
-## v1.0.1
+## v1.1.0
+### Added
+- Add `sClass` property for `DataTableColumn` class
+- Add `title` property for `LinkColumn` class
 ### Changed
 - Improve README
+- Change `options` property to `linkOptions` at LinkColumn class
+- Move asset classes to separate directory
+- Update minimal php version to 5.5.0
+- Reverse order CHANGELOG
+
+## v1.0.4
+### Added
+- php 7.2 compatibility
 
+## v1.0.3
+### Added
+- Data and response formatting in DataTableAction
 
 ## v1.0.2
 ### Fixed
 - Server-side pagination
 
+## v1.0.1
+### Changed
+- Improve README
 
-## v1.0.3
-### Added
-- Data and response formatting in DataTableAction
+## v1.0.0
+### Changed 
+- Move DataTable options to protected array. Add __set and __get methods.

README.md

@@ -45,11 +45,11 @@ To pass them as widget options:
         'name',
         'email'
     ],
-    'withColumnFilter' => true
+    'withColumnFilter' => true,
 ]) ?>
 ```
 
-## Specifies header label
+## Specifies header label and css class for cell
 
 ```php
     <?= \nullref\datatable\DataTable::widget([
@@ -58,6 +58,7 @@ To pass them as widget options:
             [
                 'data' => 'active',
                 'title' => 'Is active',
+                'sClass' => 'active-cell-css-class',
             ],
         ],
     ]) ?>
@@ -72,7 +73,7 @@ To pass them as widget options:
             [
                 'class' => 'nullref\datatable\LinkColumn',
                 'url' => ['/model/delete'],
-                'options' => ['data-confirm' => 'Are you sure you want to delete this item?', 'data-method' => 'post'],
+                'linkOptions' => ['data-confirm' => 'Are you sure you want to delete this item?', 'data-method' => 'post'],
                 'label' => 'Delete',
             ],
         ],
@@ -84,7 +85,7 @@ Properties of `LinkColumn`:
 - `label` - text placed in `a` tag;
 - `title` - header title of column;
 - `url` - will be passed to `Url::to()`;
-- `options` - HTML options of the `a` tag;
+- `linkOptions` - HTML options of the `a` tag;
 - `queryParams` - array of params added to `url`, `['id']` by default;
 - `render` - custom render js function. E.g:
 ```php
@@ -121,11 +122,11 @@ You ca add column filtering functionality by setting option `withColumnFilter` t
             [
                 'data' => 'active',
                 'title' => \Yii::t('app', 'Is active'),
-                'filter' => [ 'true' => 'Yes', 'false' => 'No' ]
+                'filter' => ['true' => 'Yes', 'false' => 'No'],
             ],
             [
                 'data' => 'last_connection',
-                'filter' => false
+                'filter' => false,
             ],
         ],
     ]) ?>
@@ -167,8 +168,8 @@ Cell rendering or filter can be customized using `\nullref\datatable\DataTableCo
 ```php
 'assetManager' => [
     'bundles' => [
-        'nullref\datatable\DataTableAsset' => [
-            'styling' => \nullref\datatable\DataTableAsset::STYLING_BOOTSTRAP,
+        'nullref\datatable\assets\DataTableAsset' => [
+            'styling' => \nullref\datatable\assets\DataTableAsset::STYLING_BOOTSTRAP,
         ]
     ],
 ],
@@ -187,15 +188,15 @@ Bootstrap tables require the class 'table', so you'll need to add the 'table' cl
     'columns' => [
         'id',
         'name',
-        'email'
+        'email',
     ],
 ]) ?>
 ```
 
 ## Custom assets
-It's posible to use custom styles and scripts:
+It's possible to use custom styles and scripts:
 ```php
-'nullref\datatable\DataTableAsset' => [
+'nullref\datatable\assets\DataTableAsset' => [
     'sourcePath' => '@webroot/js/plugin/datatables/',
     'js' => [
         'jquery.dataTables-1.10-cust.js',

src/DataTable.php

@@ -7,6 +7,7 @@
 
 namespace nullref\datatable;
 
+use nullref\datatable\assets\DataTableAsset;
 use yii\base\Widget;
 use yii\helpers\ArrayHelper;
 use yii\helpers\Html;

src/DataTableColumn.php

@@ -24,6 +24,7 @@ class DataTableColumn extends Widget
      * If it is not set [[\yii\helpers\Inflector::camel2words()]] will be used to get a label.
      */
     public $title;
+
     /**
      * @var array the HTML attributes for the filter input fields. This property is used in combination with
      * the [[filter]] property. When [[filter]] is not set or is an array, this property will be used to
@@ -35,10 +36,16 @@ class DataTableColumn extends Widget
      * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
      */
     public $filterInputOptions = ['class' => 'form-control', 'id' => null];
+
     /** @var JsExpression Javascript (function or expression) used to display the filter */
     public $renderFilter;
+
     /** @var JsExpression Javascript (function) used to display the value. */
     public $render;
+
+    /** @var string CSS class for column cell */
+    public $sClass = '';
+
     /**
      * @var array|null|false Indicating if a filter will be displayed or not.
      *
@@ -50,6 +57,9 @@ class DataTableColumn extends Widget
      */
     private $filter;
 
+    /**
+     * Check if all required properties is set
+     */
     public function init()
     {
         parent::init();
@@ -71,11 +81,11 @@ public function init()
         }
     }
 
+    /**
+     * @return JsExpression
+     */
     public function getJsRender()
     {
-        $jsTitle = Html::encode($this->label);
-        $jsClass = Html::encode($this->filterInputOptions['class']);
-        $jsId = $this->filterInputOptions['id'] ? Html::encode($this->filterInputOptions['id']) : $this->getId();
         if (is_array($this->filter)) {
             $select = "switch (data) {";
 
@@ -93,6 +103,9 @@ public function getJsRender()
         }
     }
 
+    /**
+     * @return JsExpression
+     */
     public function getJsFilter()
     {
         $jsTitle = Html::encode($this->label);
@@ -160,7 +173,7 @@ public function getFilter()
     /**
      * @param array|false|null $filter
      */
-    public function setFilter($filter): void
+    public function setFilter($filter)
     {
         $this->filter = $filter;
     }

src/LinkColumn.php

@@ -11,29 +11,26 @@
 use yii\helpers\Json;
 use yii\web\JsExpression;
 
-class LinkColumn extends \yii\base\BaseObject
+class LinkColumn extends DataTableColumn
 {
     public $queryParams = ['id'];
     public $url;
-    public $title;
     public $label;
-    public $options = [];
-    public $data = null;
-    public $render;
+    public $linkOptions = [];
     public $searchable = false;
     public $orderable = false;
 
     public function init()
     {
-        if (empty($this->options['id'])) {
-            $this->options['id'] = 'link';
+        if (empty($this->linkOptions['id'])) {
+            $this->linkOptions['id'] = 'link';
         }
 
         if (!isset($this->render)) {
             $this->render = new JsExpression('function render(data, type, row, meta){
             var p = ' . Json::encode($this->queryParams) . ';
             var q = {};for (var i = 0; i < p.length; i++) {q[p[i]] = row[p[i]];}
-            var link = jQuery(\'' . Html::a($this->label, $this->url, $this->options) . '\');
+            var link = jQuery(\'' . Html::a($this->label, $this->url, $this->linkOptions) . '\');
             var paramPrefix = ((link.attr("href").indexOf("?") < 0) ? "?" : "&");
             link.attr("id", link.attr("id") + meta.row);link.attr("href", link.attr("href") + paramPrefix + jQuery.param(q));
             return link.get()[0].outerHTML;}');

src/DataTableAsset.php renamed to src/assets/DataTableAsset.php

@@ -5,7 +5,7 @@
  * @author Serhiy Vinichuk <[email protected]>
  */
 
-namespace nullref\datatable;
+namespace nullref\datatable\assets;
 
 
 use yii\web\AssetBundle;

src/DataTableBaseAsset.php renamed to src/assets/DataTableBaseAsset.php

@@ -5,7 +5,7 @@
  * @author Serhiy Vinichuk <[email protected]>
  */
 
-namespace nullref\datatable;
+namespace nullref\datatable\assets;
 
 
 use yii\web\AssetBundle;

src/DataTableBootstrapAsset.php renamed to src/assets/DataTableBootstrapAsset.php

@@ -5,7 +5,7 @@
  * @author Serhiy Vinichuk <[email protected]>
  */
 
-namespace nullref\datatable;
+namespace nullref\datatable\assets;
 
 
 use yii\web\AssetBundle;

src/DataTableDefaultAsset.php renamed to src/assets/DataTableDefaultAsset.php

@@ -5,7 +5,7 @@
  * @author Serhiy Vinichuk <[email protected]>
  */
 
-namespace nullref\datatable;
+namespace nullref\datatable\assets;
 
 
 use yii\web\AssetBundle;

DataTableFaAsset.php renamed to src/assets/DataTableFaAsset.php

@@ -5,21 +5,18 @@
  * @author Serhiy Vinichuk <[email protected]>
  */
 
-namespace nullref\datatable;
+namespace nullref\datatable\assets;
 
 
 use yii\web\AssetBundle;
 
 class DataTableFaAsset extends AssetBundle
 {
+    public $css = [
+        'dataTables.fontAwesome.css',
+    ];
+
     public $depends = [
         DataTableBaseAsset::class,
     ];
-
-    public function init()
-    {
-        parent::init();
-        $this->css[] = 'dataTables.fontAwesome.css';
-    }
-
 }