Bitrix API

CheckList extends CompositeTreeItem

Class CheckList

Table of Contents

Methods

__construct()  : mixed
CheckList constructor.
add()  : mixed
addAttachments()  : mixed
Adds attachments to checklist.
addMembers()  : mixed
Adds members to checklist.
checkFields()  : Result
Checks checklist data fields.
copy()  : CheckList
Returns new item copied from current item.
findById()  : CheckList|null
Finds and returns checklist with given id if it is a part of current checklist subtree (or root itself), otherwise returns null.
findChild()  : $this|TreeItem|null
getAction()  : array<string|int, mixed>
getDescendants()  : array<string|int, mixed>
getDescendantsCount()  : int
getFields()  : array<string|int, mixed>
Returns checklist fields.
getNodeId()  : mixed
getParent()  : mixed
getSkipMembers()  : bool
isComposite()  : bool
remove()  : mixed
removeAttachments()  : mixed
Removes attachments from checklist.
removeMembers()  : mixed
Removes members from checklist.
save()  : Result
Saves checklist and it's whole subtree.
setFields()  : mixed
Sets new values to checklist fields.
setNodeId()  : mixed
setParent()  : mixed
setSkipMembers()  : void
toItemsArray()  : array<string|int, mixed>
Transforms current item object tree structure to array of items.
toTreeArray()  : array<string|int, mixed>
Transforms current item object tree structure to array tree structure.

Methods

__construct()

CheckList constructor.

public __construct(mixed $nodeId, int $userId, CheckListFacade|string $facade[, array<string|int, mixed> $fields = [] ]) : mixed
Parameters
$nodeId : mixed
$userId : int
$facade : CheckListFacade|string
$fields : array<string|int, mixed> = []
Tags
throws
NotImplementedException

addAttachments()

Adds attachments to checklist.

public addAttachments(mixed $filesIds) : mixed
Parameters
$filesIds : mixed

addMembers()

Adds members to checklist.

public addMembers(mixed $members) : mixed
Parameters
$members : mixed

copy()

Returns new item copied from current item.

public copy() : CheckList
Tags
throws
NotImplementedException
Return values
CheckList

findById()

Finds and returns checklist with given id if it is a part of current checklist subtree (or root itself), otherwise returns null.

public findById(mixed $id) : CheckList|null
Parameters
$id : mixed
Return values
CheckList|null

getAction()

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

getDescendants()

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

getFields()

Returns checklist fields.

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

getSkipMembers()

public getSkipMembers() : bool
Return values
bool

removeAttachments()

Removes attachments from checklist.

public removeAttachments(mixed $attachmentsIds) : mixed
Parameters
$attachmentsIds : mixed

removeMembers()

Removes members from checklist.

public removeMembers(mixed $membersIds) : mixed
Parameters
$membersIds : mixed

save()

Saves checklist and it's whole subtree.

public save() : Result

Updates existing item's fields or adds new item if ID is not set.

Tags
throws
ArgumentException
throws
NotImplementedException
throws
ObjectException
throws
ObjectPropertyException
throws
SqlQueryException
throws
SystemException
Return values
Result

setFields()

Sets new values to checklist fields.

public setFields(mixed $data) : mixed
Parameters
$data : mixed

setNodeId()

public setNodeId(mixed $nodeId) : mixed
Parameters
$nodeId : mixed

setSkipMembers()

public setSkipMembers() : void

toItemsArray()

Transforms current item object tree structure to array of items.

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

toTreeArray()

Transforms current item object tree structure to array tree structure.

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results