Класс AuthComponent

_getUser()source protected

_getUser( )

Аналогично AuthComponent::user(), но если пользователя в сессии не найти, вызываются методы getUser() подключенных объектов аутентификации. Это позволяет корректно работать методам аутентификации без состояния.

Возвращает

boolean
True, если пользователь найден, false — если нет.

_isAllowed()source protected

_isAllowed( Controller $controller )

Проверяет, доступна ли текущая операция без аутентификации.

Параметры

Controller $controller

Ссылка на объект контроллера, его инициализировавший

Возвращает

boolean
True, если действие доступно без аутентификации, иначе false

_isLoginAction()source protected

_isLoginAction( Controller $controller )

Нормализует $loginAction и проверяет, совпадает ли текущий URL запроса с действием входа в систему.

Параметры

Controller $controller

Ссылка на объект контроллера.

Возвращает

boolean
True, если текущее действие — действие входа в систему, иначе false.

_setDefaults()source protected

_setDefaults( )

Попытка получить правильные значения для свойств объекта.

Возвращает

boolean
True

_unauthenticated()source protected

_unauthenticated( Controller $controller )

Обрабатывает попытку доступа без аутентификации. Сначала вызывается метод unathenticated() последнего аутентификатора в цепочке. Аутентификатор может обработать отправку ответа или переадресацию, как необходимо, и вернуть true для указания, что дальнейшие действия не нужны. Если аутентификатор возвращает null, этот метод перенаправляет пользователя на действие входа в систему. Если это запрос AJAX и задан $ajaxLogin, то отображается элемент, в противном случае возвращается код состояния HTTP 403.

Параметры

Controller $controller

Ссылка на объект контроллера.

Возвращает

boolean
True, если текущее действие — действие входа в систему, иначе false.

_unauthorized()source protected

_unauthorized( Controller $controller )

Обработка попытки неавторизованного доступа

Параметры

Controller $controller

Ссылка на объект контроллера

Возвращает

boolean
Возвращает false

Вызывает

ForbiddenException

См. также

AuthComponent::$unauthorizedRedirect

allow()source public

allow( string|array|null $action null )

Принимает список действий в текущем контроллере, для которых аутентификация не требуется, или без параметров для разрешения всех действий.

Можно использовать allow с массивом или с переменным числом аргументов.

$this->Auth->allow(array('edit', 'add')); или $this->Auth->allow('edit', 'add'); или $this->Auth->allow(); для разрешения всех действий

Параметры

string|array|null $action необязательно null

Имя действия контроллера или массив действий

Ссылка

https://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#making-actions-public

constructAuthenticate()source public

constructAuthenticate( )

Загружает настроенные объекты аутентификации.

Возвращает

mixed
Либо null при пустом значении authenticate, либо массив загруженных объектов.

Вызывает

CakeException

constructAuthorize()source public

constructAuthorize( )

Загружает настроенные объекты авторизации.

Возвращает

mixed
Либо null при пустом authorize, либо загруженные объекты авторизации.

Вызывает

CakeException

deny()source public

deny( string|array|null $action null )

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

Вы можете использовать deny с массивом или с переменными аргументами.

$this->Auth->deny(array('edit', 'add')); или $this->Auth->deny('edit', 'add'); или $this->Auth->deny(); для удаления всех элементов из списка разрешенных

Параметры

string|array|null $action необязательный null

Имя действия контроллера или массив действий

См. также

AuthComponent::allow()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/components/authentication.html#making-actions-require-authorization

flash()source public

flash( string $message )

Устанавливает сообщение всплывающего окна. Использует компонент Session и значения из AuthComponent::$flash.

Параметры

string $message

Сообщения для установки.

identify()source public

identify( CakeRequest $request , CakeResponse $response )

Использует настроенные адаптеры аутентификации и пытается идентифицировать пользователя по данным аутентификации, содержащимся в $request.

Параметры

CakeRequest $request

Запрос, содержащий данные аутентификации.

CakeResponse $response

Ответ

Возвращает

array
Данные записи пользователя или false, если пользователь не был идентифицирован.

initialize()source public

initialize( Controller $controller )

Инициализирует AuthComponent для использования в контроллере.

Параметры

Controller $controller

Ссылка на объект контроллера, который его инициализирует

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

Component::initialize()

isAuthorized()source public

isAuthorized( array|null $user null , CakeRequest $request null )

Проверяет, авторизован ли предоставленный пользователь для запроса.

Использует настроенные адаптеры авторизации, чтобы проверить, авторизован ли пользователь. Каждый адаптер проверяется последовательно; если любой из них возвращает true, то пользователь авторизован для запроса.

Параметры

array|null $user необязательный null

Пользователь, авторизация которого проверяется. Если пусто, используется пользователь из сессии.

CakeRequest $request необязательный null

Запрос, для которого проверяется аутентификация. Если пусто, используется текущий запрос.

