lavdiu/php-grid

PHP Grid - Easily create flexible grids in PHP

1.1.0 2021-04-02 07:56 UTC

Requires

• php: >=7.2
• ext-json: *
• ext-pdo: *
• box/spout: ^3.1
• phpoffice/phpspreadsheet: ^1.14

Requires (Dev)

• phpunit/phpunit: ^9.2

MIT

• Lulzim

README

PHP Grid - simple php class that allows building dynamic grids using PHP and JS

Getting Started

Prerequisites

This class relies on the following libaries:

• box/spout and phpoffice/phpspreadsheet to generate Excel exports on the server side
• SheetJS to generate Excel/CSV export in the browser.
• JQuery and
• Bootstrap 4

Installation

To install this library use

composer require lavdiu/php-grid

Copy grid.js from assets/ folder to your assets folder or root of your web directory and include it in your page.

Usage

require_once __DIR__ . '/../vendor/autoload.php';

use PhpGrid\PhpGrid;
use PhpGrid\Column;
use PhpGrid\ActionButton;

$pdo = new PDO('mysql:host=localhost;dbname=database', 'username', 'password');

$grid = new PhpGrid($pdo, 'contacts_list');
$grid->setTitle('List of all contacts')
    ->setRowsPerPage(10)
    ->setSqlQuery("SELECT id, name, email, created_on FROM contact_list")
    ->addColumn(new Column('id', 'Contact Id', true, true, '?mod=contact&id={id}', '_blank'))
    ->addColumn(new Column('email', 'Email Address'))
    ->addActionButton(new ActionButton('View', '?mod=contact&id={id}', 'fa fa-eye'))
    ->addActionButton(new ActionButton('Update', '?mod=contact&id={id}&action=update', 'fa fa-pencil'));

/**
 * Setting custom attributes to the button
 */
$deleteButton = new ActionButton('Delete', '?mod=contact&id={id}&action=delete', 'fa fa-trash');
$deleteButton->addAttribute('onclick', "return confirm('Are you sure?');");
$grid->addActionButton($deleteButton);

/**
 * Set custom style/classes to the cell itself
 */
$col1 = new Column('name', 'Full Name');
$col1->setOuterElementCssClass('text-center');
$col1->setOuterElementCssStyle('background-color:silver');
$grid->addColumn($col1);

/**
 * Set custom style/classes to the content of the cell
 */
$col2 = new Column('created_on', 'Registration Date', true);
$col2->setInnerElementCssClass('border border-danger');
$col2->setInnerElementCssStyle('color:red;cursor:pointer;');
$grid->addColumn($col2);

$grid->setDebug(true); #output additional debugging info in json responses

if ($grid->isReadyToHandleRequests()) {
    $grid->bootstrap();
}

echo $grid->draw();

See examples directory for more examples