Queue/Adapter/Db.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Queue
subpackage: Adapter
version: $Id: Db.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Queue_Adapter_Db

Description

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 license@zend.com so we can send you a copy immediately.

Zend_Queue_Adapter_Db
jump to top

Extends from: Zend_Queue_Adapter_AdapterAbstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Queue
subpackage: Adapter
Properties: $_queueTable; $_messageTable; $_messageRow
Methods: __construct; _initDbAdapter; isExists; create; delete; getQueues; count; send; receive; deleteMessage; getCapabilities; getQueueId

Description

Class for using connecting to a Zend_Db-based queuing system

Properties

$_messageRow
jump to class

Zend_Db_Table_Row_Abstract $_messageRow = 'null'

Details

$_messageRow: Zend_Db_Table_Row_Abstract
visibility: protected
default: null
final: false
static: false

$_messageTable
jump to class

Zend_Queue_Adapter_Db_Message $_messageTable = 'null'

Details

$_messageTable: Zend_Queue_Adapter_Db_Message
visibility: protected
default: null
final: false
static: false

$_queueTable
jump to class

Zend_Queue_Adapter_Db_Queue $_queueTable = 'null'

Details

$_queueTable: Zend_Queue_Adapter_Db_Queue
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

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

Constructor

Arguments

$options: arrayZend_Config
$queue: Zend_Queuenull

Details

visibility: public
final: false
static: false

_initDbAdapter
jump to class

_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.

Output

Zend_Db_Adapter_Abstract

Details

visibility: protected
final: false
static: false
throws

count
jump to class

count(
          Zend_Queue $queue
              =
              null
          )
        
        :
        integer

Return the approximate number of messages in the queue

Arguments

$queue: Zend_Queue

Output

integer

Details

visibility: public
final: false
static: false
throws

create
jump to class

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.

Arguments

$name: string
queue name
$timeout: integer
default visibility timeout

Output

boolean

Details

visibility: public
final: false
static: false
throws: - database error

delete
jump to class

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

Arguments

$name: string
queue name

Output

boolean

Details

visibility: public
final: false
static: false
throws: - database error

deleteMessage
jump to class

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.

Arguments

$message: Zend_Queue_Message

Output

boolean

Details

visibility: public
final: false
static: false
throws: - database error

getCapabilities
jump to class

getCapabilities(
          
          )
        
        :
        array

Return a list of queue capabilities functions

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

Output

array

Details

visibility: public
final: false
static: false

getQueueId
jump to class

getQueueId(
          string $name
          )
        
        :
        integer|null

Get the queue ID

Returns the queue's row identifier.

Arguments

$name: string

Output

integer|null

Details

visibility: protected
final: false
static: false
throws

getQueues
jump to class

getQueues(
          
          )
        
        :

Details

visibility: public
final: false
static: false

isExists
jump to class

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.

Arguments

$name: string

Output

boolean

Details

visibility: public
final: false
static: false
throws

receive
jump to class

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

Get messages in the queue

Arguments

$maxMessages: integer
Maximum number of messages to return
$timeout: integer
Visibility timeout for these messages
$queue: Zend_Queue

Output

Zend_Queue_Message_Iterator

Details

visibility: public
final: false
static: false
throws: - database error

send
jump to class

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

Send a message to the queue

Arguments

$message: string
Message to send to the active queue
$queue: Zend_Queue

Output

Zend_Queue_Message

Details

visibility: public
final: false
static: false
throws: - database error

API Documentation

Queue/Adapter/Db.php

Description

Zend_Queue_Adapter_Dbjump to top

Description

Properties

$_messageRowjump to class

Details

$_messageTablejump to class

Details

$_queueTablejump to class

Details

Methods

__constructjump to class

Arguments

Details

_initDbAdapterjump to class

Output

Details

countjump to class

Arguments

Output

Details

createjump to class

Arguments

Output

Details

deletejump to class

Arguments

Output

Details

deleteMessagejump to class

Arguments

Output

Details

getCapabilitiesjump to class

Output

Details

getQueueIdjump to class

Arguments

Output

Details

getQueuesjump to class

Details

isExistsjump to class

Arguments

Output

Details

receivejump to class

Arguments

Output

Details

sendjump to class

Arguments

Output

Details

Zend_Queue_Adapter_Db
jump to top

$_messageRow
jump to class

$_messageTable
jump to class

$_queueTable
jump to class

__construct
jump to class

_initDbAdapter
jump to class

count
jump to class

create
jump to class

delete
jump to class

deleteMessage
jump to class

getCapabilities
jump to class

getQueueId
jump to class

getQueues
jump to class

isExists
jump to class

receive
jump to class

send
jump to class