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 connecting to queues performing common operations.

string
$_messageClass= ''Zend_Queue_Message''
Zend_Queue_Message class
'Zend_Queue_Message'
Details
string
$_messageSetClass= ''Zend_Queue_Message_Iterator''
Zend_Queue_Message_Iterator class
'Zend_Queue_Message_Iterator'
Details
__construct(
string|\Zend_Queue_Adapter|array|\Zend_Config|null $spec, \Zend_Config|array $options
=
array()
)
:
void
Constructor
Can be called as $queue = new Zend_Queue($config); - or - $queue = new Zend_Queue('array', $config); - or - $queue = new Zend_Queue(null, $config); // Zend_Queue->createQueue();
Name | Type | Description |
---|---|---|
$spec | string|\Zend_Queue_Adapter|array|\Zend_Config|null | String or adapter instance, or options array or Zend_Config instance |
$options | \Zend_Config|array | Zend_Config or a configuration array |

_setName(
string $name
)
:
\Zend_Queue|false
Set the name of the queue
This is AN UNSUPPORTED FUNCTION
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
\Zend_Queue|false | Provides a fluent interface |

count(
)
:
integer
Returns the approximate number of messages in the queue
Type | Description |
---|---|
integer |

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

debugInfo(
)
:
array
returns a listing of Zend_Queue details.
useful for debugging
Type | Description |
---|---|
array |

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.
Returns true if the adapter doesn't support message deletion.
Name | Type | Description |
---|---|---|
$message | \Zend_Queue_Message |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Queue_Exception |

deleteQueue(
)
:
boolean
Delete the queue this object is working on.
This queue is disabled, regardless of the outcome of the deletion of the queue, because the programmers intent is to disable this queue.
Type | Description |
---|---|
boolean |

getAdapter(
)
:
\Zend_Queue_Adapter_AdapterInterface
Get the adapter for this queue
Type | Description |
---|---|
\Zend_Queue_Adapter_AdapterInterface |

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 |

getName(
)
:
string
Get the name of the queue
Note: _setName() used to exist, but it caused confusion with createQueue Will evaluate later to see if we should add it back in.
Type | Description |
---|---|
string |

getOption(
string $name
)
:
null|mixed
Retrieve a single option
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
null|mixed | Returns null if option does not exist; option value otherwise |

hasOption(
string $name
)
:
bool
Determine if a requested option has been defined
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
bool |

isSupported(
string $name
)
:
boolean
Indicates if a function is supported or not.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |

receive(
integer $maxMessages
=
null, integer $timeout
=
null
)
:
\Zend_Queue_Message_Iterator
Return the first element in the queue
Name | Type | Description |
---|---|---|
$maxMessages | integer | |
$timeout | integer |
Type | Description |
---|---|
\Zend_Queue_Message_Iterator |

send(
mixed $message
)
:
\Zend_Queue_Message
Send a message to the queue
Name | Type | Description |
---|---|---|
$message | mixed | message |
Type | Description |
---|---|
\Zend_Queue_Message |
Exception | Description |
---|---|
\Zend_Queue_Exception |

setAdapter(
string|\Zend_Queue_Adapter_AdapterInterface $adapter
)
:
\Zend_Queue
Set the adapter for this queue
Name | Type | Description |
---|---|---|
$adapter | string|\Zend_Queue_Adapter_AdapterInterface |
Type | Description |
---|---|
\Zend_Queue | Provides a fluent interface |

setMessageClass(
string $className
)
:
\Zend_Queue
Name | Type | Description |
---|---|---|
$className | string |
Type | Description |
---|---|
\Zend_Queue | Provides a fluent interface |

setMessageSetClass(
string $className
)
:
\Zend_Queue
Name | Type | Description |
---|---|---|
$className | string |
Type | Description |
---|---|
\Zend_Queue | Provides a fluent interface |