Bitrix API

Item implements IBPWorkflowDocument

Table of Contents

Interfaces

IBPWorkflowDocument

Methods

canUserOperateDocument()  : bool
canUserOperateDocumentType()  : bool
createAutomationTarget()  : mixed
createDocument()  : mixed
deleteDocument()  : mixed
getAllowableOperations()  : array<string|int, mixed>
getAllowableUserGroups()  : array<string|int, mixed>
getDocument()  : array<string|int, mixed>|null
getDocumentAdminPage()  : string
getDocumentFields()  : array<string|int, mixed>
getDocumentFieldTypes()  : array<string|int, mixed>
getDocumentForHistory()  : mixed
getDocumentItemId()  : int
getDocumentName()  : string
getDocumentResponsible()  : mixed
getDocumentStages()  : array<string|int, mixed>
getDocumentType()  : string
getDocumentTypeId()  : int
getDocumentTypeName()  : string
getEntityName()  : string
GetJSFunctionsForFields()  : mixed
getUsersFromUserGroup()  : array<string|int, mixed>
isDocumentLocked()  : mixed
isFeatureEnabled()  : bool
lockDocument()  : mixed
makeComplexId()  : array<string|int, mixed>
makeComplexType()  : array<string|int, mixed>
onTaskChange()  : void
publishDocument()  : mixed
recoverDocumentFromHistory()  : mixed
unlockDocument()  : mixed
unpublishDocument()  : mixed
updateDocument()  : mixed

Methods

canUserOperateDocument()

public static canUserOperateDocument(mixed $operation, mixed $userId, mixed $documentId[, mixed $arParameters = [] ]) : bool
Parameters
$operation : mixed
$userId : mixed
$documentId : mixed
$arParameters : mixed = []
Return values
bool

canUserOperateDocumentType()

public static canUserOperateDocumentType(mixed $operation, mixed $userId, mixed $documentType[, mixed $arParameters = [] ]) : bool
Parameters
$operation : mixed
$userId : mixed
$documentType : mixed
$arParameters : mixed = []
Return values
bool

createAutomationTarget()

public static createAutomationTarget(mixed $documentType) : mixed
Parameters
$documentType : mixed

createDocument()

public static createDocument(mixed $parentDocumentId, mixed $arFields) : mixed
Parameters
$parentDocumentId : mixed
$arFields : mixed

deleteDocument()

public static deleteDocument(mixed $documentId) : mixed
Parameters
$documentId : mixed

getAllowableOperations()

public static getAllowableOperations(mixed $documentType) : array<string|int, mixed>
Parameters
$documentType : mixed
Return values
array<string|int, mixed>

getAllowableUserGroups()

public static getAllowableUserGroups(mixed $documentType) : array<string|int, mixed>
Parameters
$documentType : mixed
Return values
array<string|int, mixed>

getDocument()

public static getDocument(mixed $documentId[, mixed $documentType = null ]) : array<string|int, mixed>|null
Parameters
$documentId : mixed
$documentType : mixed = null
Return values
array<string|int, mixed>|null

getDocumentAdminPage()

public static getDocumentAdminPage(mixed $documentId) : string
Parameters
$documentId : mixed
Return values
string

getDocumentFields()

public static getDocumentFields(mixed $documentType) : array<string|int, mixed>
Parameters
$documentType : mixed
Return values
array<string|int, mixed>

getDocumentFieldTypes()

public static getDocumentFieldTypes(mixed $documentType) : array<string|int, mixed>
Parameters
$documentType : mixed
Return values
array<string|int, mixed>

getDocumentForHistory()

public static getDocumentForHistory(mixed $documentId, mixed $historyIndex) : mixed
Parameters
$documentId : mixed
$historyIndex : mixed

getDocumentItemId()

public static getDocumentItemId(string $documentId) : int
Parameters
$documentId : string
Return values
int

getDocumentName()

public static getDocumentName(mixed $documentId) : string
Parameters
$documentId : mixed
Return values
string

getDocumentResponsible()

public static getDocumentResponsible(mixed $documentId) : mixed
Parameters
$documentId : mixed

getDocumentStages()

public static getDocumentStages(string $documentType) : array<string|int, mixed>
Parameters
$documentType : string
Return values
array<string|int, mixed>

getDocumentType()

public static getDocumentType(mixed $documentId) : string
Parameters
$documentId : mixed
Return values
string

getDocumentTypeId()

public static getDocumentTypeId(mixed $documentId) : int
Parameters
$documentId : mixed
Return values
int

getDocumentTypeName()

public static getDocumentTypeName(mixed $documentType) : string
Parameters
$documentType : mixed
Return values
string

getEntityName()

public static getEntityName(mixed $entity) : string
Parameters
$entity : mixed
Return values
string

GetJSFunctionsForFields()

public static GetJSFunctionsForFields() : mixed

getUsersFromUserGroup()

public static getUsersFromUserGroup(mixed $group, mixed $documentId) : array<string|int, mixed>
Parameters
$group : mixed
$documentId : mixed
Return values
array<string|int, mixed>

isDocumentLocked()

public static isDocumentLocked(mixed $documentId, mixed $workflowId) : mixed
Parameters
$documentId : mixed
$workflowId : mixed

isFeatureEnabled()

public static isFeatureEnabled(mixed $documentType, mixed $feature) : bool
Parameters
$documentType : mixed
$feature : mixed
Return values
bool

lockDocument()

public static lockDocument(mixed $documentId, mixed $workflowId) : mixed
Parameters
$documentId : mixed
$workflowId : mixed

makeComplexId()

public static makeComplexId(int $typeId, int $itemId) : array<string|int, mixed>
Parameters
$typeId : int
$itemId : int
Return values
array<string|int, mixed>

makeComplexType()

public static makeComplexType(mixed $typeId) : array<string|int, mixed>
Parameters
$typeId : mixed
Return values
array<string|int, mixed>

onTaskChange()

public static onTaskChange(string $documentId, mixed $taskId, array<string|int, mixed> $taskData, mixed $status) : void
Parameters
$documentId : string
$taskId : mixed
$taskData : array<string|int, mixed>
$status : mixed

publishDocument()

public static publishDocument(mixed $documentId) : mixed
Parameters
$documentId : mixed

recoverDocumentFromHistory()

public static recoverDocumentFromHistory(mixed $documentId, mixed $arDocument) : mixed
Parameters
$documentId : mixed
$arDocument : mixed

unlockDocument()

public static unlockDocument(mixed $documentId, mixed $workflowId) : mixed
Parameters
$documentId : mixed
$workflowId : mixed

unpublishDocument()

public static unpublishDocument(mixed $documentId) : mixed
Parameters
$documentId : mixed

updateDocument()

public static updateDocument(mixed $documentId, mixed $fields[, mixed $modifiedById = null ]) : mixed
Parameters
$documentId : mixed
$fields : mixed
$modifiedById : mixed = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results