インターフェース yii\web\IdentityInterface

IdentityInterface は、ID 情報を提供するクラスで実装されるべきインターフェースです。

このインターフェースは、通常、ユーザーモデルクラスで実装できます。例えば、以下のコードは、User ActiveRecord クラスでこのインターフェースを実装する方法を示しています。

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;
    }
}

状況によっては、これらのメソッド全てを実装する必要はありません。例えば、アプリケーションが純粋なステートレスなRESTfulアプリケーションの場合、findIdentityByAccessToken() と getId() のみを実装し、他のメソッドは空のボディのままにしておくことができます。または、アプリケーションがセッションのみの認証を使用する場合、findIdentityByAccessToken() を除くすべてのメソッドを実装する必要があります。