Класс yii\web\User

Все классы | Свойства | Методы | Константы

Наследование	yii\web\User » yii\base\Component » yii\base\Object
Реализует	yii\base\Configurable
Доступно с версии	2.0
Исходный код	https://github.com/yiisoft/yii2/blob/master/framework/web/User.php

Класс User представляет собой компонент приложения user, который управляет состоянием аутентификации пользователя.

Вы можете использовать $isGuest для определения, является ли текущий пользователь гостем. Если пользователь является гостем, свойство $identity вернёт null. В противном случае, это будет экземпляр yii\web\IdentityInterface.

Вы можете вызвать различные методы для изменения состояния аутентификации пользователя:

login(): устанавливает указанную личность и запоминает состояние аутентификации в сессии и куки;
logout(): помечает пользователя как гостя и очищает соответствующую информацию из сессии и куки;
setIdentity(): изменяет личность пользователя без изменения сессии или куки (это наиболее эффективно используется в реализации бессерверных RESTful API).

Обратите внимание, что User только поддерживает состояние аутентификации пользователя. Он НЕ обрабатывает процесс аутентификации пользователя. Логика аутентификации пользователя должна быть реализована в классе, имплементирующем yii\web\IdentityInterface. Также необходимо установить $identityClass с именем этого класса.

Компонент User настроен в качестве компонента приложения yii\web\Application по умолчанию. Вы можете получить доступ к этому экземпляру через Yii::$app->user.

Вы можете изменить его конфигурацию, добавив массив в конфигурацию вашего приложения в components как показано в следующем примере:

'user' => [
    'identityClass' => 'app\models\User', // User must implement the IdentityInterface
    'enableAutoLogin' => true,
    // 'loginUrl' => ['user/login'],
    // ...
]

Свойства

Свойство	Тип	Описание	Определено
$absoluteAuthTimeout	целое число	Количество секунд, после которого пользователь будет автоматически выведен из системы независимо от активности.	yii\web\User
$absoluteAuthTimeoutParam	строка	Имя переменной сессии, используемой для хранения значения временной метки абсолютного истечения срока действия аутентифицированного состояния.	yii\web\User
$acceptableRedirectTypes	массив	Типы MIME, для которых компонент должен перенаправить на $loginUrl.	yii\web\User
$accessChecker	yii\rbac\CheckAccessInterface	Используемый контроллер доступа для проверки доступа.	yii\web\User
$authTimeout	целое число	Количество секунд, после которых пользователь будет автоматически выведен из системы, если он остается неактивным.	yii\web\User
$authTimeoutParam	строка	Имя переменной сессии, используемой для хранения значения временной метки истечения срока действия аутентифицированного состояния.	yii\web\User
$autoRenewCookie	логическое	Автоматически обновлять куки аутентификации при каждом запросе страницы.	yii\web\User
$behaviors	yii\base\Behavior[]	Список присоединенных к этому компоненту поведений.	yii\base\Component
$enableAutoLogin	логическое	Включить авторизацию через cookie.	yii\web\User
$enableSession	логическое	Использовать сессию для сохранения состояния аутентификации между запросами.	yii\web\User
$id	строка\|целое число	Уникальный идентификатор пользователя.	yii\web\User
$idParam	строка	Имя переменной сессии, используемой для хранения значения $id.	yii\web\User
$identity	yii\web\IdentityInterface\|null	Объект личности, связанный с текущим вошедшим пользователем.	yii\web\User
$identityClass	строка	Имя класса объекта $identity.	yii\web\User
$identityCookie	массив	Конфигурация куки аутентификации.	yii\web\User
$isGuest	логическое	Является ли текущий пользователь гостем.	yii\web\User
$loginUrl	строка\|массив	URL для входа, когда вызывается loginRequired().	yii\web\User
$returnUrl	строка	URL, на который пользователь должен быть перенаправлен после входа.	yii\web\User
$returnUrlParam	строка	Имя переменной сессии, используемой для хранения значения $returnUrl.	yii\web\User

Методы

