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 XmlContent( /* ... */)
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 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
209 function XmlElement($tagname /* , $attr_or_content , ...*/)
211 //FIXME: php5 incompatible
213 $this->_init(func_get_args());
216 function _init($args)
218 if (!is_array($args))
219 $args = func_get_args();
221 assert(count($args) >= 1);
222 //assert(is_string($args[0]));
223 $this->_tag = array_shift($args);
225 if ($args && is_array($args[0]))
226 $this->_attr = array_shift($args);
228 $this->_attr = array();
229 if ($args && $args[0] === false)
233 $this->setContent($args);
236 /** Methods only needed for XmlParser,
237 * to be fully compatible to perl Html::Element
239 // doesn't yet work with php5 as __destruct()
242 if ($this->hasChildren()) {
243 foreach ($this->getChildren() as $node) {
249 unset($this->_content);
252 function getChildren()
254 return $this->_children;
257 function hasChildren()
259 return !empty($this->_children);
262 /* End XmlParser Methods
270 function setAttr($attr, $value = false)
272 if (is_array($attr)) {
273 assert($value === false);
274 foreach ($attr as $a => $v) {
275 $this->_attr[strtolower($a)] = $v;
276 //$this->set($a, $v);
281 assert(is_string($attr));
283 if ($value === false) {
284 unset($this->_attr[$attr]);
288 $this->_attr[$attr] = (string)$value;
291 if ($attr == 'class')
292 unset($this->_classes);
295 function getAttr($attr)
297 if ($attr == 'class')
298 $this->_setClasses();
300 if (isset($this->_attr[strtolower($attr)]))
301 return $this->_attr[strtolower($attr)];
306 function _getClasses()
308 if (!isset($this->_classes)) {
309 $this->_classes = array();
310 if (isset($this->_attr['class'])) {
311 $classes = explode(' ', (string)$this->_attr['class']);
312 foreach ($classes as $class) {
313 $class = trim($class);
315 $this->_classes[$class] = $class;
319 return $this->_classes;
322 function _setClasses()
324 if (isset($this->_classes)) {
326 $this->_attr['class'] = join(' ', $this->_classes);
328 unset($this->_attr['class']);
333 * Manipulate the elements CSS class membership.
335 * This adds or remove an elements membership
336 * in a give CSS class.
338 * @param $class string
340 * @param $in_class bool
341 * If true (the default) the element is added to class $class.
342 * If false, the element is removed from the class.
344 function setInClass($class, $in_class = true)
346 $this->_getClasses();
347 $class = trim($class);
349 $this->_classes[$class] = $class;
351 unset($this->_classes[$class]);
355 * Is element in a given (CSS) class?
357 * This checks for the presence of a particular class in the
358 * elements 'class' attribute.
360 * @param $class string The class to check for.
361 * @return bool True if the element is a member of $class.
363 function inClass($class)
365 $this->_parseClasses();
366 return isset($this->_classes[trim($class)]);
371 $start = "<" . $this->_tag;
372 $this->_setClasses();
373 foreach ($this->_attr as $attr => $val) {
379 $qval = str_replace("\"", '"', $this->_quote((string)$val));
380 $start .= " $attr=\"$qval\"";
388 return substr($this->startTag(), 0, -1) . "/>";
393 return "</$this->_tag>";
398 if ($this->isEmpty())
399 echo $this->emptyTag();
401 echo $this->startTag();
402 // FIXME: The next two lines could be removed for efficiency
403 if (!$this->hasInlineContent())
405 XmlContent::printXML();
406 echo "</$this->_tag>";
408 if (!$this->isInlineElement())
414 if ($this->isEmpty()) {
415 $xml = $this->emptyTag();
417 $xml = $this->startTag();
418 // FIXME: The next two lines could be removed for efficiency
419 if (!$this->hasInlineContent())
421 $xml .= XmlContent::asXML();
422 $xml .= "</$this->_tag>";
424 if (!$this->isInlineElement())
430 * Can this element have inline content?
432 * This is a hack, but is probably the best one can do without
433 * knowledge of the DTD...
435 function hasInlineContent()
438 if (empty($this->_content))
440 if (is_object($this->_content[0]))
446 * Is this element part of inline content?
448 * This is a hack, but is probably the best one can do without
449 * knowledge of the DTD...
451 function isInlineElement()
460 function RawXml($xml_text)
462 $this->_xml = $xml_text;
471 function __toString()
488 return empty($this->_xml);
494 function FormattedText($fs /* , ... */)
497 $this->_init(func_get_args());
501 function _init($args)
503 $this->_fs = array_shift($args);
505 // PHP's sprintf doesn't support variable width specifiers,
506 // like sprintf("%*s", 10, "x"); --- so we won't either.
508 if (!preg_match_all('/(?<!%)%(\d+)\$/x', $this->_fs, $m)) {
509 $this->_args = $args;
511 // Format string has '%2$s' style argument reordering.
512 // PHP doesn't support this.
513 if (preg_match('/(?<!%)%[- ]?\d*[^- \d$]/x', $this->_fs)) // $fmt
514 // literal variable name substitution only to keep locale
515 // strings uncluttered
516 trigger_error(sprintf(_("Can't mix ā%sā with ā%sā type format strings"),
517 '%1\$s', '%s'), E_USER_WARNING);
519 $this->_fs = preg_replace('/(?<!%)%\d+\$/x', '%', $this->_fs);
521 $this->_args = array();
522 foreach ($m[1] as $argnum) {
523 if ($argnum < 1 || $argnum > count($args))
524 trigger_error(sprintf("%s: argument index out of range",
525 $argnum), E_USER_WARNING);
526 $this->_args[] = $args[$argnum - 1];
533 // Not all PHP's have vsprintf, so...
534 $args[] = XmlElement::_quote((string)$this->_fs);
535 foreach ($this->_args as $arg)
536 $args[] = AsXML($arg);
537 return call_user_func_array('sprintf', $args);
542 // Not all PHP's have vsprintf, so...
543 $args[] = XmlElement::_quote((string)$this->_fs);
544 foreach ($this->_args as $arg)
545 $args[] = AsXML($arg);
546 call_user_func_array('printf', $args);
551 $args[] = $this->_fs;
552 foreach ($this->_args as $arg)
553 $args[] = AsString($arg);
554 return call_user_func_array('sprintf', $args);
558 function __toString()
560 return $this->asString();
566 * Error[2048]: Non-static method XmlContent::_quote() should not be called statically
567 * Note: There's lot of room for performance increase if the right charset variant can
568 * be created on load-time.
570 function XmlContent_quote($string)
572 if (!$string) return $string;
573 return htmlspecialchars($string, ENT_COMPAT, 'UTF-8');
576 function PrintXML($val /* , ... */)
578 if (func_num_args() > 1) {
579 foreach (func_get_args() as $arg)
581 } elseif (is_object($val)) {
582 if (method_exists($val, 'printXML'))
584 elseif (method_exists($val, 'asXML')) {
586 } elseif (method_exists($val, 'asString'))
587 echo XmlContent_quote($val->asString()); else
588 printf("==Object(%s)==", get_class($val));
589 } elseif (is_array($val)) {
591 // Use XmlContent objects instead of arrays for collections of XmlElements.
592 trigger_error("Passing arrays to PrintXML() is deprecated: (" . AsXML($val, true) . ")",
597 echo (string)XmlContent_quote((string)$val);
600 function AsXML($val /* , ... */)
604 if (func_num_args() > 1) {
606 foreach (func_get_args() as $arg)
609 } elseif (is_object($val)) {
610 if (method_exists($val, 'asXML'))
611 return $val->asXML();
612 elseif (method_exists($val, 'asString'))
613 return XmlContent_quote($val->asString()); else
614 return sprintf("==Object(%s)==", get_class($val));
615 } elseif (is_array($val)) {
617 // Use XmlContent objects instead of arrays for collections of XmlElements.
618 if (empty($nowarn)) {
620 trigger_error("Passing arrays to AsXML() is deprecated: (" . AsXML($val) . ")",
629 return XmlContent_quote((string)$val);
632 function AsString($val)
634 if (func_num_args() > 1) {
636 foreach (func_get_args() as $arg)
637 $str .= AsString($arg);
639 } elseif (is_object($val)) {
640 if (method_exists($val, 'asString'))
641 return $val->asString();
643 return sprintf("==Object(%s)==", get_class($val));
644 } elseif (is_array($val)) {
646 // Use XmlContent objects instead of arrays for collections of XmlElements.
647 trigger_error("Passing arrays to AsString() is deprecated", E_USER_NOTICE);
650 $str .= AsString($x);
657 function fmt($fs /* , ... */)
659 $s = new FormattedText(false);
661 $args = func_get_args();
662 $args[0] = _($args[0]);
671 // c-hanging-comment-ender-p: nil
672 // indent-tabs-mode: nil