Класс 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/ru/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()

Ссылка

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 необязательно 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 при ошибке

Ссылка

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

logout()source public

logout( )

Выводит пользователя из системы.

Возвращает действие 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 для объектов авторизации.

Параметры

array $map необязательно 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 необязательно 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 )

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

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

Параметры

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

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

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

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

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

Object::__construct()

__get()source public

__get( string $name )

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

Параметры

string $name

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

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

mixed
Объект компонента или 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( )

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

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

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