HumHub Documentation (unofficial)

Queue extends Queue
in package

Amqp Queue.

Tags
author

Maksym Kotliar kotlyar.maksim@gmail.com

since
2.0.2

Table of Contents

Constants

ATTEMPT  = 'yii-attempt'
DELAY  = 'yii-delay'
ENQUEUE_AMQP_BUNNY  = 'enqueue/amqp-bunny'
ENQUEUE_AMQP_EXT  = 'enqueue/amqp-ext'
ENQUEUE_AMQP_LIB  = 'enqueue/amqp-lib'
EVENT_AFTER_ERROR  = 'afterError'
EVENT_AFTER_EXEC  = 'afterExec'
EVENT_AFTER_PUSH  = 'afterPush'
EVENT_BEFORE_EXEC  = 'beforeExec'
EVENT_BEFORE_PUSH  = 'beforePush'
EVENT_WORKER_LOOP  = 'workerLoop'
EVENT_WORKER_START  = 'workerStart'
EVENT_WORKER_STOP  = 'workerStop'
PRIORITY  = 'yii-priority'
STATUS_DONE  = 3
STATUS_RESERVED  = 2
STATUS_WAITING  = 1
TTR  = 'yii-ttr'

Properties

$attempts  : int
$behaviors  : array<string|int, Behavior>
$commandClass  : string
The property contains a command class which used in cli.
$commandOptions  : array<string|int, mixed>
$connectionTimeout  : float|null
The time RabbitMQ keeps the connection on idle. In seconds.
$context  : AmqpContext
$driver  : string
Defines the amqp interop transport being internally used. Currently supports lib, ext and bunny values.
$dsn  : string
The connection to the broker could be configured as an array of options or as a DSN string like amqp:, amqps:, amqps://user:pass@localhost:1000/vhost.
$exchangeFlags  : int
Set of flags for the exchange
$exchangeName  : string
The exchange used to publish messages to.
$exchangeType  : string
The exchange type. Can take values: direct, fanout, topic, headers
$heartbeat  : float|null
The periods of time PHP pings the broker in order to prolong the connection timeout. In seconds.
$host  : string|null
The message queue broker's host.
$keepalive  : bool
Send keep-alive packets for a socket connection
$lazy  : bool|null
The connection will be established as later as possible if set true.
$loopConfig  : array<string|int, mixed>|string
$password  : string|null
This is RabbitMQ password which is used to login on the broker.
$persisted  : bool|null
PHP uses one shared connection if set true.
$port  : string|null
The message queue broker's port.
$qosGlobal  : bool|null
If false prefetch_count option applied separately to each new consumer on the channel If true prefetch_count option shared across all consumers on the channel.
$qosPrefetchCount  : int|null
Defines number of message pre-fetched in advance per consumer.
$qosPrefetchSize  : int|null
Defines number of message pre-fetched in advance on a channel basis.
$queueFlags  : int
Set of flags for the queue
$queueName  : string
The queue used to consume messages from.
$queueOptionalArguments  : array<string|int, mixed>
Setting optional arguments for the queue (key-value pairs) ```php [ 'x-expires' => 300000, 'x-max-priority' => 10 ] ```
$readTimeout  : float|null
The time PHP socket waits for an information while reading. In seconds.
$routingKey  : string|null
Routing key for publishing messages. Default is NULL.
$serializer  : SerializerInterface|array<string|int, mixed>
$setMessageHeaders  : array<string|int, mixed>
Headers to send along with the message ```php [ 'header-1' => 'header-value-1', 'header-2' => 'header-value-2', ] ```
$sslCacert  : string|null
Location of Certificate Authority file on local filesystem which should be used with the verify_peer context option to authenticate the identity of the remote peer.
$sslCert  : string|null
Path to local certificate file on filesystem.
$sslKey  : string|null
Path to local private key file on filesystem in case of separate files for certificate (local_cert) and private key.
$sslOn  : bool|null
Defines whether secure connection should be used or not.
$sslVerify  : bool|null
Require verification of SSL certificate used.
$strictJobType  : bool
$ttr  : int
$user  : string|null
This is RabbitMQ user which is used to login on the broker.
$vhost  : string|null
Virtual hosts provide logical grouping and separation of resources.
$writeTimeout  : float|null
The time PHP socket waits for an information while witting. In seconds.
$context  : AmqpContext
Amqp interop context.
$setupBrokerDone  : bool
The property tells whether the setupBroker method was called or not.
$supportedDrivers  : array<string|int, string>
List of supported amqp interop drivers.
$_behaviors  : array<string|int, Behavior>|null
$_events  : array<string|int, mixed>
$_eventWildcards  : array<string|int, mixed>
$_workerPid  : int|null
$pushDelay  : mixed
$pushPriority  : mixed
$pushTtr  : mixed

