Bitrix API

Factory

Table of Contents

Methods

canUseAutomation()  : bool
createTarget()  : Base
Create Target instance by entity type.
getAvailableTriggers()  : array<string|int, mixed>
getTriggerByCode()  : bool|Base
onAfterStageDelete()  : mixed
runOnAdd()  : mixed
runOnStatusChanged()  : mixed

Methods

canUseAutomation()

public static canUseAutomation() : bool
Return values
bool

createTarget()

Create Target instance by entity type.

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

Document type id.

$documentId : int|null = null

Document id.

Tags
throws
NotSupportedException
Return values
Base

Target instance, child of BaseTarget.

getAvailableTriggers()

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

Document type id.

Return values
array<string|int, mixed>

getTriggerByCode()

public static getTriggerByCode(mixed $code) : bool|Base
Parameters
$code : mixed
  • Trigger string code.
Return values
bool|Base

Trigger class name or false.

onAfterStageDelete()

public static onAfterStageDelete(int $typeId, int $stageId) : mixed
Parameters
$typeId : int
$stageId : int

runOnAdd()

public static runOnAdd(mixed $typeId, mixed $itemId[, array<string|int, mixed> $fields = null ]) : mixed
Parameters
$typeId : mixed
$itemId : mixed
$fields : array<string|int, mixed> = null

runOnStatusChanged()

public static runOnStatusChanged(mixed $typeId, mixed $itemId[, array<string|int, mixed> $fields = null ]) : mixed
Parameters
$typeId : mixed
$itemId : mixed
$fields : array<string|int, mixed> = null

        
On this page

Search results