Метод	Описание	Определено в
__call()	Вызывает именованный метод, который не является методом класса.	yii\base\Component
__clone()	Этот метод вызывается после создания объекта путём клонирования существующего.	yii\base\Component
__construct()	Конструктор.	yii\base\Object
__get()	Возвращает значение свойства компонента.	yii\base\Component
__isset()	Проверяет, установлено ли свойство, т.е. определено и не равно null.	yii\base\Component
__set()	Устанавливает значение свойства компонента.	yii\base\Component
__unset()	Устанавливает свойство компонента в значение null.	yii\base\Component
attachBehavior()	Присоединяет поведение к этому компоненту.	yii\base\Component
attachBehaviors()	Присоединяет список поведений к компоненту.	yii\base\Component
behaviors()	Возвращает список поведений, по которым должен вести себя этот компонент.	yii\base\Component
can()	Проверяет, может ли пользователь выполнить операцию, как указано заданным разрешением.	yii\web\User
canGetProperty()	Возвращает значение, указывающее, может ли свойство быть прочитано.	yii\base\Component
canSetProperty()	Возвращает значение, указывающее, может ли свойство быть установлено.	yii\base\Component
className()	Возвращает полное имя этого класса.	yii\base\Object
detachBehavior()	Отсоединяет поведение от компонента.	yii\base\Component
detachBehaviors()	Отсоединяет все поведения от компонента.	yii\base\Component
ensureBehaviors()	Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту.	yii\base\Component
getBehavior()	Возвращает объект именованного поведения.	yii\base\Component
getBehaviors()	Возвращает все поведения, присоединенные к этому компоненту.	yii\base\Component
getId()	Возвращает значение, уникально представляющее пользователя.	yii\web\User
getIdentity()	Возвращает объект идентификации, связанный с текущим вошедшим пользователем.	yii\web\User
getIsGuest()	Возвращает значение, указывающее, является ли пользователь гостем (не авторизован).	yii\web\User
getReturnUrl()	Возвращает URL, на который должен перенаправить браузер после успешного входа.	yii\web\User
hasEventHandlers()	Возвращает значение, указывающее, существует ли какой-либо обработчик, прикрепленный к названному событию.	yii\base\Component
hasMethod()	Возвращает значение, указывающее, определён ли метод.	yii\base\Component
hasProperty()	Возвращает значение, указывающее, определено ли свойство для этого компонента.	yii\base\Component
init()	Инициализирует компонент приложения.	yii\web\User
login()	Вход пользователя.	yii\web\User
loginByAccessToken()	Вход пользователя по заданному токену доступа.	yii\web\User
loginRequired()	Перенаправляет браузер пользователя на страницу входа.	yii\web\User
logout()	Выход текущего пользователя.	yii\web\User
off()	Отсоединяет существующий обработчик событий от этого компонента.	yii\base\Component
on()	Присоединяет обработчик событий к событию.	yii\base\Component
setIdentity()	Устанавливает объект идентификации пользователя.	yii\web\User
setReturnUrl()	Запоминает URL в сессии, чтобы его можно было получить позднее с помощью getReturnUrl().	yii\web\User
switchIdentity()	Переключается на новую идентификацию для текущего пользователя.	yii\web\User
trigger()	Вызывает событие.	yii\base\Component

Защищенные методы

Метод	Описание	Определено в
afterLogin()	Этот метод вызывается после успешного входа пользователя.	yii\web\User
afterLogout()	Этот метод вызывается сразу после выхода пользователя с помощью logout().	yii\web\User
beforeLogin()	Этот метод вызывается перед входом пользователя.	yii\web\User
beforeLogout()	Этот метод вызывается при вызове logout() для выхода пользователя.	yii\web\User
checkRedirectAcceptable()	Проверяет, содержит ли заголовок `Accept` тип контента, позволяющий перенаправить на страницу входа.	yii\web\User
getAccessChecker()	Возвращает контроллер доступа, используемый для проверки доступа.	yii\web\User
getAuthManager()	Возвращает менеджер авторизации, связанный с компонентом пользователя.	yii\web\User
getIdentityAndDurationFromCookie()	Определяет, имеет ли cookie идентификации правильный формат и содержит ли он действительный ключ авторизации.	yii\web\User
loginByCookie()	Вход пользователя по cookie.	yii\web\User
removeIdentityCookie()	Удаляет cookie идентификации.	yii\web\User
renewAuthStatus()	Обновляет статус авторизации, используя информацию из сессии и cookie.	yii\web\User
renewIdentityCookie()	Обновляет cookie идентификации.	yii\web\User
sendIdentityCookie()	Отправляет cookie идентификации.	yii\web\User

