1C-Bitrix 25.700.0
Загрузка...
Поиск...
Не найдено
Класс HostRestriction

Открытые члены

 __construct ()
 process ($host=null)
 isValidHost ($host)
 getProperties ()
 setProperties (array $properties)
 getAction ()
 getActionOptions ()
 setAction ($action, array $options=array())
 getLogging ()
 setLogging ($isLogNeeded=true)
 getActive ()
 setActive ($isActive=false)
 getHosts ()
 setHosts ($hosts, $ignoreChecking=false)
 getValidationRegExp ()
 save ()

Поля данных

const ACTION_REDIRECT = 'redirect'
const ACTION_STOP = 'stop'

Защищенные члены

 isBound ()
 getTargetHost ()
 log ($host)
 doActions ()
 genValidationRegExp ($hosts)
 checkNewHosts ($hosts)

Подробное описание

См. определение в файле hostrestriction.php строка 26

Конструктор(ы)

◆ __construct()

__construct ( )

См. определение в файле hostrestriction.php строка 61

Методы

◆ checkNewHosts()

checkNewHosts ( $hosts)
protected

Checks the host to detect logical errors (eg blocking the current host)

Аргументы
string$hostsAllowed hosts (wild card supported, e.g.: *.example.com).
Возвращает
$this
Исключения

Bitrix\Security\LogicException

См. определение в файле hostrestriction.php строка 463

◆ doActions()

doActions ( )
protected

Perform some actions when requested host is not allowed by host restriction policy

Возвращает
$this

@noinspection PhpIncludeInspection

См. определение в файле hostrestriction.php строка 416

◆ genValidationRegExp()

genValidationRegExp ( $hosts)
protected

Generates regular expression obtained from hosts

Аргументы
string$hostsAllowed hosts (wild card supported, e.g.: *.example.com).
Возвращает
string

См. определение в файле hostrestriction.php строка 441

◆ getAction()

getAction ( )
Возвращает
string

См. определение в файле hostrestriction.php строка 178

◆ getActionOptions()

getActionOptions ( )
Возвращает
array

См. определение в файле hostrestriction.php строка 186

◆ getActive()

getActive ( )
Возвращает
bool

См. определение в файле hostrestriction.php строка 257

◆ getHosts()

getHosts ( )
Возвращает
string

См. определение в файле hostrestriction.php строка 285

◆ getLogging()

getLogging ( )
Возвращает
bool

См. определение в файле hostrestriction.php строка 232

◆ getProperties()

getProperties ( )
Возвращает
array

См. определение в файле hostrestriction.php строка 116

◆ getTargetHost()

getTargetHost ( )
protected

Return requested host for checking

Возвращает
string

См. определение в файле hostrestriction.php строка 391

◆ getValidationRegExp()

getValidationRegExp ( )

Return regular expressions (based on hosts) for checking. Note: regular expression is cached for performance improvement and auto cleared after saving {

См. также
save}
Возвращает
string

См. определение в файле hostrestriction.php строка 318

◆ isBound()

isBound ( )
protected

Return true if HostRestriction already handled on system event "OnPageStart"

Возвращает
bool

См. определение в файле hostrestriction.php строка 373

◆ isValidHost()

isValidHost ( $host)

Checking host by host restriction policy

Аргументы
string$hostHost for checking.
Возвращает
bool Return true for valid (allowed) host.
Исключения

Bitrix\Main\ArgumentTypeException

См. определение в файле hostrestriction.php строка 98

◆ log()

log ( $host)
protected

Logging current host by event manager

Аргументы
string$hostRequested host.
Возвращает
bool

См. определение в файле hostrestriction.php строка 406

◆ process()

process ( $host = null)

The main method that checks the current host, logging and starting action

Аргументы
string$hostRequested host for checking.
Возвращает
$this

См. определение в файле hostrestriction.php строка 75

◆ save()

save ( )

Save all properties, enable automatic checking and clear cache if needed

Возвращает
$this

См. определение в файле hostrestriction.php строка 343

◆ setAction()

setAction ( $action,
array $options = array() )

Set action performed while checking

Аргументы
string$actionSome action, now supported: redirect and stop.
array$optionsSome options for action, so far supported only host for redirect in redirect action.
Возвращает
$this
Исключения

Bitrix\Security\LogicException

Исключения

Bitrix\Main\ArgumentTypeException

Исключения

Bitrix\Main\ArgumentNullException

Исключения

Bitrix\Main\ArgumentOutOfRangeException

См. определение в файле hostrestriction.php строка 202

◆ setActive()

setActive ( $isActive = false)

Activate or deactivate automatic checking

Аргументы
bool$isActiveSet true for enable checking on every request.
Исключения

Bitrix\Main\ArgumentTypeException

Возвращает
$this

См. определение в файле hostrestriction.php строка 272

◆ setHosts()

setHosts ( $hosts,
$ignoreChecking = false )

Set allowed hosts

Аргументы
string$hostsAllowed hosts (wild card supported, e.g.: *.example.com).
bool$ignoreCheckingSet false for disable host validating before set.
Исключения

Bitrix\Main\ArgumentTypeException

Исключения
LogicException
Возвращает
$this

См. определение в файле hostrestriction.php строка 299

◆ setLogging()

setLogging ( $isLogNeeded = true)

Activate or deactivate logging on unallowed host requested

Аргументы
bool$isLogNeededSet true if need logging unallowed host.
Возвращает
$this
Исключения

Bitrix\Main\ArgumentTypeException

См. определение в файле hostrestriction.php строка 244

◆ setProperties()

setProperties ( array $properties)

Set various properties for host checking, now support:

  • hosts: a string with allowed hosts (wild card supported, e.g.: *.example.com) {
    См. также
    setHosts}
  • action: a string with action for unallowed host {
    См. также
    validActions}
  • action_options: array with some options for action {
    См. также
    setAction}
  • logging: bool, set true if need logging unallowed host {
    См. также
    setLogging}
  • active: bool, set true if automatic checking on every request needed
Аргументы
array$propertiesSee above.
Исключения

Bitrix\Main\ArgumentOutOfRangeException

Исключения

Bitrix\Main\ArgumentTypeException

Исключения

Bitrix\Main\ArgumentNullException

Исключения
LogicException
Возвращает
$this

См. определение в файле hostrestriction.php строка 143

Поля

◆ ACTION_REDIRECT

const ACTION_REDIRECT = 'redirect'

См. определение в файле hostrestriction.php строка 28

◆ ACTION_STOP

const ACTION_STOP = 'stop'

См. определение в файле hostrestriction.php строка 29

Объявления и описания членов класса находятся в файле: