<?php
-/* ***** BEGIN LICENSE BLOCK *****
- *
- * The contents of this file are subject to Austrian copyright reegulations
- * ("Urheberrecht"); you may not use this file except in compliance with
- * those laws.
- * This contents and any derived work, if it gets distributed in any way,
- * is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND,
- * either express or implied.
- *
- * The Original Code is KaiRo's extended DOM document classes.
- *
- * The Initial Developer of the Original Code is
- * KaiRo - Robert Kaiser.
- * Portions created by the Initial Developer are Copyright (C) 2010
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s): Robert Kaiser <kairo@kairo.at>
- *
- * ***** END LICENSE BLOCK ***** */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
class ExtendedDocument extends DOMDocument {
// ExtendedDocument PHP class
// CONSTRUCTOR
// construct a new DOM Document that uses our element definitions
//
- // static function initHTML5()
+ // static function initHTML5([$doc])
// initialize as an HTML5 document and return references to its basic elements.
+ // If a $doc is handed over (an ExtendedDocument or a derived class), load the content into that document.
// returns an associative array with the following elements: 'html', 'head', 'title', 'body'
//
// public function appendElement($name, [$value])
// appends an ExtendedDocument::createElementTextArea() as a child of this document (see there for params)
// returns the new child
//
- // public function appendElementSelect($name, [$id], [$options], [$default])
+ // public function appendElementSelect($name, [$id], [$options], [$default], [$strictmatch])
// appends an ExtendedDocument::createElementSelect() as a child of this document (see there for params)
// returns the new child
//
// appends a DOMDocument::createTextNode() as a child of this document (see there for params)
// returns the new child
//
+ // public function appendLinebreak()
+ // appends a <br> as a child of this document
+ // returns the new child
+ //
// public function appendEntity($name)
// appends a DOMDocument::createEntityReference() as a child of this document (see there for params)
// returns the new child
// appends an ExtendedDocument::createElementJS() as a child of this document (see there for params)
// NO return value!
//
- // public function appendJSFile($jsURL)
+ // public function appendJSFile($jsURL, [$defer], [$async])
// appends an ExtendedDocument::createElementJSFile() as a child of this document (see there for params)
// returns the new child
//
// returns an ExtendedElement that is an HTML <textarea> with the given name, columns, rows,
// and optionally id and value
//
- // public function createElementSelect($name, [$id], [$options], [$default])
+ // public function createElementSelect($name, [$id], [$options], [$default], [$strictmatch])
// returns an ExtendedElement that is an HTML <select> with the given name, and optionally id,
- // array of options (key => description) and key of the by-default selected entry
+ // array of options (key => description) and key of the by-default selected entry (matched including type when strictmatch is true)
//
// public function createElementOption($key, $desc, [$selected])
// returns an ExtendedElement that is an HTML <option> with the given key (value) and description (content)
// public function createElementJS($jsdata)
// returns an ExtendedElement that is an HTML <script> of JavaScript type with the JS data inside
//
- // public function createElementJSFile($jsURL)
+ // public function createElementJSFile($jsURL, [$defer], [$async])
// returns an ExtendedElement that is an HTML <script> of JavaScript type linking to the file given by the URL
+ // $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.
function __construct($version = '1.0', $encoding = 'utf-8') {
// make sure the default DOMDocument constructor runs
$this->registerNodeClass('DOMDocumentFragment', 'ExtendedDocumentFragment');
}
- static function initHTML5() {
- $doc = new ExtendedDocument();
+ static function initHTML5($doc = null) {
+ if (is_null($doc)) { $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.
public function appendTextArea($name, $columns, $rows, $id = null, $value = null) {
return $this->appendChild($this->createElementTextArea($name, $columns, $rows, $id, $value));
}
- public function appendElementSelect($name, $id = null, $options = array(), $default = null) {
- return $this->appendChild($this->createElementSelect($name, $id, $options, $default));
+ public function appendElementSelect($name, $id = null, $options = array(), $default = null, $strictmatch = false) {
+ return $this->appendChild($this->createElementSelect($name, $id, $options, $default, $strictmatch));
}
public function appendElementOption($key, $desc, $selected = false) {
return $this->appendChild($this->createElementOption($key, $desc, $selected));
public function appendText($text) {
return $this->appendChild($this->createTextNode($text));
}
+ public function appendLinebreak() {
+ return $this->appendChild($this->createElement('br'));
+ }
public function appendEntity($name) {
return $this->appendChild($this->createEntityReference($name));
}
public function appendJSElement($jsdata) {
$this->appendChild($this->createElementJS($jsdata));
}
- public function appendJSFile($jsdata) {
- return $this->appendChild($this->createElementJSFile($jsdata));
+ public function appendJSFile($jsdata, $defer = false, $async = false) {
+ return $this->appendChild($this->createElementJSFile($jsdata, $defer, $async));
}
public function appendHTMLMarkup($htmldata, $parentNode = null) {
if (is_null($parentNode)) { $parentNode =& $this; }
- // XXX: just a workaround for now!
- $parentNode->appendChild($this->createCDATASection($htmldata));
+ // Use loadHTML() to parse and turn the markup into proper HTML.
+ $tmpdoc = new ExtendedDocument;
+ // The XML line is needed to tell the parser that we need UTF-8 parsing.
+ $tmpdoc->loadHTML('<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html><html><body>'.$htmldata.'</body></html>');
+ foreach ($tmpdoc->getElementsByTagName('body')->item(0)->childNodes as $child) {
+ $parentNode->appendChild($this->importNode($child, true));
+ }
}
public function appendXMLMarkup($xmldata, $parentNode = null) {
return $txtarea;
}
- public function createElementSelect($name, $id = null, $options = array(), $default = null) {
+ public function createElementSelect($name, $id = null, $options = array(), $default = null, $strictmatch = false) {
$select = $this->createElement('select');
$select->setAttribute('name', $name);
if (!is_null($id)) { $select->setAttribute('id', $id); }
foreach ($options as $key => $desc) {
- $select->appendElementOption($key, $desc, ($key == $default));
+ $select->appendElementOption($key, $desc, $strictmatch ? ($key === $default) : ($key == $default));
}
return $select;
}
return $jselem;
}
- public function createElementJSFile($jsURL) {
+ public function createElementJSFile($jsURL, $defer = false, $async = false) {
$jselem = $this->createElement('script');
// Note: type can/should be left out for HTML5.
$jselem->setAttribute('type', 'text/javascript');
+ if ($defer) {
+ $jselem->setAttribute('defer', '');
+ }
+ if ($async) {
+ $jselem->setAttribute('async', '');
+ }
$jselem->setAttribute('src', $jsURL);
return $jselem;
}
// appends an ExtendedDocument::createElementTextArea() as a child of this element (see there for params)
// returns the new child
//
- // public function appendElementSelect($name, [$id], [$options], [$default])
+ // public function appendElementSelect($name, [$id], [$options], [$default], [$strictmatch])
// appends an ExtendedDocument::createElementSelect() as a child of this element (see there for params)
// returns the new child
//
// appends a DOMDocument::createTextNode() as a child of this element (see there for params)
// returns the new child
//
+ // public function appendLinebreak()
+ // appends a <br> as a child of this element
+ // returns the new child
+ //
// public function appendEntity($name)
// appends a DOMDocument::createEntityReference() as a child of this element (see there for params)
// returns the new child
// appends an ExtendedDocument::createElementJS() as a child of this element (see there for params)
// NO return value!
//
- // public function appendJSFile($jsURL)
+ // public function appendJSFile($jsURL, [$defer], [$async])
// appends an ExtendedDocument::createElementJSFile() as a child of this element (see there for params)
// returns the new child
+ //
+ // public function setClass($classname)
+ // sets the 'class' attribute of the element to the given classname value
+ //
+ // public function addClass($classname)
+ // adds the given classname value to the space-separated list in the 'class' attribute
+ // returns the value of the 'class' attribute
+ //
+ // public function setID($elem_id)
+ // sets the 'id' attribute of the element to the given elem_id value
public function appendElement($name, $value = '') {
return $this->appendChild($this->ownerDocument->createElement($name, $value));
public function appendTextArea($name, $columns, $rows, $id = null, $value = null) {
return $this->appendChild($this->ownerDocument->createElementTextArea($name, $columns, $rows, $id, $value));
}
- public function appendElementSelect($name, $id = null, $options = array(), $default = null) {
- return $this->appendChild($this->ownerDocument->createElementSelect($name, $id, $options, $default));
+ public function appendElementSelect($name, $id = null, $options = array(), $default = null, $strictmatch = false) {
+ return $this->appendChild($this->ownerDocument->createElementSelect($name, $id, $options, $default, $strictmatch));
}
public function appendElementOption($key, $desc, $selected = false) {
return $this->appendChild($this->ownerDocument->createElementOption($key, $desc, $selected));
public function appendText($text) {
return $this->appendChild($this->ownerDocument->createTextNode($text));
}
+ public function appendLinebreak() {
+ return $this->appendChild($this->ownerDocument->createElement('br'));
+ }
public function appendEntity($name) {
return $this->appendChild($this->ownerDocument->createEntityReference($name));
}
public function appendJSElement($jsdata) {
$this->appendChild($this->ownerDocument->createElementJS($jsdata));
}
- public function appendJSFile($jsdata) {
- return $this->appendChild($this->ownerDocument->createElementJSFile($jsdata));
+ public function appendJSFile($jsdata, $defer = false, $async = false) {
+ return $this->appendChild($this->ownerDocument->createElementJSFile($jsdata, $defer, $async));
+ }
+ public function setClass($classname) {
+ $this->setAttribute('class', $classname);
+ }
+ public function addClass($classname) {
+ $classval = $this->getAttribute('class');
+ if (strlen($classval)) { $classval .= ' '; }
+ $classval .= $classname;
+ $this->setClass($classval);
+ return $classval;
+ }
+ public function setID($elem_id) {
+ $this->setAttribute('id', $elem_id);
}
}
// appends an ExtendedDocument::createElementTextArea() as a child of this fragment (see there for params)
// returns the new child
//
- // public function appendElementSelect($name, [$id], [$options], [$default])
+ // public function appendElementSelect($name, [$id], [$options], [$default], [$strictmatch])
// appends an ExtendedDocument::createElementSelect() as a child of this fragment (see there for params)
// returns the new child
//
// appends a DOMDocument::createTextNode() as a child of this fragment (see there for params)
// returns the new child
//
+ // public function appendLinebreak()
+ // appends a <br> as a child of this fragment
+ // returns the new child
+ //
// public function appendEntity($name)
// appends a DOMDocument::createEntityReference() as a child of this fragment (see there for params)
// returns the new child
// appends an ExtendedDocument::createElementJS() as a child of this fragment (see there for params)
// NO return value!
//
- // public function appendJSFile($jsURL)
+ // public function appendJSFile($jsURL, [$defer], [$async])
// appends an ExtendedDocument::createElementJSFile() as a child of this fragment (see there for params)
// returns the new child
public function appendTextArea($name, $columns, $rows, $id = null, $value = null) {
return $this->appendChild($this->ownerDocument->createElementTextArea($name, $columns, $rows, $id, $value));
}
- public function appendElementSelect($name, $id = null, $options = array(), $default = null) {
- return $this->appendChild($this->ownerDocument->createElementSelect($name, $id, $options, $default));
+ public function appendElementSelect($name, $id = null, $options = array(), $default = null, $strictmatch = false) {
+ return $this->appendChild($this->ownerDocument->createElementSelect($name, $id, $options, $default, $strictmatch));
}
public function appendElementOption($key, $desc, $selected = false) {
return $this->appendChild($this->ownerDocument->createElementOption($key, $desc, $selected));
public function appendText($text) {
return $this->appendChild($this->ownerDocument->createTextNode($text));
}
+ public function appendLinebreak() {
+ return $this->appendChild($this->ownerDocument->createElement('br'));
+ }
public function appendEntity($name) {
return $this->appendChild($this->ownerDocument->createEntityReference($name));
}
public function appendJSElement($jsdata) {
$this->appendChild($this->ownerDocument->createElementJS($jsdata));
}
- public function appendJSFile($jsdata) {
- return $this->appendChild($this->ownerDocument->createElementJSFile($jsdata));
+ public function appendJSFile($jsdata, $defer = false, $async = false) {
+ return $this->appendChild($this->ownerDocument->createElementJSFile($jsdata, $defer, $async));
}
}
?>