Константы

Постоянная	Значение	Определено в
EVENT_AFTER_LOGIN	'afterLogin'	yii\web\User
EVENT_AFTER_LOGOUT	'afterLogout'	yii\web\User
EVENT_BEFORE_LOGIN	'beforeLogin'	yii\web\User
EVENT_BEFORE_LOGOUT	'beforeLogout'	yii\web\User

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

$absoluteAuthTimeout общедоступное свойство

Количество секунд, после которого пользователь будет автоматически выведен из системы, независимо от активности. Обратите внимание, что это не сработает, если $enableAutoLogin true.

public integer $absoluteAuthTimeout = null

$absoluteAuthTimeoutParam общедоступное свойство

Имя переменной сессии, используемой для хранения значения отметки времени абсолютного истечения срока действия аутентифицированного состояния. Используется, когда $absoluteAuthTimeout задано.

public string $absoluteAuthTimeoutParam = '__absoluteExpire'

$acceptableRedirectTypes общедоступное свойство (доступно начиная с версии 2.0.8)

Типы MIME, для которых этот компонент должен перенаправлять на $loginUrl.

public array $acceptableRedirectTypes = ['text/html', 'application/xhtml+xml']

$accessChecker общедоступное свойство (доступно начиная с версии 2.0.9)

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

public yii\rbac\CheckAccessInterface $accessChecker = null

$authTimeout общедоступное свойство

Количество секунд, после которого пользователь будет автоматически выведен из системы, если он остаётся неактивным. Если это свойство не задано, пользователь будет выведен из системы после истечения срока действия текущей сессии (см. yii\web\Session::$timeout). Обратите внимание, что это не сработает, если $enableAutoLogin true.

public integer $authTimeout = null

$authTimeoutParam общедоступное свойство

Имя переменной сессии, используемой для хранения значения отметки времени истечения срока действия аутентифицированного состояния. Используется, когда $authTimeout задано.

public string $authTimeoutParam = '__expire'

$autoRenewCookie общедоступное свойство

Автоматически обновлять куки идентификатора каждый раз при запросе страницы. Это свойство эффективно только при $enableAutoLogin true. Когда это false, куки идентификатора истекает по истечении указанного времени с момента первоначального входа в систему пользователя. Когда это true, куки идентификатора истекает по истечении указанного времени с момента последнего посещения сайта пользователем.

См. также $enableAutoLogin.

public boolean $autoRenewCookie = true

$enableAutoLogin общедоступное свойство

Включить вход по cookie. По умолчанию false. Обратите внимание, что это свойство будет проигнорировано, если $enableSession false.

public boolean $enableAutoLogin = false

$enableSession общедоступное свойство

Использовать сессию для сохранения статуса аутентификации на протяжении нескольких запросов. Вы задаёте это свойство в false , если ваше приложение бессостояние, что часто встречается в RESTful API.

public boolean $enableSession = true

$id общедоступное только для чтения свойство

Уникальный идентификатор пользователя. Если null, это означает, что пользователь — гость.

public string|integer getId ( )

$idParam общедоступное свойство

Имя переменной сессии, используемой для хранения значения $id.

public string $idParam = '__id'

$identity общедоступное свойство

Объект идентификации, связанный с текущим вошедшим пользователем. null возвращается, если пользователь не вошел в систему (не авторизован).

public yii\web\IdentityInterface|null getIdentity ( $autoRenew = true )
public void setIdentity ( $identity )

$identityClass общедоступное свойство

Имя класса объекта $identity.

public string $identityClass = null

$identityCookie общедоступное свойство

Настройка куки идентификатора. Это свойство используется только тогда, когда $enableAutoLogin true.

См. также yii\web\Cookie.

public array $identityCookie = ['name' => '_identity', 'httpOnly' => true]

$isGuest общедоступное только для чтения свойство

Является ли текущий пользователь гостем.

public boolean getIsGuest ( )

$loginUrl общедоступное свойство

