michaelthedev / php-datatables
PHP Helper for Datatables
Requires
- php: >=7.4
- ext-json: *
Requires (Dev)
- phpunit/phpunit: @stable
README
PHP DataTablesHelper
About The Project
PHP DataTablesHelper is a library that provides a helper class for managing DataTables in PHP. It allows you to set table callbacks and process requests to retrieve table data as JSON.
Installation
How to install.
-
Using composer
composer require michaelthedev/php-datatables
Include the generated autoload in your file, See index.php for example
-
If you prefer to include the DataTablesHelper file directly, you can follow these steps:
Download the DataTablesHelper.php file from the GitHub repository.
Include the DataTablesHelper file in your PHP file:
require_once 'path/to/DataTablesHelper.php'; use Michaelthedev\PhpDatatables\DataTablesHelper;
Usage
To use the DataTablesHelper class, follow these steps:
-
Include the DataTablesHelper class in your PHP file:
use Michaelthedev\PhpDatatables\DataTablesHelper;
-
Create an instance of the DataTablesHelper class:
$helper = new DataTablesHelper();
-
Set table callbacks using the
set
method. The table ID is a string identifier for your table, and the callback function should return the table data:$helper->set('tableIdHere', function () { // Your table data retrieval logic here return [ ['col1' => 'val1', 'col2' => 'val2'], ['col1' => 'val3', 'col2' => 'val4'], // ... ]; });
-
Process requests to retrieve table data by calling the
processTableRequest
method with the table ID:$helper->processTableRequest('tableIdHere');
This will return the table data as JSON.
-
Optionally, you can retrieve the IDs of all the tables using the
getTableIds
method:$tableIds = $helper->getTableIds();
This will return an array of table IDs that have been set.
-
See index.php for full usage example
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch
- Commit your Changes
- Push to the Branch
- Open a Pull Request
Built With
License
This project is licensed under the MIT License.