0

Final Class Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareDispatcher

All Classes | Methods | Constants
InheritanceYiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareDispatcher

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareDispatcher
dispatch() Dispatch request through middleware to get response. Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareDispatcher
withMiddlewares() Returns new instance with middleware handlers replaced with the ones provided. Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareDispatcher

Constants

Hide inherited constants

Constant Value Description Defined By
DEFAULT_PIPELINE 'failure-pipeline-default' Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareDispatcher

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareFactoryInterface $middlewareFactory, array[][]|callable[][]|\Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareInterface[][]|string[][] $middlewareDefinitions )
$middlewareFactory Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareFactoryInterface
$middlewareDefinitions array[][]|callable[][]|\Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareInterface[][]|string[][] 

                public function __construct(
    private readonly FailureMiddlewareFactoryInterface $middlewareFactory,
    private array $middlewareDefinitions,
) {
    $this->init();
}
dispatch() public method

Dispatch request through middleware to get response.

public Yiisoft\Queue\Middleware\FailureHandling\FailureHandlingRequest dispatch ( Yiisoft\Queue\Middleware\FailureHandling\FailureHandlingRequest $request, Yiisoft\Queue\Middleware\FailureHandling\FailureHandlerInterface $finishHandler )
$request Yiisoft\Queue\Middleware\FailureHandling\FailureHandlingRequest

Request to pass to middleware.
$finishHandler Yiisoft\Queue\Middleware\FailureHandling\FailureHandlerInterface

Handler to use in case no middleware produced a response.

 

                public function dispatch(
    FailureHandlingRequest $request,
    FailureHandlerInterface $finishHandler,
): FailureHandlingRequest {
    $queueName = $request->getQueueName();
    if (!isset($this->middlewareDefinitions[$queueName]) || $this->middlewareDefinitions[$queueName] === []) {
        $queueName = self::DEFAULT_PIPELINE;
    }
    $definitions = array_reverse($this->middlewareDefinitions[$queueName]);
    $this->stack[$queueName] ??= new FailureMiddlewareStack($this->buildMiddlewares(...$definitions), $finishHandler);
    return $this->stack[$queueName]->handleFailure($request);
}
withMiddlewares() public method

Returns new instance with middleware handlers replaced with the ones provided.

The last specified handler will be executed first.

public self withMiddlewares ( array[][]|callable[][]|\Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareInterface[][]|string[][] $middlewareDefinitions )
$middlewareDefinitions array[][]|callable[][]|\Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareInterface[][]|string[][]

Each array element is:

  • A name of a middleware class. The middleware instance will be obtained from container executed.
  • A callable with function(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface signature.
  • A "callable-like" array in format [FooMiddleware::class, 'index']. FooMiddleware instance will be created and index() method will be executed.
  • A function returning a middleware. The middleware returned will be executed.

For callables typed parameters are automatically injected using dependency injection container.
return self

New instance of the {@see \Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareDispatcher}

 

                public function withMiddlewares(array $middlewareDefinitions): self
{
    $instance = clone $this;
    $instance->middlewareDefinitions = $middlewareDefinitions;
    // Fixes a memory leak.
    unset($instance->stack);
    $instance->stack = [];
    $instance->init();
    return $instance;
}