README

About

This is a Phalcon Framework adapter for DataTables.

Support

Currently supported

QueryBuilder interface
ResultSet interface
Pagination
Raw query interface(*new)
Global search (by value)
Ordering
Multiple column ordering
Column-based search
Caching

Installation

Installation via Composer

Install a composer
Create composer.json file inside your project directory
Paste into it

{
    "require": {
        "kirimemail/phalcon-datatables": "1.*"
    }
}

Run composer update

Example usage

It uses Phalcon QueryBuilder for pagination in DataTables.

In example we have a standart MVC application, with database enabled. Don't need to provide a normal bootstrap PHP file, for Phalcon documentation, visit official site.

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 Raw Query):

<?php
use \DataTables\DataTable;

class TestController extends \Phalcon\Mvc\Controller {
    public function indexAction() {
        if ($this->request->isAjax()) {
          $dataTables = new DataTable();
          $dataTables->fromQuery([
              "select"=> "*",
              "from"=> "user"
          ])->sendResponse();
        }
    }
}

Model:

<?php
/**
* @property integer id
* @property string name
* @property string email
* @property float balance
*/
class User 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>

Options

There are few additional option available

<?php
$options = [
    /**
    * Cache options, enabled by default, and defined by hash of the query.
    * Used for caching total and filtered, which is used by in each call.
    * By caching it, we are decreasing the query need to run.   
    */
    "cache_enabled"=>true, 
    "cache_di"=>"modelsCache",
    "cache_lifetime"=>3600
];
//example
$dt = new \DataTables\DataTable($options);
    ?>

More examples

For more examples please search in site directory. It contains basic Phalcon bootstrap page to show all Phalcon-DataTables functionality.

This is fork repo from m10me/phalcon-datatables with some bugfix and additional methods.

kirimemail / phalcon-datatables

Maintainers

Details