Bitrix API

MarkController extends Controller

Table of Contents

Methods

getInstance()  : static
Get an instance of the controller
onItemMoveToFinalStage()  : void
Register in timeline that an item was moved to a final stage
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
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

onItemMoveToFinalStage()

Register in timeline that an item was moved to a final stage

public final onItemMoveToFinalStage(ItemIdentifier $item, string $stageId[, int|null $authorId = null ]) : void
Parameters
$item : ItemIdentifier

Item that was moved to a final stage

$stageId : string

Final stage ID

$authorId : int|null = null

Author ID

Tags
throws
ArgumentException
see
PhaseSemantics

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> $options = null ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$options : array<string|int, mixed> = null

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

Return values
array<string|int, mixed>

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