3 * StatusNet, the distributed open-source microblogging tool
5 * Low-level generator for XML
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @author Sarven Capadisli <csarven@status.net>
26 * @copyright 2008 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET') && !defined('LACONICA')) {
36 * Low-level generator for XML
38 * This is a thin wrapper around PHP's XMLWriter. The main
39 * advantage is the element() method, which simplifies outputting
44 * @author Evan Prodromou <evan@status.net>
45 * @author Sarven Capadisli <csarven@status.net>
46 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47 * @link http://status.net/
55 * Wrapped XMLWriter object, which does most of the heavy lifting
64 * Initializes the wrapped XMLWriter.
66 * @param string $output URL for outputting, if null it defaults to stdout ('php://output')
67 * @param boolean $indent Whether to indent output, default true
70 function __construct($output=null, $indent=null)
72 if (is_null($output)) {
73 $output = 'php://output';
75 $this->xw = new XMLWriter();
76 $this->xw->openURI($output);
77 if(is_null($indent)) {
78 $indent = common_config('site', 'indent');
80 $this->xw->setIndent($indent);
84 * Start a new XML document
86 * @param string $doc document element
87 * @param string $public public identifier
88 * @param string $system system identifier
93 function startXML($doc=null, $public=null, $system=null)
95 $this->xw->startDocument('1.0', 'UTF-8');
97 $this->xw->writeDTD($doc, $public, $system);
102 * finish an XML document
104 * It's probably a bad idea to continue to use this object
105 * after calling endXML().
112 $this->xw->endDocument();
117 * output an XML element
119 * Utility for outputting an XML element. A convenient wrapper
120 * for a bunch of longer XMLWriter calls. This is best for
121 * when an element doesn't have any sub-elements; if that's the
122 * case, use elementStart() and elementEnd() instead.
124 * The $content element will be escaped for XML. If you need
125 * raw output, use elementStart() and elementEnd() with a call
126 * to raw() in the middle.
128 * If $attrs is a string instead of an array, it will be treated
129 * as the class attribute of the element.
131 * @param string $tag Element type or tagname
132 * @param array $attrs Array of element attributes, as
134 * @param string $content string content of the element
139 function element($tag, $attrs=null, $content=null)
141 $this->elementStart($tag, $attrs);
142 if (!is_null($content)) {
143 $this->xw->text($content);
145 $this->elementEnd($tag);
148 function elementNS(array $ns, $tag, $attrs=null, $content=null)
150 $this->elementStartNS($ns, $tag, $attrs);
151 if (!is_null($content)) {
152 $this->xw->text($content);
154 $this->elementEnd($tag);
158 * output a start tag for an element
160 * Mostly used for when an element has content that's
161 * not a simple string.
163 * If $attrs is a string instead of an array, it will be treated
164 * as the class attribute of the element.
166 * @param string $tag Element type or tagname
167 * @param array $attrs Array of element attributes
172 function elementStart($tag, $attrs=null)
174 $this->xw->startElement($tag);
175 if (is_array($attrs)) {
176 foreach ($attrs as $name => $value) {
177 $this->xw->writeAttribute($name, $value);
179 } else if (is_string($attrs)) {
180 $this->xw->writeAttribute('class', $attrs);
184 function elementStartNS(array $ns, $tag, $attrs=null)
186 reset($ns); // array pointer to 0
188 $this->xw->startElementNS($ns[$uri], $tag, $uri);
189 if (is_array($attrs)) {
190 foreach ($attrs as $name => $value) {
191 $this->xw->writeAttribute($name, $value);
193 } else if (is_string($attrs)) {
194 $this->xw->writeAttribute('class', $attrs);
199 * output an end tag for an element
201 * Used in conjunction with elementStart(). $tag param
202 * should match the elementStart() param.
204 * For HTML 4 compatibility, this method will force
205 * a full end element (</tag>) even if the element is
206 * empty, except for a handful of exception tagnames.
209 * @param string $tag Element type or tagname.
214 function elementEnd($tag)
216 static $empty_tag = array('base', 'meta', 'link', 'hr',
217 'br', 'param', 'img', 'area',
218 'input', 'col', 'source');
219 // XXX: check namespace
220 if (in_array($tag, $empty_tag)) {
221 $this->xw->endElement();
223 $this->xw->fullEndElement();
230 * Text will be escaped. If you need it not to be,
233 * @param string $txt Text to output.
240 $this->xw->text($txt);
246 * This will spit out its argument verbatim -- no escaping is
249 * @param string $xml XML to output.
256 $this->xw->writeRaw($xml);
262 * @param string $txt text of the comment
267 function comment($txt)
269 $this->xw->writeComment($txt);
273 * Flush output buffers