README

DOMTable

DOMTable is a lightweight PHP library that simplifies the process of creating tables with minimal code. It utilizes the Document Object Model (DOM) to generate HTML code, allowing you to easily display data in a table format. The library is designed to be simple, efficient, and requires no external dependencies.

Features

Create HTML tables from MySQL query results or arrays
Customize table columns and their display titles
Manipulate column values before displaying them in the table
Option to print the table directly to the browser or obtain it as a string

Installation

Composer

composer require ucscode/domtable

Manual

To use DOMTable in your PHP project, you can follow these steps:

Download the DOMTable.php repo as .zip file
Place the DOMTable.php file in your project directory.
Include the file in your PHP script using require_once 'DOMTable.php';.

Usage

Setting up a table

use Ucscode\DOMTable\DOMTable;

// Instantiate DOMTable with table name
$table = new DOMTable("users");

// Set columns to display on the table
$table->setMultipleColumns([
    "id",
    "username",
    "email"
]);

// Fetch data from MySQL database
$result = $db->query("SELECT * FROM users");

// Populate the table with data
$table->setData($result);

// Generate a UssElement Table Container
$element = $table->build();

// Print to HTML Page
echo $element->getHTML();

Populating data with Array

Data may also be populated with array. Consider the example below:

$data = [
    [
        'id' => 1,
        'username' => 'John',
        'email' => 'john@example.com',
    ],
    [
        'id' => 2,
        'username' => 'Jane',
        'email' => 'jane@example.com',
    ],
    // Add more rows as needed
];

$table->setData($data);

In this example, the $data is an array that contains multiple rows of data, where each row is represented as an associative array. Each key in the associative array corresponds to a column name, and the corresponding value represents the data for that column in the row. You can add as many rows as needed to populate the table with your desired data.

Modifying column values

You can modify the values of the each item before they are displayed by passing a DOMTableInterface instance to the second argument of the DOMTable::setData() method. This will allows you to manipulate the item data before the are rendered.

use Ucscode\DOMTable\DOMTableInterface;

$table->setData($result, new class () implements DOMTableInterface 
{
    public function foreachItem(array $item): array
    {
        $item['username'] = 'updated username';
        $item['email'] = 'changed@email.com';
        return $item;
    }
});

$table->build();

License

This project is licensed under the MIT License.

Contribution

Contributions to the DOMTable library are welcome! If you find any issues or have suggestions for improvements, please feel free to create an issue or submit a pull request on the DOMTable GitHub repository.

Support

If you have any questions or need support regarding the usage of DOMTable, please open a new issue on the GitHub repository.

With DOMTable, creating tables in PHP becomes effortless, allowing you to focus on your data presentation without the hassle of manual HTML coding. Enjoy the simplicity and flexibility that DOMTable brings to your table generation tasks. Happy coding!

ucscode / domtable

Maintainers

Details