API Documentation

Queue/Adapter/AdapterAbstract.php

Includes Classes 
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: AdapterAbstract.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Queue_Adapter_AdapterAbstract

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_AdapterAbstract
jump to top

Implements
Zend_Queue_Adapter_AdapterInterface
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
Constants
CREATE_TIMEOUT_DEFAULT
RECEIVE_TIMEOUT_DEFAULT
Properties
$_options
$_queues
$_queue
Methods
__construct
getQueue
setQueue
getOptions
isSupported

Description

Class for connecting to queues performing common operations.

Constants

CREATE_TIMEOUT_DEFAULT
jump to class

 CREATE_TIMEOUT_DEFAULT = '30'

Default timeout for createQueue() function

Details

value
30

RECEIVE_TIMEOUT_DEFAULT
jump to class

 RECEIVE_TIMEOUT_DEFAULT = '30'

Default timeout for recieve() function

Details

value
30

Properties

$_options
jump to class

array $_options = 'array'

User-provided options

Details

$_options
array
visibility
protected
default
array
final
false
static
false

$_queue
jump to class

Zend_Queue_Adapter_Abstract $_queue = 'null'

Contains the Zend_Queue that this object

Details

$_queue
Zend_Queue_Adapter_Abstract
visibility
protected
default
null
final
false
static
false

$_queues
jump to class

array $_queues = 'array'

Internal array of queues to save on lookups

Details

$_queues
array
visibility
protected
default
array
final
false
static
false

Methods

__construct
jump to class

__construct(  $options, Zend_Queue $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

Arguments
$options
$queue
Zend_Queue
The Zend_Queue object that created this class
Details
visibility
public
final
false
static
false
throws

getOptions
jump to class

getOptions( ) : array

Returns the configuration options in this adapter.

Output
array
Details
visibility
public
final
false
static
false

getQueue
jump to class

getQueue( ) : Zend_Queue|null

get the Zend_Queue class that is attached to this object

Output
Zend_Queue|null
Details
visibility
public
final
false
static
false

isSupported
jump to class

isSupported( string $name ) : boolean

Indicates if a function is supported or not.

Arguments
$name
string
Output
boolean
Details
visibility
public
final
false
static
false

setQueue
jump to class

setQueue( Zend_Queue $queue ) : Zend_Queue_Adapter_AdapterInterface

set the Zend_Queue class for this object

Arguments
$queue
Zend_Queue
Output
Zend_Queue_Adapter_AdapterInterface
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.