Spec-Zone.ru › Yii 1.1

IWebUser

Пакет system.base
Наследование интерфейс IWebUser
Подклассы CWebUser
С момента 1.0
Исходный код framework/base/interfaces.php
Интерфейс IWebUser реализуется компонентом приложения пользователя.

Компонент приложения пользователя представляет информацию об идентичности текущего пользователя.

Публичные методы

Метод Описание Определен в
checkAccess() Выполняет проверку доступа для данного пользователя. IWebUser
getId() Возвращает значение, уникально представляющее идентичность. IWebUser
getIsGuest() Возвращает значение, указывающее, является ли пользователь гостем (не авторизован). IWebUser
getName() Возвращает отображаемое имя для идентичности (например, имя пользователя). IWebUser
loginRequired() Перенаправляет браузер пользователя на страницу входа. IWebUser

Подробное описание методов

checkAccess() метод

abstract public boolean checkAccess(string $operation, array $params=array ( ))
$operation string имя операции, для которой требуется проверка доступа.
$params array имя-значение, которые будут переданы бизнес-правилам, связанным с задачами и ролями, назначенными пользователю.
{return} boolean возможно ли выполнение данной операции данным пользователем.
Исходный код: framework/base/interfaces.php#313 (показать)
public function checkAccess($operation,$params=array());

Выполняет проверку доступа для данного пользователя.

getId() метод

abstract public mixed getId()
{return} mixed значение, уникально представляющее идентичность (например, значение первичного ключа).
Исходный код: framework/base/interfaces.php#295 (показать)
public function getId();

Возвращает значение, уникально представляющее идентичность.

getIsGuest() метод

abstract public boolean getIsGuest()
{return} boolean является ли пользователь гостем (не авторизован).
Исходный код: framework/base/interfaces.php#305 (показать)
public function getIsGuest();

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

getName() метод

abstract public string getName()
{return} string отображаемое имя для идентичности.
Исходный код: framework/base/interfaces.php#300 (показать)
public function getName();

Возвращает отображаемое имя для идентичности (например, имя пользователя).

loginRequired() метод

abstract public void loginRequired()
Исходный код: framework/base/interfaces.php#323 (показать)
public function loginRequired();

Перенаправляет браузер пользователя на страницу входа. Перед перенаправлением текущий URL (если это не AJAX запрос) сохраняется в returnUrl, чтобы браузер пользователя мог вернуться на текущую страницу после успешного входа. Убедитесь, что вы установили loginUrl, чтобы браузер пользователя мог быть перенаправлен на указанный URL входа после вызова этого метода. После вызова этого метода текущая обработка запроса будет завершена.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/IWebUser

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API