Source for file ComponentContainer.php

Documentation is available at ComponentContainer.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/Component.php';
24:
25: require_once dirname(__FILE__) . '/IComponentContainer.php';
26:
27:
28:
29: /**
30: * ComponentContainer is default implementation of IComponentContainer.
31: *
32: * @author David Grudl
33: * @copyright Copyright (c) 2004, 2009 David Grudl
34: * @package Nette
35: */
36: class ComponentContainer extends Component implements IComponentContainer
37: {
38: /** @var array of IComponent */
39: private $components = array();
40:
41: /** @var IComponent|NULL*/
42: private $cloning;
43:
44:
45:
46: /********************* interface IComponentContainer ****************d*g**/
47:
48:
49:
50: /**
51: * Adds the specified component to the IComponentContainer.
52: * @param IComponent
53: * @param string
54: * @param string
55: * @return void
56: * @throws InvalidStateException
57: */
58: public function addComponent(IComponent $component, $name, $insertBefore = NULL)
59: {
60: if ($name === NULL) {
61: $name = $component->getName();
62: }
63:
64: if (is_int($name)) {
65: $name = (string) $name;
66:
67: } elseif (!is_string($name)) {
68: throw new InvalidArgumentException("Component name must be string, " . gettype($name) . " given.");
69:
70: } elseif (!preg_match('#^[a-zA-Z0-9_]+$#', $name)) {
71: throw new InvalidArgumentException("Component name must be non-empty alphanumeric string, '$name' given.");
72: }
73:
74: if (isset($this->components[$name])) {
75: throw new InvalidStateException("Component with name '$name' already exists.");
76: }
77:
78: // check circular reference
79: $obj = $this;
80: do {
81: if ($obj === $component) {
82: throw new InvalidStateException("Circular reference detected.");
83: }
84: $obj = $obj->getParent();
85: } while ($obj !== NULL);
86:
87: // user checking
88: $this->validateChildComponent($component);
89:
90: try {
91: if (isset($this->components[$insertBefore])) {
92: $tmp = array();
93: foreach ($this->components as $k => $v) {
94: if ($k === $insertBefore) $tmp[$name] = $component;
95: $tmp[$k] = $v;
96: }
97: $this->components = $tmp;
98: } else {
99: $this->components[$name] = $component;
100: }
101: $component->setParent($this, $name);
102:
103: } catch (Exception $e) {
104: unset($this->components[$name]); // undo
105: throw $e;
106: }
107: }
108:
109:
110:
111: /**
112: * Removes a component from the IComponentContainer.
113: * @param IComponent
114: * @return void
115: */
116: public function removeComponent(IComponent $component)
117: {
118: $name = $component->getName();
119: if (!isset($this->components[$name]) || $this->components[$name] !== $component) {
120: throw new InvalidArgumentException("Component named '$name' is not located in this container.");
121: }
122:
123: unset($this->components[$name]);
124: $component->setParent(NULL);
125: }
126:
127:
128:
129: /**
130: * Returns component specified by name or path.
131: * @param string
132: * @param bool throw exception if component doesn't exist?
133: * @return IComponent|NULL
134: */
135: final public function getComponent($name, $need = TRUE)
136: {
137: $a = strpos($name, self::NAME_SEPARATOR);
138: if ($a !== FALSE) {
139: $ext = substr($name, $a + 1);
140: $name = substr($name, 0, $a);
141: }
142:
143: if (!isset($this->components[$name])) {
144: $this->createComponent($name);
145: }
146:
147: if (isset($this->components[$name])) {
148: return $a === FALSE ? $this->components[$name] : $this->components[$name]->getComponent($ext);
149:
150: } elseif ($need) {
151: throw new InvalidArgumentException("Component with name '$name' does not exist.");
152:
153: } else {
154: return NULL;
155: }
156: }
157:
158:
159:
160: /**
161: * Component factory. Descendant can override this method to enable lazy component loading.
162: * @param string component name
163: * @return void
164: */
165: protected function createComponent($name)
166: {
167: }
168:
169:
170:
171: /**
172: * Iterates over a components.
173: * @param bool recursive?
174: * @param string class types filter
175: * @return ArrayIterator
176: */
177: final public function getComponents($deep = FALSE, $filterType = NULL)
178: {
179: $iterator = new RecursiveComponentIterator($this->components);
180: if ($deep) {
181: $deep = $deep > 0 ? RecursiveIteratorIterator::SELF_FIRST : RecursiveIteratorIterator::CHILD_FIRST;
182: $iterator = new RecursiveIteratorIterator($iterator, $deep);
183: }
184: if ($filterType) {
185: fixNamespace($filterType);
186: $iterator = new InstanceFilterIterator($iterator, $filterType);
187: }
188: return $iterator;
189: }
190:
191:
192:
193: /**
194: * Descendant can override this method to disallow insert a child by throwing an \InvalidStateException.
195: * @param IComponent
196: * @return void
197: * @throws InvalidStateException
198: */
199: protected function validateChildComponent(IComponent $child)
200: {
201: }
202:
203:
204:
205: /********************* cloneable, serializable ****************d*g**/
206:
207:
208:
209: /**
210: * Object cloning.
211: */
212: public function __clone()
213: {
214: if ($this->components) {
215: $oldMyself = reset($this->components)->getParent();
216: $oldMyself->cloning = $this;
217: foreach ($this->components as $name => $component) {
218: $this->components[$name] = clone $component;
219: }
220: $oldMyself->cloning = NULL;
221: }
222: parent::__clone();
223: }
224:
225:
226:
227: /**
228: * Is container cloning now?
229: * @return NULL|IComponent
230: * @ignore internal
231: */
232: public function isCloning()
233: {
234: return $this->cloning;
235: }
236:
237: }
238:
239:
240:
241: /**
242: * Recursive component iterator. See ComponentContainer::getComponents().
243: *
244: * @author David Grudl
245: * @copyright Copyright (c) 2004, 2009 David Grudl
246: * @package Nette
247: */
248: class RecursiveComponentIterator extends RecursiveArrayIterator
249: {
250:
251: /**
252: * Has the current element has children?
253: * @return bool
254: */
255: public function hasChildren()
256: {
257: return $this->current() instanceof IComponentContainer;
258: }
259:
260:
261:
262: /**
263: * The sub-iterator for the current element.
264: * @return RecursiveIterator
265: */
266: public function getChildren()
267: {
268: return $this->current()->getComponents();
269: }
270:
271: }

Source for file ComponentContainer.php

Namespaces