Documentation

SqlSpecTrait

If a field is specifically stored in the database, then use SqlSpecTrait to describe how to read/write the field.

Table of Contents

Properties

$columnName  : string

SQL column which stores this field.

$operators  : array<string|int, string>

If set, limits the operators that can be used on this field for "get" actions.

$sqlFilters  : array<string|int, callable>

Some fields use a callback to generate their SQL (for reading/searching).

$sqlRenderer  : callable

$tableName  : string

SQL table which stores this field.

Methods

addSqlFilter()  : $this

getColumnName()  : string|null

getTableName()  : string

setColumnName()  : $this

setOperators()  : $this

setSqlFilters()  : $this

setSqlRenderer()  : $this

setTableName()  : $this