URL для входа, когда вызывается loginRequired(). Если задан массив, вызывается yii\web\UrlManager::createUrl() для создания соответствующего URL. Первый элемент массива должен быть маршрутом к действию входа, а остальные пары имя-значение — параметрами GET, используемыми для построения URL входа. Например,

['site/login', 'ref' => 1]

Если это свойство null, при вызове loginRequired() будет поднято исключение 403 HTTP.

public string|array $loginUrl = ['site/login']

$returnUrl общедоступное свойство

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

public string getReturnUrl ( $defaultUrl = null )
public void setReturnUrl ( $url )

$returnUrlParam общедоступное свойство

Имя переменной сессии, используемой для хранения значения $returnUrl.

public string $returnUrlParam = '__returnUrl'

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

afterLogin() защищённый метод

Этот метод вызывается после успешного входа пользователя в систему.

В стандартной реализации запускается событие EVENT_AFTER_LOGIN. Если вы переопределяете этот метод, убедитесь, что вызывается родительская реализация, чтобы событие было запущено.

защищённый void afterLogin ( $identity, $cookieBased, $duration )
$identity	yii\web\IdentityInterface	Информация об идентификации пользователя
$cookieBased	boolean	Является ли вход в систему cookie-базированным
$duration	integer	Количество секунд, в течение которого пользователь может оставаться авторизованным. Если 0, значит вход сохраняется до закрытия браузера или до ручного уничтожения сессии.

afterLogout() защищённый метод

Этот метод вызывается сразу после выхода пользователя из системы с помощью logout().

В стандартной реализации запускается событие EVENT_AFTER_LOGOUT. Если вы переопределяете этот метод, убедитесь, что вызывается родительская реализация, чтобы событие было запущено.

защищённый void afterLogout ( $identity )
$identity	yii\web\IdentityInterface	Информация об идентификации пользователя

beforeLogin() защищённый метод

Этот метод вызывается перед входом пользователя в систему.

В стандартной реализации запускается событие EVENT_BEFORE_LOGIN. Если вы переопределяете этот метод, убедитесь, что вызывается родительская реализация, чтобы событие было запущено.

защищённый boolean beforeLogin ( $identity, $cookieBased, $duration )
$identity	yii\web\IdentityInterface	Информация об идентификации пользователя
$cookieBased	boolean	Является ли вход в систему cookie-базированным
$duration	integer	Количество секунд, в течение которого пользователь может оставаться авторизованным. Если 0, значит вход сохраняется до закрытия браузера или до ручного уничтожения сессии.
return	boolean	Продолжать ли вход в систему

beforeLogout() защищённый метод

Этот метод вызывается при вызове logout() для выхода пользователя из системы.

В стандартной реализации запускается событие EVENT_BEFORE_LOGOUT. Если вы переопределяете этот метод, убедитесь, что вызывается родительская реализация, чтобы событие было запущено.

защищённый boolean beforeLogout ( $identity )
$identity	yii\web\IdentityInterface	Информация об идентификации пользователя
return	boolean	Продолжать ли выход пользователя из системы

can() публичный метод

Проверяет, может ли пользователь выполнить операцию в соответствии с заданным разрешением.

Обратите внимание, что вы должны настроить компонент приложения "authManager", чтобы использовать этот метод. В противном случае он всегда вернёт false.

публичный boolean can ( $permissionName, $params = [], $allowCaching = true )
$permissionName	string	Название разрешения (например, «редактировать пост»), для которого требуется проверка доступа.
$params	array	Имя-значение, которые будут переданы правилам, связанным с ролями и разрешениями, назначенными пользователю.
$allowCaching	boolean	Разрешить кэширование результата проверки доступа. Когда этот параметр имеет значение true (по умолчанию), если проверка доступа к операции уже выполнялась ранее, её результат будет возвращён напрямую при вызове этого метода для проверки той же операции. Если этот параметр имеет значение false, этот метод всегда вызовет yii\rbac\CheckAccessInterface::checkAccess(), чтобы получить актуальный результат доступа. Обратите внимание, что этот кэширование действует только в рамках одного запроса и работает только когда `$params = []`.
return	boolean	Может ли пользователь выполнить операцию в соответствии с заданным разрешением.

checkRedirectAcceptable() защищённый метод (доступен начиная с версии 2.0.8)

