1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
<?php
/**
* 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
* @package Zend_Queue
* @subpackage Adapter
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: AdapterAbstract.php 20096 2010-01-06 02:05:09Z bkarwin $
*/
/**
* @see Zend_Queue
*/
require_once 'Zend/Queue.php';
/**
* @see Zend_Queue_Adapter_AdapterInterface
*/
require_once 'Zend/Queue/Adapter/AdapterInterface.php';
/**
* Class for connecting to queues performing common operations.
*
* @category Zend
* @package Zend_Queue
* @subpackage Adapter
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
abstract class Zend_Queue_Adapter_AdapterAbstract
implements Zend_Queue_Adapter_AdapterInterface
{
/**
* Default timeout for createQueue() function
*/
const CREATE_TIMEOUT_DEFAULT = 30;
/**
* Default timeout for recieve() function
*/
const RECEIVE_TIMEOUT_DEFAULT = 30;
/**
* User-provided options
*
* @var array
*/
protected $_options = array();
/**
* Internal array of queues to save on lookups
*
* @var array
*/
protected $_queues = array();
/**
* Contains the Zend_Queue that this object
*
* @var Zend_Queue_Adapter_Abstract
*/
protected $_queue = null;
/**
* 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
*
* @param array|Zend_Config $config An array having configuration data
* @param Zend_Queue The Zend_Queue object that created this class
* @return void
* @throws Zend_Queue_Exception
*/
public function __construct($options, Zend_Queue $queue = null)
{
if ($options instanceof Zend_Config) {
$options = $options->toArray();
}
/*
* Verify that adapter parameters are in an array.
*/
if (!is_array($options)) {
require_once 'Zend/Queue/Exception.php';
throw new Zend_Queue_Exception('Adapter options must be an array or Zend_Config object');
}
// set the queue
if ($queue !== null) {
$this->setQueue($queue);
}
$adapterOptions = array();
$driverOptions = array();
// Normalize the options and merge with the defaults
if (array_key_exists('options', $options)) {
if (!is_array($options['options'])) {
require_once 'Zend/Queue/Exception.php';
throw new Zend_Queue_Exception("Configuration array 'options' must be an array");
}
// Can't use array_merge() because keys might be integers
foreach ($options['options'] as $key => $value) {
$adapterOptions[$key] = $value;
}
}
if (array_key_exists('driverOptions', $options)) {
// can't use array_merge() because keys might be integers
foreach ((array)$options['driverOptions'] as $key => $value) {
$driverOptions[$key] = $value;
}
}
$this->_options = array_merge($this->_options, $options);
$this->_options['options'] = $adapterOptions;
$this->_options['driverOptions'] = $driverOptions;
}
/********************************************************************
* Queue management functions
*********************************************************************/
/**
* get the Zend_Queue class that is attached to this object
*
* @return Zend_Queue|null
*/
public function getQueue()
{
return $this->_queue;
}
/**
* set the Zend_Queue class for this object
*
* @param Zend_Queue $queue
* @return Zend_Queue_Adapter_AdapterInterface
*/
public function setQueue(Zend_Queue $queue)
{
$this->_queue = $queue;
return $this;
}
/**
* Returns the configuration options in this adapter.
*
* @return array
*/
public function getOptions()
{
return $this->_options;
}
/**
* Indicates if a function is supported or not.
*
* @param string $name
* @return boolean
*/
public function isSupported($name)
{
$list = $this->getCapabilities();
return (isset($list[$name]) && $list[$name]);
}
}
|
