mini\Table\Contracts\TableInterface abstract interface

Documentation

Interface for tabular data access with filtering, ordering, and pagination

Implementations MUST be immutable - each method returns a new instance with the constraint applied, leaving the original unchanged:

$all = $table;
$active = $table->eq('status', 'active');  // $all unchanged
$sorted = $active->order('name');           // $active unchanged

This enables safe composition and reuse of filtered views.

Iteration MUST yield row ID as key and row data as stdClass:

foreach ($table as $rowId => $row) {
    // $rowId: int|string unique identifier
    // $row: stdClass with column properties
    echo $row->name;
}

Using stdClass (not array) ensures column names are always explicit, which is required for SetInterface::has() with composite keys.

Row IDs are required for UPDATE/DELETE operations and for deduplication when merging results (e.g., OR clauses via union()).

TableInterface extends SetInterface, enabling tables to be used as subqueries in IN clauses:

$activeUserIds = $users->eq('status', 'active')->columns('id');
$orders->in('user_id', $activeUserIds);

Inheritance

Implements: mini\Table\Contracts\SetInterface IteratorAggregate Countable Traversable

Methods (28)

Source

src/Table/Contracts/TableInterface.php:50-373