Возвращает

boolean
True, если $user авторизован, в противном случае false

loggedIn()source public

loggedIn( )

Проверяет, есть ли данные текущего пользователя в сессии и считается ли он авторизованным.

Устарело

3.0.0 С версии 2.5. Используйте AuthComponent::user() напрямую.

Возвращает

boolean
true, если пользователь авторизован, false в противном случае

login()source public

login( array|null $user null )

Вход пользователя.

Если предоставлен $user, эти данные будут сохранены как данные вошедшего пользователя. Если $user пусто или не указано, для идентификации пользователя будет использован запрос. Если идентификация прошла успешно, запись пользователя записывается в ключ сессии, указанный в AuthComponent::$sessionKey. Вход также изменит идентификатор сессии, чтобы помочь предотвратить повторное использование сессии.

Параметры

array|null $user необязательный null

Массив данных пользователя или null для идентификации пользователя с помощью текущего запроса.

Возвращает

boolean
True при успешном входе, false при ошибке

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/components/authentication.html#identifying-users-and-logging-them-in

logout()source public

logout( )

Выход пользователя.

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

Возвращает

string
AuthComponent::$logoutRedirect

См. также

AuthComponent::$logoutRedirect

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/components/authentication.html#logging-users-out

mapActions()source public

mapActions( array $map array() )

Сопоставляет имена действий с операциями CRUD.

Используется для аутентификации на основе контроллера. Убедитесь, что вы настроите свойство authorize перед вызовом этого метода. Так как он делегирует $map всем подключенным объектам authorize.

Устарело

3.0.0 Используйте параметр конфигурации actionMap в объектах authorize для сопоставления действий

Параметры

array $map необязательный array()

Действия для сопоставления

Возвращает

array

См. также

BaseAuthorize::mapActions()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/components/authentication.html#mapping-actions-when-using-crudauthorize

password()source public static

password( string $password )

