neurosys/doctrine-datatables

Library providing a Doctrine2 wrapper over Datatables.js

dev-master 2016-12-09 08:52 UTC

Requires

• php: >=5.3.3
• doctrine/orm: ~2.2
• jms/serializer: ~0.11
• symfony/property-access: ~2.2

Requires (Dev)

• twig/twig: ~1.14

Suggests

• twig/twig: Allows field rendering using Twig templating engine

MIT

• Bartosz Pasiński

README

Doctrine Datatables library provides a Doctrine2 server side processing for Datatables.

This library was created because existing libraries lack of flexibility around field types and field filtering. This library does not provide any JavaScript code generation nor datatables.js sources, you need to install and run datatables.js yourself.

Installation

You can install this library using composer

composer require neurosys/doctrine-datatables

or add the package name to your composer.json

"require": {
    ...
    "neurosys/doctrine-datatables": "dev-master"
}

Features

• support of doctrine query builder
• support of column search with custom column definitions (ex. number, date, composed fields)

It does not support global search (yet)

Usage

$builder = new TableBuilder($entityManager, $_GET);
$builder
    ->from('Foo\Bar\Entity\Sample', 's')
    ->add('text', 's.name')      // field name will be resolved from request (mDataProp_X)
    ->add('number', 's.price')   // field will be a number field which can be filtered by value range
    ->add('boolean', 's.active')
    ;

$response = $builder->getTable()
    ->getResponseArray('entity') // hydrate entity, defaults to array
    ;

// now you can simply return a response
// header ('Content-Type', 'application/json');
// echo json_encode($response);

Composed fields example:

$builder
    ->from('Foo\Bar\Entity\Sample', 's')
    ->join('s.user', 'u')
    ->add('text', 's.name')                          // select and filter by a name field
    ->add('text', 'u.firstName, u.lastName', 'u.id') // select firstName and lastName but filter by an id field
    ->add('date')
    ;

Custom query builder example:

$responseArray = $builder
    ->setQueryBuilder($customQueryBuilder)
    ->add('text', 's.foo', 's.bar') // select foo field but filter by a bar field
    ->getTable()
    ->getResponseArray();

Available field types

• text
• number
• date
• boolean
• choice

Twig field rendering

Default renderer is PhpRenderer, this can be changed by passing another renderer as 4th argument to the TableBuilder:

new TableBuilder($entityManager, $_GET, null, new TwigRenderer($twigEnvironment));

To set field template pass template option:

$builder
    ->add('date', 's.createdAt', null, array(
        'template' => 'path/to/template.html.twig'
    ))

In template.html.twig

{{ value | date }}

Warning

This library is still in development, API is most likely to change.

License

Doctrine Datatables is licensed under the MIT license.