Проверяет, содержит ли заголовок Accept тип содержимого, который позволяет перенаправить на страницу входа.

По умолчанию предполагается, что страница входа предоставляет text/html или application/xhtml+xml. Вы можете изменить допустимые типы содержимого, изменив свойство $acceptableRedirectTypes.

См. также $acceptableRedirectTypes.

защищённый boolean checkRedirectAcceptable ( )
return	boolean	Может ли этот запрос быть перенаправлен на страницу входа.

getAccessChecker() защищённый метод (доступен начиная с версии 2.0.9)

Возвращает контролёр доступа, используемый для проверки доступа.

защищённый yii\rbac\CheckAccessInterface getAccessChecker ( )

getAuthManager() защищённый метод (доступен начиная с версии 2.0.6)

Устарело начиная с версии 2.0.9, будет удалено в версии 2.1. Используйте getAccessChecker() вместо него.

Возвращает менеджер авторизации, связанный с компонентом пользователя.

По умолчанию это компонент приложения authManager. Вы можете переопределить этот метод, чтобы вернуть другой экземпляр менеджера авторизации, если это необходимо.

защищённый yii\rbac\ManagerInterface getAuthManager ( )

getId() публичный метод

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

См. также getIdentity().

публичный string\|integer getId ( )
return	string\|integer	Уникальный идентификатор пользователя. Если `null`, это означает, что пользователь является гостем.

getIdentity() публичный метод

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

Когда $enableSession имеет значение true, этот метод может попытаться прочитать данные аутентификации пользователя, хранящиеся в сессии, и воссоздать соответствующий объект идентификации, если это ещё не было сделано.

См. также:

публичный yii\web\IdentityInterface\|null getIdentity ( $autoRenew = true )
$autoRenew	boolean	Автоматически возобновить состояние аутентификации, если это ещё не было сделано. Это полезно только когда $enableSession имеет значение true.
return	yii\web\IdentityInterface\|null	Объект идентификации, связанный с текущим авторизованным пользователем. `null` возвращается, если пользователь не авторизован.

getIdentityAndDurationFromCookie() защищённый метод (доступен начиная с версии 2.0.9)

Определяет, имеет ли куки-файл с идентификацией допустимый формат и содержит ли он допустимый ключ аутентификации.

Этот метод используется, когда $enableAutoLogin имеет значение true. Этот метод пытается аутентифицировать пользователя, используя информацию в куки-файле с идентификацией.

См. также loginByCookie().

protected массив\|null getIdentityAndDurationFromCookie ( )
возвращаемое значение	массив\|null	Возвращает массив 'токен' и 'время действия', если данные валидны, иначе null.

getIsGuest() public метод

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

См. также getIdentity().

public boolean getIsGuest ( )
возвращаемое значение	boolean	Является ли текущий пользователь гостем.

getReturnUrl() public метод

Возвращает URL, на который браузер должен быть перенаправлен после успешной авторизации.

Этот метод считывает URL возврата из сессии. Обычно используется действием входа в систему, которое может вызвать этот метод для перенаправления браузера туда, куда он должен перейти после успешной аутентификации.

См. также loginRequired().

public строка getReturnUrl ( $defaultUrl = null )
$defaultUrl	строка\|массив	URL по умолчанию, в случае если он не был установлен ранее. Если это null и URL возврата не был установлен ранее, произойдет перенаправление на yii\web\Application::$homeUrl. Обратитесь к setReturnUrl() по поводу допустимого формата URL.
возвращаемое значение	строка	URL, на который должен быть перенаправлен пользователь после входа.

init() public метод

Инициализирует компонент приложения.

public void init ( )

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

После входа пользователя:

информация об идентификации пользователя доступна через свойство $identity

Если $enableSession true:

информация об идентификации будет сохранена в сессии и будет доступна в следующих запросах
в случае $duration == 0: до тех пор, пока сессия активна или пока пользователь не закроет браузер
в случае $duration > 0: до тех пор, пока сессия активна или пока cookie остается валидным в течение $duration секунд, когда $enableAutoLogin установлен true.

Если $enableSession false:

параметр $duration будет проигнорирован

