3 * Code for writing XML.
5 * @author: Jeff Dairiki,
6 * Reini Urban (php5 tricks)
8 * WARNING: This module is very php5 sensitive.
9 * Fixed for 1.3.9, 1.3.11 and 1.3.13 (php-5.2).
10 * With allow_call_time_pass_reference clean fixes.
14 * A sequence of (zero or more) XmlElements (possibly interspersed with
15 * plain strings (CDATA).
19 function __construct( /* ... */)
21 $this->_content = array();
22 $this->_pushContent_array(func_get_args());
25 function pushContent($arg /*, ...*/)
27 if (func_num_args() > 1)
28 $this->_pushContent_array(func_get_args());
29 elseif (is_array($arg))
30 $this->_pushContent_array($arg); else
31 $this->_pushContent($arg);
34 function _pushContent_array($array)
36 foreach ($array as $item) {
38 $this->_pushContent_array($item);
40 $this->_pushContent($item);
44 function _pushContent($item)
46 if (is_object($item) && strtolower(get_class($item)) == 'xmlcontent')
47 array_splice($this->_content, count($this->_content), 0,
50 $this->_content[] = $item;
53 function unshiftContent($arg /*, ...*/)
55 if (func_num_args() > 1)
56 $this->_unshiftContent_array(func_get_args());
57 elseif (is_array($arg))
58 $this->_unshiftContent_array($arg); else
59 $this->_unshiftContent($arg);
62 function _unshiftContent_array($array)
64 foreach (array_reverse($array) as $item) {
66 $this->_unshiftContent_array($item);
68 $this->_unshiftContent($item);
72 function _unshiftContent($item)
74 if (strtolower(get_class($item)) == 'xmlcontent')
75 array_splice($this->_content, 0, 0, $item->_content);
77 array_unshift($this->_content, $item);
82 return $this->_content;
85 function setContent($arg /* , ... */)
87 $this->_content = array();
88 $this->_pushContent_array(func_get_args());
93 foreach ($this->_content as $item) {
94 if (is_object($item)) {
95 if (method_exists($item, 'printXML'))
97 elseif (method_exists($item, 'asXML'))
98 echo $item->asXML(); elseif (method_exists($item, 'asString'))
99 echo $this->_quote($item->asString()); else
100 printf("==Object(%s)==", get_class($item));
101 } elseif (is_array($item)) {
103 // Use XmlContent objects instead of arrays for collections of XmlElements.
104 trigger_error("Passing arrays to printXML() is deprecated: (" . AsXML($item, true) . ")",
106 foreach ($item as $x)
109 echo $this->_quote((string)$item);
117 foreach ($this->_content as $item) {
118 if (is_object($item)) {
119 if (method_exists($item, 'asXML'))
120 $xml .= $item->asXML();
121 elseif (method_exists($item, 'asString'))
122 $xml .= $this->_quote($item->asString()); else
123 $xml .= sprintf("==Object(%s)==", get_class($item));
124 } elseif (is_array($item)) {
125 trigger_error("Passing arrays to ->asXML() is deprecated: (" . AsXML($item, true) . ")",
127 foreach ($item as $x)
128 $xml .= $this->asXML($x);
130 $xml .= $this->_quote((string)$item);
138 foreach ($this->_content as $item) {
139 if (is_object($item)) {
140 if (method_exists($item, 'asPDF'))
141 $pdf .= $item->asPDF();
142 elseif (method_exists($item, 'asString'))
143 $pdf .= $this->_quote($item->asString()); else
144 $pdf .= sprintf("==Object(%s)==", get_class($item));
146 $pdf .= $this->_quote((string)$item);
152 function __toString()
154 return $this->asString();
160 foreach ($this->_content as $item) {
161 if (is_object($item)) {
162 if (method_exists($item, 'asString')) {
163 $string = $item->asString();
164 if (is_object($string)) {
165 ; // ignore error so far: ImageLink labels
167 $val .= $this->_quote($item->asString());
170 $val .= sprintf("==Object(%s)==", get_class($item));
173 $val .= (string)$item;
179 * See if element is empty.
181 * Empty means it has no content.
182 * @return bool True if empty.
186 if (empty($this->_content))
188 foreach ($this->_content as $x) {
189 if (is_string($x) ? strlen($x) : !empty($x))
195 static function _quote($string)
197 if (!$string) return $string;
198 return htmlspecialchars($string, ENT_COMPAT, 'UTF-8');
205 * @param $tagname string Tag of html element.
207 class XmlElement extends XmlContent
214 function __construct($tagname /* , $attr_or_content , ...*/)
216 parent::__construct();
217 $this->_init(func_get_args());
220 function _init($args)
222 if (!is_array($args))
223 $args = func_get_args();
225 assert(count($args) >= 1);
226 //assert(is_string($args[0]));
227 $this->_tag = array_shift($args);
229 if ($args && is_array($args[0]))
230 $this->_attr = array_shift($args);
232 $this->_attr = array();
233 if ($args && $args[0] === false)
237 $this->setContent($args);
240 /** Methods only needed for XmlParser,
241 * to be fully compatible to perl Html::Element
243 // doesn't yet work with php5 as __destruct()
246 if ($this->hasChildren()) {
247 foreach ($this->getChildren() as $node) {
253 unset($this->_content);
256 function getChildren()
258 return $this->_children;
261 function hasChildren()
263 return !empty($this->_children);
266 /* End XmlParser Methods
274 function setAttr($attr, $value = false)
276 if (is_array($attr)) {
277 assert($value === false);
278 foreach ($attr as $a => $v) {
279 $this->_attr[strtolower($a)] = $v;
280 //$this->set($a, $v);
285 assert(is_string($attr));
287 if ($value === false) {
288 unset($this->_attr[$attr]);
292 $this->_attr[$attr] = (string)$value;
295 if ($attr == 'class')
296 unset($this->_classes);
299 function getAttr($attr)
301 if ($attr == 'class')
302 $this->_setClasses();
304 if (isset($this->_attr[strtolower($attr)]))
305 return $this->_attr[strtolower($attr)];
310 function _getClasses()
312 if (!isset($this->_classes)) {
313 $this->_classes = array();
314 if (isset($this->_attr['class'])) {
315 $classes = explode(' ', (string)$this->_attr['class']);
316 foreach ($classes as $class) {
317 $class = trim($class);
319 $this->_classes[$class] = $class;
323 return $this->_classes;
326 function _setClasses()
328 if (isset($this->_classes)) {
330 $this->_attr['class'] = join(' ', $this->_classes);
332 unset($this->_attr['class']);
337 * Manipulate the elements CSS class membership.
339 * This adds or remove an elements membership
340 * in a give CSS class.
342 * @param $class string
344 * @param $in_class bool
345 * If true (the default) the element is added to class $class.
346 * If false, the element is removed from the class.
348 function setInClass($class, $in_class = true)
350 $this->_getClasses();
351 $class = trim($class);
353 $this->_classes[$class] = $class;
355 unset($this->_classes[$class]);
359 * Is element in a given (CSS) class?
361 * This checks for the presence of a particular class in the
362 * elements 'class' attribute.
364 * @param $class string The class to check for.
365 * @return bool True if the element is a member of $class.
367 function inClass($class)
369 $this->_parseClasses();
370 return isset($this->_classes[trim($class)]);
375 $start = "<" . $this->_tag;
376 $this->_setClasses();
377 foreach ($this->_attr as $attr => $val) {
383 $qval = str_replace("\"", '"', $this->_quote((string)$val));
384 $start .= " $attr=\"$qval\"";
392 return substr($this->startTag(), 0, -1) . "/>";
397 return "</$this->_tag>";
402 if ($this->isEmpty())
403 echo $this->emptyTag();
405 echo $this->startTag();
406 // FIXME: The next two lines could be removed for efficiency
407 if (!$this->hasInlineContent())
409 XmlContent::printXML();
410 echo "</$this->_tag>";
412 if (!$this->isInlineElement())
418 if ($this->isEmpty()) {
419 $xml = $this->emptyTag();
421 $xml = $this->startTag();
422 // FIXME: The next two lines could be removed for efficiency
423 if (!$this->hasInlineContent())
425 $xml .= XmlContent::asXML();
426 $xml .= "</$this->_tag>";
428 if (!$this->isInlineElement())
434 * Can this element have inline content?
436 * This is a hack, but is probably the best one can do without
437 * knowledge of the DTD...
439 function hasInlineContent()
442 if (empty($this->_content))
444 if (is_object($this->_content[0]))
450 * Is this element part of inline content?
452 * This is a hack, but is probably the best one can do without
453 * knowledge of the DTD...
455 function isInlineElement()
464 function RawXml($xml_text)
466 $this->_xml = $xml_text;
475 function __toString()
492 return empty($this->_xml);
501 function FormattedText($fs /* , ... */)
504 $this->_init(func_get_args());
508 function _init($args)
510 $this->_fs = array_shift($args);
512 // PHP's sprintf doesn't support variable width specifiers,
513 // like sprintf("%*s", 10, "x"); --- so we won't either.
515 if (!preg_match_all('/(?<!%)%(\d+)\$/x', $this->_fs, $m)) {
516 $this->_args = $args;
518 // Format string has '%2$s' style argument reordering.
519 // PHP doesn't support this.
520 if (preg_match('/(?<!%)%[- ]?\d*[^- \d$]/x', $this->_fs)) // $fmt
521 // literal variable name substitution only to keep locale
522 // strings uncluttered
523 trigger_error(sprintf(_("Can't mix ā%sā with ā%sā type format strings"),
524 '%1\$s', '%s'), E_USER_WARNING);
526 $this->_fs = preg_replace('/(?<!%)%\d+\$/x', '%', $this->_fs);
528 $this->_args = array();
529 foreach ($m[1] as $argnum) {
530 if ($argnum < 1 || $argnum > count($args))
531 trigger_error(sprintf("%s: argument index out of range",
532 $argnum), E_USER_WARNING);
533 $this->_args[] = $args[$argnum - 1];
540 // Not all PHP's have vsprintf, so...
541 $args[] = XmlElement::_quote((string)$this->_fs);
542 foreach ($this->_args as $arg)
543 $args[] = AsXML($arg);
544 return call_user_func_array('sprintf', $args);
549 // Not all PHP's have vsprintf, so...
550 $args[] = XmlElement::_quote((string)$this->_fs);
551 foreach ($this->_args as $arg)
552 $args[] = AsXML($arg);
553 call_user_func_array('printf', $args);
558 $args[] = $this->_fs;
559 foreach ($this->_args as $arg)
560 $args[] = AsString($arg);
561 return call_user_func_array('sprintf', $args);
565 function __toString()
567 return $this->asString();
572 * Note: There's lot of room for performance increase if the right charset variant can
573 * be created on load-time.
574 * @param string $string
577 function XmlContent_quote($string)
579 if (!$string) return $string;
580 return htmlspecialchars($string, ENT_COMPAT, 'UTF-8');
583 function PrintXML($val /* , ... */)
585 if (func_num_args() > 1) {
586 foreach (func_get_args() as $arg)
588 } elseif (is_object($val)) {
589 if (method_exists($val, 'printXML'))
591 elseif (method_exists($val, 'asXML')) {
593 } elseif (method_exists($val, 'asString'))
594 echo XmlContent_quote($val->asString()); else
595 printf("==Object(%s)==", get_class($val));
596 } elseif (is_array($val)) {
598 // Use XmlContent objects instead of arrays for collections of XmlElements.
599 trigger_error("Passing arrays to PrintXML() is deprecated: (" . AsXML($val, true) . ")",
604 echo (string)XmlContent_quote((string)$val);
607 function AsXML($val /* , ... */)
611 if (func_num_args() > 1) {
613 foreach (func_get_args() as $arg)
616 } elseif (is_object($val)) {
617 if (method_exists($val, 'asXML'))
618 return $val->asXML();
619 elseif (method_exists($val, 'asString'))
620 return XmlContent_quote($val->asString()); else
621 return sprintf("==Object(%s)==", get_class($val));
622 } elseif (is_array($val)) {
624 // Use XmlContent objects instead of arrays for collections of XmlElements.
625 if (empty($nowarn)) {
627 trigger_error("Passing arrays to AsXML() is deprecated: (" . AsXML($val) . ")",
636 return XmlContent_quote((string)$val);
639 function AsString($val)
641 if (func_num_args() > 1) {
643 foreach (func_get_args() as $arg)
644 $str .= AsString($arg);
646 } elseif (is_object($val)) {
647 if (method_exists($val, 'asString'))
648 return $val->asString();
650 return sprintf("==Object(%s)==", get_class($val));
651 } elseif (is_array($val)) {
653 // Use XmlContent objects instead of arrays for collections of XmlElements.
654 trigger_error("Passing arrays to AsString() is deprecated", E_USER_NOTICE);
657 $str .= AsString($x);
664 function fmt($fs /* , ... */)
666 $s = new FormattedText(false);
668 $args = func_get_args();
669 $args[0] = _($args[0]);
678 // c-hanging-comment-ender-p: nil
679 // indent-tabs-mode: nil