add MJ12bot to tests
[php-utility-classes.git] / classes / document.php-class
1 <?php
2 /* This Source Code Form is subject to the terms of the Mozilla Public
3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
4  * You can obtain one at http://mozilla.org/MPL/2.0/. */
5
6 class ExtendedDocument extends DOMDocument {
7   // ExtendedDocument PHP class
8   // this extends the general PHP DOM Document class to simplify some usual constructs
9   //
10   // function __construct([$version], [$encoding])
11   //   CONSTRUCTOR
12   //   construct a new DOM Document that uses our element definitions
13   //
14   // static function initHTML5([$doc])
15   //   initialize as an HTML5 document and return references to its basic elements.
16   //     If a $doc is handed over (an ExtendedDocument or a derived class), load the content into that document.
17   //     returns an associative array with the following elements: 'html', 'head', 'title', 'body'
18   //
19   // public function appendElement($name, [$value])
20   //   appends a DOMDocument::createElement() as a child of this document (see there for params)
21   //     returns the new child
22   //
23   // public function appendElementXML($name, $xmldata)
24   //   appends a DOMDocument::createElement() with the given name as a child of this document,
25   //   with an ExtendedDocument::createXMLFragment() of the given XML data inside
26   //     returns the new child
27   //
28   // public function appendLink($target, [$value])
29   //   appends an ExtendedDocument::createElementLink() as a child of this document (see there for params)
30   //     returns the new child
31   //
32   // public function appendImage($src, [$alt_text])
33   //   appends an ExtendedDocument::createElementImage() as a child of this document (see there for params)
34   //     returns the new child
35   //
36   // public function appendForm($action, $method, $name, [$id])
37   //   appends an ExtendedDocument::createElementForm() as a child of this document (see there for params)
38   //     returns the new child
39   //
40   // public function appendFormDiv($action, $method, $name, [$id])
41   //   appends an ExtendedDocument::createElementForm() as a child of this document (see there for params)
42   //     returns an HTML <div> that is a child of the new child
43   //
44   // public function appendInputHidden($name, $value)
45   //   appends an ExtendedDocument::createElementInputHidden() as a child of this document (see there for params)
46   //     returns the new child
47   //
48   // public function appendInputText($name, $maxlength, $size, [$id], [$value])
49   //   appends an ExtendedDocument::createElementInputText() as a child of this document (see there for params)
50   //     returns the new child
51   //
52   // public function appendInputNumber($name, $maxlength, $size, [$id], [$value])
53   //   appends an ExtendedDocument::createElementInputNumber() as a child of this document (see there for params)
54   //     returns the new child
55   //
56   // public function appendInputEmail($name, $maxlength, $size, [$id], [$value])
57   //   appends an ExtendedDocument::createElementInputEmail() as a child of this document (see there for params)
58   //     returns the new child
59   //
60   // public function appendInputPassword($name, $maxlength, $size, [$id], [$value])
61   //   appends an ExtendedDocument::createElementInputPassword() as a child of this document (see there for params)
62   //     returns the new child
63   //
64   // public function appendInputRadio($name, $id, $value, $checked)
65   //   appends an ExtendedDocument::createElementInputRadio() as a child of this document (see there for params)
66   //     returns the new child
67   //
68   // public function appendInputCheckbox($name, $id, $value, $checked)
69   //   appends an ExtendedDocument::createElementInputCheckbox() as a child of this document (see there for params)
70   //     returns the new child
71   //
72   // public function appendInputFile($name, $id, $accept)
73   //   appends an ExtendedDocument::createElementInputFile() as a child of this document (see there for params)
74   //     returns the new child
75   //
76   // public function appendInputSubmit($value)
77   //   appends an ExtendedDocument::createElementInputSubmit() as a child of this document (see there for params)
78   //     returns the new child
79   //
80   // public function appendButton($value, $onclick = null)
81   //   appends an ExtendedDocument::createElementButton() as a child of this document (see there for params)
82   //     returns the new child
83   //
84   // public function appendTextArea($name, $columns, $rows, [$id], [$value])
85   //   appends an ExtendedDocument::createElementTextArea() as a child of this document (see there for params)
86   //     returns the new child
87   //
88   // public function appendElementSelect($name, [$id], [$options], [$default])
89   //   appends an ExtendedDocument::createElementSelect() as a child of this document (see there for params)
90   //     returns the new child
91   //
92   // public function appendElementOption($key, $desc, [$selected])
93   //   appends an ExtendedDocument::createElementOption() as a child of this document (see there for params)
94   //     returns the new child
95   //
96   // public function appendLabel($for_id, $value)
97   //   appends an ExtendedDocument::createElementLabel() as a child of this document (see there for params)
98   //     returns the new child
99   //
100   // public function appendText($text)
101   //   appends a DOMDocument::createTextNode() as a child of this document (see there for params)
102   //     returns the new child
103   //
104   // public function appendEntity($name)
105   //   appends a DOMDocument::createEntityReference() as a child of this document (see there for params)
106   //     returns the new child
107   //
108   // public function appendComment($comment_data)
109   //   appends a DOMDocument::createComment() as a child of this document (see there for params)
110   //     returns the new child
111   //
112   // public function appendHTMLMarkup($htmldata, [$parentNode])
113   //   appends a representation of the HTML data as children of the given parent node, by default this document
114   //     NO return value!
115   //
116   // public function appendXMLMarkup($xmldata, [$parentNode])
117   //   appends a representation of the XML data as children of the given parent node, by default this document
118   //     NO return value!
119   //
120   // public function appendJSElement($jsdata)
121   //   appends an ExtendedDocument::createElementJS() as a child of this document (see there for params)
122   //     NO return value!
123   //
124   // public function appendJSFile($jsURL, [$defer], [$async])
125   //   appends an ExtendedDocument::createElementJSFile() as a child of this document (see there for params)
126   //     returns the new child
127   //
128   // public function createElementLink($target, [$value])
129   //   returns an ExtendedElement that is an HTML <a> with the given target (href) and (optional) value
130   //
131   // public function createElementImage($src, [$alt_text])
132   //   returns an ExtendedElement that is an HTML <img> with the given (src) and alt attributes (set to '' by default)
133   //
134   // public function createElementForm($action, $method, $name)
135   //   returns an ExtendedElement that is an HTML <div> that is a child of an HTML <form>
136   //   with the given action, method, and name
137   //
138   // public function createElementInputHidden($name, $value)
139   //   returns an ExtendedElement that is an HTML <input> of type 'hidden' with the given name and value
140   //
141   // public function createElementInputText($name, $maxlength, $size, [$id], [$value])
142   //   returns an ExtendedElement that is an HTML <input> of type 'text' with the given name, maxlength, size,
143   //   and optionally id and value
144   //
145   // public function createElementInputNumber($name, $maxlength, $size, [$id], [$value])
146   //   returns an ExtendedElement that is an HTML <input> of type 'number' with the given name, maxlength, size,
147   //   and optionally id and value
148   //
149   // public function createElementInputEmail($name, $maxlength, $size, [$id], [$value])
150   //   returns an ExtendedElement that is an HTML <input> of type 'email' with the given name, maxlength, size,
151   //   and optionally id and value
152   //
153   // public function createElementInputPassword($name, $maxlength, $size, [$id], [$value])
154   //   returns an ExtendedElement that is an HTML <input> of type 'password' with the given name, maxlength, size,
155   //   and optionally id and value
156   //
157   // public function createElementInputRadio($name, $id, $value, $checked)
158   //   returns an ExtendedElement that is an HTML <input> of type 'radio' with the given name, id, value and
159   //   checked state
160   //
161   // public function createElementInputCheckbox($name, $id, $value, $checked)
162   //   returns an ExtendedElement that is an HTML <input> of type 'checkbox' with the given name, id, value and
163   //   checked state
164   //
165   // public function createElementInputFile($name, $id, $accept)
166   //   returns an ExtendedElement that is an HTML <input> of type 'file' with the given name, id and accept
167   //
168   // public function createElementInputSubmit($value)
169   //   returns an ExtendedElement that is an HTML <input> of type 'submit' with the given value as label
170   //
171   // public function createElementButton($value, $onclick = null)
172   //   returns an ExtendedElement that is an HTML button with the given value as label and optionally onclick attribute
173   //
174   // public function createElementTextArea($name, $columns, $rows, [$id], [$value])
175   //   returns an ExtendedElement that is an HTML <textarea> with the given name, columns, rows,
176   //   and optionally id and value
177   //
178   // public function createElementSelect($name, [$id], [$options], [$default])
179   //   returns an ExtendedElement that is an HTML <select> with the given name, and optionally id,
180   //   array of options (key => description) and key of the by-default selected entry
181   //
182   // public function createElementOption($key, $desc, [$selected])
183   //   returns an ExtendedElement that is an HTML <option> with the given key (value) and description (content)
184   //   and optionally bool that tells if the entry is selected
185   //
186   // public function createElementLabel($for_id, $value)
187   //   returns an ExtendedElement that is an HTML <label> with the given 'for' and value
188   //
189   // public function createElementJS($jsdata)
190   //   returns an ExtendedElement that is an HTML <script> of JavaScript type with the JS data inside
191   //
192   // public function createElementJSFile($jsURL, [$defer], [$async])
193   //   returns an ExtendedElement that is an HTML <script> of JavaScript type linking to the file given by the URL
194   //     $defer and $async are boolean attributes that set if the script should be executed after parsing but before onload, and if it should be loaded asynchronously.
195
196   function __construct($version = '1.0', $encoding = 'utf-8') {
197     // make sure the default DOMDocument constructor runs
198     parent::__construct($version, $encoding);
199     $this->registerNodeClass('DOMElement', 'ExtendedElement');
200     $this->registerNodeClass('DOMDocumentFragment', 'ExtendedDocumentFragment');
201   }
202
203   static function initHTML5($doc = null) {
204     if (is_null($doc)) { $doc = new ExtendedDocument(); }
205     $doc->loadHTML('<!DOCTYPE html><html></html>'); // this seems to be the only way to get the DOCTYPE set properly.
206
207     // Created basic HTML document structure.
208     $root = $doc->getElementsByTagName('html')->item(0);
209     $head = $root->appendElement('head');
210     $title = $head->appendElement('title');
211     $body = $root->appendElement('body');
212
213     return array('document' => $doc,
214                  'html' => $root,
215                  'head' => $head,
216                  'title' => $title,
217                  'body' => $body);
218   }
219
220   public function appendElement($name, $value = '') {
221     return $this->appendChild($this->createElement($name, $value));
222   }
223   public function appendElementXML($name, $xmldata) {
224     $aelem = $this->appendChild($this->createElement($name));
225     $aelem->appendXMLMarkup($xmldata);
226     //$aelem->appendChild($this->createXMLFragment($xmldata));
227     return $aelem;
228   }
229   public function appendLink($target, $value = '') {
230     return $this->appendChild($this->createElementLink($target, $value));
231   }
232   public function appendImage($src, $alt_text = '') {
233     return $this->appendChild($this->createElementImage($src, $alt_text));
234   }
235   public function appendForm($action, $method, $name, $id = null) {
236     return $this->appendChild($this->createElementForm($action, $method, $name, $id));
237   }
238   public function appendFormDiv($action, $method, $name, $id = null) {
239     $formelem = $this->appendChild($this->createElementForm($action, $method, $name, $id));
240     return $formelem->appendElement('div');
241   }
242   public function appendInputHidden($name, $value) {
243     return $this->appendChild($this->createElementInputHidden($name, $value));
244   }
245   public function appendInputText($name, $maxlength, $size, $id = null, $value = null) {
246     return $this->appendChild($this->createElementInputText($name, $maxlength, $size, $id, $value));
247   }
248   public function appendInputNumber($name, $maxlength, $size, $id = null, $value = null) {
249     return $this->appendChild($this->createElementInputNumber($name, $maxlength, $size, $id, $value));
250   }
251   public function appendInputEmail($name, $maxlength, $size, $id = null, $value = null) {
252     return $this->appendChild($this->createElementInputEmail($name, $maxlength, $size, $id, $value));
253   }
254   public function appendInputPassword($name, $maxlength, $size, $id = null, $value = null) {
255     return $this->appendChild($this->createElementInputPassword($name, $maxlength, $size, $id, $value));
256   }
257   public function appendInputRadio($name, $id, $value, $checked) {
258     return $this->appendChild($this->createElementInputRadio($name, $id, $value, $checked));
259   }
260   public function appendInputCheckbox($name, $id, $value, $checked) {
261     return $this->appendChild($this->createElementInputCheckbox($name, $id, $value, $checked));
262   }
263   public function appendInputFile($name, $id, $accept) {
264     return $this->appendChild($this->createElementInputFile($name, $id, $accept));
265   }
266   public function appendInputSubmit($value) {
267     return $this->appendChild($this->createElementInputSubmit($value));
268   }
269   public function appendButton($value, $onclick = null) {
270     return $this->appendChild($this->createElementButton($value, $onclick));
271   }
272   public function appendTextArea($name, $columns, $rows, $id = null, $value = null) {
273     return $this->appendChild($this->createElementTextArea($name, $columns, $rows, $id, $value));
274   }
275   public function appendElementSelect($name, $id = null, $options = array(), $default = null) {
276     return $this->appendChild($this->createElementSelect($name, $id, $options, $default));
277   }
278   public function appendElementOption($key, $desc, $selected = false) {
279     return $this->appendChild($this->createElementOption($key, $desc, $selected));
280   }
281   public function appendLabel($for_id, $value) {
282     return $this->appendChild($this->createElementLabel($for_id, $value));
283   }
284   public function appendText($text) {
285     return $this->appendChild($this->createTextNode($text));
286   }
287   public function appendEntity($name) {
288     return $this->appendChild($this->createEntityReference($name));
289   }
290   public function appendComment($comment_data) {
291     return $this->appendChild($this->createComment($comment_data));
292   }
293   public function appendJSElement($jsdata) {
294     $this->appendChild($this->createElementJS($jsdata));
295   }
296   public function appendJSFile($jsdata, $defer = false, $async = false) {
297     return $this->appendChild($this->createElementJSFile($jsdata, $defer, $async));
298   }
299
300   public function appendHTMLMarkup($htmldata, $parentNode = null) {
301     if (is_null($parentNode)) { $parentNode =& $this; }
302     // Use loadHTML() to parse and turn the markup into proper HTML.
303     $tmpdoc = new ExtendedDocument;
304     // The XML line is needed to tell the parser that we need UTF-8 parsing.
305     $tmpdoc->loadHTML('<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html><html><body>'.$htmldata.'</body></html>');
306     foreach ($tmpdoc->getElementsByTagName('body')->item(0)->childNodes as $child) {
307       $parentNode->appendChild($this->importNode($child, true));
308     }
309   }
310
311   public function appendXMLMarkup($xmldata, $parentNode = null) {
312     if (is_null($parentNode)) { $parentNode =& $this; }
313     $tmpdoc = new ExtendedDocument;
314     $tmpxml = '<?xml version="1.0" encoding="utf-8"?>'."\n";
315     $tmpxml .= '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
316     $tmpxml .= '<root>'.$xmldata.'</root>';
317     $tmpdoc->loadXML($tmpxml);
318     foreach ($tmpdoc->getElementsByTagName('root')->item(0)->childNodes as $child) {
319       $parentNode->appendChild($this->importNode($child, true));
320     }
321   }
322
323   public function createElement($name, $value = '') {
324     // Adding the $value in DOMDocument's createElement does NOT escape it, so override it and use appendText to support that.
325     $aelem = parent::createElement($name);
326     $aelem->appendText($value);
327     return $aelem;
328   }
329
330   public function createElementLink($target, $value = '') {
331     $link = $this->createElement('a', $value);
332     $link->setAttribute('href', $target); // XXX: take care of & etc. in links
333     return $link;
334   }
335
336   public function createElementImage($src, $alt_text = '') {
337     $img = $this->createElement('img');
338     $img->setAttribute('src', $src);
339     $img->setAttribute('alt', $alt_text);
340     return $img;
341   }
342
343   public function createElementForm($action, $method, $name, $id = null) {
344     $formelem = $this->createElement('form');
345     $formelem->setAttribute('action', $action);
346     $formelem->setAttribute('method', $method);
347     $formelem->setAttribute('name', $name);
348     $formelem->setAttribute('id', $id);
349     return $formelem;
350   }
351
352   public function createElementInputHidden($name, $value) {
353     $hidden = $this->createElement('input');
354     $hidden->setAttribute('type', 'hidden');
355     $hidden->setAttribute('name', $name);
356     $hidden->setAttribute('value', $value);
357     return $hidden;
358   }
359
360   public function createElementInputText($name, $maxlength, $size, $id = null, $value = null) {
361     $txfield = $this->createElement('input');
362     $txfield->setAttribute('type', 'text');
363     if (!is_null($id)) { $txfield->setAttribute('id', $id); }
364     $txfield->setAttribute('name', $name);
365     $txfield->setAttribute('maxlength', $maxlength);
366     $txfield->setAttribute('size', $size);
367     if (!is_null($value)) { $txfield->setAttribute('value', $value); }
368     return $txfield;
369   }
370
371   public function createElementInputNumber($name, $maxlength, $size, $id = null, $value = null) {
372     $txfield = $this->createElement('input');
373     $txfield->setAttribute('type', 'number');
374     if (!is_null($id)) { $txfield->setAttribute('id', $id); }
375     $txfield->setAttribute('name', $name);
376     $txfield->setAttribute('maxlength', $maxlength);
377     $txfield->setAttribute('size', $size);
378     if (!is_null($value)) { $txfield->setAttribute('value', $value); }
379     return $txfield;
380   }
381
382   public function createElementInputEmail($name, $maxlength, $size, $id = null, $value = null) {
383     $txfield = $this->createElement('input');
384     $txfield->setAttribute('type', 'email');
385     if (!is_null($id)) { $txfield->setAttribute('id', $id); }
386     $txfield->setAttribute('name', $name);
387     $txfield->setAttribute('maxlength', $maxlength);
388     $txfield->setAttribute('size', $size);
389     if (!is_null($value)) { $txfield->setAttribute('value', $value); }
390     return $txfield;
391   }
392
393   public function createElementInputPassword($name, $maxlength, $size, $id = null, $value = null) {
394     $pwfield = $this->createElement('input');
395     $pwfield->setAttribute('type', 'password');
396     if (!is_null($id)) { $pwfield->setAttribute('id', $id); }
397     $pwfield->setAttribute('name', $name);
398     $pwfield->setAttribute('maxlength', $maxlength);
399     $pwfield->setAttribute('size', $size);
400     if (!is_null($value)) { $pwfield->setAttribute('value', $value); }
401     return $pwfield;
402   }
403
404   public function createElementInputRadio($name, $id, $value, $checked) {
405     $radio = $this->createElement('input');
406     $radio->setAttribute('type', 'radio');
407     $radio->setAttribute('name', $name);
408     if (!is_null($id)) { $radio->setAttribute('id', $id); }
409     $radio->setAttribute('value', $value);
410     if ($checked) { $radio->setAttribute('checked', ''); }
411     return $radio;
412   }
413
414   public function createElementInputCheckbox($name, $id, $value, $checked) {
415     $cbox = $this->createElement('input');
416     $cbox->setAttribute('type', 'checkbox');
417     $cbox->setAttribute('name', $name);
418     if (!is_null($id)) { $cbox->setAttribute('id', $id); }
419     $cbox->setAttribute('value', $value);
420     if ($checked) { $cbox->setAttribute('checked', ''); }
421     return $cbox;
422   }
423
424   public function createElementInputFile($name, $id, $accept) {
425     $fileinput = $this->createElement('input');
426     $fileinput->setAttribute('type', 'file');
427     $fileinput->setAttribute('name', $name);
428     if (!is_null($id)) { $fileinput->setAttribute('id', $id); }
429     $fileinput->setAttribute('accept', $accept);
430     return $fileinput;
431   }
432
433   public function createElementInputSubmit($value) {
434     $submitbtn = $this->createElement('input');
435     $submitbtn->setAttribute('type', 'submit');
436     $submitbtn->setAttribute('value', $value);
437     return $submitbtn;
438   }
439
440   public function createElementButton($value, $onclick = null) {
441     $btn = $this->createElement('input');
442     $btn->setAttribute('type', 'button');
443     $btn->setAttribute('value', $value);
444     if (!is_null($onclick)) { $btn->setAttribute('onclick', $onclick); }
445     return $btn;
446   }
447
448   public function createElementTextArea($name, $columns, $rows, $id = null, $value = null) {
449     $txtarea = $this->createElement('textarea', $value);
450     $txtarea->setAttribute('name', $name);
451     $txtarea->setAttribute('cols', $columns);
452     $txtarea->setAttribute('rows', $rows);
453     if (!is_null($id)) { $txtarea->setAttribute('id', $id); }
454     return $txtarea;
455   }
456
457   public function createElementSelect($name, $id = null, $options = array(), $default = null) {
458     $select = $this->createElement('select');
459     $select->setAttribute('name', $name);
460     if (!is_null($id)) { $select->setAttribute('id', $id); }
461     foreach ($options as $key => $desc) {
462       $select->appendElementOption($key, $desc, ($key == $default));
463     }
464     return $select;
465   }
466
467   public function createElementOption($key, $desc, $selected = false) {
468     $option = $this->createElement('option', $desc);
469     $option->setAttribute('value', $key);
470     if ($selected) { $option->setAttribute('selected', ''); }
471     return $option;
472   }
473
474   public function createElementLabel($for_id, $value) {
475     $label = $this->createElement('label', $value);
476     $label->setAttribute('for', $for_id);
477     return $label;
478   }
479
480   public function createElementJS($jsdata) {
481     $jselem = $this->createElement('script');
482     // Note: type can/should be left out for HTML5.
483     $jselem->setAttribute('type', 'text/javascript');
484     $jselem->appendChild($this->createCDATASection($jsdata));
485     return $jselem;
486   }
487
488   public function createElementJSFile($jsURL, $defer = false, $async = false) {
489     $jselem = $this->createElement('script');
490     // Note: type can/should be left out for HTML5.
491     $jselem->setAttribute('type', 'text/javascript');
492     if ($defer) {
493       $jselem->setAttribute('defer', '');
494     }
495     if ($async) {
496       $jselem->setAttribute('async', '');
497     }
498     $jselem->setAttribute('src', $jsURL);
499     return $jselem;
500   }
501 }
502
503 class ExtendedElement extends DOMElement {
504   // ExtendedElement PHP class
505   // this extends the general PHP DOM Element class to simplify some usual constructs
506   //
507   // public function appendElement($name, [$value])
508   //   appends a DOMDocument::createElement() as a child of this element (see there for params)
509   //     returns the new child
510   //
511   // public function appendElementXML($name, $xmldata)
512   //   appends a DOMDocument::createElement() with the given name as a child of this element,
513   //   with an ExtendedDocument::createXMLFragment() of the given XML data inside
514   //     returns the new child
515   //
516   // public function appendLink($target, [$value])
517   //   appends an ExtendedDocument::createElementLink() as a child of this element (see there for params)
518   //     returns the new child
519   //
520   // public function appendImage($src, [$alt_text])
521   //   appends an ExtendedDocument::createElementImage() as a child of this document (see there for params)
522   //     returns the new child
523   //
524   // public function appendForm($action, $method, $name, [$id])
525   //   appends an ExtendedDocument::createElementForm() as a child of this element (see there for params)
526   //     returns the new child
527   //
528   // public function appendFormDiv($action, $method, $name, [$id])
529   //   appends an ExtendedDocument::createElementForm() as a child of this element (see there for params)
530   //     returns an HTML <div> that is a child of the new child
531   //
532   // public function appendInputHidden($name, $value)
533   //   appends an ExtendedDocument::createElementInputHidden() as a child of this element (see there for params)
534   //     returns the new child
535   //
536   // public function appendInputText($name, $maxlength, $size, [$id], [$value])
537   //   appends an ExtendedDocument::createElementInputText() as a child of this element (see there for params)
538   //     returns the new child
539   //
540   // public function appendInputNumber($name, $maxlength, $size, [$id], [$value])
541   //   appends an ExtendedDocument::createElementInputNumber() as a child of this element (see there for params)
542   //     returns the new child
543   //
544   // public function appendInputEmail($name, $maxlength, $size, [$id], [$value])
545   //   appends an ExtendedDocument::createElementInputEmail() as a child of this element (see there for params)
546   //     returns the new child
547   //
548   // public function appendInputPassword($name, $maxlength, $size, [$id], [$value])
549   //   appends an ExtendedDocument::createElementInputPassword() as a child of this element (see there for params)
550   //     returns the new child
551   //
552   // public function appendInputRadio($name, $id, $value, $checked)
553   //   appends an ExtendedDocument::createElementInputRadio() as a child of this element (see there for params)
554   //     returns the new child
555   //
556   // public function appendInputCheckbox($name, $id, $value, $checked)
557   //   appends an ExtendedDocument::createElementInputCheckbox() as a child of this element (see there for params)
558   //     returns the new child
559   //
560   // public function appendInputFile($name, $id, $accept)
561   //   appends an ExtendedDocument::createElementInputFile() as a child of this element (see there for params)
562   //     returns the new child
563   //
564   // public function appendInputSubmit($value)
565   //   appends an ExtendedDocument::createElementInputSubmit() as a child of this element (see there for params)
566   //     returns the new child
567   //
568   // public function appendButton($value, $onclick = null)
569   //   appends an ExtendedDocument::createElementButton() as a child of this element (see there for params)
570   //     returns the new child
571   //
572   // public function appendTextArea($name, $columns, $rows, [$id], [$value])
573   //   appends an ExtendedDocument::createElementTextArea() as a child of this element (see there for params)
574   //     returns the new child
575   //
576   // public function appendElementSelect($name, [$id], [$options], [$default])
577   //   appends an ExtendedDocument::createElementSelect() as a child of this element (see there for params)
578   //     returns the new child
579   //
580   // public function appendElementOption($key, $desc, [$selected])
581   //   appends an ExtendedDocument::createElementOption() as a child of this element (see there for params)
582   //     returns the new child
583   //
584   // public function appendLabel($for_id, $value)
585   //   appends an ExtendedDocument::createElementLabel() as a child of this element (see there for params)
586   //     returns the new child
587   //
588   // public function appendText($text)
589   //   appends a DOMDocument::createTextNode() as a child of this element (see there for params)
590   //     returns the new child
591   //
592   // public function appendEntity($name)
593   //   appends a DOMDocument::createEntityReference() as a child of this element (see there for params)
594   //     returns the new child
595   //
596   // public function appendComment($comment_data)
597   //   appends a DOMDocument::createComment() as a child of this element (see there for params)
598   //     returns the new child
599   //
600   // public function appendHTMLMarkup($htmldata)
601   //   appends a representation of the HTML data as children of this element
602   //     NO return value!
603   //
604   // public function appendXMLMarkup($xmldata)
605   //   appends a representation of the XML data as children of this element
606   //     NO return value!
607   //
608   // public function appendJSElement($jsdata)
609   //   appends an ExtendedDocument::createElementJS() as a child of this element (see there for params)
610   //     NO return value!
611   //
612   // public function appendJSFile($jsURL, [$defer], [$async])
613   //   appends an ExtendedDocument::createElementJSFile() as a child of this element (see there for params)
614   //     returns the new child
615
616   public function appendElement($name, $value = '') {
617     return $this->appendChild($this->ownerDocument->createElement($name, $value));
618   }
619   public function appendElementXML($name, $xmldata) {
620     $aelem = $this->appendChild($this->ownerDocument->createElement($name));
621     $aelem->appendXMLMarkup($xmldata);
622     return $aelem;
623   }
624   public function appendLink($target, $value = '') {
625     return $this->appendChild($this->ownerDocument->createElementLink($target, $value));
626   }
627   public function appendImage($src, $alt_text = '') {
628     return $this->appendChild($this->ownerDocument->createElementImage($src, $alt_text));
629   }
630   public function appendForm($action, $method, $name, $id = null) {
631     return $this->appendChild($this->ownerDocument->createElementForm($action, $method, $name, $id));
632   }
633   public function appendFormDiv($action, $method, $name, $id = null) {
634     $formelem = $this->appendChild($this->ownerDocument->createElementForm($action, $method, $name, $id));
635     return $formelem->appendElement('div');
636   }
637   public function appendInputHidden($name, $value) {
638     return $this->appendChild($this->ownerDocument->createElementInputHidden($name, $value));
639   }
640   public function appendInputText($name, $maxlength, $size, $id = null, $value = null) {
641     return $this->appendChild($this->ownerDocument->createElementInputText($name, $maxlength, $size, $id, $value));
642   }
643   public function appendInputNumber($name, $maxlength, $size, $id = null, $value = null) {
644     return $this->appendChild($this->ownerDocument->createElementInputNumber($name, $maxlength, $size, $id, $value));
645   }
646   public function appendInputEmail($name, $maxlength, $size, $id = null, $value = null) {
647     return $this->appendChild($this->ownerDocument->createElementInputEmail($name, $maxlength, $size, $id, $value));
648   }
649   public function appendInputPassword($name, $maxlength, $size, $id = null, $value = null) {
650     return $this->appendChild($this->ownerDocument->createElementInputPassword($name, $maxlength, $size, $id, $value));
651   }
652   public function appendInputRadio($name, $id, $value, $checked) {
653     return $this->appendChild($this->ownerDocument->createElementInputRadio($name, $id, $value, $checked));
654   }
655   public function appendInputCheckbox($name, $id, $value, $checked) {
656     return $this->appendChild($this->ownerDocument->createElementInputCheckbox($name, $id, $value, $checked));
657   }
658   public function appendInputFile($name, $id, $accept) {
659     return $this->appendChild($this->ownerDocument->createElementInputFile($name, $id, $accept));
660   }
661   public function appendInputSubmit($value) {
662     return $this->appendChild($this->ownerDocument->createElementInputSubmit($value));
663   }
664   public function appendButton($value, $onclick = null) {
665     return $this->appendChild($this->ownerDocument->createElementButton($value, $onclick));
666   }
667   public function appendTextArea($name, $columns, $rows, $id = null, $value = null) {
668     return $this->appendChild($this->ownerDocument->createElementTextArea($name, $columns, $rows, $id, $value));
669   }
670   public function appendElementSelect($name, $id = null, $options = array(), $default = null) {
671     return $this->appendChild($this->ownerDocument->createElementSelect($name, $id, $options, $default));
672   }
673   public function appendElementOption($key, $desc, $selected = false) {
674     return $this->appendChild($this->ownerDocument->createElementOption($key, $desc, $selected));
675   }
676   public function appendLabel($for_id, $value) {
677     return $this->appendChild($this->ownerDocument->createElementLabel($for_id, $value));
678   }
679   public function appendText($text) {
680     return $this->appendChild($this->ownerDocument->createTextNode($text));
681   }
682   public function appendEntity($name) {
683     return $this->appendChild($this->ownerDocument->createEntityReference($name));
684   }
685   public function appendComment($comment_data) {
686     return $this->appendChild($this->ownerDocument->createComment($comment_data));
687   }
688   public function appendHTMLMarkup($htmldata) {
689     $this->ownerDocument->appendHTMLMarkup($htmldata, $this);
690   }
691   public function appendXMLMarkup($xmldata) {
692     $this->ownerDocument->appendXMLMarkup($xmldata, $this);
693   }
694   public function appendJSElement($jsdata) {
695     $this->appendChild($this->ownerDocument->createElementJS($jsdata));
696   }
697   public function appendJSFile($jsdata, $defer = false, $async = false) {
698     return $this->appendChild($this->ownerDocument->createElementJSFile($jsdata, $defer, $async));
699   }
700 }
701
702 class ExtendedDocumentFragment extends DOMDocumentFragment {
703   // ExtendedDocumentFragment PHP class
704   // this extends the general PHP DOM Document Fragment class to simplify some usual constructs
705   //
706   // public function appendElement($name, [$value])
707   //   appends a DOMDocument::createElement() as a child of this fragment (see there for params)
708   //     returns the new child
709   //
710   // public function appendElementXML($name, $xmldata)
711   //   appends a DOMDocument::createElement() with the given name as a child of this fragment,
712   //   with an ExtendedDocument::createXMLFragment() of the given XML data inside
713   //     returns the new child
714   //
715   // public function appendLink($target, [$value])
716   //   appends an ExtendedDocument::createElementLink() as a child of this fragment (see there for params)
717   //     returns the new child
718   //
719   // public function appendImage($src, [$alt_text])
720   //   appends an ExtendedDocument::createElementImage() as a child of this document (see there for params)
721   //     returns the new child
722   //
723   // public function appendForm($action, $method, $name, [$id])
724   //   appends an ExtendedDocument::createElementForm() as a child of this fragment (see there for params)
725   //     returns the new child
726   //
727   // public function appendFormDiv($action, $method, $name, [$id])
728   //   appends an ExtendedDocument::createElementForm() as a child of this fragment (see there for params)
729   //     returns an HTML <div> that is a child of the new child
730   //
731   // public function appendInputHidden($name, $value)
732   //   appends an ExtendedDocument::createElementInputHidden() as a child of this fragment (see there for params)
733   //     returns the new child
734   //
735   // public function appendInputText($name, $maxlength, $size, [$id], [$value])
736   //   appends an ExtendedDocument::createElementInputText() as a child of this fragment (see there for params)
737   //     returns the new child
738   //
739   // public function appendInputNumber($name, $maxlength, $size, [$id], [$value])
740   //   appends an ExtendedDocument::createElementInputNumber() as a child of this fragment (see there for params)
741   //     returns the new child
742   //
743   // public function appendInputEmail($name, $maxlength, $size, [$id], [$value])
744   //   appends an ExtendedDocument::createElementInputEmail() as a child of this fragment (see there for params)
745   //     returns the new child
746   //
747   // public function appendInputPassword($name, $maxlength, $size, [$id], [$value])
748   //   appends an ExtendedDocument::createElementInputPassword() as a child of this fragment (see there for params)
749   //     returns the new child
750   //
751   // public function appendInputRadio($name, $id, $value, $checked)
752   //   appends an ExtendedDocument::createElementInputRadio() as a child of this fragment (see there for params)
753   //     returns the new child
754   //
755   // public function appendInputCheckbox($name, $id, $value, $checked)
756   //   appends an ExtendedDocument::createElementInputCheckbox() as a child of this fragment (see there for params)
757   //     returns the new child
758   //
759   // public function appendInputFile($name, $id, $accept)
760   //   appends an ExtendedDocument::createElementInputFile() as a child of this fragment (see there for params)
761   //     returns the new child
762   //
763   // public function appendInputSubmit($value)
764   //   appends an ExtendedDocument::createElementInputSubmit() as a child of this fragment (see there for params)
765   //     returns the new child
766   //
767   // public function appendButton($value, $onclick = null)
768   //   appends an ExtendedDocument::createElementButton() as a child of this fragment (see there for params)
769   //     returns the new child
770   //
771   // public function appendTextArea($name, $columns, $rows, [$id], [$value])
772   //   appends an ExtendedDocument::createElementTextArea() as a child of this fragment (see there for params)
773   //     returns the new child
774   //
775   // public function appendElementSelect($name, [$id], [$options], [$default])
776   //   appends an ExtendedDocument::createElementSelect() as a child of this fragment (see there for params)
777   //     returns the new child
778   //
779   // public function appendElementOption($key, $desc, [$selected])
780   //   appends an ExtendedDocument::createElementOption() as a child of this fragment (see there for params)
781   //     returns the new child
782   //
783   // public function appendLabel($for_id, $value)
784   //   appends an ExtendedDocument::createElementLabel() as a child of this fragment (see there for params)
785   //     returns the new child
786   //
787   // public function appendText($text)
788   //   appends a DOMDocument::createTextNode() as a child of this fragment (see there for params)
789   //     returns the new child
790   //
791   // public function appendEntity($name)
792   //   appends a DOMDocument::createEntityReference() as a child of this fragment (see there for params)
793   //     returns the new child
794   //
795   // public function appendComment($comment_data)
796   //   appends a DOMDocument::createComment() as a child of this fragment (see there for params)
797   //     returns the new child
798   //
799   // public function appendHTMLMarkup($htmldata)
800   //   appends a representation of the HTML data as children of this fragment
801   //     NO return value!
802   //
803   // public function appendXMLMarkup($xmldata)
804   //   appends a representation of the XML data as children of this fragment
805   //     NO return value!
806   //
807   // public function appendJSElement($jsdata)
808   //   appends an ExtendedDocument::createElementJS() as a child of this fragment (see there for params)
809   //     NO return value!
810   //
811   // public function appendJSFile($jsURL, [$defer], [$async])
812   //   appends an ExtendedDocument::createElementJSFile() as a child of this fragment (see there for params)
813   //     returns the new child
814
815   public function appendElement($name, $value = '') {
816     return $this->appendChild($this->ownerDocument->createElement($name, $value));
817   }
818   public function appendElementXML($name, $xmldata) {
819     $aelem = $this->appendChild($this->ownerDocument->createElement($name));
820     $aelem->appendXMLMarkup($xmldata);
821     return $aelem;
822   }
823   public function appendLink($target, $value = '') {
824     return $this->appendChild($this->ownerDocument->createElementLink($target, $value));
825   }
826   public function appendImage($src, $alt_text = '') {
827     return $this->appendChild($this->ownerDocument->createElementImage($src, $alt_text));
828   }
829   public function appendForm($action, $method, $name, $id = null) {
830     return $this->appendChild($this->ownerDocument->createElementForm($action, $method, $name, $id));
831   }
832   public function appendFormDiv($action, $method, $name, $id = null) {
833     $formelem = $this->appendChild($this->ownerDocument->createElementForm($action, $method, $name, $id));
834     return $formelem->appendElement('div');
835   }
836   public function appendInputHidden($name, $value) {
837     return $this->appendChild($this->ownerDocument->createElementInputHidden($name, $value));
838   }
839   public function appendInputText($name, $maxlength, $size, $id = null, $value = null) {
840     return $this->appendChild($this->ownerDocument->createElementInputText($name, $maxlength, $size, $id, $value));
841   }
842   public function appendInputNumber($name, $maxlength, $size, $id = null, $value = null) {
843     return $this->appendChild($this->ownerDocument->createElementInputNumber($name, $maxlength, $size, $id, $value));
844   }
845   public function appendInputEmail($name, $maxlength, $size, $id = null, $value = null) {
846     return $this->appendChild($this->ownerDocument->createElementInputEmail($name, $maxlength, $size, $id, $value));
847   }
848   public function appendInputPassword($name, $maxlength, $size, $id = null, $value = null) {
849     return $this->appendChild($this->ownerDocument->createElementInputPassword($name, $maxlength, $size, $id, $value));
850   }
851   public function appendInputRadio($name, $id, $value, $checked) {
852     return $this->appendChild($this->ownerDocument->createElementInputRadio($name, $id, $value, $checked));
853   }
854   public function appendInputCheckbox($name, $id, $value, $checked) {
855     return $this->appendChild($this->ownerDocument->createElementInputCheckbox($name, $id, $value, $checked));
856   }
857   public function appendInputFile($name, $id, $accept) {
858     return $this->appendChild($this->ownerDocument->createElementInputFile($name, $id, $accept));
859   }
860   public function appendInputSubmit($value) {
861     return $this->appendChild($this->ownerDocument->createElementInputSubmit($value));
862   }
863   public function appendButton($value, $onclick = null) {
864     return $this->appendChild($this->ownerDocument->createElementButton($value, $onclick));
865   }
866   public function appendTextArea($name, $columns, $rows, $id = null, $value = null) {
867     return $this->appendChild($this->ownerDocument->createElementTextArea($name, $columns, $rows, $id, $value));
868   }
869   public function appendElementSelect($name, $id = null, $options = array(), $default = null) {
870     return $this->appendChild($this->ownerDocument->createElementSelect($name, $id, $options, $default));
871   }
872   public function appendElementOption($key, $desc, $selected = false) {
873     return $this->appendChild($this->ownerDocument->createElementOption($key, $desc, $selected));
874   }
875   public function appendLabel($for_id, $value) {
876     return $this->appendChild($this->ownerDocument->createElementLabel($for_id, $value));
877   }
878   public function appendText($text) {
879     return $this->appendChild($this->ownerDocument->createTextNode($text));
880   }
881   public function appendEntity($name) {
882     return $this->appendChild($this->ownerDocument->createEntityReference($name));
883   }
884   public function appendComment($comment_data) {
885     return $this->appendChild($this->ownerDocument->createComment($comment_data));
886   }
887   public function appendHTMLMarkup($htmldata) {
888     $this->ownerDocument->appendHTMLMarkup($htmldata, $this);
889   }
890   public function appendXMLMarkup($xmldata) {
891     $this->ownerDocument->appendXMLMarkup($xmldata, $this);
892   }
893   public function appendJSElement($jsdata) {
894     $this->appendChild($this->ownerDocument->createElementJS($jsdata));
895   }
896   public function appendJSFile($jsdata, $defer = false, $async = false) {
897     return $this->appendChild($this->ownerDocument->createElementJSFile($jsdata, $defer, $async));
898   }
899 }
900 ?>