public boolean login ( yii\web\IdentityInterface $identity, $duration = 0 )
$identity	yii\web\IdentityInterface	Идентификатор пользователя (который уже должен быть аутентифицирован)
$duration	целое число	Количество секунд, в течение которых пользователь может оставаться в статусе входа, по умолчанию `0`
возвращаемое значение	boolean	Выполнен ли вход пользователя

loginByAccessToken() public метод

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

Этот метод сначала выполнит аутентификацию пользователя, вызвав yii\web\IdentityInterface::findIdentityByAccessToken() с предоставленным токеном доступа. При успешной аутентификации вызовется login() для входа аутентифицированного пользователя. В случае неудачи аутентификации или при неудачном входе, метод вернет null.

public yii\web\IdentityInterface\|null loginByAccessToken ( $token, $type = null )
$token	строка	Токен доступа
$type	смешанное	Тип токена. Значение этого параметра зависит от реализации. Например, yii\filters\auth\HttpBearerAuth установит этот параметр в `yii\filters\auth\HttpBearerAuth`.
возвращаемое значение	yii\web\IdentityInterface\|null	Идентификатор, связанный с заданным токеном доступа. Null возвращается, если токен доступа недействителен или вход login() не удался.

loginByCookie() protected метод

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

Этот метод пытается выполнить вход пользователя, используя ID и authKey, предоставленные cookie пользователя.

protected void loginByCookie ( )

loginRequired() public метод

Перенаправляет браузер пользователя на страницу входа.

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

Убедитесь, что вы установили $loginUrl, чтобы браузер пользователя мог быть перенаправлен на указанный URL входа после вызова этого метода.

Обратите внимание, что при установке $loginUrl вызов этого метода НЕ завершит выполнение приложения.

public yii\web\Response loginRequired ( $checkAjax = true, $checkAcceptHeader = true )
$checkAjax	boolean	Нужно ли проверять, является ли запрос AJAX-запросом. Если true и запрос является AJAX-запросом, текущий URL (для AJAX запроса) НЕ будет установлен как URL возврата.
$checkAcceptHeader	boolean	Нужно ли проверять, принимает ли запрос HTML-ответы. По умолчанию `true`. Если true и запрос не принимает HTML-ответы, текущий URL не будет установлен как URL возврата. Вместо перенаправления будет выброшено исключение ForbiddenHttpException. Этот параметр доступен начиная с версии 2.0.8.
возвращаемое значение	yii\web\Response	Ответ перенаправления, если $loginUrl установлен
вызывает	yii\web\ForbiddenHttpException	Исключение "Доступ запрещён" HTTP, если $loginUrl не установлен или перенаправление неприменимо.

logout() public метод

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

Это приведет к удалению данных сессии, связанных с аутентификацией. Если $destroySession равно true, все данные сессии будут удалены.

public boolean logout ( $destroySession = true )
$destroySession	boolean	Нужно ли уничтожить всю сессию. По умолчанию true. Этот параметр игнорируется, если $enableSession равен false.
возвращаемое значение	boolean	Выполнен ли выход пользователя

removeIdentityCookie() protected метод (доступен с версии 2.0.9)

Удаляет cookie пользователя.

Этот метод используется, когда $enableAutoLogin равен true.

protected void removeIdentityCookie ( )

renewAuthStatus() protected метод

Обновляет статус аутентификации, используя информацию из сессии и cookie.

Этот метод попытается определить идентификацию пользователя, используя переменную сессии $idParam.

Если $authTimeout установлен, этот метод обновит таймер.

Если идентификацию пользователя невозможно определить по сессии, этот метод попытается выполнить вход по cookie, если $enableAutoLogin равен true.

protected void renewAuthStatus ( )

renewIdentityCookie() protected метод

Обновляет cookie пользователя.

Этот метод установит время истечения cookie пользователя на текущее время плюс изначально указанную продолжительность cookie.

protected void renewIdentityCookie ( )

sendIdentityCookie() protected method

Отправляет куки-файл идентификации.

Этот метод используется, когда $enableAutoLogin имеет значение true. Он сохраняет $id, ключ аутентификации и продолжительность срока действия информации о входе в систему на основе куки-файлов.

См. также loginByCookie().

protected void sendIdentityCookie ( $identity, $duration )
$identity	yii\web\IdentityInterface
$duration	целое число	Количество секунд, в течение которых пользователь может оставаться авторизованным.

