AbstractGateway
in package
implements
GatewayInterface
AbstractYes
Db abstract gateway class
Tags
Table of Contents
Interfaces
- GatewayInterface
- Db gateway interface
Constants
- OPTIONS = ['select', 'limit', 'offset', 'order', 'group', 'join', 'columns']
- Recognized $options keys. This is the union of the keys consumed by the table gateway, the row gateway and the relationship classes - a key outside of it is a typo.
Properties
- $table : string|null
- Table
Methods
- __construct() : mixed
- Constructor
- getTable() : string
- Get the table name
- getTableInfo() : array<string|int, mixed>
- Get table info
- checkOptions() : void
- Check the keys of an $options array, firing a notice naming any that isn't recognized
Constants
OPTIONS
Recognized $options keys. This is the union of the keys consumed by the table gateway, the row gateway and the relationship classes - a key outside of it is a typo.
public
array<string|int, mixed>
OPTIONS
= ['select', 'limit', 'offset', 'order', 'group', 'join', 'columns']
Properties
$table
Table
protected
string|null
$table
= null
Methods
__construct()
Constructor
public
__construct(string $table) : mixed
Instantiate the AbstractGateway object.
Parameters
- $table : string
getTable()
Get the table name
public
getTable() : string
Return values
stringgetTableInfo()
Get table info
public
getTableInfo([AbstractAdapter|null $db = null ]) : array<string|int, mixed>
Parameters
- $db : AbstractAdapter|null = null
Return values
array<string|int, mixed>checkOptions()
Check the keys of an $options array, firing a notice naming any that isn't recognized
protected
checkOptions([array<string|int, mixed>|null $options = null ]) : void
An unrecognized key is silently ignored by the query builders, so a misspelled or wrong-cased one ('limitt', 'Limit', 'orderBy') would otherwise return unfiltered results with no signal at all. This is deliberately a notice and not an exception, so that applications passing extra keys today keep working.
Parameters
- $options : array<string|int, mixed>|null = null