Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Class for using a standard PHP array as a queue

__construct(
array|\Zend_Config $options, \Zend_Queue|null $queue
=
null
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$options | array|\Zend_Config | |
$queue | \Zend_Queue|null |

count(
\Zend_Queue $queue
=
null
)
:
integer
Return the approximate number of messages in the queue
Name | Type | Description |
---|---|---|
$queue | \Zend_Queue |
Type | Description |
---|---|
integer |
Exception | Description |
---|---|
\Zend_Queue_Exception |

create(
string $name, integer $timeout
=
null
)
:
boolean
Create a new queue
Visibility timeout is how long a message is left in the queue "invisible" to other readers. If the message is acknowleged (deleted) before the timeout, then the message is deleted. However, if the timeout expires then the message will be made available to other queue readers.
Name | Type | Description |
---|---|---|
$name | string | queue name |
$timeout | integer | default visibility timeout |
Type | Description |
---|---|
boolean |

delete(
string $name
)
:
boolean
Delete a queue and all of it's messages
Returns false if the queue is not found, true if the queue exists
Name | Type | Description |
---|---|---|
$name | string | queue name |
Type | Description |
---|---|
boolean |

deleteMessage(
\Zend_Queue_Message $message
)
:
boolean
Delete a message from the queue
Returns true if the message is deleted, false if the deletion is unsuccessful.
Name | Type | Description |
---|---|---|
$message | \Zend_Queue_Message |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Queue_Exception |

getCapabilities(
)
:
array
Return a list of queue capabilities functions
$array['function name'] = true or false true is supported, false is not supported.
Type | Description |
---|---|
array |

getData(
)
:
\$this;
returns underlying _data array $queue->getAdapter()->getData();
Type | Description |
---|---|
\$this; |

getQueues(
)
:
array
Get an array of all available queues
Not all adapters support getQueues(), use isSupported('getQueues') to determine if the adapter supports this feature.
Type | Description |
---|---|
array |

isExists(
string $name
)
:
boolean
Does a queue already exist?
Throws an exception if the adapter cannot determine if a queue exists. use isSupported('isExists') to determine if an adapter can test for queue existance.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |

receive(
integer $maxMessages
=
null, integer $timeout
=
null, \Zend_Queue $queue
=
null
)
:
\Zend_Queue_Message_Iterator
Get messages in the queue
Name | Type | Description |
---|---|---|
$maxMessages | integer | Maximum number of messages to return |
$timeout | integer | Visibility timeout for these messages |
$queue | \Zend_Queue |
Type | Description |
---|---|
\Zend_Queue_Message_Iterator |

send(
string $message, \Zend_Queue $queue
=
null
)
:
\Zend_Queue_Message
Send a message to the queue
Name | Type | Description |
---|---|---|
$message | string | Message to send to the active queue |
$queue | \Zend_Queue |
Type | Description |
---|---|
\Zend_Queue_Message |
Exception | Description |
---|---|
\Zend_Queue_Exception |