mini\Table\Contracts\TableInterface::withProperty() Method

public abstract

Signature

public abstract function withProperty(string $name, mixed $value): mini\Table\Contracts\TableInterface

Parameters

Name Type Default Description
$name string required Documentation missing
$value mixed required Documentation missing

Returns

mini\Table\Contracts\TableInterface

Documentation

Return table with property set

Properties can be set to any value including null. Immutable - returns a new table instance with the property set.

$aliased = $users->withProperty('alias', 'u');
$aliased->getProperty('alias');  // 'u'
$users->getProperty('alias');    // null (original unchanged)

Source

src/Table/Contracts/TableInterface.php:372