Download the PHP package nullref/yii2-datatables without Composer

Yii2 DataTables

Yii2 Widget for DataTables plug-in for jQuery

Installation

The preferred way to install this extension is through composer.

Either run

or add

to the require section of your composer.json file.

Basic Usage

For backwards compatibility the old usage via data is still supported

DataTable options

Also you can use all Datatables options

To pass them as widget options:

Specifies header label and css class for cell

Specifies datatable id

Add Links to row

Properties of LinkColumn:

• label - text placed in a tag;
• title - header title of column;
• url - will be passed to Url::to();
• linkOptions - HTML options of the a tag;
• queryParams - array of params added to url, ['id'] by default;
• render - custom render js function. E.g:

You should pass fields that are using at render function to queryParams property

Column filtering

You can add column filtering functionality by setting option withColumnFilter to true :

• By default it generates a text field as filter input.
• It can be replaced by a combo box using filter parameter when defining column. It should be a associative array where key is used as filter (value sent to server) and value for cell rendering
• It can be avoided by setting filter to false

In this example above, filter for active field sent to server will contains 'true' or 'false' but the cell content will be 'Yes' or 'No' and the filter will be rendered as a combo box.

No filter will be generated for last_connection attrribute.

Advanced column definition

Cell rendering or filter can be customized using \nullref\datatable\DataTableColumn class.

Styling

DataTables supports several styling solutions, including Bootstrap, jQuery UI, Foundation.

Bootstrap

Bootstrap tables require the class 'table', so you'll need to add the 'table' class using tableOptions via the widget config.

Custom assets

It's possible to use custom styles and scripts:

Server-side processing

To enable server-side processing add DataTableAction to controller like this:

Searching and ordering can be customized using closures

If you need to get some relation data you can call join or similar methods from $query in applyFilter closure.

You may also specify a closure for query in DataTableAction config if you need complex query like in the following code:

And add options to widget:

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: