Class for connecting to queues performing common operations.
| category | Zend |
|---|---|
| package | Zend_Queue |
| copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license | New BSD License |
__construct($spec, \Zend_Config|array $options = array()) : void
Can be called as $queue = new Zend_Queue($config);
\Zend_ConfigarrayZend_Config or a configuration array
count() : integer
integercreateQueue(string $name, integer $timeout = null) : \Zend_Queue | false
stringqueue name
integerdefault visibility timeout
\Zend_Queue_Exception |
|---|
\Zend_Queuefalse
debugInfo() : array
useful for debugging
arraydeleteMessage(\Zend_Queue_Message $message) : boolean
Returns true if the message is deleted, false if the deletion is unsuccessful.
Returns true if the adapter doesn't support message deletion.
\Zend_Queue_Message
\Zend_Queue_Exception |
|---|
booleandeleteQueue() : boolean
This queue is disabled, regardless of the outcome of the deletion of the queue, because the programmers intent is to disable this queue.
booleangetAdapter() : \Zend_Queue_Adapter_AdapterInterface
\Zend_Queue_Adapter_AdapterInterfacegetCapabilities() : array
$array['function name'] = true or false true is supported, false is not supported.
arraygetMessageClass() : string
stringgetMessageSetClass() : string
stringgetName() : string
Note: _setName() used to exist, but it caused confusion with createQueue Will evaluate later to see if we should add it back in.
stringgetOption(string $name) : null | mixed
string
nullmixedReturns null if option does not exist; option value otherwisegetOptions() : array
arraygetQueues() : array
\Zend_Queue_Exception |
|---|
arrayhasOption(string $name) : boolean
string
booleanisSupported(string $name) : boolean
string
booleanreceive(integer $maxMessages= null, integer $timeout= null) : \Zend_Queue_Message_Iterator
integer
integer
\Zend_Queue_Message_Iteratorsend(mixed $message) : \Zend_Queue_Message
mixedmessage
\Zend_Queue_Exception |
|---|
\Zend_Queue_MessagesetAdapter(string|\Zend_Queue_Adapter_AdapterInterface $adapter) : \Zend_Queue
string\Zend_Queue_Adapter_AdapterInterface
\Zend_QueueProvides a fluent interfacesetMessageClass(string $className) : \Zend_Queue
string
\Zend_QueueProvides a fluent interfacesetMessageSetClass(string $className) : \Zend_Queue
string
\Zend_QueueProvides a fluent interfacesetOption(string $name, mixed $value) : \Zend_Queue
string
mixed
\Zend_QueuesetOptions(array $options) : \Zend_Queue
array
\Zend_Queue_setName(string $name) : \Zend_Queue | false
This is AN UNSUPPORTED FUNCTION
string
\Zend_QueuefalseProvides a fluent interface$_adapter : \Zend_Queue_Adapter_AdapterInterface
null$_logger : \Zend_Log
nullNAME = 'name'
TIMEOUT = 'timeout'
VISIBILITY_TIMEOUT = 30