twhiston / simplexml_debug

src/SxmlDebug.php

Doc Comments +4 added lines, -4 removed lines

@@ -94,7 +94,7 @@ 
   }
 
   /**
-   * @param      $title
+   * @param      string $title
    * @param      $data
    * @param int  $indent
    * @param bool $backtick
@@ -254,7 +254,7 @@ 
   }
 
   /**
-   * @param $index
+   * @param integer $index
    * @return string
    */
   private static function getHeaderLine($index): string {
@@ -490,8 +490,8 @@ 
 
   /**
    * @param $item
-   * @param $depth
-   * @param $include_string_content
+   * @param integer $depth
+   * @param boolean $include_string_content
    * @return string
    */
   private static function recursivelyProcessNode(\SimpleXMLElement $item,

Indentation +270 added lines, -270 removed lines

@@ -17,25 +17,25 @@ 
 class SxmlDebug {
 
 
-  /**
-   * Character to use for indenting strings
-   */
-  const INDENT = "\t";
-  /**
-   * How much of a string to extract
-   */
-  const EXTRACT_SIZE = 15;
-
-  /**
-   * Output a summary of the node or list of nodes referenced by a particular
-   * SimpleXML object Rather than attempting a recursive inspection, presents
-   * statistics aimed at understanding what your SimpleXML code is doing.
-   *
-   * @param \SimpleXMLElement $sxml The object to inspect
-   * @return string output string
-   *
-   */
-  public static function dump(\SimpleXMLElement $sxml) {
+    /**
+     * Character to use for indenting strings
+     */
+    const INDENT = "\t";
+    /**
+     * How much of a string to extract
+     */
+    const EXTRACT_SIZE = 15;
+
+    /**
+     * Output a summary of the node or list of nodes referenced by a particular
+     * SimpleXML object Rather than attempting a recursive inspection, presents
+     * statistics aimed at understanding what your SimpleXML code is doing.
+     *
+     * @param \SimpleXMLElement $sxml The object to inspect
+     * @return string output string
+     *
+     */
+    public static function dump(\SimpleXMLElement $sxml) {
 
     $dump = '';
     // Note that the header is added at the end, so we can add stats
@@ -48,72 +48,72 @@ 
     $item_index = 0;
     while (isset($sxml[$item_index])) {
 
-      /** @var \SimpleXMLElement $item */
-      $item = $sxml[$item_index];
-      $item_index++;
+        /** @var \SimpleXMLElement $item */
+        $item = $sxml[$item_index];
+        $item_index++;
 
-      // It's surprisingly hard to find something which behaves consistently differently for an attribute and an element within SimpleXML
-      // The below relies on the fact that the DOM makes a much clearer distinction
-      // Note that this is not an expensive conversion, as we are only swapping PHP wrappers around an existing LibXML resource
-      if (dom_import_simplexml($item) instanceOf \DOMAttr) {
+        // It's surprisingly hard to find something which behaves consistently differently for an attribute and an element within SimpleXML
+        // The below relies on the fact that the DOM makes a much clearer distinction
+        // Note that this is not an expensive conversion, as we are only swapping PHP wrappers around an existing LibXML resource
+        if (dom_import_simplexml($item) instanceOf \DOMAttr) {
         $dump .= self::dumpAddAttribute($item);
-      } else {
+        } else {
         $dump .= self::dumpAddElement($item);
-      }
+        }
     }
     $dump .= ']' . PHP_EOL;
 
     // Add on the header line, with the total number of items output
     return self::getHeaderLine($item_index) . $dump;
-  }
+    }
 
-  /**
-   * @param \SimpleXMLElement $item
-   * @return string
-   */
-  private static function dumpAddNamespace(\SimpleXMLElement $item): string {
+    /**
+     * @param \SimpleXMLElement $item
+     * @return string
+     */
+    private static function dumpAddNamespace(\SimpleXMLElement $item): string {
 
     $dump = '';
     // To what namespace does this attribute belong? Returns array( alias => URI )
     $ns = $item->getNamespaces(FALSE);
     if ($ns) {
-      $dump .= self::INDENT . self::INDENT . 'Namespace: \'' . reset($ns) .
-               '\'' .
-               PHP_EOL;
-      if (key($ns) == '') {
+        $dump .= self::INDENT . self::INDENT . 'Namespace: \'' . reset($ns) .
+                '\'' .
+                PHP_EOL;
+        if (key($ns) == '') {
         $dump .= self::INDENT . self::INDENT . '(Default Namespace)' . PHP_EOL;
-      } else {
+        } else {
         $dump .= self::INDENT . self::INDENT . 'Namespace Alias: \'' .
-                 key($ns) .
-                 '\'' .
-                 PHP_EOL;
-      }
+                    key($ns) .
+                    '\'' .
+                    PHP_EOL;
+        }
     }
 
     return $dump;
-  }
-
-  /**
-   * @param      $title
-   * @param      $data
-   * @param int  $indent
-   * @param bool $backtick
-   * @return string
-   */
-  private static function dumpGetLine($title,
-                                      $data,
-                                      $indent = 1,
-                                      $backtick = TRUE): string {
+    }
+
+    /**
+     * @param      $title
+     * @param      $data
+     * @param int  $indent
+     * @param bool $backtick
+     * @return string
+     */
+    private static function dumpGetLine($title,
+                                        $data,
+                                        $indent = 1,
+                                        $backtick = TRUE): string {
     return str_repeat(self::INDENT, $indent) . $title . ': ' .
-           ($backtick ? '\'' : '') . $data .
-           ($backtick ? '\'' : '') . PHP_EOL;
-  }
+            ($backtick ? '\'' : '') . $data .
+            ($backtick ? '\'' : '') . PHP_EOL;
+    }
 
-  /**
-   * @param \SimpleXMLElement $item
-   * @return string
-   */
-  private static function dumpAddAttribute(\SimpleXMLElement $item): string {
+    /**
+     * @param \SimpleXMLElement $item
+     * @return string
+     */
+    private static function dumpAddAttribute(\SimpleXMLElement $item): string {
 
     $dump = self::INDENT . 'Attribute {' . PHP_EOL;
 
@@ -125,13 +125,13 @@ 
     $dump .= self::INDENT . '}' . PHP_EOL;
     return $dump;
 
-  }
+    }
 
-  /**
-   * @param \SimpleXMLElement $item
-   * @return string
-   */
-  private static function dumpAddElement(\SimpleXMLElement $item): string {
+    /**
+     * @param \SimpleXMLElement $item
+     * @return string
+     */
+    private static function dumpAddElement(\SimpleXMLElement $item): string {
 
     $dump = self::INDENT . 'Element {' . PHP_EOL;
 
@@ -147,16 +147,16 @@ 
     $all_ns = $item->getNamespaces(TRUE);
     // If the default namespace is never declared, it will never show up using the below code
     if (!array_key_exists('', $all_ns)) {
-      $all_ns[''] = NULL;
+        $all_ns[''] = NULL;
     }
 
     foreach ($all_ns as $ns_alias => $ns_uri) {
-      $children = $item->children($ns_uri);
-      $attributes = $item->attributes($ns_uri);
+        $children = $item->children($ns_uri);
+        $attributes = $item->attributes($ns_uri);
 
-      // Somewhat confusingly, in the case where a parent element is missing the xmlns declaration,
-      //	but a descendant adds it, SimpleXML will look ahead and fill $all_ns[''] incorrectly
-      if (
+        // Somewhat confusingly, in the case where a parent element is missing the xmlns declaration,
+        //	but a descendant adds it, SimpleXML will look ahead and fill $all_ns[''] incorrectly
+        if (
         empty($ns_alias)
         &&
         NULL !== $ns_uri
@@ -164,123 +164,123 @@ 
         count($children) === 0
         &&
         count($attributes) === 0
-      ) {
+        ) {
         // Try looking for a default namespace without a known URI
         $ns_uri = NULL;
         $children = $item->children($ns_uri);
         $attributes = $item->attributes($ns_uri);
-      }
+        }
 
-      // Don't show zero-counts, as they're not that useful
-      if (count($children) === 0 && count($attributes) === 0) {
+        // Don't show zero-counts, as they're not that useful
+        if (count($children) === 0 && count($attributes) === 0) {
         continue;
-      }
+        }
 
-      $ns_label = (($ns_alias === '') ? 'Default Namespace' :
+        $ns_label = (($ns_alias === '') ? 'Default Namespace' :
         "Namespace $ns_alias");
 
-      $dump .= self::INDENT . self::INDENT . 'Content in ' . $ns_label .
-               PHP_EOL;
+        $dump .= self::INDENT . self::INDENT . 'Content in ' . $ns_label .
+                PHP_EOL;
 
-      if (NULL !== $ns_uri) {
+        if (NULL !== $ns_uri) {
         $dump .= self::dumpGetLine('Namespace URI', $ns_uri, 3);
-      }
+        }
 
 
-      $dump .= self::dumpGetLine('Children',
-                                 self::dumpGetChildDetails($children),
-                                 3,
-                                 FALSE);
+        $dump .= self::dumpGetLine('Children',
+                                    self::dumpGetChildDetails($children),
+                                    3,
+                                    FALSE);
 
 
-      $dump .= self::dumpGetLine('Attributes',
-                                 self::dumpGetAttributeDetails($attributes),
-                                 3,
-                                 FALSE);
+        $dump .= self::dumpGetLine('Attributes',
+                                    self::dumpGetAttributeDetails($attributes),
+                                    3,
+                                    FALSE);
     }
 
     return $dump . self::INDENT . '}' . PHP_EOL;
-  }
+    }
 
-  /**
-   * @param \SimpleXMLElement $children
-   * @return string
-   */
-  private static function dumpGetChildDetails(\SimpleXMLElement $children): string {
+    /**
+     * @param \SimpleXMLElement $children
+     * @return string
+     */
+    private static function dumpGetChildDetails(\SimpleXMLElement $children): string {
     // Count occurrence of child element names, rather than listing them all out
     $child_names = [];
     foreach ($children as $sx_child) {
-      // Below is a rather clunky way of saying $child_names[ $sx_child->getName() ]++;
-      // 	which avoids Notices about unset array keys
-      $child_node_name = $sx_child->getName();
-      if (array_key_exists($child_node_name, $child_names)) {
+        // Below is a rather clunky way of saying $child_names[ $sx_child->getName() ]++;
+        // 	which avoids Notices about unset array keys
+        $child_node_name = $sx_child->getName();
+        if (array_key_exists($child_node_name, $child_names)) {
         $child_names[$child_node_name]++;
-      } else {
+        } else {
         $child_names[$child_node_name] = 1;
-      }
+        }
     }
     ksort($child_names);
     $child_name_output = [];
     foreach ($child_names as $name => $count) {
-      $child_name_output[] = "$count '$name'";
+        $child_name_output[] = "$count '$name'";
     }
 
     $childrenString = count($children);
     // Don't output a trailing " - " if there are no children
     if (count($children) > 0) {
-      $childrenString .= ' - ' . implode(', ', $child_name_output);
+        $childrenString .= ' - ' . implode(', ', $child_name_output);
     }
     return $childrenString;
-  }
+    }
 
-  /**
-   * @param \SimpleXMLElement $attributes
-   * @return string
-   */
-  private static function dumpGetAttributeDetails(\SimpleXMLElement $attributes): string {
+    /**
+     * @param \SimpleXMLElement $attributes
+     * @return string
+     */
+    private static function dumpGetAttributeDetails(\SimpleXMLElement $attributes): string {
 // Attributes can't be duplicated, but I'm going to put them in alphabetical order
     $attribute_names = [];
     foreach ($attributes as $sx_attribute) {
-      $attribute_names[] = "'" . $sx_attribute->getName() . "'";
+        $attribute_names[] = "'" . $sx_attribute->getName() . "'";
     }
     ksort($attribute_names);
 
     $attString = count($attributes);
     // Don't output a trailing " - " if there are no attributes
     if (count($attributes) > 0) {
-      $attString .= ' - ' . implode(', ', $attribute_names);
+        $attString .= ' - ' . implode(', ', $attribute_names);
     }
     return $attString;
-  }
+    }
 
-  /**
-   * @param $index
-   * @return string
-   */
-  private static function getHeaderLine($index): string {
+    /**
+     * @param $index
+     * @return string
+     */
+    private static function getHeaderLine($index): string {
 
     return 'SimpleXML object (' . $index . ' item' .
-           ($index > 1 ? 's' : '') . ')' . PHP_EOL;
-  }
-
-  /**
-   * Output a tree-view of the node or list of nodes referenced by a particular
-   * SimpleXML object Unlike simplexml_dump(), this processes the entire XML
-   * tree recursively, while attempting to be more concise and readable than
-   * the XML itself. Additionally, the output format is designed as a hint of
-   * the syntax needed to traverse the object.
-   *
-   * @param \SimpleXMLElement $sxml                   The object to inspect
-   * @param boolean           $include_string_content Default false. If true,
-   *                                                  will summarise textual
-   *                                                  content, as well as child
-   *                                                  elements and attribute
-   *                                                  names
-   * @return null|string Nothing, or output, depending on $return param
-   *
-   */
-  public static function tree(\SimpleXMLElement $sxml,
-                              $include_string_content = FALSE): string {
+            ($index > 1 ? 's' : '') . ')' . PHP_EOL;
+    }
+
+    /**
+     * Output a tree-view of the node or list of nodes referenced by a particular
+     * SimpleXML object Unlike simplexml_dump(), this processes the entire XML
+     * tree recursively, while attempting to be more concise and readable than
+     * the XML itself. Additionally, the output format is designed as a hint of
+     * the syntax needed to traverse the object.
+     *
+     * @param \SimpleXMLElement $sxml                   The object to inspect
+     * @param boolean           $include_string_content Default false. If true,
+     *                                                  will summarise textual
+     *                                                  content, as well as child
+     *                                                  elements and attribute
+     *                                                  names
+     * @return null|string Nothing, or output, depending on $return param
+     *
+     */
+    public static function tree(\SimpleXMLElement $sxml,
+                                $include_string_content = FALSE): string {
 
     // Get all the namespaces declared at the *root* of this document
     // All the items we're looking at are in the same document, so we only need do this once
@@ -294,30 +294,30 @@ 
     // Numeric array indexes, however, operate consistently: $node[0] just returns the node
     $root_item_index = 0;
     while (isset($sxml[$root_item_index])) {
-      $root_item = $sxml[$root_item_index];
+        $root_item = $sxml[$root_item_index];
 
-      // Special case if the root is actually an attribute
-      // It's surprisingly hard to find something which behaves consistently differently for an attribute and an element within SimpleXML
-      // The below relies on the fact that the DOM makes a much clearer distinction
-      // Note that this is not an expensive conversion, as we are only swapping PHP wrappers around an existing LibXML resource
-      if (dom_import_simplexml($root_item) instanceOf \DOMAttr) {
+        // Special case if the root is actually an attribute
+        // It's surprisingly hard to find something which behaves consistently differently for an attribute and an element within SimpleXML
+        // The below relies on the fact that the DOM makes a much clearer distinction
+        // Note that this is not an expensive conversion, as we are only swapping PHP wrappers around an existing LibXML resource
+        if (dom_import_simplexml($root_item) instanceOf \DOMAttr) {
         // To what namespace does this attribute belong? Returns array( alias => URI )
         $ns = $root_item->getNamespaces(FALSE);
         if (key($ns)) {
-          $dump .= key($ns) . ':';
+            $dump .= key($ns) . ':';
         }
         $dump .= $root_item->getName() . '="' . (string) $root_item . '"' .
-                 PHP_EOL;
-      } else {
+                    PHP_EOL;
+        } else {
         // Display the root node as a numeric key reference, plus a hint as to its tag name
         // e.g. '[42] // <Answer>'
 
         // To what namespace does this attribute belong? Returns array( alias => URI )
         $ns = $root_item->getNamespaces(FALSE);
         if (key($ns)) {
-          $root_node_name = key($ns) . ':' . $root_item->getName();
+            $root_node_name = key($ns) . ':' . $root_item->getName();
         } else {
-          $root_node_name = $root_item->getName();
+            $root_node_name = $root_item->getName();
         }
         $dump .= "[$root_item_index] // <$root_node_name>" . PHP_EOL;
 
@@ -325,13 +325,13 @@ 
         // but this is managed manually using a stack rather than actual recursion
         // Each item on the stack is of the form array(int $depth, SimpleXMLElement $element, string $header_row)
         $dump .= SxmlDebug::recursivelyProcessNode(
-          $root_item,
-          1,
-          $include_string_content
+            $root_item,
+            1,
+            $include_string_content
         );
-      }
+        }
 
-      $root_item_index++;
+        $root_item_index++;
     }
 
     // Add on the header line, with the total number of items output
@@ -339,39 +339,39 @@ 
 
     return $dump;
 
-  }
+    }
 
 
-  /**
-   * @param string $stringContent
-   * @param        $depth
-   * @return string
-   */
-  private static function treeGetStringExtract(string $stringContent,
-                                               $depth): string {
+    /**
+     * @param string $stringContent
+     * @param        $depth
+     * @return string
+     */
+    private static function treeGetStringExtract(string $stringContent,
+                                                $depth): string {
     $string_extract = preg_replace('/\s+/', ' ', trim($stringContent));
     if (strlen($string_extract) > SxmlDebug::EXTRACT_SIZE) {
-      $string_extract = substr($string_extract, 0, SxmlDebug::EXTRACT_SIZE)
+        $string_extract = substr($string_extract, 0, SxmlDebug::EXTRACT_SIZE)
                         . '...';
     }
     return (strlen($stringContent) > 0) ?
       str_repeat(SxmlDebug::INDENT, $depth)
-      . '(string) '
-      . "'$string_extract'"
-      . ' (' . strlen($stringContent) . ' chars)'
-      . PHP_EOL : '';
-
-  }
-
-  /**
-   * @param \SimpleXMLElement $item
-   * @return array
-   */
-  private static function treeGetNamespaces(\SimpleXMLElement $item): array {
+        . '(string) '
+        . "'$string_extract'"
+        . ' (' . strlen($stringContent) . ' chars)'
+        . PHP_EOL : '';
+
+    }
+
+    /**
+     * @param \SimpleXMLElement $item
+     * @return array
+     */
+    private static function treeGetNamespaces(\SimpleXMLElement $item): array {
     // To what namespace does this element belong? Returns array( alias => URI )
     $item_ns = $item->getNamespaces(FALSE);
     if (!$item_ns) {
-      $item_ns = ['' => NULL];
+        $item_ns = ['' => NULL];
     }
 
     // This returns all namespaces used by this node and all its descendants,
@@ -379,23 +379,23 @@ 
     $all_ns = $item->getNamespaces(TRUE);
     // If the default namespace is never declared, it will never show up using the below code
     if (!array_key_exists('', $all_ns)) {
-      $all_ns[''] = NULL;
+        $all_ns[''] = NULL;
     }
 
     // Prioritise "current" namespace by merging into onto the beginning of the list
     // (it will be added to the beginning and the duplicate entry dropped)
     return array_merge($item_ns, $all_ns);
-  }
-
-  /**
-   * @param \SimpleXMLElement $attributes
-   * @param string            $nsAlias
-   * @param int               $depth
-   * @param bool              $isCurrentNamespace
-   * @param bool              $includeStringContent
-   * @return string
-   */
-  private static function treeProcessAttributes(\SimpleXMLElement $attributes,
+    }
+
+    /**
+     * @param \SimpleXMLElement $attributes
+     * @param string            $nsAlias
+     * @param int               $depth
+     * @param bool              $isCurrentNamespace
+     * @param bool              $includeStringContent
+     * @return string
+     */
+    private static function treeProcessAttributes(\SimpleXMLElement $attributes,
                                                 string $nsAlias,
                                                 int $depth,
                                                 bool $isCurrentNamespace,
@@ -403,128 +403,128 @@ 
 
     $dump = '';
     if (count($attributes) > 0) {
-      if (!$isCurrentNamespace) {
+        if (!$isCurrentNamespace) {
         $dump .= str_repeat(self::INDENT, $depth)
-                 . "->attributes('$nsAlias', true)" . PHP_EOL;
-      }
+                    . "->attributes('$nsAlias', true)" . PHP_EOL;
+        }
 
-      foreach ($attributes as $sx_attribute) {
+        foreach ($attributes as $sx_attribute) {
         // Output the attribute
         if ($isCurrentNamespace) {
-          // In current namespace
-          // e.g. ['attribName']
-          $dump .= str_repeat(self::INDENT, $depth)
-                   . "['" . $sx_attribute->getName() . "']"
-                   . PHP_EOL;
-          $string_display_depth = $depth + 1;
+            // In current namespace
+            // e.g. ['attribName']
+            $dump .= str_repeat(self::INDENT, $depth)
+                    . "['" . $sx_attribute->getName() . "']"
+                    . PHP_EOL;
+            $string_display_depth = $depth + 1;
         } else {
-          // After a call to ->attributes()
-          // e.g. ->attribName
-          $dump .= str_repeat(self::INDENT, $depth + 1)
-                   . '->' . $sx_attribute->getName()
-                   . PHP_EOL;
-          $string_display_depth = $depth + 2;
+            // After a call to ->attributes()
+            // e.g. ->attribName
+            $dump .= str_repeat(self::INDENT, $depth + 1)
+                    . '->' . $sx_attribute->getName()
+                    . PHP_EOL;
+            $string_display_depth = $depth + 2;
         }
 
         if ($includeStringContent) {
-          // Show a chunk of the beginning of the content string, collapsing whitespace HTML-style
-          $dump .= self::treeGetStringExtract((string) $sx_attribute,
-                                              $string_display_depth);
+            // Show a chunk of the beginning of the content string, collapsing whitespace HTML-style
+            $dump .= self::treeGetStringExtract((string) $sx_attribute,
+                                                $string_display_depth);
+        }
         }
-      }
     }
     return $dump;
-  }
-
-  /**
-   * @param \SimpleXMLElement $children
-   * @param string            $nsAlias
-   * @param int               $depth
-   * @param bool              $isCurrentNamespace
-   * @param bool              $includeStringContent
-   * @return string
-   */
-  private static function treeProcessChildren(\SimpleXMLElement $children,
-                                              string $nsAlias,
-                                              int $depth,
-                                              bool $isCurrentNamespace,
-                                              bool $includeStringContent): string {
+    }
+
+    /**
+     * @param \SimpleXMLElement $children
+     * @param string            $nsAlias
+     * @param int               $depth
+     * @param bool              $isCurrentNamespace
+     * @param bool              $includeStringContent
+     * @return string
+     */
+    private static function treeProcessChildren(\SimpleXMLElement $children,
+                                                string $nsAlias,
+                                                int $depth,
+                                                bool $isCurrentNamespace,
+                                                bool $includeStringContent): string {
 
     $dump = '';
     if (count($children) > 0) {
-      if ($isCurrentNamespace) {
+        if ($isCurrentNamespace) {
         $display_depth = $depth;
-      } else {
+        } else {
         $dump .= str_repeat(self::INDENT, $depth)
-                 . "->children('$nsAlias', true)" . PHP_EOL;
+                    . "->children('$nsAlias', true)" . PHP_EOL;
         $display_depth = $depth + 1;
-      }
+        }
 
-      // Recurse through the children with headers showing how to access them
-      $child_names = [];
-      foreach ($children as $sx_child) {
+        // Recurse through the children with headers showing how to access them
+        $child_names = [];
+        foreach ($children as $sx_child) {
         // Below is a rather clunky way of saying $child_names[ $sx_child->getName() ]++;
         // 	which avoids Notices about unset array keys
         $child_node_name = $sx_child->getName();
         if (array_key_exists($child_node_name, $child_names)) {
-          $child_names[$child_node_name]++;
+            $child_names[$child_node_name]++;
         } else {
-          $child_names[$child_node_name] = 1;
+            $child_names[$child_node_name] = 1;
         }
 
         // e.g. ->Foo[0]
         $dump .= str_repeat(self::INDENT, $display_depth)
-                 . '->' . $sx_child->getName()
-                 . '[' . ($child_names[$child_node_name] - 1) . ']'
-                 . PHP_EOL;
+                    . '->' . $sx_child->getName()
+                    . '[' . ($child_names[$child_node_name] - 1) . ']'
+                    . PHP_EOL;
 
         $dump .= self::recursivelyProcessNode(
-          $sx_child,
-          $display_depth + 1,
-          $includeStringContent
+            $sx_child,
+            $display_depth + 1,
+            $includeStringContent
         );
-      }
+        }
     }
     return $dump;
-  }
-
-  /**
-   * @param $item
-   * @param $depth
-   * @param $include_string_content
-   * @return string
-   */
-  private static function recursivelyProcessNode(\SimpleXMLElement $item,
-                                                 $depth,
-                                                 $include_string_content): string {
+    }
+
+    /**
+     * @param $item
+     * @param $depth
+     * @param $include_string_content
+     * @return string
+     */
+    private static function recursivelyProcessNode(\SimpleXMLElement $item,
+                                                    $depth,
+                                                    $include_string_content): string {
 
     $dump = '';
 
     if ($include_string_content) {
-      // Show a chunk of the beginning of the content string, collapsing whitespace HTML-style
-      $dump = self::treeGetStringExtract((string) $item, $depth);
+        // Show a chunk of the beginning of the content string, collapsing whitespace HTML-style
+        $dump = self::treeGetStringExtract((string) $item, $depth);
     }
 
     $itemNs = self::treeGetNamespaces($item);
     foreach ($itemNs as $ns_alias => $ns_uri) {
 
 
-      // If things are in the current namespace, display them a bit differently
-      $is_current_namespace = ($ns_uri === reset($itemNs));
+        // If things are in the current namespace, display them a bit differently
+        $is_current_namespace = ($ns_uri === reset($itemNs));
 
-      $dump .= self::treeProcessAttributes($item->attributes($ns_alias, TRUE),
-                                           $ns_alias,
-                                           $depth,
-                                           $is_current_namespace,
-                                           $include_string_content);
-      $dump .= self::treeProcessChildren($item->children($ns_alias, TRUE),
-                                         $ns_alias,
-                                         $depth,
-                                         $is_current_namespace,
-                                         $include_string_content);
+        $dump .= self::treeProcessAttributes($item->attributes($ns_alias, TRUE),
+                                            $ns_alias,
+                                            $depth,
+                                            $is_current_namespace,
+                                            $include_string_content);
+        $dump .= self::treeProcessChildren($item->children($ns_alias, TRUE),
+                                            $ns_alias,
+                                            $depth,
+                                            $is_current_namespace,
+                                            $include_string_content);
     }
 
     return $dump;
-  }
+    }
 
 }
\ No newline at end of file

Spacing +35 added lines, -36 removed lines

@@ -39,7 +39,7 @@ 
 
     $dump = '';
     // Note that the header is added at the end, so we can add stats
-    $dump .= '[' . PHP_EOL;
+    $dump .= '['.PHP_EOL;
 
     // SimpleXML objects can be either a single node, or (more commonly) a list of 0 or more nodes
     // I haven't found a reliable way of distinguishing between the two cases
@@ -61,10 +61,10 @@ 
         $dump .= self::dumpAddElement($item);
       }
     }
-    $dump .= ']' . PHP_EOL;
+    $dump .= ']'.PHP_EOL;
 
     // Add on the header line, with the total number of items output
-    return self::getHeaderLine($item_index) . $dump;
+    return self::getHeaderLine($item_index).$dump;
   }
 
   /**
@@ -77,15 +77,15 @@ 
     // To what namespace does this attribute belong? Returns array( alias => URI )
     $ns = $item->getNamespaces(FALSE);
     if ($ns) {
-      $dump .= self::INDENT . self::INDENT . 'Namespace: \'' . reset($ns) .
-               '\'' .
+      $dump .= self::INDENT.self::INDENT.'Namespace: \''.reset($ns).
+               '\''.
                PHP_EOL;
       if (key($ns) == '') {
-        $dump .= self::INDENT . self::INDENT . '(Default Namespace)' . PHP_EOL;
+        $dump .= self::INDENT.self::INDENT.'(Default Namespace)'.PHP_EOL;
       } else {
-        $dump .= self::INDENT . self::INDENT . 'Namespace Alias: \'' .
-                 key($ns) .
-                 '\'' .
+        $dump .= self::INDENT.self::INDENT.'Namespace Alias: \''.
+                 key($ns).
+                 '\''.
                  PHP_EOL;
       }
     }
@@ -104,9 +104,9 @@ 
                                       $data,
                                       $indent = 1,
                                       $backtick = TRUE): string {
-    return str_repeat(self::INDENT, $indent) . $title . ': ' .
-           ($backtick ? '\'' : '') . $data .
-           ($backtick ? '\'' : '') . PHP_EOL;
+    return str_repeat(self::INDENT, $indent).$title.': '.
+           ($backtick ? '\'' : '').$data.
+           ($backtick ? '\'' : '').PHP_EOL;
   }
 
   /**
@@ -115,14 +115,14 @@ 
    */
   private static function dumpAddAttribute(\SimpleXMLElement $item): string {
 
-    $dump = self::INDENT . 'Attribute {' . PHP_EOL;
+    $dump = self::INDENT.'Attribute {'.PHP_EOL;
 
     $dump .= self::dumpAddNamespace($item);
 
     $dump .= self::dumpGetLine('Name', $item->getName(), 2);
     $dump .= self::dumpGetLine('Value', (string) $item, 2);
 
-    $dump .= self::INDENT . '}' . PHP_EOL;
+    $dump .= self::INDENT.'}'.PHP_EOL;
     return $dump;
 
   }
