About
This is a Phalcon Framework adapter for DataTables.
This version contains community fixes and multi model search support, (*1)
Support
Currently supported
- QueryBuilder interface
- ResultSet interface
- Pagination
- Global search (by value)
- Ordering
- Multiple column ordering
- Column-based search
- Multi model search
Installation
Installation via Composer
- Install a composer
- Create
composer.json file inside your project directory
- Paste into it
{
"require": {
"qrotux/phalcon-datatables": "1.*"
}
}
Example usage
It uses Phalcon QueryBuilder for pagination in DataTables., (*2)
In example we have a stantart MVC application, with database enabled. Don't need to provide a normal bootstrap PHP file, for Phalcon documentation, visit official site., (*3)
Controller (using QueryBuilder):
<?php
use \DataTables\DataTable;
class TestController extends \Phalcon\Mvc\Controller {
public function indexAction() {
if ($this->request->isAjax()) {
$builder = $this->modelsManager->createBuilder()
->columns('id, name, email, balance')
->from('Example\Models\User');
$dataTables = new DataTable();
$dataTables->fromBuilder($builder)->sendResponse();
}
}
}
Controller (using ResultSet):
<?php
use \DataTables\DataTable;
class TestController extends \Phalcon\Mvc\Controller {
public function indexAction() {
if ($this->request->isAjax()) {
$resultset = $this->modelsManager->createQuery("SELECT * FROM \Example\Models\User")
->execute();
$dataTables = new DataTable();
$dataTables->fromResultSet($resultset)->sendResponse();
}
}
}
Controller (using Array):
<?php
use \DataTables\DataTable;
class TestController extends \Phalcon\Mvc\Controller {
public function indexAction() {
if ($this->request->isAjax()) {
$array = $this->modelsManager->createQuery("SELECT * FROM \Example\Models\User")
->execute()->toArray();
$dataTables = new DataTable();
$dataTables->fromArray($array)->sendResponse();
}
}
}
Controller (using multi models):
<?php
use \DataTables\DataTable;
class TestController extends \Phalcon\Mvc\Controller {
public function indexAction() {
if ($this->request->isAjax()) {
$builder = $this->modelsManager->createBuilder()
->columns('u.id, u.name, u.email, u.name as role_name')
->addFrom('Example\Models\User', 'u')
->addFrom('Example\Models\Role', 'r')
->where('u.role_id = r.id')
$dataTables = new DataTable();
$dataTables->fromBuilder($builder)->sendResponse();
// or pass an array of columns to the builder
$columns = ['u.id', 'u.name', 'u.email', ['u.name', 'alias' => 'role_name']];
$dataTables = new DataTable();
$dataTables->fromBuilder($builder, $columns)->sendResponse();
}
}
}
Model:
<?php
/**
* @property integer id
* @property string name
* @property string email
* @property float balance
* @property integer role_id
*/
class User extends \Phalcon\Mvc\Model {
}
/**
* @property integer id
* @property string name
*/
class Role extends \Phalcon\Mvc\Model {
}
View:
<html>
<head>
<title>Simple DataTables Application</title>
<script type="text/javascript" language="javascript" src="//code.jquery.com/jquery-1.11.1.min.js"></script>
<script type="text/javascript" language="javascript" src="//cdn.datatables.net/1.10.4/js/jquery.dataTables.min.js"></script>
<script type="text/javascript">
$(document).ready(function() {
$('#example').DataTable({
serverSide: true,
ajax: {
url: '/test/index',
method: 'POST'
},
columns: [
{data: "id", searchable: false},
{data: "name"},
{data: "email"},
{data: "balance", searchable: false}
]
});
});
</script>
</head>
<body>
<table id="example">
<thead>
<th>ID</th>
<th>Username</th>
<th>Email</th>
<th>Balance</th>
</thead>
<tbody>
</tbody>
</table>
</body>
</html>
More examples
For more examples please search in site directory.
It contains basic Phalcon bootstrap page to show all Phalcon-DataTables functionality., (*4)
Wallogit.com
