Queue/Adapter/Array.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Queue
- Subpackage
- Adapter
- Version
- $Id$
\Zend_Queue_Adapter_Array
Package: Zend_Queue\AdapterClass for using a standard PHP array as a queue
- Parent(s)
- \Zend_Queue_Adapter_AdapterAbstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
create(string $name, integer $timeout = null) : booleanVisibility 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.
Parameters| Name | Type | Description |
|---|
| $name | string | queue name |
|---|
| $timeout | integer | default visibility timeout |
|---|
Returnsdelete(string $name) : booleanDelete a queue and all of it's messages
Returns false if the queue is not found, true if the queue exists
Parameters| Name | Type | Description |
|---|
| $name | string | queue name |
|---|
ReturnsdeleteMessage(\Zend_Queue_Message $message) : booleanDelete a message from the queue
Returns true if the message is deleted, false if the deletion is
unsuccessful.
ParametersReturnsThrowsgetCapabilities() : arrayReturn a list of queue capabilities functions
$array['function name'] = true or false
true is supported, false is not supported.
ReturnsgetQueues() : arrayGet an array of all available queues
Not all adapters support getQueues(), use isSupported('getQueues')
to determine if the adapter supports this feature.
ReturnsisExists(string $name) : booleanDoes 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.
Parameters| Name | Type | Description |
|---|
| $name | string | |
|---|
Returnsreceive(integer $maxMessages = null, integer $timeout = null, \Zend_Queue $queue = null) : \Zend_Queue_Message_IteratorGet messages in the queue
Parameters| Name | Type | Description |
|---|
| $maxMessages | integer | Maximum number of messages to return |
|---|
| $timeout | integer | Visibility timeout for these messages |
|---|
| $queue | \Zend_Queue | |
|---|
Returns send(string $message, \Zend_Queue $queue = null) : \Zend_Queue_MessageSend a message to the queue
Parameters| Name | Type | Description |
|---|
| $message | string | Message to send to the active queue |
|---|
| $queue | \Zend_Queue | |
|---|
ReturnsThrows setData(array $data) : \$this;sets the underlying _data array
$queue->getAdapter()->setData($data);
Parameters| Name | Type | Description |
|---|
| $data | array | |
|---|
Returns 
inherited
Classes
