-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathStack.php
More file actions
181 lines (165 loc) · 4.58 KB
/
Copy pathStack.php
File metadata and controls
181 lines (165 loc) · 4.58 KB
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
<?php
/**
* This file is part of Transmorph.
*
* Transmorph is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Transmorph is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Transmorph. If not, see <http://www.gnu.org/licenses/>.
*
* @author Fabrice Marsaud <[email protected]>
*
* @package Plugin
*/
/**
* A plugin stack used by several components of the core package.
*
* @package Plugin
*/
class Transmorph_Plugin_Stack implements Transmorph_Plugin_StackInterface
, Iterator
{
/**
*
* @var Transmorph_Plugin_Interface[]
*/
protected $_plugins;
/**
* Initializations.
*/
public function __construct()
{
$this->_plugins = array();
}
/**
* Appending a plugin to the stack.
*
* @param Transmorph_Plugin_Interface $newPlugin A plugin.
*
* @return void
*
* @see Transmorph_Plugin_StackInterface::appendPlugin()
*/
public function appendPlugin(Transmorph_Plugin_Interface $newPlugin)
{
$this->_checkPluginDupplication($newPlugin);
array_push($this->_plugins, $newPlugin);
}
/**
* Prepending a plugin to the stack.
*
* @param Transmorph_Plugin_Interface $newPlugin A plugin.
*
* @return void
*
* @see Transmorph_Plugin_StackInterface::prependPlugin()
*/
public function prependPlugin(Transmorph_Plugin_Interface $newPlugin)
{
$this->_checkPluginDupplication($newPlugin);
array_unshift($this->_plugins, $newPlugin);
}
/**
* Checks if a plugin is already registered before adding.
*
* @param Transmorph_Plugin_Interface $newPlugin The plugin to check.
*
* @return void
*
* @throws Transmorph_Exception If a plugin of the same class is already in
* the stack.
*/
private function _checkPluginDupplication(Transmorph_Plugin_Interface $newPlugin)
{
foreach ($this->_plugins as $p)
{
if (get_class($p) == get_class($newPlugin))
{
throw new Transmorph_Exception('Plugin ' . get_class($newPlugin) . ' already registered');
}
}
}
/**
* Removing a plugin from the stack.
*
* @param type $pluginClassName A plgin class name.
*
* @return void
*
* @see Transmorph_Plugin_StackInterface::removePlugin()
*/
public function removePlugin($pluginClassName)
{
$removeKey = null;
foreach ($this->_plugins as $key => $value)
{
if (get_class($value) === $pluginClassName)
{
$removeKey = $key;
break;
}
}
if ($removeKey === null)
{
throw new Transmorph_Exception('Plugin ' . $pluginClassName . ' not found for removal.');
}
unset($this->_plugins[$removeKey]);
}
/**
* See {@link http://www.php.net/manual/en/class.iterator.php PHP Manual : Iterator}
*
* @return Transmorph_Plugin_Interface Current element from the stack.
*/
public function current()
{
return current($this->_plugins);
}
/**
* See {@link http://www.php.net/manual/en/class.iterator.php PHP Manual : Iterator}
*
* @return integer Key of the current stack element.
*/
public function key()
{
return key($this->_plugins);
}
/**
* See {@link http://www.php.net/manual/en/class.iterator.php PHP Manual : Iterator}
*
* @return Transmorph_Plugin_Interface The next element from the stack.
*/
public function next()
{
return next($this->_plugins);
}
/**
* See {@link http://www.php.net/manual/en/class.iterator.php PHP Manual : Iterator}
*
* @return void
*/
public function rewind()
{
reset($this->_plugins);
}
/**
* See {@link http://www.php.net/manual/en/class.iterator.php PHP Manual : Iterator}
*
* @return boolean
*/
public function valid()
{
/**
* This is OK as encapsulation prevents the array of containing
* boolean values.
*/
return current($this->_plugins) !== false;
}
}