Source for file IComponentContainer.php

Documentation is available at IComponentContainer.php

1. 1: <?php
2. 2:  
3. 3: /**
4. 4:  * Nette Framework
5. 5:  *
6. 6:  * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7. 7:  *
8. 8:  * This source file is subject to the "Nette license" that is bundled
9. 9:  * with this package in the file license.txt.
10. 10:  *
11. 11:  * For more information please see https://nette.org
12. 12:  *
13. 13:  * @copyright  Copyright (c) 2004, 2009 David Grudl
14. 14:  * @license    https://nette.org/license  Nette license
15. 15:  * @link       https://nette.org
16. 16:  * @category   Nette
17. 17:  * @package    Nette
18. 18:  * @version    $Id$
19. 19:  */
20. 20:  
21. 21:  
22. 22:  
23. 23: require_once dirname(__FILE__) . '/IComponent.php';
24. 24:  
25. 25:  
26. 26:  
27. 27: /**
28. 28:  * Containers are objects that logically contain zero or more IComponent components.
29. 29:  *
30. 30:  * @author     David Grudl
31. 31:  * @copyright  Copyright (c) 2004, 2009 David Grudl
32. 32:  * @package    Nette
33. 33:  */
34. 34: interface IComponentContainer extends IComponent
35. 35: {
36. 36:  
37. 37:     /**
38. 38:      * Adds the specified component to the IComponentContainer.
39. 39:      * @param  IComponent 
40. 40:      * @param  string 
41. 41:      * @return void 
42. 42:      */
43. 43:     function addComponent(IComponent $component, $name);
44. 44:  
45. 45:     /**
46. 46:      * Removes a component from the IComponentContainer.
47. 47:      * @param  IComponent 
48. 48:      * @return void 
49. 49:      */
50. 50:     function removeComponent(IComponent $component);
51. 51:  
52. 52:     /**
53. 53:      * Returns single component.
54. 54:      * @param  string 
55. 55:      * @return IComponent|NULL
56. 56:      */
57. 57:     function getComponent($name);
58. 58:  
59. 59:     /**
60. 60:      * Iterates over a components.
61. 61:      * @param  bool    recursive?
62. 62:      * @param  string  class types filter
63. 63:      * @return ArrayIterator 
64. 64:      */
65. 65:     function getComponents($deep = FALSE, $filterType = NULL);
66. 66:  
67. 67: }