support defer and sanc for added JS files

[php-utility-classes.git] / classes / document.php-class
diff --git a/classes/document.php-class b/classes/document.php-class

index 218ec3cfde4950d2475bc9b614a87769632d478e..3e39f0acefdcd7ddaa852ffde3e15bb1689ccbc6 100755 (executable)
--- a/classes/document.php-class
+++ b/classes/document.php-class
@@ -11,8 +11,9 @@ class ExtendedDocument extends DOMDocument {
    //   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])
@@ -120,7 +121,7 @@ class ExtendedDocument extends DOMDocument {
    //   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
    //
@@ -188,8 +189,9 @@ class ExtendedDocument extends DOMDocument {
    // 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
@@ -198,8 +200,8 @@ class ExtendedDocument extends DOMDocument {
      $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.
@@ -291,8 +293,8 @@ class ExtendedDocument extends DOMDocument {
    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) {
@@ -478,10 +480,16 @@ class ExtendedDocument extends DOMDocument {
      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;
    }
@@ -596,7 +604,7 @@ class ExtendedElement extends DOMElement {
    //   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
  
@@ -681,8 +689,8 @@ class ExtendedElement extends DOMElement {
    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));
    }
  }
  
@@ -795,7 +803,7 @@ class ExtendedDocumentFragment extends DOMDocumentFragment {
    //   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
  
@@ -880,8 +888,8 @@ class ExtendedDocumentFragment extends DOMDocumentFragment {
    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));
    }
  }
  ?>