DefaultUserInfoRequestHandlerSpi
extends DefaultUserClaimProvider
in package
implements
UserInfoRequestHandlerSpi
An implementation of the UserInfoRequestHandlerSpi interface.
Table of Contents
Interfaces
- UserInfoRequestHandlerSpi
- Service Provider Interface for UserInfoRequestHandler.
Methods
- __construct() : mixed
- Constructor.
- getSub() : string
- Get the value of the "sub" claim that will be embedded in the response from the userinfo endpoint.
- getUser() : User
- Get the user.
- getUserClaimValue() : mixed
- Get the value of a claim of the user.
- setUser() : DefaultUserClaimProvider
- Set the user.
Methods
__construct()
Constructor.
public
__construct() : mixed
getSub()
Get the value of the "sub" claim that will be embedded in the response from the userinfo endpoint.
public
getSub() : string
Return values
string —The value of the "sub" claim.
getUser()
Get the user.
public
getUser() : User
Return values
User —The user.
getUserClaimValue()
Get the value of a claim of the user.
public
getUserClaimValue(string $subject, string $claimName, string $languageTag) : mixed
Parameters
- $subject : string
- $claimName : string
- $languageTag : string
Return values
mixed —The value of the claim. null if the value is not available.
The returned value must be able to be processed by json_encode().
setUser()
Set the user.
public
setUser([User $user = null ]) : DefaultUserClaimProvider
Parameters
- $user : User = null
-
The user.
Return values
DefaultUserClaimProvider —$this object.