Bitrix API

EntityChannelTable extends DataManager

Class EntityChannelTable

DO NOT WRITE ANYTHING BELOW THIS

<<< ORMENTITYANNOTATION

Table of Contents

Methods

bind()  : void
Bind entity to channels.
createCollection()  : EO_EntityChannel_Collection
createObject()  : EO_EntityChannel
getBindingByType()  : array<string|int, mixed>
Get channel bindings for specified entity.
getBindings()  : array<string|int, mixed>
Get channel bindings for specified entity.
getById()  : EO_EntityChannel_Result
getByPrimary()  : EO_EntityChannel_Result
getEntity()  : EO_EntityChannel_Entity
getList()  : EO_EntityChannel_Result
getMap()  : array<string|int, mixed>
Get table fields map.
getTableName()  : string
Get table name.
hasBindings()  : bool
Check if entity has channel bindings.
query()  : EO_EntityChannel_Query
unbind()  : void
Unbind specified entity from specified channels.
unbindAll()  : void
Unbind specified entity from all channels.
upsert()  : void
Execute UPSERT operation.
wakeUpCollection()  : EO_EntityChannel_Collection
wakeUpObject()  : EO_EntityChannel

Methods

bind()

Bind entity to channels.

public static bind(int $entityTypeID, int $entityID, array<string|int, mixed> $bindings) : void
Parameters
$entityTypeID : int

Entity type ID.

$entityID : int

Entity ID.

$bindings : array<string|int, mixed>

Array of channel bindings.

Tags
throws
ArgumentException

createCollection()

public static createCollection() : EO_EntityChannel_Collection
Return values
EO_EntityChannel_Collection

createObject()

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

getBindingByType()

Get channel bindings for specified entity.

public static getBindingByType(int $entityTypeID, int $entityID, int $typeID) : array<string|int, mixed>
Parameters
$entityTypeID : int

Entity type ID.

$entityID : int

Entity ID.

$typeID : int

Type ID.

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

getBindings()

Get channel bindings for specified entity.

public static getBindings(int $entityTypeID, int $entityID) : array<string|int, mixed>
Parameters
$entityTypeID : int

Entity type ID.

$entityID : int

Entity ID.

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

getById()

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

getByPrimary()

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

getEntity()

public static getEntity() : EO_EntityChannel_Entity
Return values
EO_EntityChannel_Entity

getList()

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

getMap()

Get table fields map.

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

getTableName()

Get table name.

public static getTableName() : string
Return values
string

hasBindings()

Check if entity has channel bindings.

public static hasBindings(int $entityTypeID, int $entityID) : bool
Parameters
$entityTypeID : int

Entity type ID.

$entityID : int

Entity ID.

Tags
throws
ArgumentException
Return values
bool

query()

public static query() : EO_EntityChannel_Query
Return values
EO_EntityChannel_Query

unbind()

Unbind specified entity from specified channels.

public static unbind(int $entityTypeID, int $entityID, array<string|int, mixed> $bindings) : void
Parameters
$entityTypeID : int

Entity type ID.

$entityID : int

Entity ID.

$bindings : array<string|int, mixed>

Array of channel bindings.

Tags
throws
ArgumentException
throws
SqlQueryException

unbindAll()

Unbind specified entity from all channels.

public static unbindAll(int $entityTypeID, int $entityID) : void
Parameters
$entityTypeID : int

Entity type ID.

$entityID : int

Entity ID.

Tags
throws
ArgumentException

upsert()

Execute UPSERT operation.

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

Field data.

wakeUpCollection()

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

wakeUpObject()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results