Middleware
in package
Table of Contents
- contentType() : callable
- Middleware wrapper function that adds a Content-Type header to requests.
- history() : callable
- Tracks command and request history using a history container.
- invocationId() : callable
- Middleware wrapper function that adds an invocation id header to requests, which is only applied after the build step.
- mapCommand() : callable
- Creates a middleware that applies a map function to commands as they pass through the middleware.
- mapRequest() : callable
- Creates a middleware that applies a map function to requests as they pass through the middleware.
- mapResult() : callable
- Creates a middleware that applies a map function to results.
- requestBuilder() : callable
- Builds an HTTP request for a command.
- retry() : callable
- Middleware wrapper function that retries requests based on the boolean result of invoking the provided "decider" function.
- signer() : callable
- Creates a middleware that signs requests for a command.
- sourceFile() : callable
- Middleware used to allow a command parameter (e.g., "SourceFile") to be used to specify the source of data for an upload operation.
- tap() : callable
- Creates a middleware that invokes a callback at a given step.
- timer() : mixed
- validation() : callable
- Adds a middleware that uses client-side validation.
Methods
contentType()
Middleware wrapper function that adds a Content-Type header to requests.
public
static contentType(array<string|int, mixed> $operations) : callable
This is only done when the Content-Type has not already been set, and the request body's URI is available. It then checks the file extension of the URI to determine the mime-type.
Parameters
- $operations : array<string|int, mixed>
-
Operations that Content-Type should be added to.
Return values
callable —history()
Tracks command and request history using a history container.
public
static history(History $history) : callable
This is useful for testing.
Parameters
- $history : History
-
History container to store entries.
Return values
callable —invocationId()
Middleware wrapper function that adds an invocation id header to requests, which is only applied after the build step.
public
static invocationId() : callable
This is a uniquely generated UUID to identify initial and subsequent retries as part of a complete request lifecycle.
Return values
callable —mapCommand()
Creates a middleware that applies a map function to commands as they pass through the middleware.
public
static mapCommand(callable $f) : callable
Parameters
- $f : callable
-
Map function that accepts a command and returns a command.
Return values
callable —mapRequest()
Creates a middleware that applies a map function to requests as they pass through the middleware.
public
static mapRequest(callable $f) : callable
Parameters
- $f : callable
-
Map function that accepts a RequestInterface and returns a RequestInterface.
Return values
callable —mapResult()
Creates a middleware that applies a map function to results.
public
static mapResult(callable $f) : callable
Parameters
- $f : callable
-
Map function that accepts an Aws\ResultInterface and returns an Aws\ResultInterface.
Return values
callable —requestBuilder()
Builds an HTTP request for a command.
public
static requestBuilder(callable $serializer) : callable
Parameters
- $serializer : callable
-
Function used to serialize a request for a command.
Return values
callable —retry()
Middleware wrapper function that retries requests based on the boolean result of invoking the provided "decider" function.
public
static retry([callable $decider = null ][, callable $delay = null ][, bool $stats = false ]) : callable
If no delay function is provided, a simple implementation of exponential backoff will be utilized.
Parameters
- $decider : callable = null
-
Function that accepts the number of retries, a request, [result], and [exception] and returns true if the command is to be retried.
- $delay : callable = null
-
Function that accepts the number of retries and returns the number of milliseconds to delay.
- $stats : bool = false
-
Whether to collect statistics on retries and the associated delay.
Return values
callable —signer()
Creates a middleware that signs requests for a command.
public
static signer(callable $credProvider, callable $signatureFunction) : callable
Parameters
- $credProvider : callable
-
Credentials provider function that returns a promise that is resolved with a CredentialsInterface object.
- $signatureFunction : callable
-
Function that accepts a Command object and returns a SignatureInterface.
Return values
callable —sourceFile()
Middleware used to allow a command parameter (e.g., "SourceFile") to be used to specify the source of data for an upload operation.
public
static sourceFile(Service $api[, string $bodyParameter = 'Body' ][, string $sourceParameter = 'SourceFile' ]) : callable
Parameters
- $api : Service
- $bodyParameter : string = 'Body'
- $sourceParameter : string = 'SourceFile'
Return values
callable —tap()
Creates a middleware that invokes a callback at a given step.
public
static tap(callable $fn) : callable
The tap callback accepts a CommandInterface and RequestInterface as arguments but is not expected to return a new value or proxy to downstream middleware. It's simply a way to "tap" into the handler chain to debug or get an intermediate value.
Parameters
- $fn : callable
-
Tap function
Return values
callable —timer()
public
static timer() : mixed
Return values
mixed —validation()
Adds a middleware that uses client-side validation.
public
static validation(Service $api[, Validator $validator = null ]) : callable