Bitrix API

RelationController extends Controller

Table of Contents

Methods

getInstance()  : static
Get an instance of the controller
onItemsBind()  : void
onItemsUnbind()  : void
Register an unbind event in items' timelines
prepareAuthorInfo()  : mixed
prepareAuthorInfoBulk()  : mixed
prepareHistoryDataModel()  : array<string|int, mixed>
Prepare data about an timeline entry. The data is used in interface to display timeline event
registerEventsByBindingsChange()  : void
registerEventsByFieldsChange()  : void
sendPullEventOnAdd()  : void
Send pull event about timeline item creation
sendPullEventOnDelete()  : void
Send pull event about timeline item deletion
sendPullEventOnPin()  : mixed
sendPullEventOnUpdate()  : void
Send pull event about timeline item modification

Methods

getInstance()

Get an instance of the controller

public static getInstance() : static
Return values
static

onItemsBind()

public onItemsBind(ItemIdentifier $parent, ItemIdentifier $child[, int|null $authorId = null ]) : void
Parameters
$parent : ItemIdentifier
$child : ItemIdentifier
$authorId : int|null = null

onItemsUnbind()

Register an unbind event in items' timelines

public onItemsUnbind(ItemIdentifier $parent, ItemIdentifier $child[, int|null $authorId = null ]) : void
Parameters
$parent : ItemIdentifier
$child : ItemIdentifier
$authorId : int|null = null

prepareAuthorInfo()

public static prepareAuthorInfo(array<string|int, mixed> &$item) : mixed
Parameters
$item : array<string|int, mixed>

prepareAuthorInfoBulk()

public static prepareAuthorInfoBulk(array<string|int, mixed> &$items) : mixed
Parameters
$items : array<string|int, mixed>

prepareHistoryDataModel()

Prepare data about an timeline entry. The data is used in interface to display timeline event

public prepareHistoryDataModel(array<string|int, mixed> $data[, array<string|int, mixed>|null $options = null ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$options : array<string|int, mixed>|null = null

= [ 'ENABLE_USER_INFO' => false, // prepare detailed author info (link, image, name). Disabled by default ];

Return values
array<string|int, mixed>

registerEventsByBindingsChange()

public registerEventsByBindingsChange(ItemIdentifier $child, int $parentEntityTypeId, array<string|int, array<string|int, mixed>> $previousBindings, array<string|int, array<string|int, mixed>> $currentBindings[, array<string|int, ItemIdentifier> $itemsToIgnore = [] ][, int|null $authorId = null ]) : void
Parameters
$child : ItemIdentifier
$parentEntityTypeId : int
$previousBindings : array<string|int, array<string|int, mixed>>
$currentBindings : array<string|int, array<string|int, mixed>>
$itemsToIgnore : array<string|int, ItemIdentifier> = []
$authorId : int|null = null

registerEventsByFieldsChange()

public registerEventsByFieldsChange(ItemIdentifier $child, array<string|int, array<string|int, mixed>> $fieldsInfo, array<string|int, mixed> $previousFields, array<string|int, mixed> $currentFields[, array<string|int, ItemIdentifier> $itemsToIgnore = [] ][, int|null $authorId = null ]) : void
Parameters
$child : ItemIdentifier
$fieldsInfo : array<string|int, array<string|int, mixed>>
$previousFields : array<string|int, mixed>
$currentFields : array<string|int, mixed>
$itemsToIgnore : array<string|int, ItemIdentifier> = []
$authorId : int|null = null

sendPullEventOnAdd()

Send pull event about timeline item creation

public sendPullEventOnAdd(ItemIdentifier $itemIdentifier, int $timelineEntryId[, int|null $userId = null ]) : void
Parameters
$itemIdentifier : ItemIdentifier
$timelineEntryId : int
$userId : int|null = null

sendPullEventOnDelete()

Send pull event about timeline item deletion

public sendPullEventOnDelete(ItemIdentifier $itemIdentifier, int $timelineEntryId[, int|null $userId = null ]) : void
Parameters
$itemIdentifier : ItemIdentifier
$timelineEntryId : int
$userId : int|null = null

sendPullEventOnPin()

public sendPullEventOnPin(ItemIdentifier $itemIdentifier, int $timelineEntryId, bool $isPinned[, int $userId = null ]) : mixed
Parameters
$itemIdentifier : ItemIdentifier
$timelineEntryId : int
$isPinned : bool
$userId : int = null

sendPullEventOnUpdate()

Send pull event about timeline item modification

public sendPullEventOnUpdate(ItemIdentifier $itemIdentifier, int $timelineEntryId[, int|null $userId = null ]) : void
Parameters
$itemIdentifier : ItemIdentifier
$timelineEntryId : int
$userId : int|null = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results