Source for file Html.php

Documentation is available at Html.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\Web
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../Object.php';
24:
25:
26:
27: /**
28: * HTML helper.
29: *
30: * <code>
31: * $anchor = Html::el('a')->href($link)->setText('Nette');
32: * $el->class = 'myclass';
33: * echo $el;
34: *
35: * echo $el->startTag(), $el->endTag();
36: * </code>
37: *
38: * @author David Grudl
39: * @copyright Copyright (c) 2004, 2009 David Grudl
40: * @package Nette\Web
41: */
42: class Html extends Object implements ArrayAccess, Countable, IteratorAggregate
43: {
44: /** @var string element's name */
45: private $name;
46:
47: /** @var bool is element empty? */
48: private $isEmpty;
49:
50: /** @var array element's attributes */
51: public $attrs = array();
52:
53: /** @var array of Html | string nodes */
54: protected $children = array();
55:
56: /** @var bool use XHTML syntax? */
57: public static $xhtml = TRUE;
58:
59: /** @var array empty elements */
60: public static $emptyElements = array('img'=>1,'hr'=>1,'br'=>1,'input'=>1,'meta'=>1,'area'=>1,
61: 'base'=>1,'col'=>1,'link'=>1,'param'=>1,'basefont'=>1,'frame'=>1,'isindex'=>1,'wbr'=>1,'embed'=>1);
62:
63:
64:
65: /**
66: * Static factory.
67: * @param string element name (or NULL)
68: * @param array|stringelement's attributes (or textual content)
69: * @return Html
70: */
71: public static function el($name = NULL, $attrs = NULL)
72: {
73: $el = new self ;
74: $parts = explode(' ', $name);
75: $el->setName(array_shift($parts));
76: if (is_array($attrs)) {
77: $el->attrs = $attrs;
78:
79: } elseif ($attrs !== NULL) {
80: $el->setText($attrs);
81: }
82:
83: foreach ($parts as $pair) {
84: $pair = explode('=', $pair, 2);
85: $el->attrs[$pair[0]] = isset($pair[1]) ? trim($pair[1], '"') : TRUE;
86: }
87: return $el;
88: }
89:
90:
91:
92: /**
93: * Changes element's name.
94: * @param string
95: * @param bool Is element empty?
96: * @return Html provides a fluent interface
97: * @throws InvalidArgumentException
98: */
99: final public function setName($name, $isEmpty = NULL)
100: {
101: if ($name !== NULL && !is_string($name)) {
102: throw new InvalidArgumentException("Name must be string or NULL, " . gettype($name) ." given.");
103: }
104:
105: $this->name = $name;
106: $this->isEmpty = $isEmpty === NULL ? isset(self::$emptyElements[$name]) : (bool) $isEmpty;
107: return $this;
108: }
109:
110:
111:
112: /**
113: * Returns element's name.
114: * @return string
115: */
116: final public function getName()
117: {
118: return $this->name;
119: }
120:
121:
122:
123: /**
124: * Is element empty?
125: * @return bool
126: */
127: final public function isEmpty()
128: {
129: return $this->isEmpty;
130: }
131:
132:
133:
134: /**
135: * Overloaded setter for element's attribute.
136: * @param string HTML attribute name
137: * @param mixed HTML attribute value
138: * @return void
139: */
140: final public function __set($name, $value)
141: {
142: $this->attrs[$name] = $value;
143: }
144:
145:
146:
147: /**
148: * Overloaded getter for element's attribute.
149: * @param string HTML attribute name
150: * @return mixed HTML attribute value
151: */
152: final public function &__get($name)
153: {
154: return $this->attrs[$name];
155: }
156:
157:
158:
159: /**
160: * Overloaded unsetter for element's attribute.
161: * @param string HTML attribute name
162: * @return void
163: */
164: final public function __unset($name)
165: {
166: unset($this->attrs[$name]);
167: }
168:
169:
170:
171: /**
172: * Overloaded setter for element's attribute.
173: * @param string HTML attribute name
174: * @param array (string) HTML attribute value or pair?
175: * @return Html provides a fluent interface
176: */
177: final public function __call($m, $args)
178: {
179: if (count($args) === 1) { // set
180: $this->attrs[$m] = $args[0];
181:
182: } elseif ($args[0] == NULL) { // intentionally ==
183: // append empty value -> ignore
184:
185: } elseif (!isset($this->attrs[$m]) || is_array($this->attrs[$m])) { // needs array
186: $this->attrs[$m][$args[0]] = $args[1];
187:
188: } else {
189: $this->attrs[$m] = array($this->attrs[$m], $args[0] => $args[1]);
190: }
191:
192: return $this;
193: }
194:
195:
196:
197: /**
198: * Special setter for element's attribute.
199: * @param string path
200: * @param array query
201: * @return Html provides a fluent interface
202: */
203: final public function href($path, $query = NULL)
204: {
205: if ($query) {
206: $query = http_build_query($query, NULL, '&');
207: if ($query !== '') $path .= '?' . $query;
208: }
209: $this->attrs['href'] = $path;
210: return $this;
211: }
212:
213:
214:
215: /**
216: * Sets element's HTML content.
217: * @param string
218: * @throws InvalidArgumentException
219: * @return Html provides a fluent interface
220: */
221: final public function setHtml($html)
222: {
223: if ($html === NULL) {
224: $html = '';
225:
226: } elseif (is_array($html)) {
227: throw new InvalidArgumentException("Textual content must be a scalar, " . gettype($html) ." given.");
228:
229: } else {
230: $html = (string) $html;
231: }
232:
233: $this->removeChildren();
234: $this->children[] = $html;
235: return $this;
236: }
237:
238:
239:
240: /**
241: * Sets element's textual content.
242: * @param string
243: * @throws InvalidArgumentException
244: * @return Html provides a fluent interface
245: */
246: final public function setText($text, $isHtml = FALSE)
247: {
248: if ($isHtml) {
249: trigger_error('Html::setText(..., TRUE) is deprecated; use Html::setHtml(...) instead.', E_USER_WARNING);
250:
251: } elseif (!is_array($text)) {
252: $text = str_replace(array('&', '<', '>'), array('&', '<', '>'), (string) $text);
253: }
254: return $this->setHtml($text);
255: }
256:
257:
258:
259: /**
260: * Gets element's textual content.
261: * @return string
262: */
263: final public function getText()
264: {
265: $s = '';
266: foreach ($this->children as $child) {
267: if (is_object($child)) return FALSE;
268: $s .= $child;
269: }
270: return $s;
271: }
272:
273:
274:
275: /**
276: * Adds new element's child.
277: * @param Html|stringchild node
278: * @return Html provides a fluent interface
279: */
280: final public function add($child)
281: {
282: return $this->insert(NULL, $child);
283: }
284:
285:
286:
287: /**
288: * Creates and adds a new Html child.
289: * @param string elements's name
290: * @param array|stringelement's attributes (or textual content)
291: * @return Html created element
292: */
293: final public function create($name, $attrs = NULL)
294: {
295: $this->insert(NULL, $child = self ::el($name, $attrs));
296: return $child;
297: }
298:
299:
300:
301: /**
302: * Inserts child node.
303: * @param int
304: * @param Html node
305: * @param bool
306: * @return Html provides a fluent interface
307: * @throws Exception
308: */
309: public function insert($index, $child, $replace = FALSE)
310: {
311: if ($child instanceof Html || is_scalar($child)) {
312: if ($index === NULL) { // append
313: $this->children[] = $child;
314:
315: } else { // insert or replace
316: array_splice($this->children, (int) $index, $replace ? 1 : 0, array($child));
317: }
318:
319: } else {
320: throw new InvalidArgumentException("Child node must be scalar or Html object, " . (is_object($child) ? get_class($child) : gettype($child)) ." given.");
321: }
322:
323: return $this;
324: }
325:
326:
327:
328: /**
329: * Inserts (replaces) child node (\ArrayAccess implementation).
330: * @param int
331: * @param Html node
332: * @return void
333: */
334: final public function offsetSet($index, $child)
335: {
336: $this->insert($index, $child, TRUE);
337: }
338:
339:
340:
341: /**
342: * Returns child node (\ArrayAccess implementation).
343: * @param int index
344: * @return mixed
345: */
346: final public function offsetGet($index)
347: {
348: return $this->children[$index];
349: }
350:
351:
352:
353: /**
354: * Exists child node? (\ArrayAccess implementation).
355: * @param int index
356: * @return bool
357: */
358: final public function offsetExists($index)
359: {
360: return isset($this->children[$index]);
361: }
362:
363:
364:
365: /**
366: * Removes child node (\ArrayAccess implementation).
367: * @param int index
368: * @return void
369: */
370: public function offsetUnset($index)
371: {
372: if (isset($this->children[$index])) {
373: array_splice($this->children, (int) $index, 1);
374: }
375: }
376:
377:
378:
379: /**
380: * Required by the \Countable interface.
381: * @return int
382: */
383: final public function count()
384: {
385: return count($this->children);
386: }
387:
388:
389:
390: /**
391: * Removed all children.
392: * @return void
393: */
394: public function removeChildren()
395: {
396: $this->children = array();
397: }
398:
399:
400:
401: /**
402: * Iterates over a elements.
403: * @param bool recursive?
404: * @param string class types filter
405: * @return RecursiveIterator
406: */
407: final public function getIterator($deep = FALSE)
408: {
409: if ($deep) {
410: $deep = $deep > 0 ? RecursiveIteratorIterator::SELF_FIRST : RecursiveIteratorIterator::CHILD_FIRST;
411: return new RecursiveIteratorIterator(new RecursiveHtmlIterator($this->children), $deep);
412:
413: } else {
414: return new RecursiveHtmlIterator($this->children);
415: }
416: }
417:
418:
419:
420: /**
421: * Returns all of children.
422: * return array
423: */
424: final public function getChildren()
425: {
426: return $this->children;
427: }
428:
429:
430:
431: /**
432: * Renders element's start tag, content and end tag.
433: * @param int indent
434: * @return string
435: */
436: final public function render($indent = NULL)
437: {
438: $s = $this->startTag();
439:
440: // empty elements are finished now
441: if ($this->isEmpty) {
442: return $s;
443: }
444:
445: // add content
446: if ($indent !== NULL) {
447: $indent++;
448: }
449: foreach ($this->children as $child) {
450: if (is_object($child)) {
451: $s .= $child->render($indent);
452: } else {
453: $s .= $child;
454: }
455: }
456:
457: // add end tag
458: $s .= $this->endTag();
459: if ($indent !== NULL) {
460: return "\n" . str_repeat("\t", $indent - 1) . $s . "\n" . str_repeat("\t", max(0, $indent - 2));
461: }
462: return $s;
463: }
464:
465:
466:
467: final public function __toString()
468: {
469: return $this->render();
470: }
471:
472:
473:
474: /**
475: * Returns element's start tag.
476: * @return string
477: */
478: final public function startTag()
479: {
480: if ($this->name) {
481: return '<' . $this->name . $this->attributes() . (self::$xhtml && $this->isEmpty ? ' />' : '>');
482:
483: } else {
484: return '';
485: }
486: }
487:
488:
489:
490: /**
491: * Returns element's end tag.
492: * @return string
493: */
494: final public function endTag()
495: {
496: return $this->name && !$this->isEmpty ? '</' . $this->name . '>' : '';
497: }
498:
499:
500:
501: /**
502: * Returns element's attributes.
503: * @return string
504: */
505: final public function attributes()
506: {
507: if (!is_array($this->attrs)) {
508: return '';
509: }
510:
511: $s = '';
512: foreach ($this->attrs as $key => $value)
513: {
514: // skip NULLs and false boolean attributes
515: if ($value === NULL || $value === FALSE) continue;
516:
517: // true boolean attribute
518: if ($value === TRUE) {
519: // in XHTML must use unminimized form
520: if (self::$xhtml) $s .= ' ' . $key . '="' . $key . '"';
521: // in HTML should use minimized form
522: else $s .= ' ' . $key;
523: continue;
524:
525: } elseif (is_array($value)) {
526:
527: // prepare into temporary array
528: $tmp = NULL;
529: foreach ($value as $k => $v) {
530: // skip NULLs & empty string; composite 'style' vs. 'others'
531: if ($v == NULL) continue; // intentionally ==
532:
533: // composite 'style' vs. 'others'
534: $tmp[] = is_string($k) ? ($v === TRUE ? $k : $k . ':' . $v) : $v;
535: }
536: if ($tmp === NULL) continue;
537:
538: $value = implode($key === 'style' || !strncmp($key, 'on', 2) ? ';' : ' ', $tmp);
539:
540: } else {
541: $value = (string) $value;
542: }
543:
544: // add new attribute
545: $s .= ' ' . $key . '="'
546: . str_replace(array('&', '"', '<', '>', '@'), array('&', '"', '<', '>', '@'), $value)
547: . '"';
548: }
549: return $s;
550: }
551:
552:
553:
554: /**
555: * Clones all children too.
556: */
557: public function __clone()
558: {
559: foreach ($this->children as $key => $value) {
560: if (is_object($value)) {
561: $this->children[$key] = clone $value;
562: }
563: }
564: }
565:
566: }
567:
568:
569:
570: /**
571: * Recursive HTML element iterator. See Html::getIterator().
572: *
573: * @author David Grudl
574: * @copyright Copyright (c) 2004, 2009 David Grudl
575: * @package Nette\Web
576: */
577: class RecursiveHtmlIterator extends RecursiveArrayIterator
578: {
579:
580: /**
581: * The sub-iterator for the current element.
582: * @return RecursiveIterator
583: */
584: public function getChildren()
585: {
586: return $this->current()->getIterator();
587: }
588:
589: }

Source for file Html.php

Namespaces