Source for file ConventionalRenderer.php

Documentation is available at ConventionalRenderer.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__) . '/../../Object.php';
24:
25: require_once dirname(__FILE__) . '/../../Forms/IFormRenderer.php';
26:
27:
28:
29: /**
30: * Converts a Form into the HTML output.
31: *
32: * @author David Grudl
33: * @copyright Copyright (c) 2004, 2009 David Grudl
34: * @package Nette\Forms
35: */
36: class ConventionalRenderer extends Object implements IFormRenderer
37: {
38: /**
39: * /--- form.container
40: *
41: * /--- if (form.errors) error.container
42: * .... error.item [.class]
43: * \---
44: *
45: * /--- hidden.container
46: * .... HIDDEN CONTROLS
47: * \---
48: *
49: * /--- group.container
50: * .... group.label
51: * .... group.description
52: *
53: * /--- controls.container
54: *
55: * /--- pair.container [.required .optional .odd]
56: *
57: * /--- label.container
58: * .... LABEL
59: * .... label.suffix
60: * \---
61: *
62: * /--- control.container [.odd]
63: * .... CONTROL [.required .text .password .file .submit .button]
64: * .... control.description
65: * .... if (control.errors) error.container
66: * \---
67: * \---
68: * \---
69: * \---
70: * \--
71: *
72: * @var array of HTML tags */
73: public $wrappers = array(
74: 'form' => array(
75: 'container' => NULL,
76: 'errors' => TRUE,
77: ),
78:
79: 'error' => array(
80: 'container' => 'ul class=error',
81: 'item' => 'li',
82: ),
83:
84: 'group' => array(
85: 'container' => 'fieldset',
86: 'label' => 'legend',
87: 'description' => 'p',
88: ),
89:
90: 'controls' => array(
91: 'container' => 'table',
92: ),
93:
94: 'pair' => array(
95: 'container' => 'tr',
96: '.required' => 'required',
97: '.optional' => NULL,
98: '.odd' => NULL,
99: ),
100:
101: 'control' => array(
102: 'container' => 'td',
103: '.odd' => NULL,
104:
105: 'errors' => FALSE,
106: 'description' => 'small',
107:
108: '.required' => 'required',
109: '.text' => 'text',
110: '.password' => 'text',
111: '.file' => 'text',
112: '.submit' => 'button',
113: '.image' => 'imagebutton',
114: '.button' => 'button',
115: ),
116:
117: 'label' => array(
118: 'container' => 'th',
119: 'suffix' => NULL,
120: ),
121:
122: 'hidden' => array(
123: 'container' => 'div',
124: ),
125: );
126:
127: /** @var Form */
128: protected $form;
129:
130: /** @var object */
130:
131: protected $clientScript = TRUE; // means autodetect
132:
133: /** @var int */
134: protected $counter;
135:
136:
137:
138: /**
139: * Provides complete form rendering.
140: * @param Form
141: * @param string
142: * @return string
143: */
144: public function render(Form $form, $mode = NULL)
145: {
146: if ($this->form !== $form) {
147: $this->form = $form;
148: $this->init();
149: }
150:
151: $s = '';
152: if (!$mode || $mode === 'begin') {
153: $s .= $this->renderBegin();
154: }
155: if ((!$mode && $this->getValue('form errors')) || $mode === 'errors') {
156: $s .= $this->renderErrors();
157: }
158: if (!$mode || $mode === 'body') {
159: $s .= $this->renderBody();
160: }
161: if (!$mode || $mode === 'end') {
162: $s .= $this->renderEnd();
163: }
164: return $s;
165: }
166:
167:
168:
169: /**
170: * Sets JavaScript handler.
171: * @param object
172: * @return void
173: */
174: public function setClientScript($clientScript = NULL)
175: {
176: $this->clientScript = $clientScript;
177: }
178:
179:
180:
181: /**
182: * Returns JavaScript handler.
183: * @return mixed
184: */
185: public function getClientScript()
186: {
187: if ($this->clientScript === TRUE) {
188: $this->clientScript = new InstantClientScript($this->form);
189: }
190: return $this->clientScript;
191: }
192:
193:
194:
195: /**
196: * Initializes form.
197: * @return void
198: */
199: protected function init()
200: {
201: $clientScript = $this->getClientScript();
202: if ($clientScript !== NULL) {
203: $clientScript->enable();
204: }
205:
206: // TODO: only for back compatiblity - remove?
207: $wrapper = & $this->wrappers['control'];
208: foreach ($this->form->getControls() as $control) {
209: if ($control->getOption('required') && isset($wrapper['.required'])) {
210: $control->getLabelPrototype()->class($wrapper['.required'], TRUE);
211: }
212:
213: $el = $control->getControlPrototype();
214: if ($el->getName() === 'input' && isset($wrapper['.' . $el->type])) {
215: $el->class($wrapper['.' . $el->type], TRUE);
216: }
217: }
218: }
219:
220:
221:
222: /**
223: * Renders form begin.
224: * @return string
225: */
226: public function renderBegin()
227: {
228: $this->counter = 0;
229:
230: foreach ($this->form->getControls() as $control) {
231: $control->setOption('rendered', FALSE);
232: }
233:
234: return $this->form->getElementPrototype()->startTag();
235: }
236:
237:
238:
239: /**
240: * Renders form end.
241: * @return string
242: */
243: public function renderEnd()
244: {
245: $s = '';
246: foreach ($this->form->getControls() as $control) {
247: if ($control instanceof HiddenField && !$control->getOption('rendered')) {
248: $s .= (string) $control->getControl();
249: }
250: }
251: if ($s) {
252: $s = $this->getWrapper('hidden container')->setHtml($s) . "\n";
253: }
254:
255: $s .= $this->form->getElementPrototype()->endTag() . "\n";
256:
257: $clientScript = $this->getClientScript();
258: if ($clientScript !== NULL) {
259: $s .= $clientScript->renderClientScript() . "\n";
260: }
261:
262: return $s;
263: }
264:
265:
266:
267: /**
268: * Renders validation errors (per form or per control).
269: * @param IFormControl
270: * @return string
271: */
272: public function renderErrors(IFormControl $control = NULL)
273: {
274: $errors = $control === NULL ? $this->form->getErrors() : $control->getErrors();
275: if (count($errors)) {
276: $ul = $this->getWrapper('error container');
277: $li = $this->getWrapper('error item');
278:
279: foreach ($errors as $error) {
280: $item = clone $li;
281: if ($error instanceof Html) {
282: $item->add($error);
283: } else {
284: $item->setText($error);
285: }
286: $ul->add($item);
287: }
288: return "\n" . $ul->render(0);
289: }
290: }
291:
292:
293:
294: /**
295: * Renders form body.
296: * @return string
297: */
298: public function renderBody()
299: {
300: $s = $remains = '';
301:
302: $defaultContainer = $this->getWrapper('group container');
303: $translator = $this->form->getTranslator();
304:
305: foreach ($this->form->getGroups() as $group) {
306: if (!$group->getControls() || !$group->getOption('visual')) continue;
307:
308: $container = $group->getOption('container', $defaultContainer);
309: $container = $container instanceof Html ? clone $container : Html::el($container);
310:
311: $s .= "\n" . $container->startTag();
312:
313: $text = $group->getOption('label');
314: if ($text instanceof Html) {
315: $s .= $text;
316:
317: } elseif (is_string($text)) {
318: if ($translator !== NULL) {
319: $text = $translator->translate($text);
320: }
321: $s .= "\n" . $this->getWrapper('group label')->setText($text) . "\n";
322: }
323:
324: $text = $group->getOption('description');
325: if ($text instanceof Html) {
326: $s .= $text;
327:
328: } elseif (is_string($text)) {
329: if ($translator !== NULL) {
330: $text = $translator->translate($text);
331: }
332: $s .= $this->getWrapper('group description')->setText($text) . "\n";
333: }
334:
335: $s .= $this->renderControls($group);
336:
337: $remains = $container->endTag() . "\n" . $remains;
338: if (!$group->getOption('embedNext')) {
339: $s .= $remains;
340: $remains = '';
341: }
342: }
343:
344: $s .= $remains . $this->renderControls($this->form);
345:
346: $container = $this->getWrapper('form container');
347: $container->setHtml($s);
348: return $container->render(0);
349: }
350:
351:
352:
353: /**
354: * Renders group of controls.
355: * @param FormContainer|FormGroup
356: * @return string
357: */
358: public function renderControls($parent)
359: {
360: if (!($parent instanceof FormContainer || $parent instanceof FormGroup)) {
361: throw new InvalidArgumentException("Argument must be FormContainer or FormGroup instance.");
362: }
363:
364: $container = $this->getWrapper('controls container');
365:
366: $buttons = NULL;
367: foreach ($parent->getControls() as $control) {
368: if ($control->getOption('rendered') || $control instanceof HiddenField || $control->getForm(FALSE) !== $this->form) {
369: // skip
370:
371: } elseif ($control instanceof Button) {
372: $buttons[] = $control;
373:
374: } else {
375: if ($buttons) {
376: $container->add($this->renderPairMulti($buttons));
377: $buttons = NULL;
378: }
379: $container->add($this->renderPair($control));
380: }
381: }
382:
383: if ($buttons) {
384: $container->add($this->renderPairMulti($buttons));
385: }
386:
387: $s = '';
388: if (count($container)) {
389: $s .= "\n" . $container . "\n";
390: }
391:
392: return $s;
393: }
394:
395:
396:
397: /**
398: * Renders single visual row.
399: * @param IFormControl
400: * @return string
401: */
402: public function renderPair(IFormControl $control)
403: {
404: $pair = $this->getWrapper('pair container');
405: $pair->add($this->renderLabel($control));
406: $pair->add($this->renderControl($control));
407: $pair->class($this->getValue($control->getOption('required') ? 'pair .required' : 'pair .optional'), TRUE);
408: $pair->class($control->getOption('class'), TRUE);
409: if (++$this->counter % 2) $pair->class($this->getValue('pair .odd'), TRUE);
410: $pair->id = $control->getOption('id');
411: return $pair->render(0);
412: }
413:
414:
415:
416: /**
417: * Renders single visual row of multiple controls.
418: * @param array of IFormControl
419: * @return string
420: */
421: public function renderPairMulti(array $controls)
422: {
423: $s = array();
424: foreach ($controls as $control) {
425: if (!($control instanceof IFormControl)) {
426: throw new InvalidArgumentException("Argument must be array of IFormControl instances.");
427: }
428: $s[] = (string) $control->getControl();
429: }
430: $pair = $this->getWrapper('pair container');
431: $pair->add($this->getWrapper('label container')->setHtml(' '));
432: $pair->add($this->getWrapper('control container')->setHtml(implode(" ", $s)));
433: return $pair->render(0);
434: }
435:
436:
437:
438: /**
439: * Renders 'label' part of visual row of controls.
440: * @param IFormControl
441: * @return string
442: */
443: public function renderLabel(IFormControl $control)
444: {
445: $head = $this->getWrapper('label container');
446:
447: if ($control instanceof Checkbox || $control instanceof Button) {
448: return $head->setHtml(' ');
449:
450: } else {
451: return $head->setHtml((string) $control->getLabel() . $this->getValue('label suffix'));
452: }
453: }
454:
455:
456:
457: /**
458: * Renders 'control' part of visual row of controls.
459: * @param IFormControl
460: * @return string
461: */
462: public function renderControl(IFormControl $control)
463: {
464: $body = $this->getWrapper('control container');
465: if ($this->counter % 2) $body->class($this->getValue('control .odd'), TRUE);
466:
467: $description = $control->getOption('description');
468: if ($description instanceof Html) {
469: $description = ' ' . $control->getOption('description');
470:
471: } elseif (is_string($description)) {
472: $description = ' ' . $this->getWrapper('control description')->setText($description);
473:
474: } else {
475: $description = '';
476: }
477:
478: if ($this->getValue('control errors')) {
479: $description .= $this->renderErrors($control);
480: }
481:
482: if ($control instanceof Checkbox || $control instanceof Button) {
483: return $body->setHtml((string) $control->getControl() . (string) $control->getLabel() . $description);
484:
485: } else {
486: return $body->setHtml((string) $control->getControl() . $description);
487: }
488: }
489:
490:
491:
492: /**
493: * @param string
494: * @return Html
495: */
496: protected function getWrapper($name)
497: {
498: $data = $this->getValue($name);
499: return $data instanceof Html ? clone $data : Html::el($data);
500: }
501:
502:
503:
504: /**
505: * @param string
506: * @return string
507: */
508: protected function getValue($name)
509: {
510: $name = explode(' ', $name);
511: $data = & $this->wrappers[$name[0]][$name[1]];
512: return $data;
513: }
514:
515: }

Source for file ConventionalRenderer.php

Namespaces