Получить дополнительные поля пресета Options::getAdditionalPresetFields
Модуль: main — подключать отдельно не нужно
Метод Options::getAdditionalPresetFields возвращает дополнительные поля пресета. Дополнительные поля — значения, которые пользователь добавил к пресету на время сессии и не сохранил в пресете. Класс хранит их в локальном хранилище сессии, а getFilter добавляет их к значениям пресета.
Сигнатура метода в классе Bitrix\Main\UI\Filter\Options:
public function getAdditionalPresetFields($presetId)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| presetId* | string |
Задает код пресета |
Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.
Возвращаемое значение
Метод возвращает массив ключ поля => значение. Если полей нет, метод возвращает пустой массив.
Примеры
Пример. Код задает дополнительное поле и читает его:
<?php
use Bitrix\Main\UI\Filter\Options;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$options = new Options('units_filter');
$options->setAdditionalPresetFields('heavy', ['COLOR' => 'red']);
echo json_encode($options->getAdditionalPresetFields('heavy'));
Код выведет {"COLOR":"red"}.
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая