API Documentation

Zend/Queue/Adapter/AdapterAbstract.php

Show: inherited
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 license@zend.com 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: AdapterAbstract.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Queue_Adapter_AdapterAbstract

Package: Zend\Queue\Adapter

Class for connecting to queues performing common operations.

Implements
\Zend_Queue_Adapter_AdapterInterface
Children
\Zend_Queue_Adapter_Array
\Zend_Queue_Adapter_Null
\Zend_Queue_Adapter_Activemq
\Zend_Queue_Adapter_PlatformJobQueue
\Zend_Queue_Adapter_Db
\Zend_Queue_Adapter_Memcacheq
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  CREATE_TIMEOUT_DEFAULT = 30

Default timeout for createQueue() function

Constant  RECEIVE_TIMEOUT_DEFAULT = 30

Default timeout for recieve() function

Properties

Propertyprotectedarray  $_options= 'array()'

User-provided options

Default valuearray()Details
Type
array
Propertyprotected\Zend_Queue_Adapter_Abstract  $_queue= 'null'

Contains the Zend_Queue that this object

Default valuenullDetails
Type
\Zend_Queue_Adapter_Abstract
Propertyprotectedarray  $_queues= 'array()'

Internal array of queues to save on lookups

Default valuearray()Details
Type
array

Methods

methodpublic__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

Parameters
Name Type Description
$options
$queue \Zend_Queue

The Zend_Queue object that created this class

Throws
Exception Description
\Zend_Queue_Exception
methodpublicgetOptions( ) : array

Returns the configuration options in this adapter.

Returns
Type Description
array
methodpublicgetQueue( ) : \Zend_Queue|null

get the Zend_Queue class that is attached to this object

Returns
Type Description
\Zend_Queue|null
methodpublicisSupported( string $name ) : boolean

Indicates if a function is supported or not.

Parameters
Name Type Description
$name string
Returns
Type Description
boolean
methodpublicsetQueue( \Zend_Queue $queue ) : \Zend_Queue_Adapter_AdapterInterface

set the Zend_Queue class for this object

Parameters
Name Type Description
$queue \Zend_Queue
Returns
Type Description
\Zend_Queue_Adapter_AdapterInterface
Documentation was generated by DocBlox 0.15.1.