FilterEntity extends BaseTable
Table of Contents
Properties
- $internalClass : string
- Internal class.
Methods
- add() : AddResult
- Create new record and return it new id.
- callback() : void
- Register calllback for internal table.
- delete() : Result
- Delete record.
- getFilter() : array<string|int, mixed>
- Gets filter row by id.
- getList() : Result
- Get records of table.
- getMap() : array<string|int, mixed>
- Get Map of table.
- removeBlock() : void
- Remove the block from all filters.
- setFilter() : void
- Store the filter for the block.
- update() : Result
- Update record.
Properties
$internalClass
Internal class.
public
static string
$internalClass
= 'FilterEntityTable'
Methods
add()
Create new record and return it new id.
public
static add(array<string|int, mixed> $fields) : AddResult
Parameters
- $fields : array<string|int, mixed>
-
Fields array.
Return values
AddResultcallback()
Register calllback for internal table.
public
static callback(string $code, callable $callback) : void
Parameters
- $code : string
-
Type of callback.
- $callback : callable
-
Callback.
delete()
Delete record.
public
static delete(int $id) : Result
Parameters
- $id : int
-
Record key.
Return values
ResultgetFilter()
Gets filter row by id.
public
static getFilter(int $filterId) : array<string|int, mixed>
Parameters
- $filterId : int
-
Filter id.
Return values
array<string|int, mixed>getList()
Get records of table.
public
static getList([array<string|int, mixed> $params = array() ]) : Result
Parameters
- $params : array<string|int, mixed> = array()
-
Params array like ORM style.
Return values
ResultgetMap()
Get Map of table.
public
static getMap() : array<string|int, mixed>
Return values
array<string|int, mixed>removeBlock()
Remove the block from all filters.
public
static removeBlock(int $blockId) : void
Parameters
- $blockId : int
-
Block id.
setFilter()
Store the filter for the block.
public
static setFilter(int $blockId[, array<string|int, mixed> &$sourceParams = [] ]) : void
Parameters
- $blockId : int
-
Block id.
- $sourceParams : array<string|int, mixed> = []
-
Source params for this block.
update()
Update record.
public
static update(int $id[, array<string|int, mixed> $fields = array() ]) : Result
Parameters
- $id : int
-
Record key.
- $fields : array<string|int, mixed> = array()
-
Fields array.