Bitrix API

TypeChecklistFacade extends CheckListFacade

Class CheckListFacade

Constants

ACTION_ADD = 0x1
ACTION_MODIFY = 0x2
ACTION_REMOVE = 0x3
ACTION_REORDER = 0x5
ACTION_TOGGLE = 0x4
ACTIONS = ['COMMON' => [self::ACTION_ADD => 'ACTION_ADD', self::ACTION_REORDER => 'ACTION_REORDER'], 'ITEM' => [self::ACTION_MODIFY => 'ACTION_MODIFY', self::ACTION_REMOVE => 'ACTION_REMOVE', self::ACTION_TOGGLE => 'ACTION_TOGGLE']]
MEMBER_ACCOMPLICE = 'A'
MEMBER_AUDITOR = 'U'
MOVING_POSITION_AFTER = 'after'
MOVING_POSITION_BEFORE = 'before'
TASK_ADD_CONTEXT = 'TASK_ADD'

Properties

$commonAccessActions : mixed
$currentAccessAction : mixed
$entityIdName : mixed
$itemAccessActions : mixed
$oldItemsToMerge : mixed
$userFieldsEntityIdName : mixed

Methods

add() : Result
addAttachmentByContent() : Result: Attaches file represented by base64 content to checklist.
addAttachmentsFromDisk() : Result: Attaches file from bitrix24 disk to checklist.
addMembers() : Result: Adds members to checklist.
checkAccess() : mixed
checkFieldsForAdd() : Result: Checks fields before adding checklist.
checkFieldsForUpdate() : Result: Checks fields before updating checklist.
complete() : Result: Completes checklist.
completeAll() : Result: Completes all checklists recursively starting from $checkList.
delete() : Result|bool
deleteByEntityId() : mixed: Deletes all checklists of entity.
deleteByEntityIdOnLowLevel() : mixed: Deletes all checklists of entity.
deleteComposite() : Result
deleteLeaf() : Result
doAddPostActions() : mixed: Does some actions after adding checklist.
doDeletePostActions() : mixed: Does some actions after deleting checklists.
doMergePostActions() : mixed: Does some actions after merging checklists.
doMergePreActions() : mixed: Does some actions before merging checklists.
doUpdatePostActions() : mixed: Does some actions after updating checklist.
fillActionsForItems() : mixed
getArrayStructuredRoots() : array<string|int, mixed>: Returns array of roots with subtrees as array structures.
getByEntityId() : array<string|int, mixed>
getCheckListDataController() : string: Returns table class for checklist table.
getCheckListMemberDataController() : string: Returns table class for checklist member table.
getCheckListTree() : string: Returns class that extends abstract class CheckListTree
getCheckListTreeDataController() : string: Returns table class for checklist tree table.
getFieldsForTable() : array<string|int, mixed>: Returns array of fields suitable for table data adding or updating.
getItemsForEntity() : array<string|int, mixed>: Returns checklists with actions for entity if entity is accessible for reading.
getList() : array<string|int, mixed>
getObjectStructuredRoots() : array<string|int, mixed>: Returns array of roots with subtrees as object structures.
isActionAllowed() : bool: Checks if action is allowed for user and entity.
logError() : mixed: Logs error message.
merge() : Result: Sets new checklists for entity by merging with old ones (runs through $newItems, adds completely new to entity, detects differences and changes inner data of changed checklists, deletes all old checklists it did not traverse through).
moveItem() : Result: Moves item before or after another item depending on position.
removeAttachments() : Result: Removes attachments from checklist.
removeMembers() : Result: Removes members from checklist.
renew() : Result: Renews checklist.
update() : Result
updateComposite() : Result

ACTION_ADD


    public
        mixed
    ACTION_ADD
    = 0x1

ACTION_MODIFY


    public
        mixed
    ACTION_MODIFY
    = 0x2

ACTION_REMOVE


    public
        mixed
    ACTION_REMOVE
    = 0x3

ACTION_REORDER


    public
        mixed
    ACTION_REORDER
    = 0x5

ACTION_TOGGLE


    public
        mixed
    ACTION_TOGGLE
    = 0x4

