mini\Table\Wrappers\SortedTable class

Documentation

Sorted table wrapper

Applies ordering to a source table. If source has an index for the order columns, delegates to source. Otherwise, buffers and sorts in-memory.

SortedTable::for($table, new OrderDef('name'), new OrderDef('age', false))

Inheritance

Extends: mini\Table\Wrappers\AbstractTableWrapper

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

Properties (5)

private array $orderBy
protected mini\Table\AbstractTable $source
protected ?Closure $compareFn
protected ?int $limit
protected int $offset

Methods (40)

Create sorted view of a table, optimizing where possible

Documentation missing

Documentation missing

Get the order specification for predicate inspection

Documentation missing

Materialize using a bounded heap for efficient top-k selection

Documentation missing

Documentation missing

Documentation missing

Build a row comparator function from OrderDef[]

public getSource()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Get the source table this wrapper delegates to

public getProperty()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public hasProperty()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public getColumns()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public getAllColumns()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public columns()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public load()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

protected getCompareFn()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public eq()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public lt()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public lte()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public gt()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public gte()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public in()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public like()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public or()
inherited from mini\Table\Wrappers\AbstractTableWrapper

Documentation missing

public __clone()
inherited from mini\Table\AbstractTable

Hook for subclasses to customize clone behavior

public getRowKeyColumns()
inherited from mini\Table\AbstractTable

Get column name(s) that the row key represents

public getLimit()
inherited from mini\Table\AbstractTable

Documentation missing

public getOffset()
inherited from mini\Table\AbstractTable

Documentation missing

public withAlias()
inherited from mini\Table\AbstractTable

Documentation missing

public getTableAlias()
inherited from mini\Table\AbstractTable

Get the current table alias (null if not set)

public union()
inherited from mini\Table\AbstractTable

Documentation missing

public except()
inherited from mini\Table\AbstractTable

Documentation missing

public distinct()
inherited from mini\Table\AbstractTable

Documentation missing

public exists()
inherited from mini\Table\AbstractTable

Documentation missing

public has()
inherited from mini\Table\AbstractTable

Check if value(s) exist in the table's projected columns

protected getPrimaryKeyColumn()
inherited from mini\Table\AbstractTable

Get the primary key column definition (cached)

public final getIterator()
inherited from mini\Table\AbstractTable

Iterate over rows with visible columns only

public withProperty()
inherited from mini\Table\AbstractTable

Return table with property set

Source

src/Table/Wrappers/SortedTable.php:23-268