Сохранить настройки для другого пользователя Options::saveOptionsForUser

Модуль: main — подключать отдельно не нужно

Метод Options::saveOptionsForUser сохраняет настройки фильтра для указанного пользователя. Метод нужен, чтобы раздать пресеты пользователям, у которых уже есть свои настройки.

Сигнатура метода в классе Bitrix\Main\UI\Filter\Options:

public function saveOptionsForUser($options, $userId)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
options* array Задает настройки в формате getOptions
userId* int Задает идентификатор пользователя

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

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

Метод ничего не возвращает.

Особенности

Метод объединяет пресеты из options с пресетами пользователя. Пресеты из options заменяют пресеты с тем же кодом, а пресеты из deleted_presets удаляются из пресетов пользователя. Права пользователя не проверяются.

Примеры

Пример. Код сохраняет настройки для пользователя с идентификатором 1 и читает их:

<?php
use Bitrix\Main\UI\Filter\Options;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$options = new Options('units_filter', ['active' => ['name' => 'Active', 'fields' => ['ACTIVE' => 'Y']]]);
$options->saveOptionsForUser($options->getOptions(), 1);

$saved = CUserOptions::GetOption('main.ui.filter', 'units_filter', [], 1);

echo implode(',', array_keys($saved['filters']));
CUserOptions::DeleteOption('main.ui.filter', 'units_filter', false, 1);

Код выведет active.

Смотрите также