AudienceChecker
in package
implements
ClaimChecker, HeaderChecker
FinalYes
This class is a header parameter and claim checker.
When the "aud" header parameter or claim is present, it will check if the value is within the allowed ones.
Table of Contents
Interfaces
Constants
- CLAIM_NAME = 'aud'
Properties
- $audience : string
- $protectedHeader : bool
Methods
- __construct() : mixed
- checkClaim() : void
- When the token has the applicable claim, the value is checked.
- checkHeader() : void
- This method is called when the header parameter is present.
- protectedHeaderOnly() : bool
- When true, the header parameter to be checked MUST be set in the protected header of the token.
- supportedClaim() : string
- The method returns the claim to be checked.
- supportedHeader() : string
- The method returns the header parameter to be checked.
- checkValue() : void
Constants
CLAIM_NAME
private
mixed
CLAIM_NAME
= 'aud'
Properties
$audience
private
string
$audience
$protectedHeader
private
bool
$protectedHeader
Methods
__construct()
public
__construct(string $audience[, bool $protectedHeader = false ]) : mixed
Parameters
- $audience : string
- $protectedHeader : bool = false
checkClaim()
When the token has the applicable claim, the value is checked.
public
checkClaim(mixed $value) : void
Parameters
- $value : mixed
checkHeader()
This method is called when the header parameter is present.
public
checkHeader(mixed $value) : void
Parameters
- $value : mixed
protectedHeaderOnly()
When true, the header parameter to be checked MUST be set in the protected header of the token.
public
protectedHeaderOnly() : bool
Return values
boolsupportedClaim()
The method returns the claim to be checked.
public
supportedClaim() : string
Return values
stringsupportedHeader()
The method returns the header parameter to be checked.
public
supportedHeader() : string
Return values
stringcheckValue()
private
checkValue(mixed $value, string $class) : void
Parameters
- $value : mixed
- $class : string