Source for file FormContainer.php

Documentation is available at FormContainer.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\Forms
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../ComponentContainer.php';
24:
25: require_once dirname(__FILE__) . '/../Forms/INamingContainer.php';
26:
27:
28:
29: /**
30: * Container for form controls.
31: *
32: * @author David Grudl
33: * @copyright Copyright (c) 2004, 2009 David Grudl
34: * @package Nette\Forms
35: */
36: class FormContainer extends ComponentContainer implements ArrayAccess, INamingContainer
37: {
38: /** @var FormGroup */
39: protected $currentGroup;
40:
41:
42: /**
43: * @param FormGroup
44: * @return void
45: */
46: public function setCurrentGroup(FormGroup $group = NULL)
47: {
48: $this->currentGroup = $group;
49: }
50:
51:
52:
53: /**
54: * Adds the specified component to the IComponentContainer.
55: * @param IComponent
56: * @param string
57: * @param string
58: * @return void
59: * @throws InvalidStateException
60: */
61: public function addComponent(IComponent $component, $name, $insertBefore = NULL)
62: {
63: parent::addComponent($component, $name, $insertBefore);
64: if ($this->currentGroup !== NULL && $component instanceof IFormControl) {
65: $this->currentGroup->add($component);
66: }
67: }
68:
69:
70:
71: /**
72: * Iterates over all form controls.
73: * @return ArrayIterator
74: */
75: public function getControls()
76: {
77: return $this->getComponents(TRUE, 'Nette\Forms\IFormControl');
78: }
79:
80:
81:
82: /**
83: * Returns form.
84: * @param bool throw exception if form doesn't exist?
85: * @return Form
86: */
87: public function getForm($need = TRUE)
88: {
89: return $this->lookup('Nette\Forms\Form', $need);
90: }
91:
92:
93:
94: /********************* control factories ****************d*g**/
95:
96:
97:
98: /**
99: * Adds single-line text input control to the form.
100: * @param string control name
101: * @param string label
102: * @param int width of the control
103: * @param int maximum number of characters the user may enter
104: * @return TextInput
105: */
106: public function addText($name, $label, $cols = NULL, $maxLength = NULL)
107: {
108: return $this[$name] = new TextInput($label, $cols, $maxLength);
109: }
110:
111:
112:
113: /**
114: * Adds single-line text input control used for sensitive input such as passwords.
115: * @param string control name
116: * @param string label
117: * @param int width of the control
118: * @param int maximum number of characters the user may enter
119: * @return TextInput
120: */
121: public function addPassword($name, $label, $cols = NULL, $maxLength = NULL)
122: {
123: $control = new TextInput($label, $cols, $maxLength);
124: $control->setPasswordMode(TRUE);
125: $this->addComponent($control, $name);
126: return $control;
127: }
128:
129:
130:
131: /**
132: * Adds multi-line text input control to the form.
133: * @param string control name
134: * @param string label
135: * @param int width of the control
136: * @param int height of the control in text lines
137: * @return TextArea
138: */
139: public function addTextArea($name, $label, $cols = 40, $rows = 10)
140: {
141: return $this[$name] = new TextArea($label, $cols, $rows);
142: }
143:
144:
145:
146: /**
147: * Adds control that allows the user to upload files.
148: * @param string control name
149: * @param string label
150: * @return FileUpload
151: */
152: public function addFile($name, $label)
153: {
154: return $this[$name] = new FileUpload($label);
155: }
156:
157:
158:
159: /**
160: * Adds hidden form control used to store a non-displayed value.
161: * @param string control name
162: * @return HiddenField
163: */
164: public function addHidden($name)
165: {
166: return $this[$name] = new HiddenField;
167: }
168:
169:
170:
171: /**
172: * Adds check box control to the form.
173: * @param string control name
174: * @param string caption
175: * @return Checkbox
176: */
177: public function addCheckbox($name, $caption)
178: {
179: return $this[$name] = new Checkbox($caption);
180: }
181:
182:
183:
184: /**
185: * Adds set of radio button controls to the form.
186: * @param string control name
187: * @param string label
188: * @param array options from which to choose
189: * @return RadioList
190: */
191: public function addRadioList($name, $label, array $items = NULL)
192: {
193: return $this[$name] = new RadioList($label, $items);
194: }
195:
196:
197:
198: /**
199: * Adds select box control that allows single item selection.
200: * @param string control name
201: * @param string label
202: * @param array items from which to choose
203: * @param int number of rows that should be visible
204: * @return SelectBox
205: */
206: public function addSelect($name, $label, array $items = NULL, $size = NULL)
207: {
208: return $this[$name] = new SelectBox($label, $items, $size);
209:
210:
211:
212:
213: /**
214: * Adds select box control that allows multiple item selection.
215: * @param string control name
216: * @param string label
217: * @param array options from which to choose
218: * @param int number of rows that should be visible
219: * @return MultiSelectBox
220: */
221: public function addMultiSelect($name, $label, array $items = NULL, $size = NULL)
222: {
223: return $this[$name] = new MultiSelectBox($label, $items, $size);
224:
225:
226:
227:
228: /**
229: * Adds button used to submit form.
230: * @param string control name
231: * @param string caption
232: * @return SubmitButton
233: */
234: public function addSubmit($name, $caption)
235: {
236: return $this[$name] = new SubmitButton($caption);
237: }
238:
239:
240:
241: /**
242: * Adds push buttons with no default behavior.
243: * @param string control name
244: * @param string caption
245: * @return Button
246: */
247: public function addButton($name, $caption)
248: {
249: return $this[$name] = new Button($caption);
250: }
251:
252:
253:
254: /**
255: * Adds graphical button used to submit form.
256: * @param string control name
257: * @param string URI of the image
258: * @param string alternate text for the image
259: * @return ImageButton
260: */
261: public function addImage($name, $src = NULL, $alt = NULL)
262: {
263: return $this[$name] = new ImageButton($src, $alt);
264: }
265:
266:
267:
268: /**
269: * Adds naming container to the form.
270: * @param string name
271: * @return FormContainer
272: */
273: public function addContainer($name)
274: {
275: $control = new FormContainer;
276: $control->currentGroup = $this->currentGroup;
277: return $this[$name] = $control;
278: }
279:
280:
281:
282: /**
283: * Adds control that repeats a specified prototype for each item in the list.
284: * @param string control name
285: * @return RepeaterControl
286: */
287: public function addRepeater($name)
288: {
289: return $this[$name] = new RepeaterControl;
290: }
291:
292:
293:
294: /********************* interface \ArrayAccess ****************d*g**/
295:
296:
297:
298: /**
299: * Adds the component to the container.
300: * @param string component name
301: * @param IComponent
302: * @return void.
303: */
304: final public function offsetSet($name, $component)
305: {
306: $this->addComponent($component, $name);
307: }
308:
309:
310:
311: /**
312: * Returns component specified by name. Throws exception if component doesn't exist.
313: * @param string component name
314: * @return IComponent
315: * @throws InvalidArgumentException
316: */
317: final public function offsetGet($name)
318: {
319: return $this->getComponent($name, TRUE);
320: }
321:
322:
323:
324: /**
325: * Does component specified by name exists?
326: * @param string component name
327: * @return bool
328: */
329: final public function offsetExists($name)
330: {
331: return $this->getComponent($name, FALSE) !== NULL;
332: }
333:
334:
335:
336: /**
337: * Removes component from the container. Throws exception if component doesn't exist.
338: * @param string component name
339: * @return void
340: */
341: final public function offsetUnset($name)
342: {
343: $component = $this->getComponent($name, FALSE);
344: if ($component !== NULL) {
345: $this->removeComponent($component);
346: }
347: }
348:
349: }

Source for file FormContainer.php

Namespaces