ACTIONS


    public
        mixed
    ACTIONS
    = ['COMMON' => [self::ACTION_ADD => 'ACTION_ADD', self::ACTION_REORDER => 'ACTION_REORDER'], 'ITEM' => [self::ACTION_MODIFY => 'ACTION_MODIFY', self::ACTION_REMOVE => 'ACTION_REMOVE', self::ACTION_TOGGLE => 'ACTION_TOGGLE']]

MEMBER_ACCOMPLICE


    public
        mixed
    MEMBER_ACCOMPLICE
    = 'A'

MEMBER_AUDITOR


    public
        mixed
    MEMBER_AUDITOR
    = 'U'

MOVING_POSITION_AFTER


    public
        mixed
    MOVING_POSITION_AFTER
    = 'after'

MOVING_POSITION_BEFORE


    public
        mixed
    MOVING_POSITION_BEFORE
    = 'before'

TASK_ADD_CONTEXT


    public
        mixed
    TASK_ADD_CONTEXT
    = 'TASK_ADD'

$commonAccessActions


        public
        static    mixed
    $commonAccessActions
     = []

$currentAccessAction


        public
        static    mixed
    $currentAccessAction

$entityIdName


        public
        static    mixed
    $entityIdName
     = 'ENTITY_ID'

$itemAccessActions


        public
        static    mixed
    $itemAccessActions
     = []

$oldItemsToMerge


        public
        static    mixed
    $oldItemsToMerge
     = []

$userFieldsEntityIdName


        public
        static    mixed
    $userFieldsEntityIdName
     = ''

add()


    public
            static        add(int $entityId, int $userId, array<string|int, mixed> $fields) : Result

Parameters

$entityId : int
$userId : int
$fields : array<string|int, mixed>

Return values

Result

addAttachmentByContent()

Attaches file represented by base64 content to checklist.


    public
            static        addAttachmentByContent(int $entityId, int $userId, CheckList $checkList, array<string|int, mixed> $attachmentParameters) : Result

This function uploads file on bitrix24 disk before attaching.

Parameters

$entityId : int

$userId : int

$checkList : CheckList

$attachmentParameters : array<string|int, mixed>

consists of NAME => (string)$name and CONTENT => (base64)$content

Return values

Result

addAttachmentsFromDisk()

Attaches file from bitrix24 disk to checklist.


    public
            static        addAttachmentsFromDisk(int $entityId, int $userId, CheckList $checkList, array<string|int, mixed> $filesIds) : Result

Parameters

$entityId : int
$userId : int
$checkList : CheckList
$filesIds : array<string|int, mixed>

Return values

Result

addMembers()

Adds members to checklist.


    public
            static        addMembers(int $entityId, int $userId, CheckList $checkList, mixed $members) : Result

Parameters

$entityId : int
$userId : int
$checkList : CheckList
$members : mixed

Return values

Result

checkAccess()


    public
            static        checkAccess(mixed $entityId, mixed $userId, mixed $action[, mixed $params = null ]) : mixed

Parameters

$entityId : mixed
$userId : mixed
$action : mixed
$params : mixed = null

checkFieldsForAdd()

Checks fields before adding checklist.


    public
            static        checkFieldsForAdd(array<string|int, mixed> $fields) : Result

Parameters

$fields : array<string|int, mixed>

Return values

Result

checkFieldsForUpdate()

Checks fields before updating checklist.


    public
            static        checkFieldsForUpdate(array<string|int, mixed> $fields) : Result

Parameters

$fields : array<string|int, mixed>

Return values

Result

complete()

Completes checklist.


    public
            static        complete(int $entityId, int $userId, CheckList $checkList) : Result

Parameters

$entityId : int
$userId : int
$checkList : CheckList

Return values

Result

completeAll()

Completes all checklists recursively starting from $checkList.


    public
            static        completeAll(int $entityId, int $userId, CheckList $checkList) : Result

Parameters

$entityId : int
$userId : int
$checkList : CheckList

Return values

Result

delete()


    public
            static        delete(int $entityId, int $userId, CheckList $checkList) : Result|bool

Parameters

$entityId : int
$userId : int
$checkList : CheckList

Return values

Result|bool

deleteByEntityId()

Deletes all checklists of entity.


    public
            static        deleteByEntityId(int $entityId, int $userId) : mixed

Works much slower than deleteByEntityIdOnLowLevel because of recursion, but checks rights and does post actions.

Parameters

$entityId : int
$userId : int

deleteByEntityIdOnLowLevel()

