php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-02 21:41:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for #9718 (#18623)

Browse Source 
Co-authored-by: Alexander Makarov <sam@rmcreative.ru>
This commit is contained in:
N. D
2021-05-05 12:47:38 +03:00
committed by GitHub
parent 68a1c32400
commit 08a133e728
2 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/guide/security-authentication.md
View File

@ -49,7 +49,9 @@ the following methods:
If a particular method is not needed, you may implement it with an empty body. For example, if your application If a particular method is not needed, you may implement it with an empty body. For example, if your application
is a pure stateless RESTful application, you would only need to implement [[yii\web\IdentityInterface::findIdentityByAccessToken()|findIdentityByAccessToken()]] is a pure stateless RESTful application, you would only need to implement [[yii\web\IdentityInterface::findIdentityByAccessToken()|findIdentityByAccessToken()]]
and [[yii\web\IdentityInterface::getId()|getId()]] while leaving all other methods with an empty body. and [[yii\web\IdentityInterface::getId()|getId()]] while leaving all other methods with an empty body. Or if your
application uses session only authentication, you would need to implement all the methods except
[[yii\web\IdentityInterface::findIdentityByAccessToken()|findIdentityByAccessToken()]].
In the following example, an [[yii\web\User::identityClass|identity class]] is implemented as In the following example, an [[yii\web\User::identityClass|identity class]] is implemented as
an [Active Record](db-active-record.md) class associated with the `user` database table. an [Active Record](db-active-record.md) class associated with the `user` database table.
@ -98,7 +100,7 @@ class User extends ActiveRecord implements IdentityInterface
} }
/** /**
* @return string current user auth key * @return string|null current user auth key
*/ */
public function getAuthKey() public function getAuthKey()
{ {
@ -107,7 +109,7 @@ class User extends ActiveRecord implements IdentityInterface
/** /**
* @param string $authKey * @param string $authKey
* @return bool if auth key is valid for current user * @return bool|null if auth key is valid for current user
*/ */
public function validateAuthKey($authKey) public function validateAuthKey($authKey)
{ {
@ -117,7 +119,7 @@ class User extends ActiveRecord implements IdentityInterface
``` ```
You may use the following code to generate an auth key for each You may use the following code to generate an auth key for each
user and store it in the `user` table: user and then store it in the `user` table:
```php ```php
class User extends ActiveRecord implements IdentityInterface class User extends ActiveRecord implements IdentityInterface

11
framework/web/IdentityInterface.php
View File

@ -43,6 +43,13 @@ namespace yii\web;
* } * }
* ``` * ```
* *
* In some situations not all of these methods are required to be implemented.
* For example, if your application is a pure stateless RESTful application,
* you would only need to implement [[yii\web\IdentityInterface::findIdentityByAccessToken()|findIdentityByAccessToken()]]
* and [[yii\web\IdentityInterface::getId()|getId()]] while leaving all other methods with an empty body.
* Or if your application uses session only authentication, you would need to implement all the methods
* except [[yii\web\IdentityInterface::findIdentityByAccessToken()|findIdentityByAccessToken()]].
*
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0 * @since 2.0
*/ */
@ -87,7 +94,7 @@ interface IdentityInterface
* Make sure to invalidate earlier issued authKeys when you implement force user logout, password change and * Make sure to invalidate earlier issued authKeys when you implement force user logout, password change and
* other scenarios, that require forceful access revocation for old sessions. * other scenarios, that require forceful access revocation for old sessions.
* *
* @return string a key that is used to check the validity of a given identity ID. * @return string|null a key that is used to check the validity of a given identity ID.
* @see validateAuthKey() * @see validateAuthKey()
*/ */
public function getAuthKey(); public function getAuthKey();
@ -96,7 +103,7 @@ interface IdentityInterface
* Validates the given auth key. * Validates the given auth key.
* *
* @param string $authKey the given auth key * @param string $authKey the given auth key
* @return bool whether the given auth key is valid. * @return bool|null whether the given auth key is valid.
* @see getAuthKey() * @see getAuthKey()
*/ */
public function validateAuthKey($authKey); public function validateAuthKey($authKey);