Класс SecurityComponent

_authRequiredsource protected

_authRequired( Cake\Controller\Controller $controller )

Проверка необходимости аутентификации

Параметры

Cake\Controller\Controller $controller

Контроллер

Возвращает

boolean
true, если аутентификация требуется

_callbacksource protected

_callback( Cake\Controller\Controller $controller , string $method , array $params [] )

Вызов метода обратного вызова контроллера

Параметры

Cake\Controller\Controller $controller

Контроллер, для которого выполняется обратный вызов

строка $method

Метод для выполнения

массив $params необязательно []

Параметры, передаваемые в метод

Возвращает

mixed
Ответ метода обратного вызова контроллера

Исключения

Cake\Network\Exception\BadRequestException
При невозможности вызвать blackholeCallback.

_requireMethodsource protected

_requireMethod( string $method , array $actions [] )

Устанавливает действия, требующие HTTP-запрос с указанным методом, или пустое значение для всех действий

Параметры

строка $method

HTTP-метод для назначения действий контроллера

массив $actions необязательно []

Действия контроллера, для которых устанавливается требуемый HTTP-метод.

_secureRequiredsource protected

_secureRequired( Cake\Controller\Controller $controller )

Проверка, требует ли доступ защищённое соединение

Параметры

Cake\Controller\Controller $controller

Контроллер

Возвращает

boolean
true, если требуется защищённое соединение

_validatePostsource protected

_validatePost( Cake\Controller\Controller $controller )

Проверка отправленной формы

Параметры

Cake\Controller\Controller $controller

Контроллер

Возвращает

boolean
true, если отправленная форма валидна

blackHolesource public

blackHole( Cake\Controller\Controller $controller , string $error '' )

Отклоняет невалидный запрос с ошибкой 400 или с использованием пользовательского обратного вызова. Если SecurityComponent::$blackHoleCallback задан, используется этот обратный вызов, выполняя метод, указанный в $error

Параметры

Cake\Controller\Controller $controller

Контроллер

строка $error необязательно ''

Метод ошибки

Возвращает

mixed
Если задан, ответ метода blackHoleCallback контроллера, в противном случае ничего не возвращает

Исключения

Cake\Network\Exception\BadRequestException
\Cake\Network\Exception\BadRequestException

См. также

SecurityComponent::$blackHoleCallback

Ссылка

http://book.cakephp.org/3.0/ru/controllers/components/security.html#handling-blackhole-callbacks

generateTokensource public

generateToken( Cake\Network\Request $request )

Добавление информации о предотвращении подделки форм в предоставленный объект запроса.

Параметры

Cake\Network\Request $request

Объект запроса для добавления

Возвращает

boolean
bool

implementedEventssource public

implementedEvents( )

Поддерживаемые события этим компонентом.

Возвращает

array
массив

Переопределяет

Cake\Controller\Component::implementedEvents()

requireAuthsource public

requireAuth( string|array $actions )

Устанавливает действия, требующие наличия в списках разрешённых элементов форм.

Добавление действий с этим методом будет обеспечивать выполнение ограничений, установленных в SecurityComponent::$allowedControllers и SecurityComponent::$allowedActions.

Параметры

строка|массив $actions

Список действий

requireSecuresource public

requireSecure( string|array $actions null )

Устанавливает действия, требующие защищённого SSL-запроса, или пустое значение для всех действий

Параметры

строка|массив $actions необязательно null

Список действий

startupsource public

startup( Cake\Event\Event $event )

Запуск компонента. Все проверки безопасности выполняются здесь.

Параметры

Cake\Event\Event $event

Объект события

Возвращает

mixed
смешанный тип

__constructsource public

__construct( Cake\Controller\ComponentRegistry $registry , array $config [] )

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry

Объект ComponentRegistry, который может использоваться этим компонентом для ленивой загрузки компонентов

массив $config необязательно []

Массив параметров конфигурации.

__debugInfosource public

__debugInfo( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

array
массив

__getsource public

__get( string $name )

Магический метод для ленивой загрузки $components.

Параметры

строка $name

Имя компонента для получения.

Возвращает

mixed
Объект компонента или null.

initializesource public

initialize( array $config )

Метод хука конструктора.

Реализуйте этот метод, чтобы избежать необходимости переопределения конструктора и вызова родительского класса.

Параметры

массив $config

Параметры конфигурации, предоставленные этому компоненту.

_configDeletesource protected

_configDelete( string $key )

Удалить один ключ конфигурации

Параметры

строка $key

Ключ для удаления.

Исключения

Cake\Core\Exception\Exception
при попытке перезаписать существующую конфигурацию

_configReadsource protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка|null $key

Ключ для чтения.

Возвращает

mixed
смешанный тип

_configWritesource protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись переменной конфигурации

Параметры

строка|массив $key

Ключ для записи.

смешанный тип $value

Значение для записи.

boolean|строка $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

Cake\Core\Exception\Exception
при попытке перезаписать существующую конфигурацию

configsource public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Использование

Чтение всей конфигурации:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

строка|массив|null $key необязательно null

Ключ для получения/установки или полный массив конфигураций.

смешанный тип|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

mixed
Значение конфигурации для чтения или сам объект при операциях записи.

Исключения

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

configShallowsource public

configShallow( string|array $key , mixed|null $value null )

Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

строка|массив $key

Ключ для установки или полный массив конфигураций.

смешанный тип|null $value необязательно null

Значение для установки.

Возвращает

mixed
Сам объект $this.

logsource public

log( mixed $msg , integer|string $level LogLevel::ERROR , string|array $context [] )

Удобный метод для записи сообщения в журнал. См. Log::write() для получения дополнительной информации о записи в журналы.

Параметры

смешанный тип $msg

Сообщение журнала.

целое число|строка $level необязательно LogLevel::ERROR

Уровень ошибки.

строка|массив $context необязательно []

Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

boolean
Успешность записи в журнал.

null

[
    'blackHoleCallback' => null,
    'requireSecure' => [],
    'requireAuth' => [],
    'allowedControllers' => [],
    'allowedActions' => [],
    'unlockedFields' => [],
    'unlockedActions' => [],
    'validatePost' => true
]

[]

[]

[]

false