method public

FunctionBase::onPrepareParameters()

Класс: \Bitrix\Iblock\Template\Functions\FunctionBase

Сигнатура

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

Описание

Вызывается перед вычислением. Его результат будет передан в метод calculate.

Параметры

$entity Base

Этот объект.

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

Разобранный и подготовленный список параметров.

Возвращаемое значение

array<string|int, mixed>

Как применяется в FunctionBase

FunctionBase::onPrepareParameters() — метод класса \Bitrix\Iblock\Template\Functions\FunctionBase модуля «Информационные блоки». FunctionBase: Класс FunctionBase Базовый класс для всех объектов функций, обрабатываемых движком.

Метод объекта: сначала нужен экземпляр FunctionBase.

use Bitrix\Main\Loader;
use Bitrix\Iblock\Template\Functions\FunctionBase;

Loader::includeModule('iblock');

/** @var FunctionBase $object */
$entity = null; // Base
$parameters = [];
$result = $object->onPrepareParameters($entity, $parameters);
// $result: array<string|int, mixed>

Другие методы FunctionBase

calculate() Вызывается движком для обработки вызова функции.

onPrepareParameters() есть и у других классов модуля «Информационные блоки»: FunctionConcat, FunctionContrast, FunctionDistinct, FunctionLimit, FunctionLower, FunctionMax, FunctionMin, FunctionStripTags.

Исходный файл: source/iblock/lib/template/functions/fabric.php:115