Methods

__call()  : mixed
Calls the named method which is not a class method.
__clone()  : mixed
This method is called after the object is created by cloning an existing one.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of a component property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets the value of a component property.
__unset()  : mixed
Sets a component property to be null.
attachBehavior()  : Behavior
Attaches a behavior to this component.
attachBehaviors()  : mixed
Attaches a list of behaviors to the component.
behaviors()  : array<string|int, mixed>
Returns a list of behaviors that this component should behave as.
bootstrap()  : mixed
Bootstrap method to be called during application bootstrap stage.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
delay()  : $this
Sets delay for later execute.
detachBehavior()  : Behavior|null
Detaches a behavior from the component.
detachBehaviors()  : mixed
Detaches all behaviors from the component.
ensureBehaviors()  : mixed
Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
getBehavior()  : Behavior|null
Returns the named behavior object.
getBehaviors()  : array<string|int, Behavior>
Returns all behaviors attached to this component.
getContext()  : AmqpContext
getWorkerPid()  : int|null
Gets process ID of a worker.
hasEventHandlers()  : bool
Returns a value indicating whether there is any handler attached to the named event.
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined for this component.
init()  : mixed
Initializes the object.
isDone()  : bool
isReserved()  : bool
isWaiting()  : bool
listen()  : mixed
Listens amqp-queue and runs new jobs.
off()  : bool
Detaches an existing event handler from this component.
on()  : mixed
Attaches an event handler to an event.
priority()  : $this
Sets job priority.
push()  : string|null
Pushes job into queue.
status()  : int
trigger()  : mixed
Triggers an event.
ttr()  : $this
Sets TTR for job execute.
unserializeMessage()  : array<string|int, mixed>
Unserializes.
close()  : mixed
Closes connection and channel.
getCommandId()  : string
handleMessage()  : bool
open()  : mixed
Opens connection and channel.
pushMessage()  : string
redeliver()  : mixed
{@inheritdoc}
runWorker()  : null|int
Runs worker.
setupBroker()  : mixed
attachBehaviorInternal()  : Behavior
Attaches a behavior to this component.

Constants

ATTEMPT

public mixed ATTEMPT = 'yii-attempt'

DELAY

public mixed DELAY = 'yii-delay'

ENQUEUE_AMQP_BUNNY

public mixed ENQUEUE_AMQP_BUNNY = 'enqueue/amqp-bunny'

ENQUEUE_AMQP_EXT

public mixed ENQUEUE_AMQP_EXT = 'enqueue/amqp-ext'

ENQUEUE_AMQP_LIB

public mixed ENQUEUE_AMQP_LIB = 'enqueue/amqp-lib'

EVENT_AFTER_ERROR

public mixed EVENT_AFTER_ERROR = 'afterError'
Tags
event

ExecEvent

EVENT_AFTER_EXEC

public mixed EVENT_AFTER_EXEC = 'afterExec'
Tags
event

ExecEvent

EVENT_AFTER_PUSH

public mixed EVENT_AFTER_PUSH = 'afterPush'
Tags
event

