add a static function that will initialize a new document as a basic HTML5 template

[php-utility-classes.git] / include / cbsm / util / document.php-class

diff --git a/include/cbsm/util/document.php-class b/include/cbsm/util/document.php-class
index a10041a9dc6c2b2e9cfaeb02b5816978e694f680..b708d1cb3a32c779575016b40beb70d0f2587c18 100755 (executable)
--- a/include/cbsm/util/document.php-class
+++ b/include/cbsm/util/document.php-class
@@ -27,11 +27,9 @@ class ExtendedDocument extends DOMDocument {
   //   CONSTRUCTOR
   //   construct a new DOM Document that uses our element definitions
   //
-  // private $xmheader
-  //   the default XML header
-  //
-  // private $xhtmldtype
-  //   the XHTML doctype to use by default
+  // static function initHTML5()
+  //   initialize as an HTML5 document and return references to its basic elements.
+  //     returns an associative array with the following elements: 'html', 'head', 'title', 'body'
   //
   // function appendElement($name, [$value])
   //   appends a DOMDocument::createElement() as a child of this document (see there for params)
@@ -50,7 +48,11 @@ class ExtendedDocument extends DOMDocument {
   //   appends an ExtendedDocument::createElementImage() as a child of this document (see there for params)
   //     returns the new child
   //
-  // function appendFormDiv($action, $method, $name)
+  // function appendForm($action, $method, $name, [$id])
+  //   appends an ExtendedDocument::createElementForm() as a child of this document (see there for params)
+  //     returns the new child
+  //
+  // function appendFormDiv($action, $method, $name, [$id])
   //   appends an ExtendedDocument::createElementForm() as a child of this document (see there for params)
   //     returns an HTML <div> that is a child of the new child
   //
@@ -62,6 +64,10 @@ class ExtendedDocument extends DOMDocument {
   //   appends an ExtendedDocument::createElementInputText() as a child of this document (see there for params)
   //     returns the new child
   //
+  // function appendInputNumber($name, $maxlength, $size, [$id], [$value])
+  //   appends an ExtendedDocument::createElementInputNumber() as a child of this document (see there for params)
+  //     returns the new child
+  //
   // function appendInputPassword($name, $maxlength, $size, [$id], [$value])
   //   appends an ExtendedDocument::createElementInputPassword() as a child of this document (see there for params)
   //     returns the new child
@@ -74,6 +80,10 @@ class ExtendedDocument extends DOMDocument {
   //   appends an ExtendedDocument::createElementInputCheckbox() as a child of this document (see there for params)
   //     returns the new child
   //
+  // function appendInputFile($name, $id, $accept)
+  //   appends an ExtendedDocument::createElementInputFile() as a child of this document (see there for params)
+  //     returns the new child
+  //
   // function appendInputSubmit($value)
   //   appends an ExtendedDocument::createElementInputSubmit() as a child of this document (see there for params)
   //     returns the new child
@@ -139,6 +149,10 @@ class ExtendedDocument extends DOMDocument {
   //   returns an ExtendedElement that is an HTML <input> of type 'text' with the given name, maxlength, size,
   //   and optionally id and value
   //
+  // function createElementInputNumber($name, $maxlength, $size, [$id], [$value])
+  //   returns an ExtendedElement that is an HTML <input> of type 'number' with the given name, maxlength, size,
+  //   and optionally id and value
+  //
   // function createElementInputPassword($name, $maxlength, $size, [$id], [$value])
   //   returns an ExtendedElement that is an HTML <input> of type 'password' with the given name, maxlength, size,
   //   and optionally id and value
@@ -151,6 +165,9 @@ class ExtendedDocument extends DOMDocument {
   //   returns an ExtendedElement that is an HTML <input> of type 'checkbox' with the given name, id, value and
   //   checked state
   //
+  // function createElementInputFile($name, $id, $accept)
+  //   returns an ExtendedElement that is an HTML <input> of type 'file' with the given name, id and accept
+  //
   // function createElementInputSubmit($value)
   //   returns an ExtendedElement that is an HTML <input> of type 'submit' with the given value as label
   //
@@ -186,6 +203,23 @@ class ExtendedDocument extends DOMDocument {
     $this->registerNodeClass('DOMDocumentFragment', 'ExtendedDocumentFragment');
   }
 
+  static function initHTML5() {
+    $doc = new ExtendedDocument();
+    $doc->loadHTML('<!DOCTYPE html><html></html>'); // this seems to be the only way to get the DOCTYPE set properly.
+
+    // Created basic HTML document structure.
+    $root = $doc->getElementsByTagName('html')->item(0);
+    $head = $root->appendElement('head');
+    $title = $head->appendElement('title');
+    $body = $root->appendElement('body');
+
+    return array('document' => $doc,
+                 'html' => $root,
+                 'head' => $head,
+                 'title' => $title,
+                 'body' => $body);
+  }
+
   function appendElement($name, $value = '') {
     return $this->appendChild($this->createElement($name, $value));
   }
@@ -201,8 +235,11 @@ class ExtendedDocument extends DOMDocument {
   function appendImage($src, $alt_text = '') {
     return $this->appendChild($this->createElementImage($src, $alt_text));
   }
-  function appendFormDiv($action, $method, $name) {
-    $formelem = $this->appendChild($this->createElementForm($action, $method, $name));
+  function appendForm($action, $method, $name, $id = null) {
+    return $this->appendChild($this->createElementForm($action, $method, $name, $id));
+  }
+  function appendFormDiv($action, $method, $name, $id = null) {
+    $formelem = $this->appendChild($this->createElementForm($action, $method, $name, $id));
     return $formelem->appendElement('div');
   }
   function appendInputHidden($name, $value) {
@@ -211,6 +248,9 @@ class ExtendedDocument extends DOMDocument {
   function appendInputText($name, $maxlength, $size, $id = null, $value = null) {
     return $this->appendChild($this->createElementInputText($name, $maxlength, $size, $id, $value));
   }
+  function appendInputNumber($name, $maxlength, $size, $id = null, $value = null) {
+    return $this->appendChild($this->createElementInputNumber($name, $maxlength, $size, $id, $value));
+  }
   function appendInputPassword($name, $maxlength, $size, $id = null, $value = null) {
     return $this->appendChild($this->createElementInputPassword($name, $maxlength, $size, $id, $value));
   }
@@ -220,6 +260,9 @@ class ExtendedDocument extends DOMDocument {
   function appendInputCheckbox($name, $id, $value, $checked) {
     return $this->appendChild($this->createElementInputCheckbox($name, $id, $value, $checked));
   }
+  function appendInputFile($name, $id, $accept) {
+    return $this->appendChild($this->createElementInputFile($name, $id, $accept));
+  }
   function appendInputSubmit($value) {
     return $this->appendChild($this->createElementInputSubmit($value));
   }
@@ -269,6 +312,13 @@ class ExtendedDocument extends DOMDocument {
     }
   }
 
+  function createElement($name, $value = '') {
+    // Adding the $value in DOMDocument's createElement does NOT escape it, so override it and use appendText to support that.
+    $aelem = parent::createElement($name);
+    $aelem->appendText($value);
+    return $aelem;
+  }
+
   function createElementLink($target, $value = '') {
     $link = $this->createElement('a', $value);
     $link->setAttribute('href', $target); // XXX: take care of & etc. in links
@@ -276,17 +326,18 @@ class ExtendedDocument extends DOMDocument {
   }
 
   function createElementImage($src, $alt_text = '') {
-    $link = $this->createElement('img');
-    $link->setAttribute('src', $src);
-    $link->setAttribute('alt', $alt_text);
-    return $link;
+    $img = $this->createElement('img');
+    $img->setAttribute('src', $src);
+    $img->setAttribute('alt', $alt_text);
+    return $img;
   }
 
-  function createElementForm($action, $method, $name) {
+  function createElementForm($action, $method, $name, $id = null) {
     $formelem = $this->createElement('form');
     $formelem->setAttribute('action', $action);
     $formelem->setAttribute('method', $method);
     $formelem->setAttribute('name', $name);
+    $formelem->setAttribute('id', $id);
     return $formelem;
   }
 
@@ -309,9 +360,9 @@ class ExtendedDocument extends DOMDocument {
     return $txfield;
   }
 
-  function createElementInputPassword($name, $maxlength, $size, $id = null, $value = null) {
+  function createElementInputNumber($name, $maxlength, $size, $id = null, $value = null) {
     $txfield = $this->createElement('input');
-    $txfield->setAttribute('type', 'password');
+    $txfield->setAttribute('type', 'number');
     if (!is_null($id)) { $txfield->setAttribute('id', $id); }
     $txfield->setAttribute('name', $name);
     $txfield->setAttribute('maxlength', $maxlength);
@@ -320,11 +371,22 @@ class ExtendedDocument extends DOMDocument {
     return $txfield;
   }
 
+  function createElementInputPassword($name, $maxlength, $size, $id = null, $value = null) {
+    $pwfield = $this->createElement('input');
+    $pwfield->setAttribute('type', 'password');
+    if (!is_null($id)) { $pwfield->setAttribute('id', $id); }
+    $pwfield->setAttribute('name', $name);
+    $pwfield->setAttribute('maxlength', $maxlength);
+    $pwfield->setAttribute('size', $size);
+    if (!is_null($value)) { $pwfield->setAttribute('value', $value); }
+    return $pwfield;
+  }
+
   function createElementInputRadio($name, $id, $value, $checked) {
     $radio = $this->createElement('input');
     $radio->setAttribute('type', 'radio');
     $radio->setAttribute('name', $name);
-    $radio->setAttribute('id', $id);
+    if (!is_null($id)) { $radio->setAttribute('id', $id); }
     $radio->setAttribute('value', $value);
     if ($checked) { $radio->setAttribute('checked', ''); }
     return $radio;
@@ -334,12 +396,21 @@ class ExtendedDocument extends DOMDocument {
     $cbox = $this->createElement('input');
     $cbox->setAttribute('type', 'checkbox');
     $cbox->setAttribute('name', $name);
-    $cbox->setAttribute('id', $id);
+    if (!is_null($id)) { $cbox->setAttribute('id', $id); }
     $cbox->setAttribute('value', $value);
     if ($checked) { $cbox->setAttribute('checked', ''); }
     return $cbox;
   }
 
+  function createElementInputFile($name, $id, $accept) {
+    $fileinput = $this->createElement('input');
+    $fileinput->setAttribute('type', 'file');
+    $fileinput->setAttribute('name', $name);
+    if (!is_null($id)) { $fileinput->setAttribute('id', $id); }
+    $fileinput->setAttribute('accept', $accept);
+    return $fileinput;
+  }
+
   function createElementInputSubmit($value) {
     $submitbtn = $this->createElement('input');
     $submitbtn->setAttribute('type', 'submit');
@@ -426,7 +497,11 @@ class ExtendedElement extends DOMElement {
   //   appends an ExtendedDocument::createElementImage() as a child of this document (see there for params)
   //     returns the new child
   //
-  // function appendFormDiv($action, $method, $name)
+  // function appendForm($action, $method, $name, [$id])
+  //   appends an ExtendedDocument::createElementForm() as a child of this element (see there for params)
+  //     returns the new child
+  //
+  // function appendFormDiv($action, $method, $name, [$id])
   //   appends an ExtendedDocument::createElementForm() as a child of this element (see there for params)
   //     returns an HTML <div> that is a child of the new child
   //
@@ -438,6 +513,10 @@ class ExtendedElement extends DOMElement {
   //   appends an ExtendedDocument::createElementInputText() as a child of this element (see there for params)
   //     returns the new child
   //
+  // function appendInputNumber($name, $maxlength, $size, [$id], [$value])
+  //   appends an ExtendedDocument::createElementInputNumber() as a child of this element (see there for params)
+  //     returns the new child
+  //
   // function appendInputPassword($name, $maxlength, $size, [$id], [$value])
   //   appends an ExtendedDocument::createElementInputPassword() as a child of this element (see there for params)
   //     returns the new child
@@ -450,6 +529,10 @@ class ExtendedElement extends DOMElement {
   //   appends an ExtendedDocument::createElementInputCheckbox() as a child of this element (see there for params)
   //     returns the new child
   //
+  // function appendInputFile($name, $id, $accept)
+  //   appends an ExtendedDocument::createElementInputFile() as a child of this element (see there for params)
+  //     returns the new child
+  //
   // function appendInputSubmit($value)
   //   appends an ExtendedDocument::createElementInputSubmit() as a child of this element (see there for params)
   //     returns the new child
@@ -512,8 +595,11 @@ class ExtendedElement extends DOMElement {
   function appendImage($src, $alt_text = '') {
     return $this->appendChild($this->ownerDocument->createElementImage($src, $alt_text));
   }
-  function appendFormDiv($action, $method, $name) {
-    $formelem = $this->appendChild($this->ownerDocument->createElementForm($action, $method, $name));
+  function appendForm($action, $method, $name, $id = null) {
+    return $this->appendChild($this->ownerDocument->createElementForm($action, $method, $name, $id));
+  }
+  function appendFormDiv($action, $method, $name, $id = null) {
+    $formelem = $this->appendChild($this->ownerDocument->createElementForm($action, $method, $name, $id));
     return $formelem->appendElement('div');
   }
   function appendInputHidden($name, $value) {
@@ -522,6 +608,9 @@ class ExtendedElement extends DOMElement {
   function appendInputText($name, $maxlength, $size, $id = null, $value = null) {
     return $this->appendChild($this->ownerDocument->createElementInputText($name, $maxlength, $size, $id, $value));
   }
+  function appendInputNumber($name, $maxlength, $size, $id = null, $value = null) {
+    return $this->appendChild($this->ownerDocument->createElementInputNumber($name, $maxlength, $size, $id, $value));
+  }
   function appendInputPassword($name, $maxlength, $size, $id = null, $value = null) {
     return $this->appendChild($this->ownerDocument->createElementInputPassword($name, $maxlength, $size, $id, $value));
   }
@@ -531,6 +620,9 @@ class ExtendedElement extends DOMElement {
   function appendInputCheckbox($name, $id, $value, $checked) {
     return $this->appendChild($this->ownerDocument->createElementInputCheckbox($name, $id, $value, $checked));
   }
+  function appendInputFile($name, $id, $accept) {
+    return $this->appendChild($this->ownerDocument->createElementInputFile($name, $id, $accept));
+  }
   function appendInputSubmit($value) {
     return $this->appendChild($this->ownerDocument->createElementInputSubmit($value));
   }
@@ -590,7 +682,11 @@ class ExtendedDocumentFragment extends DOMDocumentFragment {
   //   appends an ExtendedDocument::createElementImage() as a child of this document (see there for params)
   //     returns the new child
   //
-  // function appendFormDiv($action, $method, $name)
+  // function appendForm($action, $method, $name, [$id])
+  //   appends an ExtendedDocument::createElementForm() as a child of this fragment (see there for params)
+  //     returns the new child
+  //
+  // function appendFormDiv($action, $method, $name, [$id])
   //   appends an ExtendedDocument::createElementForm() as a child of this fragment (see there for params)
   //     returns an HTML <div> that is a child of the new child
   //
@@ -602,6 +698,10 @@ class ExtendedDocumentFragment extends DOMDocumentFragment {
   //   appends an ExtendedDocument::createElementInputText() as a child of this fragment (see there for params)
   //     returns the new child
   //
+  // function appendInputNumber($name, $maxlength, $size, [$id], [$value])
+  //   appends an ExtendedDocument::createElementInputNumber() as a child of this fragment (see there for params)
+  //     returns the new child
+  //
   // function appendInputPassword($name, $maxlength, $size, [$id], [$value])
   //   appends an ExtendedDocument::createElementInputPassword() as a child of this fragment (see there for params)
   //     returns the new child
@@ -614,6 +714,10 @@ class ExtendedDocumentFragment extends DOMDocumentFragment {
   //   appends an ExtendedDocument::createElementInputCheckbox() as a child of this fragment (see there for params)
   //     returns the new child
   //
+  // function appendInputFile($name, $id, $accept)
+  //   appends an ExtendedDocument::createElementInputFile() as a child of this fragment (see there for params)
+  //     returns the new child
+  //
   // function appendInputSubmit($value)
   //   appends an ExtendedDocument::createElementInputSubmit() as a child of this fragment (see there for params)
   //     returns the new child
@@ -676,8 +780,11 @@ class ExtendedDocumentFragment extends DOMDocumentFragment {
   function appendImage($src, $alt_text = '') {
     return $this->appendChild($this->ownerDocument->createElementImage($src, $alt_text));
   }
-  function appendFormDiv($action, $method, $name) {
-    $formelem = $this->appendChild($this->ownerDocument->createElementForm($action, $method, $name));
+  function appendForm($action, $method, $name, $id = null) {
+    return $this->appendChild($this->ownerDocument->createElementForm($action, $method, $name, $id));
+  }
+  function appendFormDiv($action, $method, $name, $id = null) {
+    $formelem = $this->appendChild($this->ownerDocument->createElementForm($action, $method, $name, $id));
     return $formelem->appendElement('div');
   }
   function appendInputHidden($name, $value) {
@@ -686,6 +793,9 @@ class ExtendedDocumentFragment extends DOMDocumentFragment {
   function appendInputText($name, $maxlength, $size, $id = null, $value = null) {
     return $this->appendChild($this->ownerDocument->createElementInputText($name, $maxlength, $size, $id, $value));
   }
+  function appendInputNumber($name, $maxlength, $size, $id = null, $value = null) {
+    return $this->appendChild($this->ownerDocument->createElementInputNumber($name, $maxlength, $size, $id, $value));
+  }
   function appendInputPassword($name, $maxlength, $size, $id = null, $value = null) {
     return $this->appendChild($this->ownerDocument->createElementInputPassword($name, $maxlength, $size, $id, $value));
   }
@@ -695,6 +805,9 @@ class ExtendedDocumentFragment extends DOMDocumentFragment {
   function appendInputCheckbox($name, $id, $value, $checked) {
     return $this->appendChild($this->ownerDocument->createElementInputCheckbox($name, $id, $value, $checked));
   }
+  function appendInputFile($name, $id, $accept) {
+    return $this->appendChild($this->ownerDocument->createElementInputFile($name, $id, $accept));
+  }
   function appendInputSubmit($value) {
     return $this->appendChild($this->ownerDocument->createElementInputSubmit($value));
   }