UserCredentials

• Full name: \OAuth2\GrantType\UserCredentials
• This class implements: \OAuth2\GrantType\GrantTypeInterface

Properties

userInfo

private array $userInfo

---

storage

protected \OAuth2\Storage\UserCredentialsInterface $storage

---

Methods

__construct

public __construct(\OAuth2\Storage\UserCredentialsInterface $storage): mixed

Parameters:

Parameter	Type	Description
$storage	\OAuth2\Storage\UserCredentialsInterface	- REQUIRED Storage class for retrieving user credentials information

---

getQueryStringIdentifier

Get query string identifier

public getQueryStringIdentifier(): string

---

validateRequest

public validateRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response): bool|mixed|null

Parameters:

Parameter	Type	Description
$request	\OAuth2\RequestInterface
$response	\OAuth2\ResponseInterface

Throws:

• LogicException

---

getClientId

Get client id

public getClientId(): mixed|null

---

getUserId

Get user id

public getUserId(): mixed

---

getScope

Get scope

public getScope(): null|string

---

createAccessToken

Create access token

public createAccessToken(\OAuth2\ResponseType\AccessTokenInterface $accessToken, mixed $client_id, mixed $user_id, string $scope): array

Parameters:

Parameter	Type	Description
$accessToken	\OAuth2\ResponseType\AccessTokenInterface
$client_id	mixed	- client identifier related to the access token.
$user_id	mixed	- user id associated with the access token
$scope	string	- scopes to be stored in space-separated string.

---

---

Automatically generated on 2025-03-18