MiddlewareChain
in package
Uses
Microable, Containable
Table of Contents
Properties
- $context : ContainerInterface|Container|null
- Application container context
- $macros : array<string|int, mixed>
- $app : PioniaApplication
- $middlewareContainer : Arrayable
Methods
- __call() : mixed
- Dynamically handle calls to the class.
- __callStatic() : mixed
- Dynamically handle calls to the class.
- __construct() : mixed
- add() : MiddlewareChain
- Add a middleware to the middleware chain
- addAfter() : MiddlewareChain
- Add a middleware to the middleware chain after a specific middleware
- addBefore() : MiddlewareChain
- Add a middleware before another middleware
- all() : mixed
- contextArrAdd() : void
- contextHas() : bool
- Check if a value exists in the container
- contextMake() : mixed
- Make an instance of a class from the container. This will throw an exception if the class is not found
- contextMakeSilently() : mixed
- Create an instance of a class without throwing an exception when it fails
- flushMacros() : void
- Remove all the macros we had registered
- get() : array<string|int, mixed>
- Get the middleware chain
- getOrDefault() : mixed
- Get a value from the container or return a default value
- getOrFail() : mixed
- Get a value from the container or throw an exception.
- getSilently() : mixed
- Get a value from the container or return null instead of throwing an exception
- handle() : void
- Run the middleware chain
- hasMacro() : bool
- Check if we have a method in the balonables
- isAMiddleware() : bool
- macro() : void
- Add a new mixable to the macros
- middlewareStack() : null|Arrayable
- mixin() : void
- Mix another object into the class.
- next() : void
- Run the next middleware in the chain
- rail() : void
- Run the middleware chain
- set() : static
- Set a value in the container
- asMiddleware() : MiddlewareContract
Properties
$context
Application container context
public
ContainerInterface|Container|null
$context
$macros
protected
static array<string|int, mixed>
$macros
= []
$app
private
PioniaApplication
$app
$middlewareContainer
private
Arrayable
$middlewareContainer
Methods
__call()
Dynamically handle calls to the class.
public
__call(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Tags
__callStatic()
Dynamically handle calls to the class.
public
static __callStatic(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Tags
__construct()
public
__construct(PioniaApplication $app) : mixed
Parameters
- $app : PioniaApplication
add()
Add a middleware to the middleware chain
public
add(string $middleware) : MiddlewareChain
Parameters
- $middleware : string
Return values
MiddlewareChainaddAfter()
Add a middleware to the middleware chain after a specific middleware
public
addAfter(string $middlewareSearch, string $middlewareToInsert) : MiddlewareChain
Parameters
- $middlewareSearch : string
-
The target middleware in the chain
- $middlewareToInsert : string
-
The new middleware we are registering
Return values
MiddlewareChainaddBefore()
Add a middleware before another middleware
public
addBefore(string $middlewareSearch, string $middlewareToInsert) : MiddlewareChain
Parameters
- $middlewareSearch : string
-
The target middleware in the chain
- $middlewareToInsert : string
-
The new middleware we are registering
Tags
Return values
MiddlewareChainall()
public
all() : mixed
contextArrAdd()
public
contextArrAdd(string $contextKey, array<string|int, mixed> $dataToAdd) : void
Parameters
- $contextKey : string
- $dataToAdd : array<string|int, mixed>
contextHas()
Check if a value exists in the container
public
contextHas(string $key) : bool
Parameters
- $key : string
Return values
boolcontextMake()
Make an instance of a class from the container. This will throw an exception if the class is not found
public
contextMake(string $name[, array<string|int, mixed> $parameters = [] ]) : mixed
Parameters
- $name : string
- $parameters : array<string|int, mixed> = []
Tags
contextMakeSilently()
Create an instance of a class without throwing an exception when it fails
public
contextMakeSilently(string $name[, array<string|int, mixed> $parameters = [] ]) : mixed
Parameters
- $name : string
- $parameters : array<string|int, mixed> = []
flushMacros()
Remove all the macros we had registered
public
static flushMacros() : void
get()
Get the middleware chain
public
get() : array<string|int, mixed>
Return values
array<string|int, mixed>getOrDefault()
Get a value from the container or return a default value
public
getOrDefault(string $key, mixed $default) : mixed
Parameters
- $key : string
- $default : mixed
getOrFail()
Get a value from the container or throw an exception.
public
getOrFail(string $key) : mixed
Parameters
- $key : string
Tags
getSilently()
Get a value from the container or return null instead of throwing an exception
public
getSilently(mixed $key) : mixed
Parameters
- $key : mixed
handle()
Run the middleware chain
public
handle(Request $request[, Response|null $response = null ]) : void
Dispatches events before and after the middleware chain is run
Parameters
hasMacro()
Check if we have a method in the balonables
public
static hasMacro(string $name) : bool
Parameters
- $name : string
Return values
boolisAMiddleware()
public
isAMiddleware(mixed $class) : bool
Parameters
- $class : mixed
Return values
boolmacro()
Add a new mixable to the macros
public
static macro(string $key, $value) : void
Parameters
middlewareStack()
public
middlewareStack() : null|Arrayable
Return values
null|Arrayablemixin()
Mix another object into the class.
public
static mixin(object $mixin[, bool $replace = true ]) : void
Parameters
- $mixin : object
- $replace : bool = true
Tags
next()
Run the next middleware in the chain
public
next(Request $request, Response|null $response, MiddlewareChain $chain) : void
Parameters
- $request : Request
- $response : Response|null
- $chain : MiddlewareChain
rail()
Run the middleware chain
public
rail(Request $request[, Response|null $response = null ]) : void
Parameters
set()
Set a value in the container
public
set(string $name, mixed $value) : static
Parameters
- $name : string
- $value : mixed
Return values
staticasMiddleware()
private
asMiddleware(mixed $klass) : MiddlewareContract
Parameters
- $klass : mixed