Bitrix API

AbstractB2eDocumentTrigger extends BaseTrigger

Table of Contents

Methods

checkApplyRules()  : mixed
className()  : string
execute()  : mixed
executeBySmartDocumentId()  : Result
getCode()  : string
getDescription()  : string
getGroup()  : array<string|int, mixed>
getInputData()  : mixed
getName()  : string
getReturnProperties()  : array<string|int, mixed>
getReturnValues()  : array<string|int, mixed>|null
getTarget()  : BaseTarget
isEnabled()  : bool
isSupported()  : bool
send()  : mixed
setInputData()  : mixed
setReturnValues()  : $this
setTarget()  : $this
toArray()  : array<string|int, mixed>

Methods

checkApplyRules()

public checkApplyRules(array<string|int, mixed> $trigger) : mixed
Parameters
$trigger : array<string|int, mixed>

className()

public static className() : string
Return values
string —

the fully qualified name of this class.

execute()

public static execute(array<string|int, mixed> $bindings[, array<string|int, mixed> $inputData = null ][, bool $useEntitySearch = true ]) : mixed
Parameters
$bindings : array<string|int, mixed>
$inputData : array<string|int, mixed> = null
$useEntitySearch : bool = true

executeBySmartDocumentId()

public static executeBySmartDocumentId(int $smartDocumentId[, array<string|int, mixed> $inputData = null ]) : Result
Parameters
$smartDocumentId : int
$inputData : array<string|int, mixed> = null
Return values
Result

getCode()

public static getCode() : string
Return values
string —

Gets the alphanumeric trigger code.

getDescription()

public static getDescription() : string
Return values
string

getInputData()

public getInputData([mixed $key = null ]) : mixed
Parameters
$key : mixed = null

getName()

public static getName() : string
Return values
string —

Gets the trigger name.

getReturnProperties()

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

getReturnValues()

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

isSupported()

public static isSupported(mixed $entityTypeId) : bool
Parameters
$entityTypeId : mixed

Target entity id

Return values
bool

send()

public send(mixed $entityId) : mixed
Parameters
$entityId : mixed

setInputData()

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

setReturnValues()

public setReturnValues(array<string|int, mixed> $values) : $this
Parameters
$values : array<string|int, mixed>
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results