highwire / opensource-php-BetterDOMDocument

src/DOMDoc.php

Doc Comments +10 added lines, -9 removed lines

@@ -22,14 +22,14 @@ 
    *  $xml can either be an XML string, a DOMDocument, or a DOMElement. 
    *  You can also pass FALSE or NULL (or omit it) and load XML later using loadXML or loadHTML
    * 
-   * @param mixed $auto_register_namespaces 
+   * @param boolean $auto_register_namespaces 
    *  Auto-register namespaces. All namespaces in the root element will be registered for use in xpath queries.
    *  Namespaces that are not declared in the root element will not be auto-registered
    *  Defaults to TRUE (Meaning it will auto register all auxiliary namespaces but not the default namespace).
    *  Pass a prefix string to automatically register the default namespace.
    *  Pass FALSE to disable auto-namespace registeration
    * 
-   * @param bool $error_checking
+   * @param string|boolean $error_checking
    *  Can be 'strict', 'warning', or 'none. Defaults to 'strict'.
    *  'none' supresses all errors
    *  'warning' is the default behavior in DOMDocument
@@ -489,10 +489,10 @@ 
   /**
    * Given a pair of nodes, replace the first with the second
    * 
-   * @param mixed $node
+   * @param \DOMElement $node
    *  Node to be replaced. Can either be an xpath string or a DOMDocument (or even a DOMNode).
    * 
-   * @param mixed $replace
+   * @param \DOMElement $replace
    *  Replace $node with $replace. Replace can be an XML string, or a DOMNode
    * 
    * @return replaced node
@@ -552,7 +552,7 @@ 
    *   $context can either be an xpath string, or a DOMElement. Ommiting it
    *   results in transforming the entire document
    * 
-   * @return a new DOMDoc
+   * @return DOMDoc new DOMDoc
    */
   function tranform($xsl, $context = NULL) {
     if (!$context) {
@@ -578,8 +578,6 @@ 
    * @param mixed $node
    *  Node to be changed. Can either be an xpath string or a DOMElement.
    * 
-   * @param mixed $replace
-   *  Replace $node with $replace. Replace can be an XML string, or a DOMNode
    * 
    * @return the changed node
    *   The node with the new namespace. The node will also be changed in-situ in the document as well.
@@ -635,7 +633,7 @@ 
    *     it will transform all elements with xlink:type = simple into a <a href> element. 
    *     Alternatively you may specify your own xpath for selecting which elements get transformed
    *     into <a href> tags. 
-   * @return HTML string
+   * @return string string
    */  
   function asHTML($context = NULL, $options = array()) {
     $xslSimple = '
@@ -717,7 +715,7 @@ 
    *   $context can either be an xpath string, or a DOMElement. Ommiting it
    *   results in outputting the entire document
    * 
-   * @return XML string
+   * @return string string
    */  
   function out($context = NULL) {
     $this->createContext($context, 'xpath');
@@ -752,6 +750,9 @@ 
     return $this->out();
   }
 
+  /**
+   * @param string|boolean $error_checking
+   */
   public function setErrorChecking($error_checking) {
     // Check up error-checking
     if ($error_checking == FALSE) {

Spacing +16 added lines, -16 removed lines

@@ -40,7 +40,7 @@ 
 
     $this->setErrorChecking($error_checking);
     
-    if(is_object($xml)){
+    if (is_object($xml)) {
       $class = get_class($xml);
       if ($class == 'DOMElement') {
         $this->appendChild($this->importNode($xml, true));
@@ -64,7 +64,7 @@ 
       }
       else {
         if (!$this->loadXML($xml, LIBXML_COMPACT)) {
-          trigger_error('BetterDOMDocument\DOMDoc: Could not load: ' . htmlspecialchars($xml), E_USER_WARNING);
+          trigger_error('BetterDOMDocument\DOMDoc: Could not load: '.htmlspecialchars($xml), E_USER_WARNING);
         }
       }
     }
@@ -329,7 +329,7 @@ 
         $prefix = $parts[0]; 
         if (isset($namespaces[$prefix])) {
           if (!strpos($root_match[0], "xmlns:$prefix")) {
-            $new_root .= " xmlns:$prefix='" . $namespaces[$prefix] . "'";             
+            $new_root .= " xmlns:$prefix='".$namespaces[$prefix]."'";             
           }
         }
       }
@@ -338,7 +338,7 @@ 
     
     $dom = new DOMDoc($xml, $this->auto_ns);
     if (!$dom->documentElement) {
-      trigger_error('BetterDomDocument\DOMDoc Error: Invalid XML: ' . $xml);
+      trigger_error('BetterDomDocument\DOMDoc Error: Invalid XML: '.$xml);
     }
     $element = $dom->documentElement;
     
@@ -450,7 +450,7 @@ 
     $this->createContext($newnode, 'xml');
     $this->createContext($context, 'xpath');
     
-    if (!$context){
+    if (!$context) {
       return FALSE;
     }
     
@@ -528,7 +528,7 @@ 
     
     if ($node) {
       if (is_array($node) || get_class($node) == 'BetterDOMDocument\DOMList') {
-        foreach($node as $item) {
+        foreach ($node as $item) {
           $this->remove($item);
         }
       }
@@ -596,12 +596,12 @@ 
     if (get_class($node) == 'DOMElement') {
       $elemname = array_pop(explode(':', $node->tagName));
 
-      $replace = DOMDocument::createElementNS($url, $prefix . ':' . $elemname);
+      $replace = DOMDocument::createElementNS($url, $prefix.':'.$elemname);
 
       $xsl = '
         <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
           <xsl:template match="*">
-            <xsl:element name="' . $prefix . ':{local-name()}" namespace="' . $url . '">
+            <xsl:element name="' . $prefix.':{local-name()}" namespace="'.$url.'">
              <xsl:copy-of select="@*"/>
              <xsl:apply-templates/>
             </xsl:element>
@@ -613,7 +613,7 @@ 
     }
     else {
       // @@TODO: Report the correct calling file and number
-      throw new Exception("Changing the namespace of a " . get_class($node) . " is not supported");
+      throw new Exception("Changing the namespace of a ".get_class($node)." is not supported");
     }
   }
 
@@ -688,7 +688,7 @@ 
       foreach ($this->getNamespaces() as $prefix => $url) {
         $namespaces = '';
         if ($prefix != 'xsl' && $prefix != 'xlink') {
-          $namespaces .= 'xmlns:' . $prefix . '="' . $url. '" ';
+          $namespaces .= 'xmlns:'.$prefix.'="'.$url.'" ';
         }
         $xslOptions = str_replace("||namespaces||", $namespaces, $xslOptions);
       }
@@ -727,8 +727,8 @@ 
 
     // Copy namespace prefixes
     foreach ($this->ns as $prefix => $namespace) {
-      if (!$context->hasAttribute('xmlns:' . $prefix)) {
-        $context->setAttribute('xmlns:' . $prefix, $namespace);
+      if (!$context->hasAttribute('xmlns:'.$prefix)) {
+        $context->setAttribute('xmlns:'.$prefix, $namespace);
       }
     }
     
@@ -738,7 +738,7 @@ 
       // The types listed are html "void" elements. 
       // Find any of these elements that have no child nodes and are therefore candidates for self-closing, replace them with a self-closed version. 
       $pattern = '<(area|base|br|col|command|embed|hr|img|input|keygen|link|meta|param|source|track|wbr)(\b[^<]*)><\/\1>';
-      return preg_replace('/' . $pattern . '/', '<$1$2/>', $output);
+      return preg_replace('/'.$pattern.'/', '<$1$2/>', $output);
     }
     else {
       return $this->saveXML($context, LIBXML_NOEMPTYTAG);
@@ -779,7 +779,7 @@ 
 
     // If it's an "XML" document, then get namespaces via xpath
     $xpath = new \DOMXPath($this);
-    foreach($xpath->query('namespace::*') as $namespace) {
+    foreach ($xpath->query('namespace::*') as $namespace) {
       if (!empty($namespace->prefix)) {
         if ($namespace->prefix != 'xml' && $namespace->nodeValue != 'http://www.w3.org/XML/1998/namespace') {
           $this->registerNamespace($namespace->prefix, $namespace->nodeValue);
@@ -817,8 +817,8 @@ 
             } 
           }
         }
-        else if (substr($attr->name,0,6) == 'xmlns:') {
-          $prefix = substr($attr->name,6);
+        else if (substr($attr->name, 0, 6) == 'xmlns:') {
+          $prefix = substr($attr->name, 6);
           $this->registerNamespace($prefix, $attr->value); 
         }
       }

Braces +21 added lines, -42 removed lines

@@ -61,8 +61,7 @@ 
     if ($xml && is_string($xml)) {
       if ($this->error_checking == 'none') {
         @$this->loadXML($xml, LIBXML_COMPACT);
-      }
-      else {
+      } else {
         if (!$this->loadXML($xml, LIBXML_COMPACT)) {
           trigger_error('BetterDOMDocument\DOMDoc: Could not load: ' . htmlspecialchars($xml), E_USER_WARNING);
         }
@@ -118,8 +117,7 @@ 
   function lookupURL($prefix) {
     if (isset($this->ns[$prefix])) {
       return $this->ns[$prefix];
-    }
-    else {
+    } else {
       return FALSE;
     }
   }
@@ -153,15 +151,13 @@ 
 
     if ($context) {
       $result = $xob->query($xpath, $context);
-    }
-    else {
+    } else {
       $result = $xob->query($xpath);
     }
 
     if ($result) {
       return new DOMList($result, $this);
-    }
-    else {
+    } else {
       return FALSE;
     }
   }
@@ -185,8 +181,7 @@ 
     
     if (empty($result) || !count($result)) {
       return FALSE;
-    }
-    else {
+    } else {
       return $result->item(0);
     }
   }
@@ -265,13 +260,11 @@ 
       if ($context->hasChildNodes()) {
         if ($context->childNodes->length == 1 && $context->firstChild->nodeType == XML_TEXT_NODE) {
           $array['#text'] = $context->firstChild->nodeValue;
-        }
-        else {
+        } else {
           foreach ($context->childNodes as $childNode) {
             if ($childNode->nodeType == XML_ELEMENT_NODE) {
               $array[$childNode->nodeName][] = $this->getArray($raw, $childNode);
-            }
-            elseif ($childNode->nodeType == XML_CDATA_SECTION_NODE) {
+            } elseif ($childNode->nodeType == XML_CDATA_SECTION_NODE) {
               $array['#text'] = $childNode->textContent;
             }
           }
@@ -303,8 +296,7 @@ 
     $matches = array();
     if (preg_match($pattern, $this->saveXML($context), $matches)) {
       return $matches[1];
-    }
-    else {
+    } else {
       return '';
     }
   }
@@ -374,8 +366,7 @@ 
   
     if ($newnode->ownerDocument === $this) {
       $appendnode = $newnode;
-    }
-    else {
+    } else {
       $appendnode = $this->importNode($newnode, true);
     }
 
@@ -457,13 +448,11 @@ 
     if ($context->nextSibling) { 
       // $context has an immediate sibling : insert newnode before this one 
       return $context->parentNode->insertBefore($newnode, $context->nextSibling); 
-    }
-    else { 
+    } else { 
       // $context has no sibling next to it : insert newnode as last child of it's parent 
       if ($newnode->ownerDocument === $this) {
         $appendnode = $newnode;
-      }
-      else {
+      } else {
         $appendnode = $this->importNode($newnode, true);
       }
       return $context->parentNode->appendChild($appendnode); 
@@ -531,11 +520,9 @@ 
         foreach($node as $item) {
           $this->remove($item);
         }
-      }
-      else if (get_class($node) == 'DOMNodeList') {
+      } else if (get_class($node) == 'DOMNodeList') {
         $this->remove(new DOMList($node, $this));
-      }
-      else {
+      } else {
         $parent = $node->parentNode;
         $parent->removeChild($node);
       }
@@ -557,8 +544,7 @@ 
   function tranform($xsl, $context = NULL) {
     if (!$context) {
       $doc = $this;
-    }
-    else {
+    } else {
       if (is_string($context)) {
         $context = $this->xpathSingle($context);
       }
@@ -610,8 +596,7 @@ 
 
       $transformed = $this->tranform($xsl, $node);
       return $this->replace($node, $transformed->documentElement);   
-    }
-    else {
+    } else {
       // @@TODO: Report the correct calling file and number
       throw new Exception("Changing the namespace of a " . get_class($node) . " is not supported");
     }
@@ -696,14 +681,12 @@ 
       // Add in xlink options
       if ($options['xlink'] === TRUE) {
         $options['xlink'] = "@xlink:type = 'simple'";
-      }
-      else if (empty($options['xlink'])) {
+      } else if (empty($options['xlink'])) {
         $options['xlink'] = "false()";
       }
       $xslOptions = str_replace("||xlink||", $options['xlink'], $xslOptions);
       $transformed = $this->tranform($xslOptions, $context);
-    }
-    else {
+    } else {
       $transformed = $this->tranform($xslSimple, $context);
     }
     
@@ -739,8 +722,7 @@ 
       // Find any of these elements that have no child nodes and are therefore candidates for self-closing, replace them with a self-closed version. 
       $pattern = '<(area|base|br|col|command|embed|hr|img|input|keygen|link|meta|param|source|track|wbr)(\b[^<]*)><\/\1>';
       return preg_replace('/' . $pattern . '/', '<$1$2/>', $output);
-    }
-    else {
+    } else {
       return $this->saveXML($context, LIBXML_NOEMPTYTAG);
     }
   }
@@ -756,8 +738,7 @@ 
     // Check up error-checking
     if ($error_checking == FALSE) {
       $this->error_checking = 'none';
-    }
-    else {
+    } else {
       $this->error_checking = $error_checking;
     }
     if ($this->error_checking != 'strict') {
@@ -784,8 +765,7 @@ 
         if ($namespace->prefix != 'xml' && $namespace->nodeValue != 'http://www.w3.org/XML/1998/namespace') {
           $this->registerNamespace($namespace->prefix, $namespace->nodeValue);
         }
-      }
-      else {
+      } else {
         $this->default_ns = $namespace->nodeValue;
         if (is_string($auto_register_namespaces)) {
           $this->registerNamespace($auto_register_namespaces, $namespace->nodeValue);
@@ -816,8 +796,7 @@ 
               $this->registerNamespace($tagname, $attr->value);
             } 
           }
-        }
-        else if (substr($attr->name,0,6) == 'xmlns:') {
+        } else if (substr($attr->name,0,6) == 'xmlns:') {
           $prefix = substr($attr->name,6);
           $this->registerNamespace($prefix, $attr->value); 
         }

src/DOMList.php

Doc Comments +3 added lines

@@ -53,6 +53,9 @@
     return isset($this->array[$this->position]);
   }
   
+  /**
+   * @param integer $index
+   */
   function item($index) {
     if (isset($this->array[$index])) {
       return $this->array[$index];

Spacing +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
   }
   
   // Provides read-only access to $length and $dom
-  function __get ($prop) {
+  function __get($prop) {
     if ($prop == 'length') {
       return $this->length;
     }

Braces +4 added lines, -5 removed lines

@@ -24,11 +24,9 @@ 
   function __get ($prop) {
     if ($prop == 'length') {
       return $this->length;
-    }
-    else if ($prop == 'dom') {
+    } else if ($prop == 'dom') {
       return $this->dom;
-    }
-    else {
+    } else {
       return null;
     }
   }
@@ -56,8 +54,9 @@ 
   function item($index) {
     if (isset($this->array[$index])) {
       return $this->array[$index];
+    } else {
+      return FALSE;
     }
-    else return FALSE;
   }
   
   function count() {