Documentation

HandlerStack
in package

Creates a composed Guzzle handler function by stacking middlewares on top of an HTTP handler function.

Table of Contents

$cached  : callable|null
$handler  : callable|null
$stack  : array<string|int, mixed>
__construct()  : mixed
__invoke()  : ResponseInterface|PromiseInterface
Invokes the handler stack as a composed handler
__toString()  : string
Dumps a string representation of the stack.
after()  : mixed
Add a middleware after another middleware by name.
before()  : mixed
Add a middleware before another middleware by name.
create()  : HandlerStack
Creates a default handler stack that can be used by clients.
hasHandler()  : bool
Returns true if the builder has a handler.
push()  : mixed
Push a middleware to the top of the stack.
remove()  : mixed
Remove a middleware by instance or name from the stack.
resolve()  : callable
Compose the middleware and handler into a single callable function.
setHandler()  : mixed
Set the HTTP handler that actually returns a promise.
unshift()  : mixed
Unshift a middleware to the bottom of the stack.
debugCallable()  : string
Provides a debug string for a given callable.
findByName()  : int
splice()  : mixed
Splices a function into the middleware list at a specific position.

Properties

Methods

__construct()

public __construct([callable $handler = null ]) : mixed
Parameters
$handler : callable = null

Underlying HTTP handler.

Return values
mixed

__toString()

Dumps a string representation of the stack.

public __toString() : string
Return values
string

after()

Add a middleware after another middleware by name.

public after(string $findName, callable $middleware[, string $withName = '' ]) : mixed
Parameters
$findName : string

Middleware to find

$middleware : callable

Middleware function

$withName : string = ''

Name to register for this middleware.

Return values
mixed

before()

Add a middleware before another middleware by name.

public before(string $findName, callable $middleware[, string $withName = '' ]) : mixed
Parameters
$findName : string

Middleware to find

$middleware : callable

Middleware function

$withName : string = ''

Name to register for this middleware.

Return values
mixed

create()

Creates a default handler stack that can be used by clients.

public static create([callable $handler = null ]) : HandlerStack

The returned handler will wrap the provided handler or use the most appropriate default handler for your system. The returned HandlerStack has support for cookies, redirects, HTTP error exceptions, and preparing a body before sending.

The returned handler stack can be passed to a client in the "handler" option.

Parameters
$handler : callable = null

HTTP handler function to use with the stack. If no handler is provided, the best handler for your system will be utilized.

Return values
HandlerStack

hasHandler()

Returns true if the builder has a handler.

public hasHandler() : bool
Return values
bool

push()

Push a middleware to the top of the stack.

public push(callable $middleware[, string $name = '' ]) : mixed
Parameters
$middleware : callable

Middleware function

$name : string = ''

Name to register for this middleware.

Return values
mixed

remove()

Remove a middleware by instance or name from the stack.

public remove(callable|string $remove) : mixed
Parameters
$remove : callable|string

Middleware to remove by instance or name.

Return values
mixed

resolve()

Compose the middleware and handler into a single callable function.

public resolve() : callable
Return values
callable

setHandler()

Set the HTTP handler that actually returns a promise.

public setHandler(callable $handler) : mixed
Parameters
$handler : callable

Accepts a request and array of options and returns a Promise.

Return values
mixed

unshift()

Unshift a middleware to the bottom of the stack.

public unshift(callable $middleware[, string $name = null ]) : mixed
Parameters
$middleware : callable

Middleware function

$name : string = null

Name to register for this middleware.

Return values
mixed

debugCallable()

Provides a debug string for a given callable.

private debugCallable(array<string|int, mixed>|callable $fn) : string
Parameters
$fn : array<string|int, mixed>|callable

Function to write as a string.

Return values
string

findByName()

private findByName(string $name) : int
Parameters
$name : string
Return values
int

splice()

Splices a function into the middleware list at a specific position.

private splice(string $findName, string $withName, callable $middleware, bool $before) : mixed
Parameters
$findName : string
$withName : string
$middleware : callable
$before : bool
Return values
mixed

Search results