Удалить параметры Option::delete

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

Метод Option::delete удаляет сохраненные параметры модуля из базы данных и сбрасывает их кеш. Аналог в классическом API — COption::RemoveOption.

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

public static function delete($moduleId, array $filter = [])

Параметры

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

Параметр Тип Описание
moduleId* string Задает идентификатор модуля без учета регистра
filter array Ограничивает удаление по имени параметра и сайту. По умолчанию — [], удаляет все доступные для удаления параметры модуля

Тип array объявлен в сигнатуре. Тип string для moduleId описывает назначение аргумента.

Ключи фильтра.

Ключ

Описание

name
string

Выбирает имя параметра без учета регистра. Пустая строка вызывает исключение. Если ключа нет, удаление охватывает все имена

site_id
string

Выбирает сайт. Пустая строка ограничивает удаление общими параметрами. Непустая строка ограничивает удаление выбранным сайтом. Если ключа нет, удаление охватывает общие параметры и все сайты

Передавайте идентификатор существующего сайта. При подготовке запроса метод ограничивает непустой site_id двумя символами. В отличие от get и set, фильтр не выбирает текущий сайт по значению false.

Без name фильтр охватывает все имена параметров, а без site_id — общие значения и значения всех сайтов. Для удаления одного общего параметра передайте фильтр ['name' => 'display_mode', 'site_id' => ''].

Метод сохраняет защищенные параметры. У модуля main — имена с начальным ~ и имена crc_code, admin_passwordh, server_uniq_id, PARAM_MAX_SITES, PARAM_MAX_USERS. У остальных модулей — ~bsm_stop_date. Фильтр по имени не отменяет эту защиту.

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

Метод не возвращает значение. Результат вызова — null. После удаления get может вернуть значение из файла модуля или переданное значение по умолчанию. Для проверки отсутствия сохраненного значения используйте getRealValue.

Исключения

Исключение Когда возникает
Bitrix\Main\ArgumentNullException moduleId равен пустой строке или фильтр содержит name с пустым значением
Bitrix\Main\ArgumentException Фильтр содержит ключ, отличный от name и site_id
Bitrix\Main\DB\ConnectionException Не удалось установить соединение с базой данных
Bitrix\Main\DB\SqlQueryException Не удалось выполнить запрос удаления

Метод выполняет удаление общих параметров и параметров сайтов отдельными запросами без собственной транзакции. Если второй запрос завершится ошибкой, первый уже мог удалить данные. Кеш метод сбрасывает после завершения запросов.

Примеры

Примеры удаляют параметр display_mode демонстрационного модуля example.optiondocs, созданный в примере Option::set. Пример D7 удаляет только общее значение. Классический API с пустым сайтом удаляет одноименный параметр и среди общих значений, и для всех сайтов.

Пример. Код удаляет общий параметр и проверяет отсутствие сохраненного значения:

<?php
use Bitrix\Main\Config\Option;

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

Option::delete('example.optiondocs', ['name' => 'display_mode', 'site_id' => '']);
var_dump(Option::getRealValue('example.optiondocs', 'display_mode', ''));

Класс COption устарел. Его методы продолжают работать. Для нового кода используйте Option.

Пример. Код удаляет демонстрационный параметр среди общих значений и значений всех сайтов:

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

COption::RemoveOption('example.optiondocs', 'display_mode', '');
var_dump(COption::GetOptionString('example.optiondocs', 'display_mode', '', '', true));

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

Следующая