ClientIpMiddleware
extends Middleware
in package
implements
MiddlewareInterface
Cient Ip middleware
Table of Contents
Interfaces
- MiddlewareInterface
- Middleware interface
Properties
- $container : ContainerInterface|null
- Container
- $options : array<string|int, mixed>
- Middleware options
Methods
- __construct() : mixed
- Constructor
- getOption() : mixed|null
- Get option value
- getOptions() : array<string|int, mixed>
- Return all options
- process() : array<string|int, mixed>
- Process middleware
- setOption() : void
- Set option
- withOption() : Middleware
- Set option
Properties
$container
Container
protected
ContainerInterface|null
$container
= null
$options
Middleware options
protected
array<string|int, mixed>
$options
= []
Methods
__construct()
Constructor
public
__construct([ContainerInterface|null $container = null ][, array<string|int, mixed>|null $options = [] ]) : mixed
Parameters
- $container : ContainerInterface|null = null
- $options : array<string|int, mixed>|null = []
getOption()
Get option value
public
getOption(string $name[, mixed $default = null ]) : mixed|null
Parameters
- $name : string
- $default : mixed = null
Return values
mixed|nullgetOptions()
Return all options
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>process()
Process middleware
public
process(ServerRequestInterface $request, ResponseInterface $response) : array<string|int, mixed>
Parameters
- $request : ServerRequestInterface
- $response : ResponseInterface
Return values
array<string|int, mixed> —[$request,$response]
setOption()
Set option
public
setOption(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed
withOption()
Set option
public
withOption(string $name, mixed $value) : Middleware
Parameters
- $name : string
- $value : mixed