Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes

Zend_Queue Class Reference

Public Member Functions

 __construct ($spec, $options=array())
 setOptions (array $options)
 setOption ($name, $value)
 getOptions ()
 hasOption ($name)
 getOption ($name)
 setAdapter ($adapter)
 getAdapter ()
 setMessageClass ($className)
 getMessageClass ()
 setMessageSetClass ($className)
 getMessageSetClass ()
 getName ()
 createQueue ($name, $timeout=null)
 deleteQueue ()
 deleteMessage (Zend_Queue_Message $message)
 send ($message)
 count ()
 receive ($maxMessages=null, $timeout=null)
 getCapabilities ()
 isSupported ($name)
 getQueues ()
 debugInfo ()

Data Fields

const TIMEOUT = 'timeout'
const VISIBILITY_TIMEOUT = 30
const NAME = 'name'

Protected Member Functions

 _setName ($name)

Protected Attributes

 $_adapter = null
 $_options = array()
 $_messageClass = 'Zend_Queue_Message'
 $_messageSetClass = 'Zend_Queue_Message_Iterator'
 $_logger = null

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|nullString or adapter instance, or options array or Zend_Config instance
Zend_Config | array$optionsZend_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:
string$name
Returns:
Zend_Queue|false Provides a fluent interface

See also:
Zend_Queue_Exception

Definition at line 521 of file Queue.php.

count (  )

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$namequeue name
integer$timeoutdefault visibility timeout
Returns:
Zend_Queue|false
Exceptions:
Zend_Queue_Exception

Definition at line 324 of file Queue.php.

debugInfo (  )

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:
Zend_Queue_Exception

Definition at line 399 of file Queue.php.

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

See also:
Zend_Queue_Adapter_Null

Definition at line 369 of file Queue.php.

getAdapter (  )

Get the adapter for this queue

Returns:
Zend_Queue_Adapter_AdapterInterface

Definition at line 262 of file Queue.php.

getCapabilities (  )

Return a list of queue capabilities functions

$array['function name'] = true or false true is supported, false is not supported.

Parameters:
string$name
Returns:
array

Definition at line 473 of file Queue.php.

getMessageClass (  )
Returns:
string

Definition at line 280 of file Queue.php.

getMessageSetClass (  )
Returns:
string

Definition at line 298 of file Queue.php.

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

Definition at line 311 of file Queue.php.

getOption ( name )

Retrieve a single option

Parameters:
string$name
Returns:
null|mixed Returns null if option does not exist; option value otherwise

Definition at line 196 of file Queue.php.

getOptions (  )

Returns the configuration options for the queue

Returns:
array

Definition at line 174 of file Queue.php.

getQueues (  )

Get an array of all available queues

Returns:
array
Exceptions:
Zend_Queue_Exception

Definition at line 504 of file Queue.php.

hasOption ( name )

Determine if a requested option has been defined

Parameters:
string$name
Returns:
bool

Definition at line 185 of file Queue.php.

isSupported ( name )

Indicates if a function is supported or not.

Parameters:
string$name
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 ( message )

Send a message to the queue

Parameters:
mixed$messagemessage
Returns:
Zend_Queue_Message
Exceptions:
Zend_Queue_Exception

Definition at line 414 of file Queue.php.

setAdapter ( adapter )

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 )
Parameters:
string$className
Returns:
Zend_Queue Provides a fluent interface

Definition at line 271 of file Queue.php.

setMessageSetClass ( className )
Parameters:
string$className
Returns:
Zend_Queue Provides a fluent interface

Definition at line 289 of file Queue.php.

setOption ( name,
value 
)

Set an individual configuration option

Parameters:
string$name
mixed$value
Returns:
Zend_Queue

Definition at line 163 of file Queue.php.

setOptions ( array $  options )

Set queue options

Parameters:
array$options
Returns:
Zend_Queue

Definition at line 150 of file Queue.php.


Field Documentation

const NAME = 'name'

Use the NAME constant in the config of Zend_Queue

Definition at line 45 of file Queue.php.

const TIMEOUT = 'timeout'

Use the TIMEOUT constant in the config of a Zend_Queue

Definition at line 35 of file Queue.php.

const VISIBILITY_TIMEOUT = 30

Default visibility passed to count

Definition at line 40 of file Queue.php.


The documentation for this class was generated from the following file: