Bitrix API

Controller extends FactoryBasedController

FinalYes

Constants

ADD_EVENT_NAME = 'timeline_factorybased_add'
REMOVE_EVENT_NAME = 'timeline_factorybased_remove'
RESTORE_EVENT_NAME = 'timeline_factorybased_restore'

Methods

getAssignedByEntity() : int|null
getCurrentBindings() : Bindings
getEntityTypeID() : int: Returns entityTypeId of entity, that this controller works with
getInstance() : static: Get an instance of the controller
getSupportedPullCommands() : array<string|int, string>: Returns associative array of supported pull commands
loadCommunicationsAndMultifields() : void
onConvert() : mixed: Register conversion event in a timeline of a source entity (This entity is a source)
onCreate() : void: Register create event in a timeline
onDelete() : void: Register delete event in a timeline
onModify() : void: Register update event in a timeline
onRestore() : mixed: Register restore event in a timeline
onTaskAccompliceAdded() : void
onTaskAdded() : void
onTaskAllCommentViewed() : void
onTaskAuditorAdded() : void
onTaskBindingsUpdated() : void
onTaskChecklistAdded() : void
onTaskCommentAdded() : void
onTaskCommentDeleted() : void
onTaskCompleted() : void
OnTaskDatePlanUpdated() : void
onTaskDeadLineChanged() : void
onTaskDeleted() : void
onTaskDescriptionChanged() : void
onTaskDisapproved() : void
onTaskExpired() : void
onTaskFilesUpdated() : void
onTaskGroupChanged() : void
onTaskPingSent() : void
onTaskPriorityChanged() : void
onTaskRenew() : void
onTaskResponsibleChanged() : void
onTaskResultAdded() : void
onTaskStatusChanged() : void
onTaskTitleUpdated() : void
onTaskViewed() : void
prepareAuthorInfo() : mixed
prepareAuthorInfoBulk() : mixed
prepareEntityPushTag() : mixed
prepareHistoryDataModel() : array<string|int, mixed>: Prepare data about an timeline entry. The data is used in interface to display timeline event
prepareMultiFieldInfo() : mixed
prepareMultiFieldInfoBulk() : mixed
prepareSearchContent() : string
refreshCommentActivity() : void
refreshTaskActivity() : void
register() : void: Register existed entity in retrospect mode.
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

ADD_EVENT_NAME


    public
        mixed
    ADD_EVENT_NAME
    = 'timeline_factorybased_add'

REMOVE_EVENT_NAME


    public
        mixed
    REMOVE_EVENT_NAME
    = 'timeline_factorybased_remove'

RESTORE_EVENT_NAME


    public
        mixed
    RESTORE_EVENT_NAME
    = 'timeline_factorybased_restore'

getAssignedByEntity()


    public
                    getAssignedByEntity(ItemIdentifier|null $identifier) : int|null

Parameters

$identifier : ItemIdentifier|null

Return values

int|null

getCurrentBindings()


    public
                    getCurrentBindings(array<string|int, mixed> $timelineParams) : Bindings

Parameters

$timelineParams : array<string|int, mixed>

Return values

Bindings

getEntityTypeID()

Returns entityTypeId of entity, that this controller works with


    public
                    getEntityTypeID() : int

Return values

int

getInstance()

Get an instance of the controller


    public
            static        getInstance() : static

Return values

static

getSupportedPullCommands()

Returns associative array of supported pull commands


    public
                    getSupportedPullCommands() : array<string|int, string>

Return values

array<string|int, string>

loadCommunicationsAndMultifields()


    public
            static        loadCommunicationsAndMultifields(array<string|int, mixed> &$items[, CCrmPerms $userPermissions = null ][, array<string|int, mixed> $options = [] ]) : void

Parameters

$items : array<string|int, mixed>
$userPermissions : CCrmPerms = null
$options : array<string|int, mixed> = []

onConvert()


    public
                    onConvert(mixed $ownerID, array<string|int, mixed> $params) : mixed

Parameters

$ownerID : mixed

id of a source entity, which this controller is associated with

$params : array<string|int, mixed>

onCreate()


    public
                    onCreate(mixed $entityID, array<string|int, mixed> $params) : void

Parameters

$entityID : mixed
$params : array<string|int, mixed>

onDelete()


    public
                    onDelete(mixed $entityID, array<string|int, mixed> $params) : void

Parameters

$entityID : mixed
$params : array<string|int, mixed>

