method public

HostRestriction::setProperties()

Сигнатура

public setProperties(array<string|int, mixed> $properties) : $this

Описание

Устанавливает различные свойства для проверки хостов, сейчас поддерживается: - hosts: строка с разрешёнными хостами (поддерживается подстановочный символ, например: *.example.com) {@see setHosts} - action: строка с действием для неразрешённого хоста {@see validActions} - action_options: массив с некоторыми опциями для действия {@see setAction} - logging: bool, установите true, если требуется логирование неразрешённого хоста {@see setLogging} - active: bool, установите true, если требуется автоматическая проверка при каждом запросе

Параметры

$properties array<string|int, mixed>

См. выше.

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

$this

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

HostRestriction::setProperties() — метод класса \Bitrix\Security\HostRestriction модуля «Проактивная защита».

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

use Bitrix\Main\Loader;
use Bitrix\Security\HostRestriction;

Loader::includeModule('security');

/** @var HostRestriction $object */
$properties = [];
$result = $object->setProperties($properties);
// $result: $this

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

getAction()
getActionOptions()
getActive()
getHosts()
getLogging()
getProperties()
getValidationRegExp() Возвращает регулярные выражения (на основе хостов) для проверки.
isValidHost() Проверка хоста по политике ограничения хостов
onPageStart() Обработчик системного события "OnPageStart", ничего не делает в режиме CLI, поскольку это не имеет…
process() Основной метод, который проверяет текущий хост, ведёт логирование и запускает действие
save() Сохраняет все свойства, включает автоматическую проверку и при необходимости очищает кеш
setAction() Устанавливает действие, выполняемое при проверке

Исходный файл: source/security/lib/hostrestriction.php:143