HeaderCheckerManager
in package
Table of Contents
Properties
- $checkers : array<string|int, HeaderChecker>
- $tokenTypes : array<string|int, TokenTypeSupport>
Methods
- __construct() : mixed
- HeaderCheckerManager constructor.
- check() : void
- This method checks all the header parameters passed as argument.
- getCheckers() : array<string|int, HeaderChecker>
- This method returns all checkers handled by this manager.
- add() : void
- addTokenTypeSupport() : void
- checkCriticalHeader() : void
- checkDuplicatedHeaderParameters() : void
- checkHeaders() : void
- checkMandatoryHeaderParameters() : void
Properties
$checkers
private
array<string|int, HeaderChecker>
$checkers
= []
$tokenTypes
private
array<string|int, TokenTypeSupport>
$tokenTypes
= []
Methods
__construct()
HeaderCheckerManager constructor.
public
__construct(array<string|int, HeaderChecker> $checkers, array<string|int, TokenTypeSupport> $tokenTypes) : mixed
Parameters
- $checkers : array<string|int, HeaderChecker>
- $tokenTypes : array<string|int, TokenTypeSupport>
check()
This method checks all the header parameters passed as argument.
public
check(JWT $jwt, int $index[, array<string|int, string> $mandatoryHeaderParameters = [] ]) : void
All header parameters are checked against the header parameter checkers. If one fails, the InvalidHeaderException is thrown.
Parameters
- $jwt : JWT
- $index : int
- $mandatoryHeaderParameters : array<string|int, string> = []
Tags
getCheckers()
This method returns all checkers handled by this manager.
public
getCheckers() : array<string|int, HeaderChecker>
Return values
array<string|int, HeaderChecker>add()
private
add(HeaderChecker $checker) : void
Parameters
- $checker : HeaderChecker
addTokenTypeSupport()
private
addTokenTypeSupport(TokenTypeSupport $tokenType) : void
Parameters
- $tokenType : TokenTypeSupport
checkCriticalHeader()
private
checkCriticalHeader(array<string|int, mixed> $protected, array<string|int, mixed> $header, array<string|int, mixed> $checkedHeaderParameters) : void
Parameters
- $protected : array<string|int, mixed>
- $header : array<string|int, mixed>
- $checkedHeaderParameters : array<string|int, mixed>
Tags
checkDuplicatedHeaderParameters()
private
checkDuplicatedHeaderParameters(array<string|int, mixed> $header1, array<string|int, mixed> $header2) : void
Parameters
- $header1 : array<string|int, mixed>
- $header2 : array<string|int, mixed>
Tags
checkHeaders()
private
checkHeaders(array<string|int, mixed> $protected, array<string|int, mixed> $header) : void
Parameters
- $protected : array<string|int, mixed>
- $header : array<string|int, mixed>
Tags
checkMandatoryHeaderParameters()
private
checkMandatoryHeaderParameters(array<string|int, string> $mandatoryHeaderParameters, array<string|int, mixed> $protected, array<string|int, mixed> $unprotected) : void
Parameters
- $mandatoryHeaderParameters : array<string|int, string>
- $protected : array<string|int, mixed>
- $unprotected : array<string|int, mixed>