Merge pull request #29 from CakeDC/feature/add-callback-created-row

add new config for set callback 'CreatedRow' for datatable

Author: arodu

README.md

@@ -331,17 +331,31 @@ $this->Datatable->getInstance()->setConfig('csrfToken', $this->getRequest()->get
 ```
 Important: if you set POST you must set "unlockedActions" on Security Component, specify the target action in the controller's initialize function
 ```php
-    public function initialize(): void
-    {
-        parent::initialize();
+public function initialize(): void
+{
+    parent::initialize();
 
-        ...
+    ...
 
-        if ($this->components()->has('Security')) {
-            $this->Security->setConfig('unlockedActions', ['list']);
-        }
+    if ($this->components()->has('Security')) {
+        $this->Security->setConfig('unlockedActions', ['list']);
+    }
 
-        ...
+    ...
 
-    }
+}
 ```
+
+# Add callback when row is created
+
+For example, if you need to add a css class (to change row color) to each tr according to a specific value in the data
+
+```php
+$this->Datatable->setCallbackCreatedRow(
+    'function( row, data, dataIndex ) {
+        if (!data.viewed) {
+            $(row).addClass("rowhighlight");
+        }
+    }'
+);
+``

src/Datatable/Datatable.php

@@ -54,6 +54,7 @@ class Datatable
         'drawCallback' => null,
         //complete callback function
         'onCompleteCallback' => null,
+        'createdRow' => false,
         'ajaxUrl' => null,
         'ajaxType' => 'GET',
         'csrfToken' => null,
@@ -300,6 +301,7 @@ class Datatable
                 columnDefs: [
                     :definitionColumns
                 ],
+                :callbackCreatedRow
                 language: :language,
                 lengthMenu: :lengthMenu,
                 //@todo add function callback in callback Datatable function
@@ -391,6 +393,10 @@ public function getTableHeaders()
         return $this->Helper->Html->tableHeaders($tableHeaders, $headersConfig['headersAttrsTr'], $headersConfig['headersAttrsTh']);
     }
 
+    public function setCallbackCreatedRow(string $functionCallback)
+    {
+        $this->setConfig('createdRow', $functionCallback);
+    }
 
     public function getDatatableScript(): string
     {
@@ -438,27 +444,35 @@ public function getDatatableScript(): string
         }
 
         // @todo change values to config _default
+        $valuesToReplace = [
+            'getDataMethod' => $this->getDataTemplate,
+            'searchTemplate' => $searchTemplate,
+            'columnSearchTemplate' => $columnSearchTemplate,
+            'tagId' => $tagId,
+            'fixedHeader' => $this->getConfig('fixedHeader') ? 'true' : 'false',
+            'autoWidth' => $this->getConfig('autoWidth') ? 'true' : 'false',
+            'pageLength' => $this->getConfig('pageLength') ?? '10',
+            'processing' => $this->getConfig('processing') ? 'true' : 'false',
+            'serverSide' => $this->getConfig('serverSide') ? 'true' : 'false',
+            'configColumns' => $this->configColumns,
+            'definitionColumns' => $this->getConfig('definitionColumns'),
+            'language' => json_encode($this->getConfig('language')),
+            'lengthMenu' => json_encode($this->getConfig('lengthMenu')),
+            'drawCallback' => $this->getConfig('drawCallback') ? $this->getConfig('drawCallback') : 'null',
+            'onCompleteCallback' => $this->getConfig('onCompleteCallback') ? $this->getConfig('onCompleteCallback') : 'null',
+            'columnSearch' => $this->getConfig('columnSearch') ? $this->columnSearchTemplate : '',
+            'tableCss' => json_encode($this->getConfig('tableCss')),
+        ];
+
+        if ($this->getConfig('createdRow')) {
+            $valuesToReplace['callbackCreatedRow'] = 'createdRow: ' . $this->getConfig('createdRow') . ',';
+        } else {
+            $valuesToReplace['callbackCreatedRow'] = '';
+        }
+
         return Text::insert(
             $this->datatableConfigurationTemplate,
-            [
-                'getDataMethod' => $this->getDataTemplate,
-                'searchTemplate' => $searchTemplate,
-                'columnSearchTemplate' => $columnSearchTemplate,
-                'tagId' => $tagId,
-                'fixedHeader' => $this->getConfig('fixedHeader') ? 'true' : 'false',
-                'autoWidth' => $this->getConfig('autoWidth') ? 'true' : 'false',
-                'pageLength' => $this->getConfig('pageLength') ?? '10',
-                'processing' => $this->getConfig('processing') ? 'true' : 'false',
-                'serverSide' => $this->getConfig('serverSide') ? 'true' : 'false',
-                'configColumns' => $this->configColumns,
-                'definitionColumns' => $this->getConfig('definitionColumns'),
-                'language' => json_encode($this->getConfig('language')),
-                'lengthMenu' => json_encode($this->getConfig('lengthMenu')),
-                'drawCallback' => $this->getConfig('drawCallback') ? $this->getConfig('drawCallback') : 'null',
-                'onCompleteCallback' => $this->getConfig('onCompleteCallback') ? $this->getConfig('onCompleteCallback') : 'null',
-                'columnSearch' => $this->getConfig('columnSearch') ? $this->columnSearchTemplate : '',
-                'tableCss' => json_encode($this->getConfig('tableCss')),
-            ]
+            $valuesToReplace
         );
     }
 

src/View/Helper/DatatableHelper.php

@@ -114,6 +114,12 @@ public function setRowActions(array $rowActions)
         $this->dtInstance->setRowActions($rowActions);
     }
 
+
+    public function setCallbackCreatedRow(string $functionCallback)
+    {
+        $this->dtInstance->setCallbackCreatedRow($functionCallback);
+    }
+
     /**
      * @param string $tagId
      * @return string