andydune/html-table

This code will simplify or improve your work with html tables.

v1.3.1 2019-04-26 12:29 UTC

This package is auto-updated.

Last update: 2024-10-29 05:28:41 UTC


README

This code will simplify or improve your work with html tables.

Build Status Software License Packagist Version Total Downloads

Requirements

PHP version >= 5.6

Installation

Installation using composer:

composer require andydune/html-table

Or if composer was not installed globally:

php composer.phar require andydune/html-table

Or edit your composer.json:

"require" : {
     "andydune/html-table": "^1"
}

And execute command:

php composer.phar update

Example

Here is small part of code for drawing html table with dynamic data.

<table class="table authlog">
    <thead>
    <tr>
        <td>ID</td>
        <td>User</td>
        <td>STATUS</td>
        <td>Created</td>
        <td>Updated</td>
        <td>Uploaded</td>
        <td>Link</td>
        <td>Data</td>
        <td></td>
        <td></td>
        <td></td>
    </tr>
    </thead>
    <tbody>
    <?php foreach ($list as $file) {
        ?>
        <tr class="<?= $file->getStatus() == 2 ? 'table-success' : null; ?>">
            <td><?= $file->getId(); ?></td>
            <td><?= $user['EMAIL'] ?> (<?= $user['XML_ID'] ?>)</td>
            <td><?= $showStatus($file->getStatus()); ?></td>
            <td><?= $file->getData('DATETIME'); ?></td>
            <td><?= $file->getData('DATETIME_UPDATE'); ?></td>
            <td><?= $file->getData('DATETIME_LAST_REQUEST'); ?></td>
            <td><?= $file->getFileName(); ?>.<?= $file->getFileType() ?></td>
            <td><? $showArray($file->getMeta()) ?></td>
            <td></td>
            <td>повтор</td>
            <td>удаление</td>
        </tr>
    <?php } ?>
    </tbody>
</table>

It is simple to accidentally break html by removing single tag. And it is difficult to read and change.

There is better code down below:

use AndyDune\HtmlTable\Builder;
use AndyDune\HtmlTable\Table;

$table = new Table();
$head = $table->head();
$head->cell()->setContent('ID');
$head->cell()->setContent('User');
$head->cell()->setContent('STATUS');
$head->cell()->setContent('Created');
$head->cell()->setContent('Updated');
$head->cell()->setContent('Uploaded');
$head->cell()->setContent('Uploaded');
$head->cell()->setContent('Data');
// Empty cells will be added automatically depends on max cell count for next rows.
foreach ($list as $file) {
    $row = $table->row();
    if ($file->getStatus() == 2) {
        $row->addClass('table-success')
    }
    $row->cell()->setContent($file->getId());
    $row->cell()->setContent($user['EMAIL'] . $user['XML_ID']);
    $row->cell()->setContent($showStatus($file->getStatus()));
    $row->cell()->setContent($file->getData('DATETIME'));
    $row->cell()->setContent($file->getData('DATETIME_UPDATE'));
    $row->cell()->setContent($file->getData('DATETIME_LAST_REQUEST'));
    $row->cell()->setContent($file->getFileName() . '.' . $file->getFileType());
    $row->cell()->setContent($showArray($file->getMeta()));
}

$buider = new Builder($table);
$builder->setGroupingSections(true);
echo $buider->getHtml(); 

Class structure

Table structure is reflect by classes:

  • AndyDune\HtmlTable\Table - a root of the structure

  • AndyDune\HtmlTable\Element\Row - it implements a table row

  • AndyDune\HtmlTable\Element\Head - it implements a special table row (head). It can be only one.

  • AndyDune\HtmlTable\Element\Cell - it implements a table cell. It is a part of Row (Head)

  • AndyDune\HtmlTable\Builder - the root class for building html code for table. It receives Table instance as a construct parameter.

  • There are many assistive classes for building table, but you don't need to know about their.

Describe table

Table may have attributes, data rows, head row. Rows and cells may have attributes too.

Table, row, cell class attribute

Use method addClass to inject class into table element. Element may have many classes:

use AndyDune\HtmlTable\Table;

// Set classes *useful* and  *one* to table.
$table = new Table();
$table->addClass('useful')->addClass('one');
$table->getClasses(); ['useful', 'one]
// <table class="useful one">

// Set class *active* to row.
$row = $table->row();
$row->addClass('active');
// <tr class="active">

// Set class *left* to cell.
$cell = $row->cell();
$row->addClass('left');
// <td class="left">

Table, row, cell id attribute

Use method setId to inject id into table element. Element may have only one id:

use AndyDune\HtmlTable\Table;

// <table id="top">
$table = new Table();
$table->setId('top');
$table->getId(); // top

// <tr id="active">
$row = $table->row();
$row->setId('active');
$row->getId(); // active

// <td id="left">
$cell = $row->cell();
$row->setId('left');
$row->getId(); //left