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\Adapter\SynchronousAdapter
Yiisoft\Queue\ChannelNormalizer
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\AdapterConfiguration\AdapterNotConfiguredException
Yiisoft\Queue\Exception\JobFailureException
Yiisoft\Queue\Message\Envelope
Yiisoft\Queue\Message\EnvelopeInterface	Envelope is a message container that adds additional metadata.
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\ConsumeMiddlewareDispatcher
Yiisoft\Queue\Middleware\Consume\ConsumeRequest
Yiisoft\Queue\Middleware\Consume\MessageHandlerConsumeInterface
Yiisoft\Queue\Middleware\Consume\MiddlewareConsumeInterface
Yiisoft\Queue\Middleware\Consume\MiddlewareConsumeStack
Yiisoft\Queue\Middleware\Consume\MiddlewareFactoryConsume	Creates a middleware based on the definition provided.
Yiisoft\Queue\Middleware\Consume\MiddlewareFactoryConsumeInterface	Creates a middleware based on the definition provided.
Yiisoft\Queue\Middleware\FailureHandling\FailureEnvelope
Yiisoft\Queue\Middleware\FailureHandling\FailureFinalHandler
Yiisoft\Queue\Middleware\FailureHandling\FailureHandlingRequest
Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareDispatcher
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\FailureHandling\MessageFailureHandlerInterface
Yiisoft\Queue\Middleware\FailureHandling\MiddlewareFactoryFailure	Creates a middleware based on the definition provided.
Yiisoft\Queue\Middleware\FailureHandling\MiddlewareFactoryFailureInterface	Creates a middleware based on the definition provided.
Yiisoft\Queue\Middleware\FailureHandling\MiddlewareFailureInterface
Yiisoft\Queue\Middleware\FailureHandling\MiddlewareFailureStack
Yiisoft\Queue\Middleware\InvalidCallableConfigurationException
Yiisoft\Queue\Middleware\InvalidMiddlewareDefinitionException
Yiisoft\Queue\Middleware\Push\AdapterPushHandler
Yiisoft\Queue\Middleware\Push\Implementation\DelayMiddlewareInterface	A middleware interface for message delaying. It must be implemented in an adapter package or in a project.
Yiisoft\Queue\Middleware\Push\Implementation\IdMiddleware	A middleware for message ID setting.
Yiisoft\Queue\Middleware\Push\MessageHandlerPushInterface
Yiisoft\Queue\Middleware\Push\MiddlewareFactoryPush	Creates a middleware based on the definition provided.
Yiisoft\Queue\Middleware\Push\MiddlewareFactoryPushInterface	Creates a middleware based on the definition provided.
Yiisoft\Queue\Middleware\Push\MiddlewarePushInterface
Yiisoft\Queue\Middleware\Push\MiddlewarePushStack
Yiisoft\Queue\Middleware\Push\PushMiddlewareDispatcher
Yiisoft\Queue\Middleware\Push\PushRequest
Yiisoft\Queue\Provider\AdapterFactoryQueueProvider	This queue provider creates new queue objects based on adapter definitions.
Yiisoft\Queue\Provider\ChannelNotFoundException	Thrown when the channel is not found.
Yiisoft\Queue\Provider\CompositeQueueProvider	Composite queue provider.
Yiisoft\Queue\Provider\InvalidQueueConfigException	Thrown when queue configuration is invalid.
Yiisoft\Queue\Provider\PrototypeQueueProvider	Queue provider that only changes the channel name of the base queue.
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 channel name.
Yiisoft\Queue\Queue
Yiisoft\Queue\QueueInterface
Yiisoft\Queue\Stubs\StubAdapter	Stub adapter that does nothing. Job status is always "done".
Yiisoft\Queue\Stubs\StubLoop	Stub loop.
Yiisoft\Queue\Stubs\StubQueue	Stub queue that does nothing. Job status is always "done".
Yiisoft\Queue\Stubs\StubWorker	Stub worker that does nothing.
Yiisoft\Queue\Worker\Worker
Yiisoft\Queue\Worker\WorkerInterface