PushEvent

EVENT_BEFORE_EXEC

public mixed EVENT_BEFORE_EXEC = 'beforeExec'
Tags
event

ExecEvent

EVENT_BEFORE_PUSH

public mixed EVENT_BEFORE_PUSH = 'beforePush'
Tags
event

PushEvent

EVENT_WORKER_LOOP

public mixed EVENT_WORKER_LOOP = 'workerLoop'
Tags
event

WorkerEvent that is triggered each iteration between requests to queue.

since
2.0.3

EVENT_WORKER_START

public mixed EVENT_WORKER_START = 'workerStart'
Tags
event

WorkerEvent that is triggered when the worker is started.

since
2.0.2

EVENT_WORKER_STOP

public mixed EVENT_WORKER_STOP = 'workerStop'
Tags
event

WorkerEvent that is triggered when the worker is stopped.

since
2.0.2

PRIORITY

public mixed PRIORITY = 'yii-priority'

TTR

public mixed TTR = 'yii-ttr'

Properties

$attempts

public int $attempts = 1

default attempt count

$behaviors read-only

public array<string|int, Behavior> $behaviors

List of behaviors attached to this component.

$commandClass

The property contains a command class which used in cli.

public string $commandClass = \yii\queue\amqp_interop\Command::class

command class name

$commandOptions

public array<string|int, mixed> $commandOptions = []

of additional options of command

$connectionTimeout

The time RabbitMQ keeps the connection on idle. In seconds.

public float|null $connectionTimeout

$context read-only

public AmqpContext $context

$driver

Defines the amqp interop transport being internally used. Currently supports lib, ext and bunny values.

public string $driver = self::ENQUEUE_AMQP_LIB

$dsn

The connection to the broker could be configured as an array of options or as a DSN string like amqp:, amqps:, amqps://user:pass@localhost:1000/vhost.

public string $dsn

$exchangeFlags

Set of flags for the exchange

public int $exchangeFlags = \Interop\Amqp\AmqpTopic::FLAG_DURABLE
Tags
since
2.3.5
see
AmqpDestination

$exchangeName

The exchange used to publish messages to.

public string $exchangeName = 'exchange'

$exchangeType

The exchange type. Can take values: direct, fanout, topic, headers

public string $exchangeType = \Interop\Amqp\AmqpTopic::TYPE_DIRECT
Tags
since
2.3.3

$heartbeat

The periods of time PHP pings the broker in order to prolong the connection timeout. In seconds.

public float|null $heartbeat

$host

The message queue broker's host.

public string|null $host

$keepalive

Send keep-alive packets for a socket connection

public bool $keepalive
Tags
since
2.3.6

$lazy

The connection will be established as later as possible if set true.

public bool|null $lazy

$loopConfig

public array<string|int, mixed>|string $loopConfig = \yii\queue\cli\SignalLoop::class
Tags
since
2.0.2

$password

This is RabbitMQ password which is used to login on the broker.

public string|null $password

$persisted

PHP uses one shared connection if set true.

public bool|null $persisted

$port

The message queue broker's port.

public string|null $port

$qosGlobal

If false prefetch_count option applied separately to each new consumer on the channel If true prefetch_count option shared across all consumers on the channel.

public bool|null $qosGlobal

$qosPrefetchCount

Defines number of message pre-fetched in advance per consumer.

public int|null $qosPrefetchCount

$qosPrefetchSize

Defines number of message pre-fetched in advance on a channel basis.

public int|null $qosPrefetchSize

$queueFlags

Set of flags for the queue

public int $queueFlags = \Interop\Amqp\AmqpQueue::FLAG_DURABLE
Tags
since
2.3.5
see
AmqpDestination

$queueName

The queue used to consume messages from.

public string $queueName = 'interop_queue'

$readTimeout

The time PHP socket waits for an information while reading. In seconds.

public float|null $readTimeout

$routingKey

Routing key for publishing messages. Default is NULL.