onModify()


    public
                    onModify(mixed $entityID, array<string|int, mixed> $params) : void

Parameters

$entityID : mixed
$params : array<string|int, mixed>

onRestore()


    public
                    onRestore(mixed $entityID, array<string|int, mixed> $params) : mixed

Parameters

$entityID : mixed
$params : array<string|int, mixed>

onTaskAccompliceAdded()


    public
                    onTaskAccompliceAdded(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskAdded()


    public
                    onTaskAdded(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskAllCommentViewed()


    public
                    onTaskAllCommentViewed(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskAuditorAdded()


    public
                    onTaskAuditorAdded(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskBindingsUpdated()


    public
                    onTaskBindingsUpdated(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskChecklistAdded()


    public
                    onTaskChecklistAdded(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskCommentAdded()


    public
                    onTaskCommentAdded(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskCommentDeleted()


    public
                    onTaskCommentDeleted(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskCompleted()


    public
                    onTaskCompleted(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

OnTaskDatePlanUpdated()


    public
                    OnTaskDatePlanUpdated(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskDeadLineChanged()


    public
                    onTaskDeadLineChanged(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskDeleted()


    public
                    onTaskDeleted(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskDescriptionChanged()


    public
                    onTaskDescriptionChanged(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskDisapproved()


    public
                    onTaskDisapproved(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskExpired()


    public
                    onTaskExpired(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskFilesUpdated()


    public
                    onTaskFilesUpdated(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskGroupChanged()


    public
                    onTaskGroupChanged(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskPingSent()


    public
                    onTaskPingSent(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskPriorityChanged()


    public
                    onTaskPriorityChanged(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskRenew()


    public
                    onTaskRenew(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskResponsibleChanged()


    public
                    onTaskResponsibleChanged(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskResultAdded()


    public
                    onTaskResultAdded(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskStatusChanged()


    public
                    onTaskStatusChanged(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskTitleUpdated()


    public
                    onTaskTitleUpdated(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

onTaskViewed()


    public
                    onTaskViewed(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

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>

prepareEntityPushTag()


    public
                    prepareEntityPushTag(mixed $entityID) : mixed

Parameters

$entityID : 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>

prepareMultiFieldInfo()


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

Parameters

$item : array<string|int, mixed>

prepareMultiFieldInfoBulk()


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

Parameters

$items : array<string|int, mixed>

prepareSearchContent()


    public
                    prepareSearchContent(array<string|int, mixed> $params) : string

Parameters

$params : array<string|int, mixed>

Return values

string

refreshCommentActivity()


    public
                    refreshCommentActivity(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

refreshTaskActivity()


    public
                    refreshTaskActivity(Bindings $bindings, array<string|int, mixed> $timelineParams) : void

Parameters

$bindings : Bindings
$timelineParams : array<string|int, mixed>

register()


    public
                    register(int $ownerID[, array<string|int, mixed> $options = null ]) : void

Parameters

$ownerID : int: Entity ID
$options : array<string|int, mixed> = 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

Controller extends FactoryBasedController

Table of Contents

Constants

Methods

Constants

ADD_EVENT_NAME

REMOVE_EVENT_NAME

RESTORE_EVENT_NAME

Methods

getAssignedByEntity()

Parameters

Return values

getCurrentBindings()

Parameters

Return values

getEntityTypeID()

Tags

Return values

getInstance()

Return values

getSupportedPullCommands()

Tags

Return values

loadCommunicationsAndMultifields()

Parameters

onConvert()

Parameters

Tags

onCreate()

Parameters

Tags

onDelete()

Parameters

Tags

onModify()

Parameters

Tags

onRestore()

Parameters

Tags

onTaskAccompliceAdded()

Parameters

onTaskAdded()

Parameters

onTaskAllCommentViewed()

Parameters

onTaskAuditorAdded()

Parameters

onTaskBindingsUpdated()

Parameters

onTaskChecklistAdded()

Parameters

onTaskCommentAdded()

Parameters

onTaskCommentDeleted()

Parameters

onTaskCompleted()

Parameters

OnTaskDatePlanUpdated()

Parameters

onTaskDeadLineChanged()

Parameters

onTaskDeleted()

Parameters

onTaskDescriptionChanged()

Parameters

onTaskDisapproved()

Parameters

onTaskExpired()

Parameters

onTaskFilesUpdated()

Parameters

onTaskGroupChanged()

Parameters

onTaskPingSent()

Parameters

onTaskPriorityChanged()

Parameters

onTaskRenew()

Parameters