[ Index ]

PHP Cross Reference of phpBB-3.3.14-deutsch

title

Body

[close]

/vendor/guzzlehttp/guzzle/src/ -> HandlerStack.php (summary)

(no description)

File Size: 277 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

HandlerStack:: (15 methods):
  create()
  __construct()
  __invoke()
  __toString()
  setHandler()
  hasHandler()
  unshift()
  push()
  before()
  after()
  remove()
  resolve()
  findByName()
  splice()
  debugCallable()


Class: HandlerStack  - X-Ref

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

create(callable $handler = null)   X-Ref
Creates a default handler stack that can be used by clients.

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.

param: callable $handler HTTP handler function to use with the stack. If no
return: HandlerStack

__construct(callable $handler = null)   X-Ref

param: callable $handler Underlying HTTP handler.

__invoke(RequestInterface $request, array $options)   X-Ref
Invokes the handler stack as a composed handler

param: RequestInterface $request
param: array            $options
return: ResponseInterface|PromiseInterface

__toString()   X-Ref
Dumps a string representation of the stack.

return: string

setHandler(callable $handler)   X-Ref
Set the HTTP handler that actually returns a promise.

param: callable $handler Accepts a request and array of options and

hasHandler()   X-Ref
Returns true if the builder has a handler.

return: bool

unshift(callable $middleware, $name = null)   X-Ref
Unshift a middleware to the bottom of the stack.

param: callable $middleware Middleware function
param: string   $name       Name to register for this middleware.

push(callable $middleware, $name = '')   X-Ref
Push a middleware to the top of the stack.

param: callable $middleware Middleware function
param: string   $name       Name to register for this middleware.

before($findName, callable $middleware, $withName = '')   X-Ref
Add a middleware before another middleware by name.

param: string   $findName   Middleware to find
param: callable $middleware Middleware function
param: string   $withName   Name to register for this middleware.

after($findName, callable $middleware, $withName = '')   X-Ref
Add a middleware after another middleware by name.

param: string   $findName   Middleware to find
param: callable $middleware Middleware function
param: string   $withName   Name to register for this middleware.

remove($remove)   X-Ref
Remove a middleware by instance or name from the stack.

param: callable|string $remove Middleware to remove by instance or name.

resolve()   X-Ref
No description

findByName($name)   X-Ref

param: string $name
return: int

splice($findName, $withName, callable $middleware, $before)   X-Ref
Splices a function into the middleware list at a specific position.

param: string   $findName
param: string   $withName
param: callable $middleware
param: bool     $before

debugCallable($fn)   X-Ref
Provides a debug string for a given callable.

param: array|callable $fn Function to write as a string.
return: string



Generated: Mon Nov 25 19:05:08 2024 Cross-referenced by PHPXref 0.7.1