Класс 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

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

Ссылка

http://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 optional null

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

См. также

AuthComponent::allow()

Ссылка

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

flash()source public

flash( string $message )

Устанавливает сообщение flash. Использует компонент 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 optional null

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

CakeRequest $request optional 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 optional null

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

Возвращает

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

Ссылка

http://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

Ссылка

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

mapActions()source public

mapActions( array $map array() )

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

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

Устаревшее

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

Параметры

array $map optional array()

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

Возвращает

array

См. также

BaseAuthorize::mapActions()

Ссылка

http://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 optional 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 optional 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 )

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

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

Параметры

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

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

Возвращает

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

Ссылка

http://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

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

array $settings необязательно array()

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

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

CakeObject::__construct()

__get()source public

__get( string $name )

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

Параметры

string $name

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

Возвращает

mixed
Объект Component или 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

string|array $url

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

integer $status необязательно null

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

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

Выполнить выход после перенаправления.

Возвращает

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

Ссылка

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

beforeRender()source public

beforeRender( Controller $controller )

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

Параметры

Controller $controller

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

Ссылка

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

shutdown()source public

shutdown( Controller $controller )

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

Параметры

Controller $controller

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

Ссылка

http://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. Если вы хотите её отключить, переопределите этот метод как пустую функцию.

Параметры

array $properties

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

string $class

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

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

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

_set()source protected

_set( array $properties array() )

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

Параметры

array $properties необязательно array()

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

integer|string $status необязательно 0

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

dispatchMethod()source public

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

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

Параметры

string $method

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

array $params необязательно array()

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

Возвращает

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

log()source public

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

Удобный метод для записи сообщения в CakeLog. Подробнее о записи в лог см. CakeLog::write().

Параметры

string $msg

Сообщение для лога

integer $type необязательно LOG_ERR

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

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

Область(и), в которой создаётся сообщение лога. Подробнее об областях логгирования см. CakeLog::config().

Возвращает

boolean
Успех записи в лог

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.

Параметры

string|array $url

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

array $extra необязательно array()

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

Возвращает

mixed

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

toString()source public

toString( )

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

Возвращает

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

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