Statistics
Legends
Deprecated
Todos
Classes
Methods
Class fields
Class constants
Inheritances
Files
Overview
FRAMES
NO FRAMES

Class Zend_Queue
Zend_Queue
|- class Zend_Queue implements Countable
Defined in line 30 of file Queue.php.
Class for connecting to queues performing common operations.
CategoryZend
PackageZend_Queue
CopyrightCopyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
Licensehttp://framework.zend.com/license/new-bsd New BSD License

Summary
Class constants
TIMEOUT Use the TIMEOUT constant in the config of a Zend_Queue
VISIBILITY_TIMEOUT Default visibility passed to count
NAME Use the NAME constant in the config of Zend_Queue
Instance fields
# $_adapter
# $_logger
# $_messageClass Zend_Queue_Message class
# $_messageSetClass Zend_Queue_Message_Iterator class
# $_options User-provided configuration
Instance methods
+ __construct() Constructor
# _setName() Set the name of the queue
+ count() Returns the approximate number of messages in the queue
+ createQueue() Create a new queue
+ debugInfo() returns a listing of Zend_Queue details.
+ deleteMessage() Delete a message from the queue
+ deleteQueue() Delete the queue this object is working on.
+ getAdapter() Get the adapter for this queue
+ getCapabilities() Return a list of queue capabilities functions
+ getMessageClass()
+ getMessageSetClass()
+ getName() Get the name of the queue
+ getOption() Retrieve a single option
+ getOptions() Returns the configuration options for the queue
+ getQueues() Get an array of all available queues
+ hasOption() Determine if a requested option has been defined
+ isSupported() Indicates if a function is supported or not
+ receive() Return the first element in the queue
+ send() Send a message to the queue
+ setAdapter() Set the adapter for this queue
+ setMessageClass()
+ setMessageSetClass()
+ setOption() Set an individual configuration option
+ setOptions() Set queue options

Details

Class constants

TIMEOUT
const TIMEOUT = 'timeout'
Use the TIMEOUT constant in the config of a Zend_Queue
Defined in Queue.php, line 35
VISIBILITY_TIMEOUT
const VISIBILITY_TIMEOUT = 30
Default visibility passed to count
Defined in Queue.php, line 40
NAME
const NAME = 'name'
Use the NAME constant in the config of Zend_Queue
Defined in Queue.php, line 45

Instance fields

$_adapter
protected $_adapter = null
Defined in Queue.php, line 50
$_logger
protected $_logger = null
Defined in Queue.php, line 76
$_messageClass
protected $_messageClass = 'Zend_Queue_Message'
Zend_Queue_Message class
Var string
Defined in Queue.php, line 64
$_messageSetClass
protected $_messageSetClass = 'Zend_Queue_Message_Iterator'
Zend_Queue_Message_Iterator class
Var string
Defined in Queue.php, line 71
$_options
protected $_options = array()
User-provided configuration
Var array
Defined in Queue.php, line 57

Instance methods

__construct()
public function __construct( $spec
$options = array())
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();
Parameters
$spec
Zend_Config|array $options Zend_Config or a configuration array
Returns void
Defined in Queue.php, line 92
_setName()
protected function _setName( $name)
Set the name of the queue

This is AN UNSUPPORTED FUNCTION
Parameters
string $name
Returns Zend_Queue|false Provides a fluent interface
Defined in Queue.php, line 521
count()
public function count( )
Returns the approximate number of messages in the queue
Returns integer
Defined in Queue.php, line 424
createQueue()
public function createQueue( $name
$timeout = null)
Create a new queue
Parameters
string $name queue name
integer $timeout default visibility timeout
Returns Zend_Queue|false
Defined in Queue.php, line 324
debugInfo()
public function debugInfo( )
returns a listing of Zend_Queue details.
useful for debugging
Returns array
Defined in Queue.php, line 553
deleteMessage()
public function 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
Defined in Queue.php, line 399
deleteQueue()
public function deleteQueue( )
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
Defined in Queue.php, line 369
getAdapter()
public function getAdapter( )
Get the adapter for this queue
Defined in Queue.php, line 262
getCapabilities()
public function getCapabilities( )
Return a list of queue capabilities functions

$array['function name'] = true or false
true is supported, false is not supported.
Returns array
Defined in Queue.php, line 473
getMessageClass()
public function getMessageClass( )
Returns string
Defined in Queue.php, line 280
getMessageSetClass()
public function getMessageSetClass( )
Returns string
Defined in Queue.php, line 298
getName()
public function getName( )
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
Defined in Queue.php, line 311
getOption()
public function getOption( $name)
Retrieve a single option
Parameters
string $name
Returns null|mixed Returns null if option does not exist; option value otherwise
Defined in Queue.php, line 196
getOptions()
public function getOptions( )
Returns the configuration options for the queue
Returns array
Defined in Queue.php, line 174
getQueues()
public function getQueues( )
Get an array of all available queues
Returns array
Defined in Queue.php, line 504
hasOption()
public function hasOption( $name)
Determine if a requested option has been defined
Parameters
string $name
Returns bool
Defined in Queue.php, line 185
isSupported()
public function isSupported( $name)
Indicates if a function is supported or not.
Parameters
string $name
Returns boolean
Defined in Queue.php, line 484
receive()
public function receive( $maxMessages = null
$timeout = null)
Return the first element in the queue
Parameters
integer $maxMessages
integer $timeout
Defined in Queue.php, line 439
send()
public function send( $message)
Send a message to the queue
Parameters
mixed $message message
Defined in Queue.php, line 414
setAdapter()
public function setAdapter( $adapter)
Set the adapter for this queue
Parameters
string|Zend_Queue_Adapter_AdapterInterface $adapter
Returns Zend_Queue Provides a fluent interface
Defined in Queue.php, line 210
setMessageClass()
public function setMessageClass( $className)
Parameters
string $className
Returns Zend_Queue Provides a fluent interface
Defined in Queue.php, line 271
setMessageSetClass()
public function setMessageSetClass( $className)
Parameters
string $className
Returns Zend_Queue Provides a fluent interface
Defined in Queue.php, line 289
setOption()
public function setOption( $name
$value)
Set an individual configuration option
Parameters
string $name
mixed $value
Returns Zend_Queue
Defined in Queue.php, line 163
setOptions()
public function setOptions( array $options)
Set queue options
Parameters
array $options
Returns Zend_Queue
Defined in Queue.php, line 150