HeaderAuthenticatorHandler
extends AbstractHandler
in package
Class HeaderAuthenticatorHandler
Tags
Table of Contents
Methods
- __construct() : mixed
- HeaderAuthenticatorHandler constructor.
- append() : HandlerInterface
- Appends handler to the end of the chain. Returns handler which was used.
- getLastHandler() : HandlerInterface
- Returns last handler in the chain. Returns current handler if this chain consist of only this handler.
- getNext() : HandlerInterface|null
- Returns next handler or null if it's not present.
- handle() : mixed|null
- Adds "x-api-key" header with provided API key
- setNext() : HandlerInterface
- Sets next handler in the chain.
Methods
__construct()
HeaderAuthenticatorHandler constructor.
public
__construct(string $apiKey) : mixed
Parameters
- $apiKey : string
append()
Appends handler to the end of the chain. Returns handler which was used.
public
append(HandlerInterface $handler) : HandlerInterface
Parameters
- $handler : HandlerInterface
Tags
Return values
HandlerInterfacegetLastHandler()
Returns last handler in the chain. Returns current handler if this chain consist of only this handler.
public
getLastHandler() : HandlerInterface
Tags
Return values
HandlerInterfacegetNext()
Returns next handler or null if it's not present.
public
getNext() : HandlerInterface|null
Tags
Return values
HandlerInterface|nullhandle()
Adds "x-api-key" header with provided API key
public
handle(mixed $item) : mixed|null
Parameters
- $item : mixed
Tags
Return values
mixed|nullsetNext()
Sets next handler in the chain.
public
setNext(HandlerInterface $handler) : HandlerInterface
Parameters
- $handler : HandlerInterface