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.
Zend Platform JobQueue adapter

__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|null $queue
=
null
)
:
integer
Return the approximate number of messages in the queue

create(
string $name, integer $timeout
=
null
)
:
void
Create a new queue
Name | Type | Description |
---|---|---|
$name | string | queue name |
$timeout | integer | default visibility timeout |
Exception | Description |
---|---|
\Zend_Queue_Exception |

delete(
string $name
)
:
void
Delete a queue and all of its messages
Name | Type | Description |
---|---|---|
$name | string | queue name |
Exception | Description |
---|---|
\Zend_Queue_Exception |

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 |

getQueues(
)
:
void
Get an array of all available queues
Exception | Description |
---|---|
\Zend_Queue_Exception |

isExists(
string $name
)
:
boolean
Does a queue already exist?
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Queue_Exception | (not supported) |

receive(
integer $maxMessages
=
null, integer $timeout
=
null, \Zend_Queue $queue
=
null
)
:
\ArrayIterator
Get messages in the queue
Name | Type | Description |
---|---|---|
$maxMessages | integer | Maximum number of messages to return |
$timeout | integer | Ignored |
$queue | \Zend_Queue | Not supported |
Type | Description |
---|---|
\ArrayIterator |
Exception | Description |
---|---|
\Zend_Queue_Exception |

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