This example shows how to integrate SearchBuilder with Editor. Since SearchBuilder 1.2 server-side processing has been supported. This uses the Editor libraries, which are free and open source. A blog post on how to set up the editor libraries can be found here. Unlike SearchPanes, SearchBuilders integration requires no changes to any controllers on the server side - all the work is done for you!
To use preDefined searches however, two additions have to be made. The first is to add the searchBuilder.preDefined.criteria.origData property. This value indicates to the server which field the filter should
be applied to. The second change is to add the searchBuilder.preDefined.criteria.type property. This option indicates to the server the data type for the condition
that is to be applied.
| First Name | Second Name | Position | Office | Start date | Salary |
|---|---|---|---|---|---|
| First Name | Second Name | Position | Office | Start date | Salary |
The Javascript shown below is used to initialise the table shown in this example:
var editor = new DataTable.Editor({
ajax: '../../controllers/staff.php',
fields: [
{
label: 'First name:',
name: 'first_name'
},
{
label: 'Last name:',
name: 'last_name'
},
{
label: 'Position:',
name: 'position'
},
{
label: 'Office:',
name: 'office'
},
{
label: 'Extension:',
name: 'extn'
},
{
label: 'Start date:',
name: 'start_date',
type: 'datetime'
},
{
label: 'Salary:',
name: 'salary'
}
],
table: '#example'
});
$('#example').DataTable({
ajax: {
url: '../../controllers/staff.php',
type: 'POST'
},
buttons: [
{ extend: 'create', editor: editor },
{ extend: 'edit', editor: editor },
{ extend: 'remove', editor: editor }
],
dom: 'QBfrtip',
columns: [
{ data: 'first_name' },
{ data: 'last_name' },
{ data: 'position' },
{ data: 'office' },
{ data: 'start_date' },
{ data: 'salary', render: DataTable.render.number(null, null, 0, '$') }
],
select: true,
searchBuilder: {
preDefined: {
criteria: [
{
condition: '=',
data: 'Office',
origData: 'office',
type: 'string',
value: ['Tokyo']
}
],
logic: 'AND'
}
},
serverSide: true
});
const editor = new DataTable.Editor({
ajax: '../../controllers/staff.php',
fields: [
{
label: 'First name:',
name: 'first_name'
},
{
label: 'Last name:',
name: 'last_name'
},
{
label: 'Position:',
name: 'position'
},
{
label: 'Office:',
name: 'office'
},
{
label: 'Extension:',
name: 'extn'
},
{
label: 'Start date:',
name: 'start_date',
type: 'datetime'
},
{
label: 'Salary:',
name: 'salary'
}
],
table: '#example'
});
new DataTable('#example', {
ajax: {
url: '../../controllers/staff.php',
type: 'POST'
},
buttons: [
{ extend: 'create', editor },
{ extend: 'edit', editor },
{ extend: 'remove', editor }
],
dom: 'QBfrtip',
columns: [
{ data: 'first_name' },
{ data: 'last_name' },
{ data: 'position' },
{ data: 'office' },
{ data: 'start_date' },
{ data: 'salary', render: DataTable.render.number(null, null, 0, '$') }
],
select: true,
searchBuilder: {
preDefined: {
criteria: [
{
condition: '=',
data: 'Office',
origData: 'office',
type: 'string',
value: ['Tokyo']
}
],
logic: 'AND'
}
},
serverSide: true
});
In addition to the above code, the following Javascript library files are loaded for use in this example:
The HTML shown below is the raw HTML table element, before it has been enhanced by DataTables:
This example uses a little bit of additional CSS beyond what is loaded from the library files (below), in order to correctly display the table. The additional CSS used is shown below:
The following CSS library files are loaded for use in this example to provide the styling of the table:
This table loads data by Ajax. The latest data that has been loaded is shown below. This data will update automatically as any additional data is loaded.
The script used to perform the server-side processing for this table is shown below. Please note that this is just an example script using PHP. Server-side processing scripts can be written in any language, using the protocol described in the DataTables documentation.