public string|null $routingKey

$setMessageHeaders

Headers to send along with the message ```php [ 'header-1' => 'header-value-1', 'header-2' => 'header-value-2', ] ```

public array<string|int, mixed> $setMessageHeaders = []
Tags
since
3.0.0

$sslCacert

Location of Certificate Authority file on local filesystem which should be used with the verify_peer context option to authenticate the identity of the remote peer.

public string|null $sslCacert

$sslCert

Path to local certificate file on filesystem.

public string|null $sslCert

$sslKey

Path to local private key file on filesystem in case of separate files for certificate (local_cert) and private key.

public string|null $sslKey

$sslOn

Defines whether secure connection should be used or not.

public bool|null $sslOn

$sslVerify

Require verification of SSL certificate used.

public bool|null $sslVerify

$strictJobType

public bool $strictJobType = true

whether to enable strict job type control. Note that in order to enable type control, a pushing job must be [[JobInterface]] instance.

Tags
since
2.0.1

$ttr

public int $ttr = 300

default time to reserve a job

$user

This is RabbitMQ user which is used to login on the broker.

public string|null $user

$vhost

Virtual hosts provide logical grouping and separation of resources.

public string|null $vhost

$writeTimeout

The time PHP socket waits for an information while witting. In seconds.

public float|null $writeTimeout

$context

Amqp interop context.

protected AmqpContext $context

$setupBrokerDone

The property tells whether the setupBroker method was called or not.

protected bool $setupBrokerDone = false

Having it we can do broker setup only once per process.

$supportedDrivers

List of supported amqp interop drivers.

protected array<string|int, string> $supportedDrivers = [self::ENQUEUE_AMQP_LIB, self::ENQUEUE_AMQP_EXT, self::ENQUEUE_AMQP_BUNNY]

$_behaviors

private array<string|int, Behavior>|null $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events

private array<string|int, mixed> $_events = []

the attached event handlers (event name => handlers)

$_eventWildcards

private array<string|int, mixed> $_eventWildcards = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

Tags
since
2.0.14

$_workerPid

private int|null $_workerPid

current process ID of a worker.

Tags
since
2.0.2

$pushDelay

private mixed $pushDelay

$pushPriority

private mixed $pushPriority

$pushTtr

private mixed $pushTtr

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.

public __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call [[init()]].

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.

public __get(string $name) : mixed

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only.

see
__set()
Return values
mixed —

the property value or the value of a behavior's property

__isset()

Checks if a property is set, i.e. defined and not null.

public __isset(string $name) : bool

This method will check in the following order and act accordingly:

  • a property defined by a setter: return whether the property is set
  • a property of a behavior: return whether the property is set
  • return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set

__set()

Sets the value of a component property.

public __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only.

see
__get()

__unset()

Sets a component property to be null.

public __unset(string $name) : mixed

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value to be null
  • a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

attachBehavior()

Attaches a behavior to this component.

public attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters
$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

  • a [[Behavior]] object
  • a string specifying the behavior class
  • an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.
Tags
see
detachBehavior()
Return values
Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.

public attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters
$behaviors : array<string|int, mixed>

list of behaviors to be attached to the component

Tags
see
attachBehavior()

behaviors()

Returns a list of behaviors that this component should behave as.

public behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values
array<string|int, mixed> —

the behavior configurations.

bootstrap()

Bootstrap method to be called during application bootstrap stage.

public bootstrap(mixed $app) : mixed
Parameters
$app : mixed

the application currently running

Tags
inheritdoc

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a readable property of the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a writable property of the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

delay()

Sets delay for later execute.

public delay(int|mixed $value) : $this
Parameters
$value : int|mixed
Return values
$this

detachBehavior()

Detaches a behavior from the component.

public detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters
$name : string

the behavior's name.

Return values
Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.

public detachBehaviors() : mixed

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.

public ensureBehaviors() : mixed

getBehavior()

