jeffersonsimaogoncalves / cakephp-utility

6.0.0 2025-10-20 14:07 UTC

Requires

• php: >=7.0
• airmanbzh/php-html-generator: ^1.0
• cakephp/utility: ^3.0
• league/fractal: >=0.13.0

MIT

• Jefferson Simão Gonçalves

• cakephp
• utils

Published on Packagist.org on 2025-10-20 14:14 UTC

README

cakephp-utility

CakePHP 3 plugin with helper classes for building server-side REST API / DataTables-style responses: rendering action links (view/edit/delete/pdf/...) as HTML, wrapping JS callbacks for DataTables configuration, and a League Fractal transformer base that gains access to all of the above.

Requirements

• PHP >=7.0
• CakePHP cakephp/utility ^3.0
• league/fractal >=0.13.0
• airmanbzh/php-html-generator ^1.0

Installation

You can install this plugin into your CakePHP application using composer:

composer require jeffersonsimaogoncalves/cakephp-utility

Load the plugin in config/bootstrap.php:

Plugin::load('JeffersonSimaoGoncalves/Utility');

Usage

TableUtility — DataTables-ready response

use JeffersonSimaoGoncalves\Utility\TableUtility;

$table = new TableUtility();
$table->columns = $columns;
$table->order = [['0', 'asc']];
$table->url = '/users/index.json';
$table->data = $rows;
$table->setCount(count($rows), $totalCount);

return $this->response->withStringBody(json_encode($table->getOptions()));

getOptions() returns data, deferLoading, columns, order and (when url is set) an ajax key, ready to be consumed by a DataTables front-end configuration.

CallbackTrait — JS function references in JSON

Use in any class that builds DataTables configuration to pass a JS function name (instead of a string) as a column callback:

use JeffersonSimaoGoncalves\Utility\CallbackTrait;

class UsersController extends AppController
{
    use CallbackTrait;

    public function index()
    {
        $renderCallback = $this->callback('renderStatusColumn', ['active']);
        // $renderCallback is JSON-serializable; encode it inside your DataTables config
        // and resolve the placeholder afterwards with CallbackFunction::resolve($json)
    }
}

Links — render action links as HTML

use JeffersonSimaoGoncalves\Utility\Links\RenderLink;
use JeffersonSimaoGoncalves\Utility\Lib\RenderTrait;

// Configure the CSS classes used per link type (usually in config/app.php or bootstrap.php)
Configure::write('JeffersonSimaoGoncalves/Utility.RenderLink.linkEdit', [
    'classLink' => 'btn btn-sm btn-primary',
    'classIcon' => 'fa fa-pencil',
]);

class UsersTransformer extends \JeffersonSimaoGoncalves\Utility\Model\Transformer\LinkBaseTransformer
{
    public function transform($user)
    {
        $link = new RenderLink();
        $link->linkEdit('/users/edit/' . $user->id);

        return [
            'id' => $user->id,
            'actions' => $this->renderLink($link),
        ];
    }
}

RenderLink supports linkView(), linkEdit(), linkAdd(), linkBack(), linkPdf(), linkImage(), linkAccept() and a generic link(). Each type reads its classLink/classIcon from Configure, keyed by JeffersonSimaoGoncalves/Utility.RenderLink.<method>.

Forms — status toggle / delete with confirmation

use JeffersonSimaoGoncalves\Utility\Links\RenderForm;

Configure::write('JeffersonSimaoGoncalves/Utility.RenderForm.formDelete', [
    'classLink' => 'btn btn-sm btn-danger',
    'classIcon' => 'fa fa-trash',
]);

$form = new RenderForm();
$form->formDelete('/users/delete/' . $user->id, $user->name);

echo $this->renderForm($form); // hidden POST form + confirm() dialog on click

RenderForm::formStatus() and formDelete() read their config the same way, under JeffersonSimaoGoncalves/Utility.RenderForm.<method>.

Credits

• Jèfferson Simão Gonçalves