add search input, fix warnings in UA class

[php-utility-classes.git] / classes / document.php-class

diff --git a/classes/document.php-class b/classes/document.php-class
index f215f7bc36a275dbc54b320a6f0e7d60e8ceb508..211ae44116cd35bd7ca3e74328591b94cad33576 100755 (executable)
--- a/classes/document.php-class
+++ b/classes/document.php-class
@@ -65,6 +65,10 @@ class ExtendedDocument extends DOMDocument {
   //   appends an ExtendedDocument::createElementInputRange() as a child of this document (see there for params)
   //     returns the new child
   //
+  // public function appendInputSearch($name, $maxlength, $size, [$id], [$value])
+  //   appends an ExtendedDocument::createElementInputSearch() as a child of this document (see there for params)
+  //     returns the new child
+  //
   // public function appendInputUrl($name, $maxlength, $size, [$id], [$value])
   //   appends an ExtendedDocument::createElementInputUrl() as a child of this document (see there for params)
   //     returns the new child
@@ -125,6 +129,10 @@ class ExtendedDocument extends DOMDocument {
   //   appends an ExtendedDocument::createElementLabel() as a child of this document (see there for params)
   //     returns the new child
   //
+  // public function appendElementDatalist([$id], [$options])
+  //   appends an ExtendedDocument::createElementDatalist() as a child of this document (see there for params)
+  //     returns the new child
+  //
   // public function appendText($text)
   //   appends a DOMDocument::createTextNode() as a child of this document (see there for params)
   //     returns the new child
@@ -173,8 +181,7 @@ class ExtendedDocument extends DOMDocument {
   //   returns an ExtendedElement that is an HTML <img> with the given src and alt attributes (set to '' by default)
   //
   // public function createElementForm($action, $method, $name)
-  //   returns an ExtendedElement that is an HTML <div> that is a child of an HTML <form>
-  //   with the given action, method, and name
+  //   returns an ExtendedElement that is an HTML <form> with the given action, method, and name
   //
   // public function createElementInputHidden($name, $value)
   //   returns an ExtendedElement that is an HTML <input> of type 'hidden' with the given name and value
@@ -199,6 +206,10 @@ class ExtendedDocument extends DOMDocument {
   //   returns an ExtendedElement that is an HTML <input> of type 'url' with the given name, maxlength, size,
   //   and optionally id and value
   //
+  // public function createElementInputSearch($name, $maxlength, $size, [$id], [$value])
+  //   returns an ExtendedElement that is an HTML <input> of type 'search' with the given name, maxlength, size,
+  //   and optionally id and value
+  //
   // public function createElementInputEmail($name, $maxlength, $size, [$id], [$value])
   //   returns an ExtendedElement that is an HTML <input> of type 'email' with the given name, maxlength, size,
   //   and optionally id and value
@@ -251,6 +262,9 @@ class ExtendedDocument extends DOMDocument {
   // public function createElementLabel($for_id, $value)
   //   returns an ExtendedElement that is an HTML <label> with the given 'for' and value
   //
+  // public function createElementDatalist([$id], [$options])
+  //   returns an ExtendedElement that is an HTML <datalist> with optionally the given id and array of options (key => description)
+  //
   // public function createElementStyle($styledata)
   //   returns an ExtendedElement that is an HTML <style> of CSS type with the style data inside
   //
@@ -344,6 +358,9 @@ class ExtendedDocument extends DOMDocument {
   public function appendInputRange($name, $id, $min, $max, $step = null, $value = null) {
     return $this->appendChild($this->createElementInputRange($name, $id, $min, $max, $step, $value));
   }
+  public function appendInputSearch($name, $maxlength, $size, $id = null, $value = null) {
+    return $this->appendChild($this->createElementInputSearch($name, $maxlength, $size, $id, $value));
+  }
   public function appendInputUrl($name, $maxlength, $size, $id = null, $value = null) {
     return $this->appendChild($this->createElementInputUrl($name, $maxlength, $size, $id, $value));
   }
@@ -389,6 +406,9 @@ class ExtendedDocument extends DOMDocument {
   public function appendLabel($for_id, $value) {
     return $this->appendChild($this->createElementLabel($for_id, $value));
   }
+  public function appendElementDatalist($id = null, $options = array()) {
+    return $this->appendChild($this->createElementDatalist($id, $options));
+  }
   public function appendText($text) {
     return $this->appendChild($this->createTextNode($text));
   }
@@ -440,7 +460,7 @@ class ExtendedDocument extends DOMDocument {
   public 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);
-    if (strlen($value)) { $aelem->appendText($value); }
+    if (strlen($value ?? '')) { $aelem->appendText($value); }
     return $aelem;
   }
 
@@ -520,6 +540,17 @@ class ExtendedDocument extends DOMDocument {
     return $rgfield;
   }
 
+  public function createElementInputSearch($name, $maxlength, $size, $id = null, $value = null) {
+    $urlfield = $this->createElement('input');
+    $urlfield->setAttribute('type', 'search');
+    if (!is_null($id)) { $urlfield->setAttribute('id', $id); }
+    $urlfield->setAttribute('name', $name);
+    $urlfield->setAttribute('maxlength', $maxlength);
+    $urlfield->setAttribute('size', $size);
+    if (!is_null($value)) { $urlfield->setAttribute('value', $value); }
+    return $urlfield;
+  }
+
   public function createElementInputUrl($name, $maxlength, $size, $id = null, $value = null) {
     $urlfield = $this->createElement('input');
     $urlfield->setAttribute('type', 'url');
@@ -554,23 +585,25 @@ class ExtendedDocument extends DOMDocument {
   }
 
   public function createElementInputDate($name, $id = null, $min = null, $max = null, $value = null) {
-    $telfield = $this->createElement('input');
-    $telfield->setAttribute('type', 'date');
-    if (!is_null($id)) { $telfield->setAttribute('id', $id); }
-    if (!is_null($min)) { $rgfield->setAttribute('min', $min); }
-    if (!is_null($max)) { $rgfield->setAttribute('max', $max); }
-    if (!is_null($value)) { $telfield->setAttribute('value', $value); }
-    return $telfield;
+    $dtfield = $this->createElement('input');
+    $dtfield->setAttribute('type', 'date');
+    if (!is_null($id)) { $dtfield->setAttribute('id', $id); }
+    $dtfield->setAttribute('name', $name);
+    if (!is_null($min)) { $dtfield->setAttribute('min', $min); }
+    if (!is_null($max)) { $dtfield->setAttribute('max', $max); }
+    if (!is_null($value)) { $dtfield->setAttribute('value', $value); }
+    return $dtfield;
   }
 
   public function createElementInputTime($name, $id = null, $min = null, $max = null, $value = null) {
-    $telfield = $this->createElement('input');
-    $telfield->setAttribute('type', 'time');
-    if (!is_null($id)) { $telfield->setAttribute('id', $id); }
-    if (!is_null($min)) { $rgfield->setAttribute('min', $min); }
-    if (!is_null($max)) { $rgfield->setAttribute('max', $max); }
-    if (!is_null($value)) { $telfield->setAttribute('value', $value); }
-    return $telfield;
+    $timefield = $this->createElement('input');
+    $timefield->setAttribute('type', 'time');
+    if (!is_null($id)) { $timefield->setAttribute('id', $id); }
+    $timefield->setAttribute('name', $name);
+    if (!is_null($min)) { $timefield->setAttribute('min', $min); }
+    if (!is_null($max)) { $timefield->setAttribute('max', $max); }
+    if (!is_null($value)) { $timefield->setAttribute('value', $value); }
+    return $timefield;
   }
 
   public function createElementInputColor($name, $id = null, $value = null) {
@@ -647,7 +680,9 @@ class ExtendedDocument extends DOMDocument {
 
   public function createElementOption($key, $desc, $selected = false) {
     $option = $this->createElement('option', $desc);
-    $option->setAttribute('value', $key);
+    if ($key) {
+      $option->setAttribute('value', $key);
+    }
     if ($selected) { $option->setAttribute('selected', ''); }
     return $option;
   }
@@ -658,6 +693,15 @@ class ExtendedDocument extends DOMDocument {
     return $label;
   }
 
+  public function createElementDatalist($id = null, $options = array()) {
+    $select = $this->createElement('datalist');
+    if (!is_null($id)) { $select->setAttribute('id', $id); }
+    foreach ($options as $key => $desc) {
+      $select->appendElementOption($key, $desc);
+    }
+    return $select;
+  }
+
   public function createElementStyle($styledata) {
     $style_elem = $this->createElement('style');
     // Note: type can/should be left out for HTML5.
@@ -738,6 +782,10 @@ class ExtendedElement extends DOMElement {
   //   appends an ExtendedDocument::createElementInputRange() as a child of this element (see there for params)
   //     returns the new child
   //
+  // public function appendInputSearch($name, $maxlength, $size, [$id], [$value])
+  //   appends an ExtendedDocument::createElementInputSearch() as a child of this element (see there for params)
+  //     returns the new child
+  //
   // public function appendInputUrl($name, $maxlength, $size, [$id], [$value])
   //   appends an ExtendedDocument::createElementInputUrl() as a child of this element (see there for params)
   //     returns the new child
@@ -797,6 +845,10 @@ class ExtendedElement extends DOMElement {
   //   appends an ExtendedDocument::createElementLabel() as a child of this element (see there for params)
   //     returns the new child
   //
+  // public function appendElementDatalist([$id], [$options])
+  //   appends an ExtendedDocument::createElementDatalist() as a child of this element (see there for params)
+  //     returns the new child
+  //
   // public function appendText($text)
   //   appends a DOMDocument::createTextNode() as a child of this element (see there for params)
   //     returns the new child
@@ -884,6 +936,9 @@ class ExtendedElement extends DOMElement {
   public function appendInputRange($name, $id, $min, $max, $step = null, $value = null) {
     return $this->appendChild($this->ownerDocument->createElementInputRange($name, $id, $min, $max, $step, $value));
   }
+  public function appendInputSearch($name, $maxlength, $size, $id = null, $value = null) {
+    return $this->appendChild($this->ownerDocument->createElementInputSearch($name, $maxlength, $size, $id, $value));
+  }
   public function appendInputUrl($name, $maxlength, $size, $id = null, $value = null) {
     return $this->appendChild($this->ownerDocument->createElementInputUrl($name, $maxlength, $size, $id, $value));
   }
@@ -929,8 +984,11 @@ class ExtendedElement extends DOMElement {
   public function appendLabel($for_id, $value) {
     return $this->appendChild($this->ownerDocument->createElementLabel($for_id, $value));
   }
+  public function appendElementDatalist($id = null, $options = array()) {
+    return $this->appendChild($this->ownerDocument->createElementDatalist($id, $options));
+  }
   public function appendText($text) {
-    return $this->appendChild($this->ownerDocument->createTextNode($text));
+    return $this->appendChild($this->ownerDocument->createTextNode($text ?? ''));
   }
   public function appendLinebreak() {
     return $this->appendChild($this->ownerDocument->createElement('br'));
@@ -1023,6 +1081,10 @@ class ExtendedDocumentFragment extends DOMDocumentFragment {
   //   appends an ExtendedDocument::createElementInputRange() as a child of this fragment (see there for params)
   //     returns the new child
   //
+  // public function appendInputSearch($name, $maxlength, $size, [$id], [$value])
+  //   appends an ExtendedDocument::createElementInputSearch() as a child of this fragment (see there for params)
+  //     returns the new child
+  //
   // public function appendInputUrl($name, $maxlength, $size, [$id], [$value])
   //   appends an ExtendedDocument::createElementInputUrl() as a child of this fragment (see there for params)
   //     returns the new child
@@ -1082,6 +1144,10 @@ class ExtendedDocumentFragment extends DOMDocumentFragment {
   //   appends an ExtendedDocument::createElementLabel() as a child of this fragment (see there for params)
   //     returns the new child
   //
+  // public function appendElementDatalist([$id], [$options])
+  //   appends an ExtendedDocument::createElementDatalist() as a child of this fragment (see there for params)
+  //     returns the new child
+  //
   // public function appendText($text)
   //   appends a DOMDocument::createTextNode() as a child of this fragment (see there for params)
   //     returns the new child
@@ -1159,6 +1225,9 @@ class ExtendedDocumentFragment extends DOMDocumentFragment {
   public function appendInputRange($name, $id, $min, $max, $step = null, $value = null) {
     return $this->appendChild($this->ownerDocument->createElementInputRange($name, $id, $min, $max, $step, $value));
   }
+  public function appendInputSearch($name, $maxlength, $size, $id = null, $value = null) {
+    return $this->appendChild($this->ownerDocument->createElementInputSearch($name, $maxlength, $size, $id, $value));
+  }
   public function appendInputUrl($name, $maxlength, $size, $id = null, $value = null) {
     return $this->appendChild($this->ownerDocument->createElementInputUrl($name, $maxlength, $size, $id, $value));
   }
@@ -1204,6 +1273,9 @@ class ExtendedDocumentFragment extends DOMDocumentFragment {
   public function appendLabel($for_id, $value) {
     return $this->appendChild($this->ownerDocument->createElementLabel($for_id, $value));
   }
+  public function appendElementDatalist($id = null, $options = array()) {
+    return $this->appendChild($this->ownerDocument->createElementDatalist($id, $options));
+  }
   public function appendText($text) {
     return $this->appendChild($this->ownerDocument->createTextNode($text));
   }