HeaderCheckerManagerFactory
in package
Table of Contents
Properties
- $checkers : array<string|int, HeaderChecker>
- $tokenTypes : array<string|int, TokenTypeSupport>
Methods
- add() : void
- This method adds a header parameter checker to this factory.
- addTokenTypeSupport() : void
- This method adds a token type support to this factory.
- aliases() : array<string|int, string>
- Returns all header parameter checker aliases supported by this factory.
- all() : array<string|int, HeaderChecker>
- Returns all header parameter checkers supported by this factory.
- create() : HeaderCheckerManager
- This method creates a Header Checker Manager and populate it with the header parameter checkers found based on the alias.
Properties
$checkers
private
array<string|int, HeaderChecker>
$checkers
= []
$tokenTypes
private
array<string|int, TokenTypeSupport>
$tokenTypes
= []
Methods
add()
This method adds a header parameter checker to this factory.
public
add(string $alias, HeaderChecker $checker) : void
The checker is uniquely identified by an alias. This allows the same header parameter checker to be added twice (or more) using several configuration options.
Parameters
- $alias : string
- $checker : HeaderChecker
addTokenTypeSupport()
This method adds a token type support to this factory.
public
addTokenTypeSupport(TokenTypeSupport $tokenType) : void
Parameters
- $tokenType : TokenTypeSupport
aliases()
Returns all header parameter checker aliases supported by this factory.
public
aliases() : array<string|int, string>
Return values
array<string|int, string>all()
Returns all header parameter checkers supported by this factory.
public
all() : array<string|int, HeaderChecker>
Return values
array<string|int, HeaderChecker>create()
This method creates a Header Checker Manager and populate it with the header parameter checkers found based on the alias.
public
create(array<string|int, string> $aliases) : HeaderCheckerManager
If the alias is not supported, an InvalidArgumentException is thrown.
Parameters
- $aliases : array<string|int, string>