@@ -133,7 +133,7 @@ 
    */
   private static function dumpAddElement(\SimpleXMLElement $item): string {
 
-    $dump = self::INDENT . 'Element {' . PHP_EOL;
+    $dump = self::INDENT.'Element {'.PHP_EOL;
 
     $dump .= self::dumpAddNamespace($item);
 
@@ -176,10 +176,9 @@ 
         continue;
       }
 
-      $ns_label = (($ns_alias === '') ? 'Default Namespace' :
-        "Namespace $ns_alias");
+      $ns_label = (($ns_alias === '') ? 'Default Namespace' : "Namespace $ns_alias");
 
-      $dump .= self::INDENT . self::INDENT . 'Content in ' . $ns_label .
+      $dump .= self::INDENT.self::INDENT.'Content in '.$ns_label.
                PHP_EOL;
 
       if (NULL !== $ns_uri) {
@@ -199,7 +198,7 @@ 
                                  FALSE);
     }
 
-    return $dump . self::INDENT . '}' . PHP_EOL;
+    return $dump.self::INDENT.'}'.PHP_EOL;
   }
 
   /**
@@ -228,7 +227,7 @@ 
     $childrenString = count($children);
     // Don't output a trailing " - " if there are no children
     if (count($children) > 0) {
-      $childrenString .= ' - ' . implode(', ', $child_name_output);
+      $childrenString .= ' - '.implode(', ', $child_name_output);
     }
     return $childrenString;
   }
@@ -241,14 +240,14 @@ 
 // Attributes can't be duplicated, but I'm going to put them in alphabetical order
     $attribute_names = [];
     foreach ($attributes as $sx_attribute) {
-      $attribute_names[] = "'" . $sx_attribute->getName() . "'";
+      $attribute_names[] = "'".$sx_attribute->getName()."'";
     }
     ksort($attribute_names);
 
     $attString = count($attributes);
     // Don't output a trailing " - " if there are no attributes
     if (count($attributes) > 0) {
-      $attString .= ' - ' . implode(', ', $attribute_names);
+      $attString .= ' - '.implode(', ', $attribute_names);
     }
     return $attString;
   }
@@ -259,8 +258,8 @@ 
    */
   private static function getHeaderLine($index): string {
 
-    return 'SimpleXML object (' . $index . ' item' .
-           ($index > 1 ? 's' : '') . ')' . PHP_EOL;
+    return 'SimpleXML object ('.$index.' item'.
+           ($index > 1 ? 's' : '').')'.PHP_EOL;
   }
 
   /**
@@ -304,9 +303,9 @@ 
         // To what namespace does this attribute belong? Returns array( alias => URI )
         $ns = $root_item->getNamespaces(FALSE);
         if (key($ns)) {
-          $dump .= key($ns) . ':';
+          $dump .= key($ns).':';
         }
-        $dump .= $root_item->getName() . '="' . (string) $root_item . '"' .
+        $dump .= $root_item->getName().'="'.(string) $root_item.'"'.
                  PHP_EOL;
       } else {
         // Display the root node as a numeric key reference, plus a hint as to its tag name
@@ -315,11 +314,11 @@ 
         // To what namespace does this attribute belong? Returns array( alias => URI )
         $ns = $root_item->getNamespaces(FALSE);
         if (key($ns)) {
-          $root_node_name = key($ns) . ':' . $root_item->getName();
+          $root_node_name = key($ns).':'.$root_item->getName();
         } else {
           $root_node_name = $root_item->getName();
         }
-        $dump .= "[$root_item_index] // <$root_node_name>" . PHP_EOL;
+        $dump .= "[$root_item_index] // <$root_node_name>".PHP_EOL;
 
         // This function is effectively recursing depth-first through the tree,
         // but this is managed manually using a stack rather than actual recursion
@@ -335,7 +334,7 @@ 
     }
 
     // Add on the header line, with the total number of items output
-    $dump = self::getHeaderLine($root_item_index) . $dump;
+    $dump = self::getHeaderLine($root_item_index).$dump;
 
     return $dump;
 
@@ -358,7 +357,7 @@ 
       str_repeat(SxmlDebug::INDENT, $depth)
       . '(string) '
       . "'$string_extract'"
-      . ' (' . strlen($stringContent) . ' chars)'
+      . ' ('.strlen($stringContent).' chars)'
       . PHP_EOL : '';
 
   }
@@ -405,7 +404,7 @@ 
     if (count($attributes) > 0) {
       if (!$isCurrentNamespace) {
         $dump .= str_repeat(self::INDENT, $depth)
-                 . "->attributes('$nsAlias', true)" . PHP_EOL;
+                 . "->attributes('$nsAlias', true)".PHP_EOL;
       }
 
       foreach ($attributes as $sx_attribute) {
@@ -414,14 +413,14 @@ 
           // In current namespace
           // e.g. ['attribName']
           $dump .= str_repeat(self::INDENT, $depth)
-                   . "['" . $sx_attribute->getName() . "']"
+                   . "['".$sx_attribute->getName()."']"
                    . PHP_EOL;
           $string_display_depth = $depth + 1;
         } else {
           // After a call to ->attributes()
           // e.g. ->attribName
           $dump .= str_repeat(self::INDENT, $depth + 1)
-                   . '->' . $sx_attribute->getName()
+                   . '->'.$sx_attribute->getName()
                    . PHP_EOL;
           $string_display_depth = $depth + 2;
         }
@@ -456,7 +455,7 @@ 
         $display_depth = $depth;
       } else {
         $dump .= str_repeat(self::INDENT, $depth)
-                 . "->children('$nsAlias', true)" . PHP_EOL;
+                 . "->children('$nsAlias', true)".PHP_EOL;
         $display_depth = $depth + 1;
       }
 
@@ -474,8 +473,8 @@ 
 
         // e.g. ->Foo[0]
         $dump .= str_repeat(self::INDENT, $display_depth)
-                 . '->' . $sx_child->getName()
-                 . '[' . ($child_names[$child_node_name] - 1) . ']'
+                 . '->'.$sx_child->getName()
+                 . '['.($child_names[$child_node_name] - 1).']'
                  . PHP_EOL;
 
         $dump .= self::recursivelyProcessNode(