Class testing. No supported functions. Also used to disable a Zend_Queue.
category |
Zend |
package |
Zend_Queue |
subpackage |
Adapter |
copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license |
New BSD License |
inherited_from |
\Zend_Queue_Adapter_AdapterAbstract |
Methods
Constructor
__construct(array|\Zend_Config $options, null|\Zend_Queue $queue = null
) : void
$options is an array of key/value pairs or an instance of Zend_Config
containing configuration options. These options are common to most adapters:
See the Zend_Queue Adapter Notes documentation for example configurations.
Some options are used on a case-by-case basis by adapters:
access_key => (string) Amazon AWS Access Key
secret_key => (string) Amazon AWS Secret Key
dbname => (string) The name of the database to user
username => (string) Connect to the database as this username.
password => (string) Password associated with the username.
host => (string) What host to connect to, defaults to localhost
port => (string) The port of the database
inherited_from |
\Zend_Queue_Adapter_AdapterAbstract::__construct() |
Parameters
$options
array
\Zend_Config
$queue
null
\Zend_Queue
Constructor.
__construct(array|\Zend_Config $options, \Zend_Queue $queue = null
) : void
Inherited
$options is an array of key/value pairs or an instance of Zend_Config
containing configuration options. These options are common to most adapters:
See the Zend_Queue Adapter Notes documentation for example configurations.
Some options are used on a case-by-case basis by adapters:
access_key => (string) Amazon AWS Access Key
secret_key => (string) Amazon AWS Secret Key
dbname => (string) The name of the database to user
username => (string) Connect to the database as this username.
password => (string) Password associated with the username.
host => (string) What host to connect to, defaults to localhost
port => (string) The port of the database
inherited_from |
\Zend_Queue_Adapter_AdapterInterface::__construct() |
Parameters
$options
$queue
Exceptions
Return the approximate number of messages in the queue
count(\Zend_Queue $queue = null
)
Parameters
$queue
Exceptions
\Zend_Queue_Exception |
- not supported. |
Create a new queue
create($name, $timeout = null
)
Parameters
$name
$timeout
Exceptions
\Zend_Queue_Exception |
- not supported. |
Delete a queue and all of it's messages
delete($name)
Parameters
$name
Exceptions
\Zend_Queue_Exception |
- not supported. |
Delete a message from the queue
deleteMessage(\Zend_Queue_Message $message)
Parameters
$message
Exceptions
\Zend_Queue_Exception |
- not supported. |
Return a list of queue capabilities functions
getCapabilities() : array
$array['function name'] = true or false
true is supported, false is not supported.
Returns
array
Returns the configuration options in this adapter.
getOptions() : array
Inherited
inherited_from |
\Zend_Queue_Adapter_AdapterInterface::getOptions() |
Returns
array
get the Zend_Queue class that is attached to this object
getQueue() : \Zend_Queue | null
Inherited
inherited_from |
\Zend_Queue_Adapter_AdapterInterface::getQueue() |
Returns
\Zend_Queue
null
Get an array of all available queues
getQueues()
Exceptions
\Zend_Queue_Exception |
- not supported. |
Does a queue already exist?
isExists($name)
Parameters
$name
Exceptions
\Zend_Queue_Exception |
- not supported. |
Indicates if a function is supported or not.
isSupported(string $name) : boolean
Inherited
inherited_from |
\Zend_Queue_Adapter_AdapterInterface::isSupported() |
Parameters
$name
string
Returns
boolean
Get messages in the queue
receive($maxMessages = null
, $timeout = null
, \Zend_Queue $queue = null
)
Parameters
$maxMessages
$timeout
$queue
Exceptions
\Zend_Queue_Exception |
- not supported. |
Send a message to the queue
send($message, \Zend_Queue $queue = null
)
Parameters
$message
$queue
Exceptions
\Zend_Queue_Exception |
- not supported. |
set the Zend_Queue class for this object
setQueue(\Zend_Queue $queue) : \Zend_Queue_Adapter_AdapterInterface
Inherited
inherited_from |
\Zend_Queue_Adapter_AdapterInterface::setQueue() |
Parameters
$queue
\Zend_Queue
Returns
\Zend_Queue_Adapter_AdapterInterface
Properties
User-provided options
$_options : array
Contains the Zend_Queue that this object
$_queue : \Zend_Queue_Adapter_Abstract
Internal array of queues to save on lookups
$_queues : array
Constants
Default timeout for createQueue() function
CREATE_TIMEOUT_DEFAULT = 30
Default timeout for recieve() function
RECEIVE_TIMEOUT_DEFAULT = 30