method public

HostRestriction::setAction()

Сигнатура

public setAction(string $action[, array<string|int, mixed> $options = array() ]) : $this

Описание

Устанавливает действие, выполняемое при проверке

Параметры

$action string

Некоторое действие, сейчас поддерживаются: redirect и stop.

$options array<string|int, mixed> = array()

Некоторые параметры для действия, пока поддерживается только хост для перенаправления в действии redirect.

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

$this

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

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

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

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

Loader::includeModule('security');

/** @var HostRestriction $object */
$action = '';
$result = $object->setAction($action);
// $result: $this

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

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

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