Queue/Adapter/Db.php

Show:

inherited

Classes
- \Zend_Queue_Adapter_Db

Table of Contents

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Queue
Subpackage: Adapter
Version: $Id: Db.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Queue_Adapter_Db
jump to top

Package: Zend\Queue\Adapter

Class for using connecting to a Zend_Db-based queuing system

Parent(s): \Zend_Queue_Adapter_AdapterAbstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                CREATE_TIMEOUT_DEFAULT
                = 30

inherited

Default timeout for createQueue() function

Inherited from: \Zend_Queue_Adapter_AdapterAbstract::CREATE_TIMEOUT_DEFAULT

Inherited_from: \Zend_Queue_Adapter_AdapterAbstract::CREATE_TIMEOUT_DEFAULT

 
                RECEIVE_TIMEOUT_DEFAULT
                = 30

inherited

Default timeout for recieve() function

Inherited from: \Zend_Queue_Adapter_AdapterAbstract::RECEIVE_TIMEOUT_DEFAULT

Inherited_from: \Zend_Queue_Adapter_AdapterAbstract::RECEIVE_TIMEOUT_DEFAULT

Properties

\Zend_Db_Table_Row_Abstract $_messageRow = null

Default valuenullDetails

Type: \Zend_Db_Table_Row_Abstract

\Zend_Queue_Adapter_Db_Message $_messageTable = null

Default valuenullDetails

Type: \Zend_Queue_Adapter_Db_Message

array $_options = array()

inherited

User-provided options

Inherited from: \Zend_Queue_Adapter_AdapterAbstract::$$_options

Default valuearray()Details

Type: array
Inherited_from: \Zend_Queue_Adapter_AdapterAbstract::$$_options

\Zend_Queue_Adapter_Abstract $_queue = null

inherited

Contains the Zend_Queue that this object

Inherited from: \Zend_Queue_Adapter_AdapterAbstract::$$_queue

Default valuenullDetails

Type: \Zend_Queue_Adapter_Abstract
Inherited_from: \Zend_Queue_Adapter_AdapterAbstract::$$_queue

\Zend_Queue_Adapter_Db_Queue $_queueTable = null

Default valuenullDetails

Type: \Zend_Queue_Adapter_Db_Queue

array $_queues = array()

inherited

Internal array of queues to save on lookups

Inherited from: \Zend_Queue_Adapter_AdapterAbstract::$$_queues

Default valuearray()Details

Type: array
Inherited_from: \Zend_Queue_Adapter_AdapterAbstract::$$_queues

Methods

__construct(array | \Zend_Config $options, \Zend_Queue | null $queue = null) : void

Constructor

$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

Parameters

Name	Type	Description
$options	array \| \Zend_Config
$queue	\Zend_Queue \| null

Throws

Exception	Description
\Zend_Queue_Exception

_initDbAdapter() : \Zend_Db_Adapter_Abstract

Initialize Db adapter using 'driverOptions' section of the _options array

Throws an exception if the adapter cannot connect to DB.

Returns

Type	Description
\Zend_Db_Adapter_Abstract

Throws

Exception	Description
\Zend_Queue_Exception

count(\Zend_Queue $queue = null) : integer

Return the approximate number of messages in the queue

Parameters

Name	Type	Description
$queue	\Zend_Queue

Returns

Type	Description
integer

Throws

Exception	Description
\Zend_Queue_Exception

create(string $name, integer $timeout = null) : boolean

Create a new queue

Visibility timeout is how long a message is left in the queue "invisible" to other readers. If the message is acknowleged (deleted) before the timeout, then the message is deleted. However, if the timeout expires then the message will be made available to other queue readers.

Parameters

Name	Type	Description
$name	string	queue name
$timeout	integer	default visibility timeout

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Queue_Exception	- database error

delete(string $name) : boolean

Delete a queue and all of it's messages

Returns false if the queue is not found, true if the queue exists

Parameters

Name	Type	Description
$name	string	queue name

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Queue_Exception	- database error

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.

Parameters

Name	Type	Description
$message	\Zend_Queue_Message

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Queue_Exception	- database error

getCapabilities() : array

Return a list of queue capabilities functions

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

Returns

Type	Description
array

getOptions() : array

inherited

Returns the configuration options in this adapter.

Inherited from: \Zend_Queue_Adapter_AdapterAbstract::getOptions()

Returns

Type	Description
array

getQueue() : \Zend_Queue | null

inherited

get the Zend_Queue class that is attached to this object

Inherited from: \Zend_Queue_Adapter_AdapterAbstract::getQueue()

Returns

Type	Description
\Zend_Queue \| null

getQueueId(string $name) : integer | null

Get the queue ID

Returns the queue's row identifier.

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
integer \| null

Throws

Exception	Description
\Zend_Queue_Exception

getQueues() : array

Get an array of all available queues

Not all adapters support getQueues(); use isSupported('getQueues') to determine if the adapter supports this feature.

Returns

Type	Description
array

isExists(string $name) : boolean

Does a queue already exist?

Throws an exception if the adapter cannot determine if a queue exists. use isSupported('isExists') to determine if an adapter can test for queue existance.

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Queue_Exception

isSupported(string $name) : boolean

inherited

Indicates if a function is supported or not.

Inherited from: \Zend_Queue_Adapter_AdapterAbstract::isSupported()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

receive(integer $maxMessages = null, integer $timeout = null, \Zend_Queue $queue = null) : \Zend_Queue_Message_Iterator

Get messages in the queue

Parameters

Name	Type	Description
$maxMessages	integer	Maximum number of messages to return
$timeout	integer	Visibility timeout for these messages
$queue	\Zend_Queue

Returns

Type	Description
\Zend_Queue_Message_Iterator

Throws

Exception	Description
\Zend_Queue_Exception	- database error

send(string $message, \Zend_Queue $queue = null) : \Zend_Queue_Message

Send a message to the queue

Parameters

Name	Type	Description
$message	string	Message to send to the active queue
$queue	\Zend_Queue

Returns

Type	Description
\Zend_Queue_Message

Throws

Exception	Description
\Zend_Queue_Exception	- database error

setQueue(\Zend_Queue $queue) : \Zend_Queue_Adapter_AdapterInterface

inherited

set the Zend_Queue class for this object

Inherited from: \Zend_Queue_Adapter_AdapterAbstract::setQueue()

Parameters

Name	Type	Description
$queue	\Zend_Queue

Returns

Type	Description
\Zend_Queue_Adapter_AdapterInterface

Queue/Adapter/Db.php

\Zend_Queue_Adapter_Dbjump to top

Constants

Properties

Methods

\Zend_Queue_Adapter_Db
jump to top