Bitrix API

StageService

FinalYes

Service for working with b2e stages.

Table of Contents

Methods

addStage()  : AddResult
getByStage()  : array<string|int, mixed>|null
getStageEntityId()  : string
isStagesCreated()  : bool
isStagesCreatedByNames()  : bool
removeByStage()  : bool
removeStagesByEntityId()  : bool

Methods

addStage()

public addStage(array<string|int, mixed> $stage) : AddResult
Parameters
$stage : array<string|int, mixed>
Tags
throws
Exception
Return values
AddResult

getByStage()

public getByStage(string $stage, int $documentCategoryId) : array<string|int, mixed>|null
Parameters
$stage : string
$documentCategoryId : int
Return values
array<string|int, mixed>|null

getStageEntityId()

public getStageEntityId(int $documentCategoryId) : string
Parameters
$documentCategoryId : int
Return values
string

isStagesCreated()

public isStagesCreated(array<string|int, mixed> $stages) : bool
Parameters
$stages : array<string|int, mixed>
Tags
throws
SystemException
throws
ArgumentException
Return values
bool

isStagesCreatedByNames()

public isStagesCreatedByNames(array<string|int, mixed> $stageNames, int $documentCategoryId) : bool
Parameters
$stageNames : array<string|int, mixed>
$documentCategoryId : int
Tags
throws
SystemException
throws
ArgumentException
Return values
bool

removeByStage()

public removeByStage(string $stage, int $documentCategoryId) : bool
Parameters
$stage : string
$documentCategoryId : int
Return values
bool

removeStagesByEntityId()

public removeStagesByEntityId(string $entityId) : bool
Parameters
$entityId : string
Return values
bool

        
On this page

Search results