• Главная
• yii
• web
• User

PHP Класс yii\web\User

You may use [[isGuest]] to determine whether the current user is a guest or not. If the user is a guest, the [[identity]] property would return null. Otherwise, it would be an instance of IdentityInterface. You may call various methods to change the user authentication status: - User::login: sets the specified identity and remembers the authentication status in session and cookie. - User::logout: marks the user as a guest and clears the relevant information from session and cookie. - User::setIdentity: changes the user identity without touching session or cookie. This is best used in stateless RESTful API implementation. Note that User only maintains the user authentication status. It does NOT handle how to authenticate a user. The logic of how to authenticate a user should be done in the class implementing IdentityInterface. You are also required to set [[identityClass]] with the name of this class. User is configured as an application component in Application by default. You can access that instance via Yii::$app->user. You can modify its configuration by adding an array to your application config under components as it is shown in the following example: ~~~ 'user' => [ 'identityClass' => 'app\models\User', // User must implement the IdentityInterface 'enableAutoLogin' => true, 'loginUrl' => ['user/login'], ... ] ~~~ Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$absoluteAuthTimeout		the number of seconds in which the user will be logged out automatically regardless of activity. Note that this will not work if [[enableAutoLogin]] is true.
$absoluteAuthTimeoutParam		the session variable name used to store the value of absolute expiration timestamp of the authenticated state. This is used when [[absoluteAuthTimeout]] is set.
$acceptableRedirectTypes		MIME types for which this component should redirect to the [[loginUrl]].
$accessChecker		The access checker to use for checking access. If not set the application auth manager will be used.
$authTimeout		the number of seconds in which the user will be logged out automatically if he remains inactive. If this property is not set, the user will be logged out after the current session expires (c.f. [[Session::timeout]]). Note that this will not work if [[enableAutoLogin]] is true.
$authTimeoutParam		the session variable name used to store the value of expiration timestamp of the authenticated state. This is used when [[authTimeout]] is set.
$autoRenewCookie		whether to automatically renew the identity cookie each time a page is requested. This property is effective only when [[enableAutoLogin]] is true. When this is false, the identity cookie will expire after the specified duration since the user is initially logged in. When this is true, the identity cookie will expire after the specified duration since the user visits the site the last time.
$enableAutoLogin		whether to enable cookie-based login. Defaults to false. Note that this property will be ignored if [[enableSession]] is false.
$enableSession		whether to use session to persist authentication status across multiple requests. You set this property to be false if your application is stateless, which is often the case for RESTful APIs.
$idParam		the session variable name used to store the value of [[id]].
$identityClass		the class name of the [[identity]] object.
$identityCookie		the configuration of the identity cookie. This property is used only when [[enableAutoLogin]] is true.
$loginUrl		the URL for login when User::loginRequired is called. If an array is given, [[UrlManager::createUrl()]] will be called to create the corresponding URL. The first element of the array should be the route to the login action, and the rest of the name-value pairs are GET parameters used to construct the login URL. For example, php ['site/login', 'ref' => 1] If this property is null, a 403 HTTP exception will be raised when User::loginRequired is called.
$returnUrlParam		the session variable name used to store the value of [[returnUrl]].

Открытые методы

Метод	Описание
can ( string $permissionName, array $params = [], boolean $allowCaching = true ) : boolean	Checks if the user can perform the operation as specified by the given permission.
getId ( ) : string | integer	Returns a value that uniquely represents the user.
getIdentity ( boolean $autoRenew = true ) : yii\web\IdentityInterface | null	Returns the identity object associated with the currently logged-in user.
getIsGuest ( ) : boolean	Returns a value indicating whether the user is a guest (not authenticated).
getReturnUrl ( string | array $defaultUrl = null ) : string	Returns the URL that the browser should be redirected to after successful login.
init ( )	Initializes the application component.
login ( yii\web\IdentityInterface $identity, integer $duration ) : boolean	Logs in a user.
loginByAccessToken ( string $token, mixed $type = null ) : yii\web\IdentityInterface | null	Logs in a user by the given access token.
loginRequired ( boolean $checkAjax = true, boolean $checkAcceptHeader = true ) : Response	Redirects the user browser to the login page.
logout ( boolean $destroySession = true ) : boolean	Logs out the current user.
setIdentity ( yii\web\IdentityInterface | null $identity )	Sets the user identity object.
setReturnUrl ( string | array $url )	Remembers the URL in the session so that it can be retrieved back later by User::getReturnUrl.
switchIdentity ( yii\web\IdentityInterface | null $identity, integer $duration )	Switches to a new identity for the current user.

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

Метод	Описание
afterLogin ( yii\web\IdentityInterface $identity, boolean $cookieBased, integer $duration )	This method is called after the user is successfully logged in.
afterLogout ( yii\web\IdentityInterface $identity )	This method is invoked right after a user is logged out via User::logout.
beforeLogin ( yii\web\IdentityInterface $identity, boolean $cookieBased, integer $duration ) : boolean	This method is called before logging in a user.
beforeLogout ( yii\web\IdentityInterface $identity ) : boolean	This method is invoked when calling User::logout to log out a user.
checkRedirectAcceptable ( ) : boolean	Checks if the Accept header contains a content type that allows redirection to the login page.
getAccessChecker ( ) : yii\rbac\CheckAccessInterface	Returns the access checker used for checking access.
getAuthManager ( ) : yii\rbac\ManagerInterface	Returns auth manager associated with the user component.
getIdentityAndDurationFromCookie ( ) : array | null	Determines if an identity cookie has a valid format and contains a valid auth key.
loginByCookie ( )	Logs in a user by cookie.
removeIdentityCookie ( )	Removes the identity cookie.
renewAuthStatus ( )	Updates the authentication status using the information from session and cookie.
renewIdentityCookie ( )	Renews the identity cookie.
sendIdentityCookie ( yii\web\IdentityInterface $identity, integer $duration )	Sends an identity cookie.

Описание методов

Описание свойств