Bitrix API

FunctionBase

Class FunctionBase Base class for all function objects processed by engine.

Table of Contents

Methods

__construct()  : mixed
calculate()  : string
Called by engine to process function call.
onPrepareParameters()  : array<string|int, mixed>
Called before calculation. It's result will be passed to the calculate method.

Methods

__construct()

public __construct([mixed|null $data = null ]) : mixed
Parameters
$data : mixed|null = null

Additional data for function instance.

calculate()

Called by engine to process function call.

public calculate(array<string|int, mixed> $parameters) : string
Parameters
$parameters : array<string|int, mixed>

Function parameters.

Return values
string

onPrepareParameters()

Called before calculation. It's result will be passed to the calculate method.

public onPrepareParameters(Base $entity, array<string|int, array<string|int, mixed>> $parameters) : array<string|int, mixed>
Parameters
$entity : Base

This object.

$parameters : array<string|int, array<string|int, mixed>>

Parsed and prepared list of parameters.

Return values
array<string|int, mixed>

        
On this page

Search results