highwire / opensource-php-BetterDOMDocument

src/DOMDoc.php

Spacing +14 added lines, -14 removed lines

@@ -324,7 +324,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]."'";             
           }
         }
       }
@@ -333,7 +333,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;
     
@@ -438,7 +438,7 @@ 
     $this->createContext($newnode, 'xml');
     $this->createContext($context, 'xpath');
     
-    if (!$context){
+    if (!$context) {
       return FALSE;
     }
     
@@ -509,7 +509,7 @@ 
     
     if ($node) {
       if (is_array($node) || get_class($node) == 'BetterDOMDocument\DOMList') {
-        foreach($node as $item) {
+        foreach ($node as $item) {
           $this->remove($item);
         }
       }
@@ -581,7 +581,7 @@ 
       $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>
@@ -593,7 +593,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");
     }
   }
 
@@ -668,7 +668,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);
       }
@@ -707,8 +707,8 @@ 
 
     // Copy namespace prefixes
     foreach ($this->ns as $prefix => $namespace) {
-      if (!empty($namespace) && !$context->hasAttribute('xmlns:' . $prefix)) {
-        $context->setAttribute('xmlns:' . $prefix, $namespace);
+      if (!empty($namespace) && !$context->hasAttribute('xmlns:'.$prefix)) {
+        $context->setAttribute('xmlns:'.$prefix, $namespace);
       }
     }
     
@@ -718,7 +718,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);
@@ -805,7 +805,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);
@@ -843,8 +843,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); 
         }
       }
@@ -901,7 +901,7 @@ 
       @$this->loadXML($xml, LIBXML_COMPACT);
     }
     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);
     }
   }
 }

Braces +25 added lines, -50 removed lines

@@ -41,23 +41,19 @@ 
     if (is_object($xml)) {
       if (is_a($xml, 'DOMElement')) {
         $this->appendChild($this->importNode($xml, true));
-      }
-      elseif (is_a($xml, 'BetterDOMDocument\DOMDoc')) {
+      } elseif (is_a($xml, 'BetterDOMDocument\DOMDoc')) {
         if ($xml->documentElement) {
           $this->appendChild($this->importNode($xml->documentElement, true));
         }
         $this->ns = $xml->ns;
-      }
-      elseif (is_a($xml, 'DOMDocument')) {
+      } elseif (is_a($xml, 'DOMDocument')) {
         if ($xml->documentElement) {
           $this->appendChild($this->importNode($xml->documentElement, true));
         }
-      }
-      elseif (method_exists($xml, '__toString')) {
+      } elseif (method_exists($xml, '__toString')) {
         $this->loadFromString($xml->__toString());
       }
-    }
-    elseif (is_string($xml) && !empty($xml)) {
+    } elseif (is_string($xml) && !empty($xml)) {
       $this->loadFromString($xml);
     }
 
@@ -113,8 +109,7 @@ 
   public function lookupURL($prefix) {
     if (isset($this->ns[$prefix])) {
       return $this->ns[$prefix];
-    }
-    else {
+    } else {
       return FALSE;
     }
   }
@@ -148,15 +143,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;
     }
   }
@@ -180,8 +173,7 @@ 
     
     if (empty($result) || !count($result)) {
       return FALSE;
-    }
-    else {
+    } else {
       return $result->item(0);
     }
   }
@@ -260,13 +252,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;
             }
           }
@@ -298,8 +288,7 @@ 
     $matches = array();
     if (preg_match($pattern, $this->saveXML($context), $matches)) {
       return $matches[1];
-    }
-    else {
+    } else {
       return '';
     }
   }
@@ -445,8 +434,7 @@ 
     if ($context->nextSibling) { 
       // $context has an immediate sibling : insert newnode before this one 
       return $context->parentNode->insertBefore($newnode, $context->nextSibling); 
-    }
-    else { 
+    } else { 
       return $context->parentNode->appendChild($newnode); 
     }
   }
@@ -512,11 +500,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);
       }
@@ -538,8 +524,7 @@ 
   public function tranform($xsl, $context = NULL) {
     if (!$context) {
       $doc = $this;
-    }
-    else {
+    } else {
       if (is_string($context)) {
         $context = $this->xpathSingle($context);
       }
@@ -590,8 +575,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");
     }
@@ -676,14 +660,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);
     }
     
@@ -719,8 +701,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);
     }
   }
@@ -749,8 +730,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') {
@@ -810,8 +790,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);
@@ -842,8 +821,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); 
         }
@@ -882,12 +860,10 @@ 
         }
         $context = $this->importNode($context->documentElement, TRUE);
         return;
-      }
-      else if (is_a($context, 'DOMDocument')) {
+      } else if (is_a($context, 'DOMDocument')) {
         $context = $this->importNode($context->documentElement, TRUE);
         return;
-      }
-      else {
+      } else {
         $context = $this->importNode($context, TRUE);
         return;
       }
@@ -899,8 +875,7 @@ 
   protected function loadFromString($xml) {
     if ($this->error_checking == 'none') {
       @$this->loadXML($xml, LIBXML_COMPACT);
-    }
-    else if (!$this->loadXML($xml, LIBXML_COMPACT)) {
+    } else if (!$this->loadXML($xml, LIBXML_COMPACT)) {
       trigger_error('BetterDOMDocument\DOMDoc: Could not load: ' . htmlspecialchars($xml), E_USER_WARNING);
     }
   }

Doc Comments +14 added lines, -5 removed lines

@@ -470,10 +470,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 mixed
@@ -533,7 +533,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
    */
   public function tranform($xsl, $context = NULL) {
     if (!$context) {
@@ -615,7 +615,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
    */  
   public function asHTML($context = NULL, $options = array()) {
     $xslSimple = '
@@ -697,7 +697,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
    */  
   public function out($context = NULL) {
     $this->createContext($context, 'xpath');
@@ -745,6 +745,9 @@ 
     );
   }
 
+  /**
+   * @param string|boolean $error_checking
+   */
   public function setErrorChecking($error_checking) {
     // Check up error-checking
     if ($error_checking == FALSE) {
@@ -774,6 +777,9 @@ 
     return boolval($success);
   }
 
+  /**
+   * @param integer $options
+   */
   public function loadXML($source, $options = NULL) {
     $success = parent::loadXML($source, $options);
     $this->AutoRegisterNamespace(TRUE);
@@ -800,6 +806,9 @@ 
     unset($this->ns[$prefix]);
   }
 
+  /**
+   * @param boolean|string $auto_register_namespaces
+   */
   protected function AutoRegisterNamespace($auto_register_namespaces) {
     $this->auto_ns = TRUE;