IWebUser
| Пакет | system.base |
|---|---|
| Наследование | интерфейс IWebUser |
| Подклассы | CWebUser |
| С момента | 1.0 |
| Исходный код | framework/base/interfaces.php |
Компонент приложения пользователя представляет информацию об идентичности текущего пользователя.
Публичные методы
| Метод | Описание | Определен в |
|---|---|---|
| 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 | возможно ли выполнение данной операции данным пользователем. |
public function checkAccess($operation,$params=array());
Выполняет проверку доступа для данного пользователя.
getId() метод
abstract public mixed getId() | ||
| {return} | mixed | значение, уникально представляющее идентичность (например, значение первичного ключа). |
Возвращает значение, уникально представляющее идентичность.
getIsGuest() метод
abstract public boolean getIsGuest() | ||
| {return} | boolean | является ли пользователь гостем (не авторизован). |
Возвращает значение, указывающее, является ли пользователь гостем (не авторизован).
getName() метод
abstract public string getName() | ||
| {return} | string | отображаемое имя для идентичности. |
Возвращает отображаемое имя для идентичности (например, имя пользователя).
loginRequired() метод
abstract public void 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