README

A minimal, framework-agnostic grid helper for sortable table headers, pagination links, and result summary text.

Installation

Install the package with Composer:

composer require piko/grid

Quick start

use Piko\Grid;

$rows = [
    ['id' => 1, 'firstname' => 'John', 'lastname' => 'Lennon'],
    ['id' => 2, 'firstname' => 'Elvis', 'lastname' => 'Presley'],
    ['id' => 3, 'firstname' => 'Mick', 'lastname' => 'Jagger'],
];

$grid = new Grid([
    'baseRoute' => '/admin/users',
    'query' => $_GET,
    'countItems' => count($rows),
    'totalItems' => 100,
    'itemsPerPage' => 10,
    'currentPage' => (int)($_GET['page'] ?? 1),
    // optional: 'language' => 'fr',
]);
?>

<table class="table">
  <thead>
    <tr>
      <th><?= $grid->sortColumn('id', 'ID') ?></th>
      <th><?= $grid->sortColumn('firstname', 'First name') ?></th>
      <th><?= $grid->sortColumn('lastname', 'Last name') ?></th>
    </tr>
  </thead>
  <tbody>
    <?php foreach ($rows as $row): ?>
      <tr>
        <td><?= $row['id'] ?></td>
        <td><?= $row['firstname'] ?></td>
        <td><?= $row['lastname'] ?></td>
      </tr>
    <?php endforeach ?>
  </tbody>
</table>

<div class="row">
  <div class="col"><?= $grid->info() ?></div>
  <div class="col"><?= $grid->paginator() ?></div>
</div>

Constructor parameters

Public API

sortColumn(string $columnName, string $label): string

Returns an HTML link for a sortable header.

• If the column is already sorted, direction toggles between ASC and DESC.
• If not sorted yet, it initializes with ASC.
• Existing query parameters are preserved.

paginator(): JasonGrimes\Paginator

Returns a configured paginator instance for the current grid state.

info(): string

Returns localized summary text:

• No results when no rows are available.
• Results {from} to {to} of {total} otherwise.

Query parameter format

Typical generated URLs use:

• page for pagination
• sort[column]=ASC|DESC for sorting

Examples:

• ?page=2
• ?sort[lastname]=ASC
• ?sort[id]=DESC&page=3

Internationalization

Piko Grid uses piko/i18n for messages.

Built-in translations include:

• English (default source strings)
• French (src/messages/fr.php)

You can force a language when creating the grid:

$grid = new Grid([
    // ...
    'language' => 'fr',
]);

Requirements

• PHP >= 8.0
• piko/i18n
• jasongrimes/paginator

When to use / When not to use

Use this library when

• You want a lightweight, framework-agnostic grid helper.
• You prefer explicit query handling (sort, page, filters) over widget conventions.
• You already control rendering in PHP templates and only need sorting links, pagination wiring, and result info.
• You want minimal dependencies and predictable behavior.

Consider a more abstract grid when

• You need built-in column filters, formatters, action columns, or rich cell rendering.
• You want tight integration with ORM/model layers and data providers.
• You need advanced admin features out of the box (AJAX/PJAX updates, bulk actions, complex column configuration).
• Your team prefers convention-heavy components that reduce custom template code.

In short: piko/grid optimizes for simplicity, portability, and control, while higher-level grids (for example, Yii GridView-style components) optimize for batteries-included features.

Quality checks

Run static checks and coding standards:

composer test

Or run them separately:

composer phpcs
composer phpstan

Contributing

Contributions are welcome.

1. Fork the repository
2. Create a feature/fix branch
3. Run quality checks
4. Open a pull request

License

LGPL-3.0-or-later. See LICENSE.txt (or package metadata) for details.