baserCMS クラスリファレンス

OAuth2UserRepository
in package
implements UserRepositoryInterface

OAuth2 User Repository

League OAuth2 Server の要求により実装されているが、 現在のBcMcpの用途(MCP/Client Credentials Grant)では実際には使用されない

Table of Contents

Interfaces

UserRepositoryInterface

Methods

getUserEntityByUserCredentials()  : UserEntityInterface|null
ユーザー認証情報でユーザーエンティティを取得
isActiveUser()  : bool
トークンに紐づくユーザーが有効(存在し、無効化されていない)かどうかを判定する
revokeTokensByUserId()  : void
指定ユーザーのアクセストークン・リフレッシュトークンをすべて失効させる

Methods

getUserEntityByUserCredentials()

ユーザー認証情報でユーザーエンティティを取得

public getUserEntityByUserCredentials(string $username, string $password, string $grantType, ClientEntityInterface $clientEntity) : UserEntityInterface|null

注意:現在のBcMcpではClient Credentials Grantのみを使用するため、 このメソッドは実際には呼び出されない

Parameters
$username : string
$password : string
$grantType : string
$clientEntity : ClientEntityInterface
Return values
UserEntityInterface|null

isActiveUser()

トークンに紐づくユーザーが有効(存在し、無効化されていない)かどうかを判定する

public static isActiveUser(int|string|null $userId) : bool

無効化・削除されたユーザーのアクセストークン・リフレッシュトークンを 有効期限内でも受け付けないために使う

Parameters
$userId : int|string|null
Return values
bool

revokeTokensByUserId()

指定ユーザーのアクセストークン・リフレッシュトークンをすべて失効させる

public static revokeTokensByUserId(int|string $userId) : void
Parameters
$userId : int|string
On this page

Search results