Deletes all checklists of entity.


    public
            static        deleteByEntityIdOnLowLevel(int $entityId) : mixed

Works much faster than deleteByEntityId. This function doesn't check rights and doesn't do post actions.

Parameters

$entityId : int

deleteComposite()


    public
            static        deleteComposite(int $entityId, int $userId, CheckList $checkList) : Result

Parameters

$entityId : int
$userId : int
$checkList : CheckList

Return values

Result

deleteLeaf()


    public
            static        deleteLeaf(int $entityId, int $userId, CheckList $checkList) : Result

Parameters

$entityId : int
$userId : int
$checkList : CheckList

Return values

Result

doAddPostActions()

Does some actions after adding checklist.


    public
            static        doAddPostActions(int $entityId, int $userId, CheckList $checkList) : mixed

Parameters

$entityId : int
$userId : int
$checkList : CheckList

doDeletePostActions()

Does some actions after deleting checklists.


    public
            static        doDeletePostActions(int $entityId, int $userId[, array<string|int, mixed> $data = [] ]) : mixed

Parameters

$entityId : int
$userId : int
$data : array<string|int, mixed> = []

doMergePostActions()

Does some actions after merging checklists.


    public
            static        doMergePostActions(int $entityId, int $userId[, array<string|int, mixed> $data = [] ]) : mixed

Parameters

$entityId : int
$userId : int
$data : array<string|int, mixed> = []

doMergePreActions()

Does some actions before merging checklists.


    public
            static        doMergePreActions(int $entityId, int $userId[, array<string|int, mixed> $data = [] ]) : mixed

Parameters

$entityId : int
$userId : int
$data : array<string|int, mixed> = []

doUpdatePostActions()

Does some actions after updating checklist.


    public
            static        doUpdatePostActions(int $entityId, int $userId, CheckList $oldCheckList, CheckList $newCheckList) : mixed

Parameters

$entityId : int
$userId : int
$oldCheckList : CheckList
$newCheckList : CheckList

fillActionsForItems()


    public
            static        fillActionsForItems(mixed $entityId, mixed $userId, mixed $items) : mixed

Parameters

$entityId : mixed
$userId : mixed
$items : mixed

getArrayStructuredRoots()

Returns array of roots with subtrees as array structures.


    public
            static        getArrayStructuredRoots(array<string|int, mixed> $sourceArray[, string $keyToParent = 'PARENT_ID' ]) : array<string|int, mixed>

Parameters

$sourceArray : array<string|int, mixed>
$keyToParent : string = 'PARENT_ID'

Return values

array<string|int, mixed>

getByEntityId()


    public
            static        getByEntityId(mixed $entityId) : array<string|int, mixed>

Parameters

$entityId : mixed

Return values

array<string|int, mixed>

getCheckListDataController()

Returns table class for checklist table.


    public
            static        getCheckListDataController() : string

Return values

string

getCheckListMemberDataController()

Returns table class for checklist member table.


    public
            static        getCheckListMemberDataController() : string

Return values

string

getCheckListTree()

Returns class that extends abstract class CheckListTree


    public
            static        getCheckListTree() : string

Return values

string

getCheckListTreeDataController()

Returns table class for checklist tree table.


    public
            static        getCheckListTreeDataController() : string

Return values

string

getFieldsForTable()

Returns array of fields suitable for table data adding or updating.


    public
            static        getFieldsForTable(mixed $fields) : array<string|int, mixed>

Parameters

$fields : mixed

Return values

array<string|int, mixed>

getItemsForEntity()

Returns checklists with actions for entity if entity is accessible for reading.


    public
            static        getItemsForEntity(mixed $entityId, mixed $userId) : array<string|int, mixed>

Parameters

$entityId : mixed
$userId : mixed

Return values

array<string|int, mixed>

getList()


    public
            static        getList([array<string|int, mixed> $select = [] ][, array<string|int, mixed> $filter = [] ][, array<string|int, mixed> $order = [] ]) : array<string|int, mixed>

Parameters

$select : array<string|int, mixed> = []
$filter : array<string|int, mixed> = []
$order : array<string|int, mixed> = []

Return values

array<string|int, mixed>

getObjectStructuredRoots()

