0 follower

Yii Framework 3.0 API Documentation

This is the Yii Framework API Documentation. Here you will find detailed information about all classes provided by the Framework. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.

On this page you find all the classes included in version 3.0 of the framework. You can use the dropdown menu on the top right to switch between versions.

You can search API documentation using the search form on the top. You can search for class names and also method and property names, e.g. ActiveRecord.save() or just .save() or ::save().

This page is also available in JSON format:
curl https://www.yiiframework.com/doc/api/3.0/queue -H 'Accept: application/json'

Class	Description
Yiisoft\Queue\Adapter\AdapterInterface
Yiisoft\Queue\Cli\LoopInterface
Yiisoft\Queue\Cli\SignalLoop
Yiisoft\Queue\Cli\SimpleLoop
Yiisoft\Queue\Cli\SoftLimitTrait
Yiisoft\Queue\Command\ListenAllCommand
Yiisoft\Queue\Command\ListenCommand
Yiisoft\Queue\Command\RunCommand
Yiisoft\Queue\Debug\QueueCollector
Yiisoft\Queue\Debug\QueueDecorator
Yiisoft\Queue\Debug\QueueProviderInterfaceProxy
Yiisoft\Queue\Debug\QueueWorkerInterfaceProxy
Yiisoft\Queue\Exception\MessageFailureException
Yiisoft\Queue\Message\DelayEnvelope
Yiisoft\Queue\Message\Envelope
Yiisoft\Queue\Message\GenericMessage	A general-purpose immutable {@see MessageInterface} implementation that holds a message type and its payload data.
Yiisoft\Queue\Message\IdEnvelope	ID envelope allows to identify a message.
Yiisoft\Queue\Message\JsonMessageSerializer
Yiisoft\Queue\Message\Message
Yiisoft\Queue\Message\MessageHandlerInterface
Yiisoft\Queue\Message\MessageInterface
Yiisoft\Queue\Message\MessageSerializerInterface
Yiisoft\Queue\Middleware\CallableFactory
Yiisoft\Queue\Middleware\Consume\ConsumeFinalHandler
Yiisoft\Queue\Middleware\Consume\ConsumeHandlerInterface
Yiisoft\Queue\Middleware\Consume\ConsumeMiddlewareDispatcher
Yiisoft\Queue\Middleware\Consume\ConsumeMiddlewareFactory	Creates a middleware based on the definition provided.
Yiisoft\Queue\Middleware\Consume\ConsumeMiddlewareFactoryInterface	Creates a middleware based on the definition provided.
Yiisoft\Queue\Middleware\Consume\ConsumeMiddlewareInterface
Yiisoft\Queue\Middleware\Consume\ConsumeMiddlewareStack
Yiisoft\Queue\Middleware\Consume\ConsumeRequest
Yiisoft\Queue\Middleware\FailureHandling\FailureEnvelope
Yiisoft\Queue\Middleware\FailureHandling\FailureFinalHandler
Yiisoft\Queue\Middleware\FailureHandling\FailureHandlerInterface
Yiisoft\Queue\Middleware\FailureHandling\FailureHandlingRequest
Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareDispatcher
Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareFactory	Creates a middleware based on the definition provided.
Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareFactoryInterface	Creates a middleware based on the definition provided.
Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareInterface
Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareStack
Yiisoft\Queue\Middleware\FailureHandling\Implementation\ExponentialDelayMiddleware	Failure strategy which resends the given message to a queue with an exponentially increasing delay.
Yiisoft\Queue\Middleware\FailureHandling\Implementation\SendAgainMiddleware	Failure strategy which resends the given message to a queue.
Yiisoft\Queue\Middleware\InvalidCallableConfigurationException
Yiisoft\Queue\Middleware\InvalidMiddlewareDefinitionException
Yiisoft\Queue\Middleware\MiddlewareFactory
Yiisoft\Queue\Middleware\Push\AdapterPushHandler
Yiisoft\Queue\Middleware\Push\Implementation\IdMiddleware	A middleware for message ID setting.
Yiisoft\Queue\Middleware\Push\PushHandlerInterface
Yiisoft\Queue\Middleware\Push\PushMiddlewareConfig	Holds the push middleware factory and the list of common middleware definitions applied to queues.
Yiisoft\Queue\Middleware\Push\PushMiddlewareDispatcher
Yiisoft\Queue\Middleware\Push\PushMiddlewareFactory	Creates a middleware based on the definition provided.
Yiisoft\Queue\Middleware\Push\PushMiddlewareFactoryInterface	Creates a middleware based on the definition provided.
Yiisoft\Queue\Middleware\Push\PushMiddlewareInterface
Yiisoft\Queue\Middleware\Push\PushMiddlewareStack
Yiisoft\Queue\Middleware\Push\SynchronousPushHandler
Yiisoft\Queue\Provider\CompositeQueueProvider	Composite queue provider.
Yiisoft\Queue\Provider\InvalidQueueConfigException	Thrown when queue configuration is invalid.
Yiisoft\Queue\Provider\PredefinedQueueProvider	Queue provider that uses a pre-defined map of queue name to queue instance.
Yiisoft\Queue\Provider\QueueFactoryProvider	This queue provider creates queue objects directly from definitions.
Yiisoft\Queue\Provider\QueueNotFoundException	Thrown when the queue is not found.
Yiisoft\Queue\Provider\QueueProviderException	Base interface representing a generic exception in a queue provider.
Yiisoft\Queue\Provider\QueueProviderInterface	`QueueProviderInterface` provides a way to get a queue instance by name.
Yiisoft\Queue\Queue
Yiisoft\Queue\QueueInterface
Yiisoft\Queue\StringNormalizer
Yiisoft\Queue\Stubs\DummyEnvelope	Dummy envelope stub for testing purposes.
Yiisoft\Queue\Stubs\InMemoryAdapter	In-memory implementation of {@see AdapterInterface} for testing and development purposes.
Yiisoft\Queue\Stubs\StubLoop	Stub loop.
Yiisoft\Queue\Stubs\StubQueue	Stub queue that does nothing. Message status is always "done".
Yiisoft\Queue\Stubs\StubWorker	Stub worker that does nothing.
Yiisoft\Queue\Worker\Worker
Yiisoft\Queue\Worker\WorkerInterface