0

Final Class Yiisoft\Queue\Middleware\Push\PushMiddlewareFactory

All Classes | Properties | Methods
InheritanceYiisoft\Queue\Middleware\Push\PushMiddlewareFactory » Yiisoft\Queue\Middleware\MiddlewareFactory
ImplementsYiisoft\Queue\Middleware\Push\PushMiddlewareFactoryInterface

Creates a middleware based on the definition provided.

Protected Properties

Hide inherited properties

Property Type Description Defined By
$container \Psr\Container\ContainerInterface Yiisoft\Queue\Middleware\MiddlewareFactory

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Queue\Middleware\MiddlewareFactory
createPushMiddleware() Yiisoft\Queue\Middleware\Push\PushMiddlewareFactory

Protected Methods

Hide inherited methods

Method Description Defined By
create() Yiisoft\Queue\Middleware\MiddlewareFactory
getInterfaceName() Yiisoft\Queue\Middleware\Push\PushMiddlewareFactory
wrapMiddleware() Yiisoft\Queue\Middleware\Push\PushMiddlewareFactory

Method Details

Hide inherited methods

__construct() public method

Defined in: Yiisoft\Queue\Middleware\MiddlewareFactory::__construct()

public mixed __construct ( \Psr\Container\ContainerInterface $container, \Psr\Container\ContainerInterface|null $callableDependencyContainer = null )
$container \Psr\Container\ContainerInterface

Container used to resolve middleware.
$callableDependencyContainer \Psr\Container\ContainerInterface|null

Container used to resolve callable middleware dependencies. If not set, the main container is used.

 

                public function __construct(
    protected readonly ContainerInterface $container,
    ?ContainerInterface $callableDependencyContainer = null,
) {
    $this->callableFactory = new CallableFactory($container, $callableDependencyContainer);
}
create() protected method

Defined in: Yiisoft\Queue\Middleware\MiddlewareFactory::create()

protected \Yiisoft\Queue\Middleware\T create ( callable|array|string $definition )
$definition callable|array|string

Middleware definition in one of the following formats:
return \Yiisoft\Queue\Middleware\T

Middleware instance
throws Yiisoft\Queue\Middleware\InvalidMiddlewareDefinitionException 

                protected function create(callable|array|string $definition): object
{
    try {
        $callable = $this->callableFactory->create($definition);
        return $this->wrapMiddleware($callable);
    } catch (InvalidCallableConfigurationException) {
        // Not a callable, try internal checks
    }
    if (is_string($definition)) {
        return $this->getFromContainer($definition);
    }
    if (is_array($definition)) {
        return $this->tryGetFromArrayDefinition($definition)
            ?? throw new InvalidMiddlewareDefinitionException($definition);
    }
    throw new InvalidMiddlewareDefinitionException($definition);
}
createPushMiddleware() public method

public Yiisoft\Queue\Middleware\Push\PushMiddlewareInterface createPushMiddleware ( mixed $middlewareDefinition )
$middlewareDefinition mixed

Middleware definition in one of the following formats:

  • A middleware object.
  • A name of a middleware class. The middleware instance will be obtained from container and executed.
  • A callable with function(MessageInterface $message, PushHandlerInterface $handler): MessageInterface signature.
  • A controller handler action in format [TestController::class, 'index']. TestController instance will be created and index() method will be executed.
  • A function returning a middleware. The middleware returned will be executed.

For handler action and callable typed parameters are automatically injected using dependency injection container. Current message and handler could be obtained by type-hinting for {@see \Yiisoft\Queue\Message\MessageInterface} and {@see \Yiisoft\Queue\Middleware\Push\PushHandlerInterface}.
throws Yiisoft\Queue\Middleware\InvalidMiddlewareDefinitionException 

                public function createPushMiddleware(mixed $middlewareDefinition): PushMiddlewareInterface
{
    if ($middlewareDefinition instanceof PushMiddlewareInterface) {
        return $middlewareDefinition;
    }
    if (!is_callable($middlewareDefinition) && !is_array($middlewareDefinition) && !is_string($middlewareDefinition)) {
        throw new InvalidMiddlewareDefinitionException($middlewareDefinition);
    }
    $middleware = $this->create($middlewareDefinition);
    if (!$middleware instanceof PushMiddlewareInterface) {
        throw new InvalidMiddlewareDefinitionException($middlewareDefinition);
    }
    return $middleware;
}
getInterfaceName() protected method

protected string getInterfaceName ( )

                protected function getInterfaceName(): string
{
    return PushMiddlewareInterface::class;
}
wrapMiddleware() protected method

protected Yiisoft\Queue\Middleware\Push\PushMiddlewareInterface wrapMiddleware ( callable $callback )
$callback callable 

                protected function wrapMiddleware(callable $callback): PushMiddlewareInterface
{
    return new class ($callback) implements PushMiddlewareInterface {
        private $callback;
        public function __construct(callable $callback)
        {
            $this->callback = $callback;
        }
        public function processPush(MessageInterface $message, PushHandlerInterface $handler): MessageInterface
        {
            $response = ($this->callback)($message, $handler);
            if ($response instanceof MessageInterface) {
                return $response;
            }
            if ($response instanceof PushMiddlewareInterface) {
                return $response->processPush($message, $handler);
            }
            throw new InvalidMiddlewareDefinitionException($this->callback);
        }
    };
}