Returns array of roots with subtrees as object structures.


    public
            static        getObjectStructuredRoots(array<string|int, mixed> $items, int $entityId, int $userId[, string $keyToParent = 'PARENT_ID' ]) : array<string|int, mixed>

Parameters

$items : array<string|int, mixed>
$entityId : int
$userId : int
$keyToParent : string = 'PARENT_ID'

Return values

array<string|int, mixed>

isActionAllowed()

Checks if action is allowed for user and entity.


    public
            static        isActionAllowed(int $entityId, CheckList|null $checkList, int $userId, mixed $actionId) : bool

Parameters

$entityId : int
$checkList : CheckList|null
$userId : int
$actionId : mixed

Return values

bool

logError()

Logs error message.


    public
            static        logError(string $message) : mixed

Parameters

$message : string

merge()

Sets new checklists for entity by merging with old ones (runs through $newItems, adds completely new to entity, detects differences and changes inner data of changed checklists, deletes all old checklists it did not traverse through).


    public
            static        merge(int $entityId, int $userId, array<string|int, mixed> $newItems[, array<string|int, mixed> $parameters = [] ]) : Result

Parameters

$entityId : int
$userId : int
$newItems : array<string|int, mixed>
$parameters : array<string|int, mixed> = []

Return values

Result

moveItem()

Moves item before or after another item depending on position.


    public
            static        moveItem(int $entityId, int $userId, CheckList $itemToMove, int $relatedItemId[, string $position = self::MOVING_POSITION_AFTER ]) : Result

Parameters

$entityId : int
$userId : int
$itemToMove : CheckList
$relatedItemId : int
$position : string = self::MOVING_POSITION_AFTER

Return values

Result

removeAttachments()

Removes attachments from checklist.


    public
            static        removeAttachments(int $entityId, int $userId, CheckList $checkList, array<string|int, mixed> $attachmentsIds) : Result

Parameters

$entityId : int
$userId : int
$checkList : CheckList
$attachmentsIds : array<string|int, mixed>

Return values

Result

removeMembers()

Removes members from checklist.


    public
            static        removeMembers(int $entityId, int $userId, CheckList $checkList, mixed $membersIds) : Result

Parameters

$entityId : int
$userId : int
$checkList : CheckList
$membersIds : mixed

Return values

Result

renew()

Renews checklist.


    public
            static        renew(int $entityId, int $userId, CheckList $checkList) : Result

Parameters

$entityId : int
$userId : int
$checkList : CheckList

Return values

Result

update()


    public
            static        update(int $entityId, int $userId, CheckList $checkList, mixed $fields) : Result

Parameters

$entityId : int
$userId : int
$checkList : CheckList
$fields : mixed

Return values

Result

updateComposite()


    public
            static        updateComposite(int $entityId, int $userId, CheckList $checkList, array<string|int, mixed> $fields) : Result

Parameters

$entityId : int
$userId : int
$checkList : CheckList
$fields : array<string|int, mixed>

Return values

Result

TypeChecklistFacade extends CheckListFacade

Table of Contents

Constants

Properties

Methods

Constants

ACTION_ADD

ACTION_MODIFY

ACTION_REMOVE

ACTION_REORDER

ACTION_TOGGLE

ACTIONS

MEMBER_ACCOMPLICE

MEMBER_AUDITOR

MOVING_POSITION_AFTER

MOVING_POSITION_BEFORE

TASK_ADD_CONTEXT

Properties

$commonAccessActions

$currentAccessAction

$entityIdName

$itemAccessActions

$oldItemsToMerge

$userFieldsEntityIdName

Methods

add()

Parameters

Tags

Return values

addAttachmentByContent()

Parameters

Return values

addAttachmentsFromDisk()

Parameters

Tags

Return values

addMembers()

Parameters

Tags

Return values

checkAccess()

Parameters

checkFieldsForAdd()

Parameters

Return values

checkFieldsForUpdate()

Parameters

Return values

complete()

Parameters

Tags

Return values

completeAll()

Parameters

Tags

Return values

delete()

Parameters

Tags

Return values

deleteByEntityId()

Parameters

Tags

deleteByEntityIdOnLowLevel()

Parameters

Tags

deleteComposite()

Parameters

Tags

Return values

deleteLeaf()

Parameters

Tags

Return values

doAddPostActions()

Parameters

doDeletePostActions()

Parameters

doMergePostActions()

Parameters