Detailed Description
Definition at line 30 of file Queue.php.
Constructor & Destructor Documentation
__construct |
( |
$ |
spec, |
|
|
$ |
options = array() |
|
) |
| |
Constructor
Can be called as $queue = new Zend_Queue($config);
- Parameters:
-
| string|Zend_Queue_Adapter|array|Zend_Config|null | String or adapter instance, or options array or Zend_Config instance |
Zend_Config | array | $options | Zend_Config or a configuration array |
- Returns:
- void
Definition at line 92 of file Queue.php.
Member Function Documentation
_setName |
( |
$ |
name ) |
[protected] |
Set the name of the queue
This is AN UNSUPPORTED FUNCTION
- Parameters:
-
- Returns:
- Zend_Queue|false Provides a fluent interface
- See also:
- Zend_Queue_Exception
Definition at line 521 of file Queue.php.
Returns the approximate number of messages in the queue
- Returns:
- integer
Definition at line 424 of file Queue.php.
createQueue |
( |
$ |
name, |
|
|
$ |
timeout = null |
|
) |
| |
Create a new queue
- Parameters:
-
string | $name | queue name |
integer | $timeout | default visibility timeout |
- Returns:
- Zend_Queue|false
- Exceptions:
-
Definition at line 324 of file Queue.php.
returns a listing of Zend_Queue details. useful for debugging
- Returns:
- array
Definition at line 553 of file Queue.php.
deleteMessage |
( |
Zend_Queue_Message $ |
message ) |
|
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.
- Parameters:
-
Zend_Queue_Message | $message | |
- Returns:
- boolean
- Exceptions:
-
Definition at line 399 of file Queue.php.
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.
- Returns:
- boolean
- See also:
- Zend_Queue_Adapter_Null
Definition at line 369 of file Queue.php.
Get the adapter for this queue
- Returns:
- Zend_Queue_Adapter_AdapterInterface
Definition at line 262 of file Queue.php.
Return a list of queue capabilities functions
$array['function name'] = true or false true is supported, false is not supported.
- Parameters:
-
- Returns:
- array
Definition at line 473 of file Queue.php.
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.
- Returns:
- string
Definition at line 311 of file Queue.php.
Retrieve a single option
- Parameters:
-
- Returns:
- null|mixed Returns null if option does not exist; option value otherwise
Definition at line 196 of file Queue.php.
Returns the configuration options for the queue
- Returns:
- array
Definition at line 174 of file Queue.php.
Get an array of all available queues
- Returns:
- array
- Exceptions:
-
Definition at line 504 of file Queue.php.
Determine if a requested option has been defined
- Parameters:
-
- Returns:
- bool
Definition at line 185 of file Queue.php.
Indicates if a function is supported or not.
- Parameters:
-
- Returns:
- boolean
Definition at line 484 of file Queue.php.
receive |
( |
$ |
maxMessages = null , |
|
|
$ |
timeout = null |
|
) |
| |
Return the first element in the queue
- Parameters:
-
integer | $maxMessages | |
integer | $timeout | |
- Returns:
- Zend_Queue_Message_Iterator
Definition at line 439 of file Queue.php.
Send a message to the queue
- Parameters:
-
- Returns:
- Zend_Queue_Message
- Exceptions:
-
Definition at line 414 of file Queue.php.
Set the adapter for this queue
- Parameters:
-
string | Zend_Queue_Adapter_AdapterInterface | $adapter | |
- Returns:
- Zend_Queue Provides a fluent interface
Definition at line 210 of file Queue.php.
setMessageClass |
( |
$ |
className ) |
|
setMessageSetClass |
( |
$ |
className ) |
|
setOption |
( |
$ |
name, |
|
|
$ |
value |
|
) |
| |
Set an individual configuration option
- Parameters:
-
- Returns:
- Zend_Queue
Definition at line 163 of file Queue.php.
setOptions |
( |
array $ |
options ) |
|
Field Documentation
Default visibility passed to count
Definition at line 40 of file Queue.php.
The documentation for this class was generated from the following file:
- E:/E/GEAMP/www/openbiz/openbiz/others/Zend/Queue.php