setIdentity() public method

Устанавливает объект идентификации пользователя.

Обратите внимание, что этот метод не работает с сеансом или cookie. Обычно следует использовать switchIdentity() для изменения идентификации текущего пользователя.

public void setIdentity ( $identity )
$identity	yii\web\IdentityInterface\|null	Объект идентификации, связанный с текущим вошедшим пользователем. Если null, это означает, что текущий пользователь является гостем без связанного идентификатора.
throws	yii\base\InvalidValueException	если `$identity` объект не реализует yii\web\IdentityInterface.

setReturnUrl() public method

Запоминает URL в сеансе, чтобы его можно было позже получить с помощью getReturnUrl().

public void setReturnUrl ( $url )
$url	строка\|массив	URL, на который пользователь должен быть перенаправлен после входа. Если задан массив, будет вызван yii\web\UrlManager::createUrl() для создания соответствующего URL. Первый элемент массива должен быть маршрутом, а остальные пары имя-значение — параметрами GET, используемыми для построения URL. Например, ['admin/index', 'ref' => 1]

public void setReturnUrl ( $url )

$url

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

URL, на который пользователь должен быть перенаправлен после входа. Если задан массив, будет вызван yii\web\UrlManager::createUrl() для создания соответствующего URL. Первый элемент массива должен быть маршрутом, а остальные пары имя-значение — параметрами GET, используемыми для построения URL. Например,

['admin/index', 'ref' => 1]

switchIdentity() public method

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

Когда $enableSession имеет значение true, этот метод может использовать сеанс и/или cookie для хранения информации об идентификации пользователя в соответствии со значением $duration. Дополнительные сведения см. в login().

Этот метод в основном вызывается login(), logout() и loginByCookie(), когда текущему пользователю необходимо связать соответствующую информацию об идентификации.

public void switchIdentity ( $identity, $duration = 0 )
$identity	yii\web\IdentityInterface\|null	Информация об идентификации, которая должна быть связана с текущим пользователем. Если null, это означает переключение текущего пользователя на гостя.
$duration	целое число	Количество секунд, в течение которых пользователь может оставаться авторизованным. Этот параметр используется только тогда, когда `$identity` не равно null.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-user.html

Класс yii\web\User

Свойства

Методы

Защищенные методы

Константы

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

$absoluteAuthTimeout общедоступное свойство

$absoluteAuthTimeoutParam общедоступное свойство

$acceptableRedirectTypes общедоступное свойство (доступно начиная с версии 2.0.8)

$accessChecker общедоступное свойство (доступно начиная с версии 2.0.9)

$authTimeout общедоступное свойство

$authTimeoutParam общедоступное свойство

$autoRenewCookie общедоступное свойство

$enableAutoLogin общедоступное свойство

$enableSession общедоступное свойство

$id общедоступное только для чтения свойство

$idParam общедоступное свойство

$identity общедоступное свойство

$identityClass общедоступное свойство

$identityCookie общедоступное свойство

$isGuest общедоступное только для чтения свойство

$loginUrl общедоступное свойство

$returnUrl общедоступное свойство

$returnUrlParam общедоступное свойство

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

afterLogin() защищённый метод

afterLogout() защищённый метод

beforeLogin() защищённый метод

beforeLogout() защищённый метод

can() публичный метод

checkRedirectAcceptable() защищённый метод (доступен начиная с версии 2.0.8)

getAccessChecker() защищённый метод (доступен начиная с версии 2.0.9)

getAuthManager() защищённый метод (доступен начиная с версии 2.0.6)

getId() публичный метод

getIdentity() публичный метод

getIdentityAndDurationFromCookie() защищённый метод (доступен начиная с версии 2.0.9)

getIsGuest() public метод

getReturnUrl() public метод

init() public метод

login() public метод

loginByAccessToken() public метод

loginByCookie() protected метод

loginRequired() public метод

logout() public метод

removeIdentityCookie() protected метод (доступен с версии 2.0.9)

renewAuthStatus() protected метод

renewIdentityCookie() protected метод

sendIdentityCookie() protected method

setIdentity() public method

setReturnUrl() public method

switchIdentity() public method