Interface yii\web\IdentityInterface

Implemented by	yii\debug\models\search\UserSearchInterface
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/web/IdentityInterface.php

IdentityInterface is the interface that should be implemented by a class providing identity information.

This interface can typically be implemented by a user model class. For example, the following code shows how to implement this interface by a User ActiveRecord class:

class User extends ActiveRecord implements IdentityInterface
{
    public static function findIdentity($id)
    {
        return static::findOne($id);
    }

    public static function findIdentityByAccessToken($token, $type = null)
    {
        return static::findOne(['access_token' => $token]);
    }

    public function getId()
    {
        return $this->id;
    }

    public function getAuthKey()
    {
        return $this->authKey;
    }

    public function validateAuthKey($authKey)
    {
        return $this->authKey === $authKey;
    }
}

Public Methods

Method	Description	Defined By
findIdentity()	Finds an identity by the given ID.	yii\web\IdentityInterface
findIdentityByAccessToken()	Finds an identity by the given token.	yii\web\IdentityInterface
getAuthKey()	Returns a key that can be used to check the validity of a given identity ID.	yii\web\IdentityInterface
getId()	Returns an ID that can uniquely identify a user identity.	yii\web\IdentityInterface
validateAuthKey()	Validates the given auth key.	yii\web\IdentityInterface

Method Details