Returns the named behavior object.

public getBehavior(string $name) : Behavior|null
Parameters
$name : string

the behavior name

Return values
Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.

public getBehaviors() : array<string|int, Behavior>
Return values
array<string|int, Behavior> —

list of behaviors attached to this component

getContext()

public getContext() : AmqpContext
Return values
AmqpContext

getWorkerPid()

Gets process ID of a worker.

public getWorkerPid() : int|null
Tags
inheritdoc
since
2.0.2
Return values
int|null

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public hasEventHandlers(string $name) : bool
Parameters
$name : string

the event name

Return values
bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

  • the class has a method with the specified name
  • an attached behavior has a method with the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkBehaviors : bool = true

whether to treat behaviors' methods as methods of this component

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.

public hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a property of the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

init()

Initializes the object.

public init() : mixed
Tags
inheritdoc

isDone()

public isDone(string $id) : bool
Parameters
$id : string

of a job message

Return values
bool

isReserved()

public isReserved(string $id) : bool
Parameters
$id : string

of a job message

Return values
bool

isWaiting()

public isWaiting(string $id) : bool
Parameters
$id : string

of a job message

Return values
bool

listen()

Listens amqp-queue and runs new jobs.

public listen() : mixed

off()

Detaches an existing event handler from this component.

public off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters
$name : string

event name

$handler : callable|null = null

the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Tags
see
on()
Return values
bool —

if a handler is found and detached

on()

Attaches an event handler to an event.

public on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});
Parameters
$name : string

the event name

$handler : callable

the event handler

$data : mixed = null

the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].

$append : bool = true

whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

Tags
see
off()

priority()

Sets job priority.

public priority(mixed $value) : $this
Parameters
$value : mixed
Return values
$this

push()

Pushes job into queue.

public push(JobInterface|mixed $job) : string|null
Parameters
$job : JobInterface|mixed
Return values
string|null —

id of a job message

status()

public status(mixed $id) : int
Parameters
$id : mixed

of a job message

Tags
inheritdoc
Return values
int —

status code

trigger()

Triggers an event.

public trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters
$name : string

the event name

$event : Event|null = null

the event instance. If not set, a default [[Event]] object will be created.

ttr()

Sets TTR for job execute.

public ttr(int|mixed $value) : $this
Parameters
$value : int|mixed
Return values
$this

unserializeMessage()

Unserializes.

public unserializeMessage(string $serialized) : array<string|int, mixed>
Parameters
$serialized : string

message

Return values
array<string|int, mixed> —

pair of a job and error that

close()

Closes connection and channel.

protected close() : mixed

getCommandId()

protected getCommandId() : string
Tags
throws
Return values
string —

command id

handleMessage()

protected handleMessage(mixed $id, mixed $message, mixed $ttr, mixed $attempt) : bool
Parameters
$id : mixed

of a job message

$message : mixed
$ttr : mixed

time to reserve

$attempt : mixed

number

Tags
inheritdoc
Return values
bool

open()

Opens connection and channel.

protected open() : mixed

pushMessage()

protected pushMessage(mixed $payload, mixed $ttr, mixed $delay, mixed $priority) : string
Parameters
$payload : mixed
$ttr : mixed

time to reserve in seconds

$delay : mixed
$priority : mixed
Tags
inheritdoc
Return values
string —

id of a job message

redeliver()

{@inheritdoc}

protected redeliver(AmqpMessage $message) : mixed
Parameters
$message : AmqpMessage

runWorker()

Runs worker.

protected runWorker(callable $handler) : null|int
Parameters
$handler : callable
Tags
since
2.0.2
Return values
null|int —

exit code

setupBroker()

protected setupBroker() : mixed

attachBehaviorInternal()

Attaches a behavior to this component.

private attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior
Parameters
$name : string|int

the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.

$behavior : string|array<string|int, mixed>|Behavior

the behavior to be attached

Return values
Behavior —

the attached behavior.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results