Bitrix API

RouteTable extends DataManager

Class RouteTable

DO NOT WRITE ANYTHING BELOW THIS

<<< ORMENTITYANNOTATION

Table of Contents

Methods

createCollection()  : EO_Route_Collection
createObject()  : EO_Route
getById()  : EO_Route_Result
getByPrimary()  : EO_Route_Result
getByRoute()  : array<string|int, mixed>|false
Returns first record filtered by $route value
getEntity()  : EO_Route_Entity
getList()  : EO_Route_Result
getMap()  : array<string|int, mixed>
Returns entity map definition
getTableName()  : string
Returns DB table name for entity
merge()  : AddResult
Adds route to route table. If route record already exists, updates it.
query()  : EO_Route_Query
wakeUpCollection()  : EO_Route_Collection
wakeUpObject()  : EO_Route

Methods

createCollection()

public static createCollection() : EO_Route_Collection
Return values
EO_Route_Collection

createObject()

public static createObject([mixed $setDefaultValues = = 'true' ]) : EO_Route
Parameters
$setDefaultValues : mixed = = 'true'
Return values
EO_Route

getById()

public static getById(mixed $id) : EO_Route_Result
Parameters
$id : mixed
Return values
EO_Route_Result

getByPrimary()

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_Route_Result
Parameters
$primary : mixed
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_Route_Result

getByRoute()

Returns first record filtered by $route value

public static getByRoute(string $route) : array<string|int, mixed>|false
Parameters
$route : string

Route template.

Tags
throws
ArgumentException
Return values
array<string|int, mixed>|false

getEntity()

public static getEntity() : EO_Route_Entity
Return values
EO_Route_Entity

getList()

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_Route_Result
Parameters
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_Route_Result

getMap()

Returns entity map definition

public static getMap() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTableName()

Returns DB table name for entity

public static getTableName() : string
Return values
string

merge()

Adds route to route table. If route record already exists, updates it.

public static merge(array<string|int, mixed> $data) : AddResult
Parameters
$data : array<string|int, mixed>

Record to be merged to the table.

Return values
AddResult

query()

public static query() : EO_Route_Query
Return values
EO_Route_Query

wakeUpCollection()

public static wakeUpCollection(mixed $rows) : EO_Route_Collection
Parameters
$rows : mixed
Return values
EO_Route_Collection

wakeUpObject()

public static wakeUpObject(mixed $row) : EO_Route
Parameters
$row : mixed
Return values
EO_Route

        
On this page

Search results