Хэширует пароль с солью приложения (как определено с помощью Configure::write('Security.salt');

Этот метод предназначен как удобная обертка для Security::hash(). Если вы хотите использовать систему хэширования/шифрования, не поддерживаемую этим методом, не используйте этот метод.

Устарело

3.0.0 С версии 2.4. Используйте Security::hash() напрямую или объект хэшера паролей.

Параметры

string $password

Пароль для хэширования

Возвращает

string
Хэшированный пароль

redirect()source public

redirect( string|array|null $url null )

Обратный совместимый псевдоним для AuthComponent::redirectUrl().

Устарело

3.0.0 С версии 2.3.0, используйте AuthComponent::redirectUrl() вместо

Параметры

string|array|null $url необязательный null

Необязательный URL для записи в качестве URL перенаправления входа.

Возвращает

string
URL перенаправления

redirectUrl()source public

redirectUrl( string|array|null $url null )

Получение URL, на который должен быть перенаправлен пользователь после входа.

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

Если параметр не передан, получает URL перенаправления аутентификации. Возвращаемый URL соответствует следующим правилам:

• Возвращает нормализованный URL из значения сессии Auth.redirect, если оно присутствует и для того же домена, на котором работает текущее приложение.
• Если значения сессии нет и есть $loginRedirect, возвращается значение $loginRedirect.
• Если значения сессии нет и нет $loginRedirect, возвращается /.

Параметры

string|array|null $url необязательный null

Необязательный URL для записи в качестве URL перенаправления входа.

Возвращает

string
URL перенаправления

startup()source public

startup( Controller $controller )

Основной метод выполнения. Обрабатывает перенаправление невалидных пользователей и обработку данных формы входа.

Параметры

Controller $controller

Ссылка на объект контроллера, который его инициализирует

Возвращает

boolean

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

Component::startup()

user()source public static

user( string|null $key null )

Получить текущего пользователя.

Будет отдавать предпочтение кэш-хранилищу пользователя перед сессиями. Кэш-хранилище пользователя в первую очередь используется для бессерверной аутентификации. Для состоятельной аутентификации будут использоваться куки + сессии.

Параметры

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

поле для извлечения. Оставьте null, чтобы получить всю запись пользователя

Возвращает

смесь|null
Запись пользователя. или null, если пользователь не авторизован.

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/components/authentication.html#accessing-the-logged-in-user

__construct()source public

__construct( ComponentCollection $collection , array $settings array() )

Конструктор

Параметры

ComponentCollection $collection

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

массив $settings необязательно массив()

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

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

CakeObject::__construct()

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

beforeRedirect()source public

beforeRedirect( Controller $controller , string|array $url , integer $status null , boolean $exit true )

Вызывается перед Controller::redirect(). Позволяет заменить URL, на который будет произведён перенаправление, на новый URL. Возвращаемое значение этого метода может быть массивом или строкой.

Если возвращаемое значение является массивом и содержит ключ 'url'. Вы также можете указать следующие:

• status Код состояния перенаправления
• exit Следует ли завершить скрипт после перенаправления.

Если ваш ответ является строкой или массивом, не содержащим ключа 'url', он будет использован в качестве нового URL для перенаправления.

Параметры

Controller $controller

Контроллер с компонентами для beforeRedirect

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

Строка или массив URL, на который происходит перенаправление.

целое число $status необязательно null

Код состояния перенаправления

логическое значение $exit необязательно true

Завершить скрипт.

Возвращает

массив|null
Массив или null.

Ссылка

https://book.cakephp.org/2.0/ru/controllers/components.html#Component::beforeRedirect

beforeRender()source public

beforeRender( Controller $controller )

Вызывается перед Controller::beforeRender(), и до загрузки класса представления, и перед Controller::render()

Параметры

Controller $controller

Контроллер с компонентами для beforeRender

Ссылка

https://book.cakephp.org/2.0/ru/controllers/components.html#Component::beforeRender

shutdown()source public

shutdown( Controller $controller )

Вызывается после Controller::render() и перед выводом на браузер.

Параметры

Controller $controller

Контроллер с компонентами для shutdown

Ссылка

https://book.cakephp.org/2.0/ru/controllers/components.html#Component::shutdown

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойства объекта $property со свойством в определении $class. Значение свойства этого класса будет объединено поверх $class'

Это предоставляет часть магии DRY, предоставляемой CakePHP. Если вы хотите отключить её, переопределите этот метод как пустую функцию.

Параметры

массив $properties

Имя свойств для объединения.

строка $class

Класс для объединения свойства с.

логическое значение $normalize необязательно true

Установить в значение true, чтобы выполнить свойства через Hash::normalize() перед объединением.

_set()source protected

_set( array $properties array() )

Позволяет устанавливать несколько свойств объекта в одной строке кода. Будут установлены только свойства, которые являются частью объявления класса.

Параметры

массив $properties необязательно массив()

Ассоциативный массив, содержащий свойства и соответствующие значения.

_stop()source protected

_stop( integer|string $status 0 )

Останавливает выполнение текущего скрипта. Обёртка exit(), что упрощает тестирование.

Параметры

целое число|строка $status необязательно 0

см. http://php.net/exit для значений

dispatchMethod()source public

dispatchMethod( string $method , array $params array() )

Вызывает метод этого объекта с заданными параметрами. Представляет собой ОО-обёртку для call_user_func_array.

Параметры

строка $method

Имя метода для вызова

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

Список параметров для использования при вызове $method

Возвращает

смесь
Результат вызова метода

log()source public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

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

Параметры

строка $msg

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

целое число $type необязательно LOG_ERR

Постоянная ошибка типа. Определено в app/Config/core.php.

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

Область(и), в которой создаётся сообщение журнала. См. CakeLog::config() для получения дополнительной информации о разделах журнала.

Возвращает

логическое значение
Успешность записи в журнал

requestAction()source public

requestAction( string|array $url , array $extra array() )

Вызывает метод контроллера из любого места. Может использоваться для подключения контроллеров или привязки плагинов к главному приложению. requestAction может использоваться для возвращения рендеренд-представлений или извлечения возвращаемого значения из действий контроллера.

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строковый URL. Вы должны использовать форматы URL, совместимые с Router::reverse()

Передача данных POST и GET

Данные POST и GET могут быть смоделированы в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

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

Строковый или массивно-базированный URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

массив $extra необязательно массив()

если массив включает ключ "return", он устанавливает AutoRender в true. Также может быть использован для отправки данных GET/POST и именованных/переданных аргументов.

Возвращает

смесь

Булевое значение true или false при успехе/неудачи, или содержимое рендеренд-действия, если в $extra установлен ключ 'return'.

toString()source public

toString( )

Преобразование CakeObject в строку. Каждый класс может переопределить этот метод по мере необходимости.

Возвращает

строка
Имя этого класса

array()

array()

array()

array()

null

array()

null

$this->Auth->authenticate = array(
    'Form' => array(
        'userModel' => 'Users.User'
    )
);

$this->Auth->authenticate = array(
    'all' => array(
        'userModel' => 'Users.User',
        'scope' => array('User.active' => 1)
    ),
    'Form',
    'Basic'
);

array('Form')

$this->Auth->authorize = array(
    'Crud' => array(
        'actionPath' => 'controllers/'
    )
);

$this->Auth->authorize = array(
    'all' => array(
        'actionPath' => 'controllers/'
    ),
    'Crud',
    'CustomAuth'
);

false

array('Session', 'Flash', 'RequestHandler')

array(
    'element' => 'default',
    'key' => 'auth',
    'params' => array()
)

array(
    'controller' => 'users',
    'action' => 'login',
    'plugin' => null
)

null

null

'Auth.User'

true