Bitrix API

WorkflowStateToGet

Table of Contents

Methods

countTotal()  : static
getFilterPresetId()  : string|null
getFilterSearchQuery()  : string|null
getFilterUserId()  : int
getFilterWorkflowIds()  : array<string|int, mixed>|null
getLimit()  : int
getOffset()  : int
getOrder()  : array<string|int, mixed>
getOrmFilter()  : array<string|int, mixed>
getOrmRuntime()  : Reference|null
getSelect()  : array<string|int, mixed>
getSelectTaskFields()  : array<string|int, mixed>
getSelectTaskLimit()  : int|null
isCountingTotal()  : bool
setAdditionalSelectFields()  : static
setFilter()  : static
setFilterPresetId()  : static
setFilterSearchQuery()  : static
setFilterUserId()  : static
setFilterWorkflowIds()  : static
setLimit()  : static
setOffset()  : static
setSelectAllFields()  : static
setSelectTaskLimit()  : $this
Sets tasks limit to get for each workflow. Throws argument exception when $taskLimit is non-positive integer.
setTaskSelectFields()  : static

Methods

countTotal()

public countTotal([bool $count = true ]) : static
Parameters
$count : bool = true
Return values
static

getFilterPresetId()

public getFilterPresetId() : string|null
Return values
string|null

getFilterSearchQuery()

public getFilterSearchQuery() : string|null
Return values
string|null

getFilterWorkflowIds()

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

getOrder()

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

getOrmFilter()

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

getSelect()

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

getSelectTaskFields()

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

getSelectTaskLimit()

public getSelectTaskLimit() : int|null
Return values
int|null

setAdditionalSelectFields()

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

setFilter()

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

setFilterPresetId()

public setFilterPresetId(string $presetId) : static
Parameters
$presetId : string
Return values
static

setFilterSearchQuery()

public setFilterSearchQuery(string $query) : static
Parameters
$query : string
Return values
static

setFilterUserId()

public setFilterUserId(int $userId) : static
Parameters
$userId : int
Return values
static

setFilterWorkflowIds()

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

setLimit()

public setLimit(int $limit) : static
Parameters
$limit : int
Return values
static

setOffset()

public setOffset(int $offset) : static
Parameters
$offset : int
Return values
static

setSelectAllFields()

public setSelectAllFields([bool $flag = true ]) : static
Parameters
$flag : bool = true
Return values
static

setSelectTaskLimit()

Sets tasks limit to get for each workflow. Throws argument exception when $taskLimit is non-positive integer.

public setSelectTaskLimit(int|null $taskLimit) : $this
Parameters
$taskLimit : int|null
Tags
throws
ArgumentException
Return values
$this

setTaskSelectFields()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results