blob: fb8d24aab0227a9c055ce56697b0e11236026a3e (
plain)
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
<?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_Server
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id$
*/
/**
* Server methods metadata
*
* @todo Implement iterator
* @category Zend
* @package Zend_Server
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Server_Definition implements Countable, Iterator
{
/**
* @var array Array of Zend_Server_Method_Definition objects
*/
protected $_methods = array();
/**
* @var bool Whether or not overwriting existing methods is allowed
*/
protected $_overwriteExistingMethods = false;
/**
* Constructor
*
* @param null|array $methods
* @return void
*/
public function __construct($methods = null)
{
if (is_array($methods)) {
$this->setMethods($methods);
}
}
/**
* Set flag indicating whether or not overwriting existing methods is allowed
*
* @param mixed $flag
* @return void
*/
public function setOverwriteExistingMethods($flag)
{
$this->_overwriteExistingMethods = (bool) $flag;
return $this;
}
/**
* Add method to definition
*
* @param array|Zend_Server_Method_Definition $method
* @param null|string $name
* @return Zend_Server_Definition
* @throws Zend_Server_Exception if duplicate or invalid method provided
*/
public function addMethod($method, $name = null)
{
if (is_array($method)) {
$method = new Zend_Server_Method_Definition($method);
} elseif (!$method instanceof Zend_Server_Method_Definition) {
throw new Zend_Server_Exception('Invalid method provided');
}
if (is_numeric($name)) {
$name = null;
}
if (null !== $name) {
$method->setName($name);
} else {
$name = $method->getName();
}
if (null === $name) {
throw new Zend_Server_Exception('No method name provided');
}
if (!$this->_overwriteExistingMethods && array_key_exists($name, $this->_methods)) {
throw new Zend_Server_Exception(sprintf('Method by name of "%s" already exists', $name));
}
$this->_methods[$name] = $method;
return $this;
}
/**
* Add multiple methods
*
* @param array $methods Array of Zend_Server_Method_Definition objects or arrays
* @return Zend_Server_Definition
*/
public function addMethods(array $methods)
{
foreach ($methods as $key => $method) {
$this->addMethod($method, $key);
}
return $this;
}
/**
* Set all methods at once (overwrite)
*
* @param array $methods Array of Zend_Server_Method_Definition objects or arrays
* @return Zend_Server_Definition
*/
public function setMethods(array $methods)
{
$this->clearMethods();
$this->addMethods($methods);
return $this;
}
/**
* Does the definition have the given method?
*
* @param string $method
* @return bool
*/
public function hasMethod($method)
{
return array_key_exists($method, $this->_methods);
}
/**
* Get a given method definition
*
* @param string $method
* @return null|Zend_Server_Method_Definition
*/
public function getMethod($method)
{
if ($this->hasMethod($method)) {
return $this->_methods[$method];
}
return false;
}
/**
* Get all method definitions
*
* @return array Array of Zend_Server_Method_Definition objects
*/
public function getMethods()
{
return $this->_methods;
}
/**
* Remove a method definition
*
* @param string $method
* @return Zend_Server_Definition
*/
public function removeMethod($method)
{
if ($this->hasMethod($method)) {
unset($this->_methods[$method]);
}
return $this;
}
/**
* Clear all method definitions
*
* @return Zend_Server_Definition
*/
public function clearMethods()
{
$this->_methods = array();
return $this;
}
/**
* Cast definition to an array
*
* @return array
*/
public function toArray()
{
$methods = array();
foreach ($this->getMethods() as $key => $method) {
$methods[$key] = $method->toArray();
}
return $methods;
}
/**
* Countable: count of methods
*
* @return int
*/
public function count()
{
return count($this->_methods);
}
/**
* Iterator: current item
*
* @return mixed
*/
public function current()
{
return current($this->_methods);
}
/**
* Iterator: current item key
*
* @return int|string
*/
public function key()
{
return key($this->_methods);
}
/**
* Iterator: advance to next method
*
* @return void
*/
public function next()
{
return next($this->_methods);
}
/**
* Iterator: return to first method
*
* @return void
*/
public function rewind()
{
return reset($this->_methods);
}
/**
* Iterator: is the current index valid?
*
* @return bool
*/
public function valid()
{
return (bool) $this->current();
}
}
|
