DataTables

Overview #

DataTables is an advanced solution to display data in table format. Beside the basic feature of displaying data, it supports features such as Row Search, Select, Column Reordering, Fixed Columns, Responsive, Row Group, Scrolling.

Get started with DataTables #

It is simple to setup DataTables to display data. Suppose you have had your dataStore and would like to display data in report's view.

First, you need to declare the class at top of the view

<?php
use \koolreport\datagrid\DataTables;
?>

Second, you create the DataTables widget

<?php
DataTables::create(array(
    "dataSource"=>$this->dataStore("orders")
))
?>

Simple, isn't it? With above minimum settings, DataTables will load data from orders dataStore and display all data.

Properties #

nametypedefaultdescription
namestringOptional. You can set the name for your data table if you want to refer to the table later on at client-side. If you don't set we will set random name for table
columnsarrayOptional. List all the columns you want to display in data table together with its settings
dataSourceDataStore, Array, functionOptional. Specify a dataStore, an array or a function that data table will get data from. If you do not set this, the data table will get data from data property
dataarrayOptional. You may set data directly here in form of associate array
optionsarrayOptional. This property will hold all the extra settings for data tables
cssClassarrayOptional. You could set css classes for the table's table, th, tr, td, tf elemens.
showFooterbooleanOptional. Show table footer or not, default value is false.
scopearrayOptional. Data table will include the scope parameters in each of its ajax call to server-side operation.
serverSidebooleanOptional. Default value is false. Determine whether data table's operations are performed on server-side or client-side (default).

Use data property #

If you have your own data in array format, you may use data property to display them in data table.

<?php 
DataTables::create(array(
    "data"=>array(
        array("name"=>"Peter","age"=>35),
        array("name"=>"Karl","age"=>31),
    )
))
?>

Columns property #

columns property is used to list columns you want to display and its settings.

DataTables::create(array(
    "dataSource"=>$this->dataStore("orders"),
    "columns"=>array("orderNumber","customerName","productName","quantity")
))

or more detail settings for each columns

DataTables::create(array(
    "dataSource"=>$this->dataStore("orders"),
    "columns"=>array(
        "orderNumber"=>array(
            "type"=>"number",
            "label"=>"Order#",
        ),
        "customerName"=>array(
            "label"=>"Customer Name",
            "type"=>"string",
            'data-order' => 'customerNumber', //order this column by customerNumber
            'data-search' => 'customerFullName', //search this column by customerFullName
        ),
        "productName"=>array(
            "label"=>"Product Name",
            "type"=>"string"
        ),
        "quantity"=>array(
            "label"=>"Quantity"
            "type"=>"number"
        ),
        "priceEach"=>array(
            "label"=>"Price",
            "type"=>"number",
            "prefix"=>"$",
            "decimals"=>2,
        )
    )
))

Enable Searching #

To enable searching box for DataTables, you do:

<?php 
DataTables::create(array(
    "dataSource"=>$this->dataStore("orders")
    "options"=>array(
        "searching"=>true,
    )
))
?>

Enable Paging #

To enable paging for DataTables, you do:

<?php 
DataTables::create(array(
    "dataSource"=>$this->dataStore("orders")
    "options"=>array(
        "paging"=>true,
    )
))
?>

Sorting(ordering) preset #

The column sorting is enabled by default, you may preset sorting(order):

<?php 
DataTables::create(array(
    "dataSource"=>$this->dataStore("orders")
    "options"=>array(
        "order"=>array(
            array(0,"desc") //Sort by first column desc
            array(1,"asc") //Sort by second column asc
        ),
    )
))
?>

Column Reorder #

DataTables allows user to re-order columns by drag and drop, to enable the feature you do:

<?php 
DataTables::create(array(
    "dataSource"=>$this->dataStore("orders")
    "options"=>array(
        "colReorder"=>true,
    )
))
?>

Fixed Header #

To get the fixed header on top of the page when scrolling, you set:

<?php 
DataTables::create(array(
    "dataSource"=>$this->dataStore("orders")
    "options"=>array(
        "fixedHeader"=>true,
    )
))
?>

Row Selection #

To enable row selection in DataTables, we do:

<?php 
DataTables::create(array(
    "dataSource"=>$this->dataStore("orders")
    "options"=>array(
        "select"=>true,
    )
))
?>

Set cutom CSS classes #

Assign an array like this:

<?php 
DataTables::create(array(
    "dataSource"=>$this->dataStore("orders")
    'cssClass'=>array(
        'table' => 'reportTable',
        'th' => 'reportHeader',
        'tr' => 'reportRow',
        'td' => function($row, $colName) {
            $v = Util::get($row, $colName, 0);
            $s = is_numeric($v) ? '' : 'reportLabel';
            return $s;
        },
        'tf' => 'reportFooter'
    )
))
?>

serverSide #

If set to false (default), all data is loaded to data table and operations like paging, filtering, sorting are performed on client-side. If set to true, those operations are performed on server-side. Server-side operations are only supported if data table's datasource is a function that returns data from a supported datasource class like this:

<?php 
DataTables::create(array(
    'name' => 'salesTable',
    'dataSource' => function() {
        return $this->src('mysql')
        ->query('select * from customer_product_dollarsales2');
    },
    "showFooter"=>true,
    "serverSide"=>true,
    // "method"=>'post', //default = 'get'
));
?>

Supported datasource classes include MySQLDataSource, SQLSRVDataSource, PostgreSQLDataSource, OracleDataSource and PdoDataSource (using with either mysql, sql server, postgresql or oracle).

Client-side events #

DataTables support client-side event, below are example of using select event. Note that you should assign name to table so that you can refer to table at client-side:

<?php 
DataTables::create(array(
    "clientEvents"=>array(
        "select"=>"function(e,dt,type,indexes){
            var data = dt.rows( indexes ).data().pluck( 'id' );

            // do something with the ID of the selected items
        }"
    )
));
?>

Here is the full list of events which you can do with DataTables.