servo-php / fluidxml

source/FluidXml.php

Doc Comments +24 added lines, -5 removed lines

@@ -68,7 +68,7 @@ 
  *
  * @param array $arguments Options that influence the construction of the XML document.
  *
- * @return FluidXml A new FluidXml instance.
+ * @return FluidContext A new FluidXml instance.
  */
 function fluidify(...$arguments)
 {
@@ -85,6 +85,9 @@ 
         return new FluidNamespace(...$arguments);
 }
 
+/**
+ * @param string $string
+ */
 function is_an_xml_string($string)
 {
         // Removes any empty new line at the beginning,
@@ -143,12 +146,16 @@ 
          * $xml->query("/doc")->query("book[@id='123']");
          * ```
          *
-         * @param string $xpath The XPath to execute.
+         * @param string[] $xpath The XPath to execute.
          *
          * @return FluidContext The context associated to the DOMNodeList.
          */
         public function query(...$xpath);
         public function times($times, callable $fn = null);
+
+        /**
+         * @return FluidContext
+         */
         public function each(callable $fn);
 
         /**
@@ -165,9 +172,6 @@ 
          * ```
          *
          * @param string|array $child The child/children to add.
-         * @param string $value The child text content.
-         * @param bool $switchContext Whether to return the current context
-         *                            or the context of the created node.
          *
          * @return FluidContext The context associated to the DOMNodeList.
          */
@@ -182,6 +186,10 @@ 
         public function remove(...$xpath);
         public function xml($strip = false);
         // Aliases:
+
+        /**
+         * @return FluidContext
+         */
         public function add($child, ...$optionals);
         public function prepend($sibling, ...$optionals);
         public function insertSiblingBefore($sibling, ...$optionals);
@@ -478,6 +486,10 @@ 
                 return new FluidContext($context, $this->namespaces);
         }
 
+        /**
+         * @param FluidContext $helpContext
+         * @param FluidContext $newContext
+         */
         protected function chooseContext($helpContext, $newContext)
         {
                 // If the two contextes are diffent, the user has requested
@@ -876,6 +888,10 @@ 
                 return new FluidContext($context, $this->namespaces);
         }
 
+        /**
+         * @param string $name
+         * @param string $value
+         */
         protected function createElement($name, $value = null)
         {
                 // The DOMElement instance must be different for every node,
@@ -1211,6 +1227,9 @@ 
         protected $context;
         protected $times;
 
+        /**
+         * @param FluidContext $context
+         */
         public function __construct($context, $times)
         {
                 $this->context = $context;

Indentation +11 added lines, -13 removed lines

@@ -136,7 +136,6 @@ 
          *
          * ```php
          * $xml = fluidxml();
-
          * $xml->query("/doc/book[@id='123']");
          *
          * // Relative queries are valid.
@@ -156,7 +155,6 @@ 
          *
          * ```php
          * $xml = fluidxml();
-
          * $xml->appendChild('title', 'The Theory Of Everything');
          * $xml->appendChild([ 'author' => 'S. Hawking' ]);
          *
@@ -234,8 +232,8 @@ 
 class FluidXml implements FluidInterface
 {
         use FluidNamespaceTrait,
-            FluidXmlShadowTrait,        // For compatibility with PHP 5.6.
-            FluidContextShadowTrait;    // For compatibility with PHP 5.6.
+                FluidXmlShadowTrait,        // For compatibility with PHP 5.6.
+                FluidContextShadowTrait;    // For compatibility with PHP 5.6.
 
         const ROOT_NODE = 'doc';
 
@@ -266,9 +264,9 @@ 
         public function __construct($root = null, $options = [])
         {
                 $defaults = [ 'root'       => self::ROOT_NODE,
-                              'version'    => '1.0',
-                              'encoding'   => 'UTF-8',
-                              'stylesheet' => null ];
+                                'version'    => '1.0',
+                                'encoding'   => 'UTF-8',
+                                'stylesheet' => null ];
 
                 if (\is_string($root)) {
                         // The root option can be specified as first argument
@@ -292,9 +290,9 @@ 
 
                 if ($opts['stylesheet']) {
                         $attrs = "type=\"text/xsl\" "
-                               . "encoding=\"{$opts['encoding']}\" "
-                               . "indent=\"yes\" "
-                               . "href=\"{$opts['stylesheet']}\"";
+                                . "encoding=\"{$opts['encoding']}\" "
+                                . "indent=\"yes\" "
+                                . "href=\"{$opts['stylesheet']}\"";
                         $stylesheet = new \DOMProcessingInstruction('xml-stylesheet', $attrs);
 
                         $this->dom->insertBefore($stylesheet, $this->dom->documentElement);
@@ -493,7 +491,7 @@ 
 class FluidContext implements FluidInterface, \ArrayAccess, \Iterator
 {
         use FluidNamespaceTrait,
-            FluidContextShadowTrait;    // For compatibility with PHP 5.6.
+                FluidContextShadowTrait;    // For compatibility with PHP 5.6.
 
         private $dom;
         private $nodes = [];
@@ -1142,8 +1140,8 @@ 
         const MODE_EXPLICIT = 1;
 
         private $config = [ self::ID   => '',
-                            self::URI  => '',
-                            self::MODE => self::MODE_EXPLICIT ];
+                                self::URI  => '',
+                                self::MODE => self::MODE_EXPLICIT ];
 
         public function __construct($id, $uri, $mode = 1)
         {

Spacing +30 added lines, -30 removed lines

@@ -210,7 +210,7 @@ 
                 $namespaces = [];
 
                 if (\is_string($arguments[0])) {
-                        $args = [ $arguments[0], $arguments[1] ];
+                        $args = [$arguments[0], $arguments[1]];
 
                         if (isset($arguments[2])) {
                                 $args[] = $arguments[2];
@@ -234,8 +234,8 @@ 
 class FluidXml implements FluidInterface
 {
         use FluidNamespaceTrait,
-            FluidXmlShadowTrait,        // For compatibility with PHP 5.6.
-            FluidContextShadowTrait;    // For compatibility with PHP 5.6.
+            FluidXmlShadowTrait, // For compatibility with PHP 5.6.
+            FluidContextShadowTrait; // For compatibility with PHP 5.6.
 
         const ROOT_NODE = 'doc';
 
@@ -243,7 +243,7 @@ 
 
         public static function load($document)
         {
-                if (\is_string($document) && ! \FluidXml\is_an_xml_string($document)) {
+                if (\is_string($document) && !\FluidXml\is_an_xml_string($document)) {
                         // Removes any empty new line at the beginning,
                         // otherwise the first character check fails.
 
@@ -255,7 +255,7 @@ 
                                 $document = \file_get_contents($file);
                         }
 
-                        if (! $is_file || ! $is_readable || ! $document) {
+                        if (!$is_file || !$is_readable || !$document) {
                                 throw new \Exception("File '$file' not accessible.");
                         }
                 }
@@ -265,10 +265,10 @@ 
 
         public function __construct($root = null, $options = [])
         {
-                $defaults = [ 'root'       => self::ROOT_NODE,
+                $defaults = ['root'       => self::ROOT_NODE,
                               'version'    => '1.0',
                               'encoding'   => 'UTF-8',
-                              'stylesheet' => null ];
+                              'stylesheet' => null];
 
                 if (\is_string($root)) {
                         // The root option can be specified as first argument
@@ -462,14 +462,14 @@ 
 
         protected function newContext($context = null)
         {
-                if (! $context) {
+                if (!$context) {
                         $context = $this->dom->documentElement;
                 }
 
                 // If the user has requested ['root' => null] at construction time
                 // the 'documentElement' property is null because we have not created
                 // a root node yet.
-                if (! $context) {
+                if (!$context) {
                         // Whether there is not a root node, the DOMDocument is
                         // promoted as root node.
                         $context = $this->dom;
@@ -493,7 +493,7 @@ 
 class FluidContext implements FluidInterface, \ArrayAccess, \Iterator
 {
         use FluidNamespaceTrait,
-            FluidContextShadowTrait;    // For compatibility with PHP 5.6.
+            FluidContextShadowTrait; // For compatibility with PHP 5.6.
 
         private $dom;
         private $nodes = [];
@@ -501,8 +501,8 @@ 
 
         public function __construct($context, array $namespaces = [])
         {
-                if (! \is_array($context)) {
-                        $context = [ $context ];
+                if (!\is_array($context)) {
+                        $context = [$context];
                 }
 
                 foreach ($context as $n) {
@@ -523,7 +523,7 @@ 
                         }
                 }
 
-                if (! empty($namespaces)) {
+                if (!empty($namespaces)) {
                         $this->namespace(...\array_values($namespaces));
                 }
         }
@@ -652,7 +652,7 @@ 
                                 }
                         }
 
-                        if (! $found) {
+                        if (!$found) {
                                 $unique_results[] = $r;
                         }
                 }
@@ -754,7 +754,7 @@ 
                 // the user has passed two arguments:
                 // 1. is the attribute name
                 // 2. is the attribute value
-                if (! \is_array($arguments[0])) {
+                if (!\is_array($arguments[0])) {
                         $attrs = [$arguments[0] => $arguments[1]];
                 }
 
@@ -938,11 +938,11 @@ 
 
                                 return [];
                         } else {
-                                return [ $fn($parent, $this->createElement($k, $v)) ];
+                                return [$fn($parent, $this->createElement($k, $v))];
                         }
                 }
 
-                $v_isnt_string = ! $v_is_string;
+                $v_isnt_string = !$v_is_string;
 
                 if ($k_is_string && $v_isnt_string) {
                         // The user has passed one of these two cases:
@@ -955,7 +955,7 @@ 
                         // they are supplied, so 'appendChild' is the perfect operation.
                         $this->newContext($el)->appendChild($v, ...$optionals);
 
-                        return [ $el ];
+                        return [$el];
                 }
 
                 $k_is_int   = \is_int($k);
@@ -977,13 +977,13 @@ 
                 }
 
                 $v_is_xml   = $v_is_string && is_an_xml_string($v);
-                $v_isnt_xml = ! $v_is_xml;
+                $v_isnt_xml = !$v_is_xml;
 
                 if ($k_is_int && $v_is_string && $v_isnt_xml) {
                         // The user has passed a node name without a node value:
                         // [ 'element', ... ]
 
-                        return [ $fn($parent, $this->createElement($v)) ];
+                        return [$fn($parent, $this->createElement($v))];
                 }
 
                 // The user has passed an XML document instance:
@@ -1046,19 +1046,19 @@ 
                 $v_is_domnode = $v instanceof \DOMNode;
 
                 if ($k_is_int && $v_is_domnode) {
-                        return $attach_nodes([ $v ]);
+                        return $attach_nodes([$v]);
                 }
 
                 $v_is_simplexml = $v instanceof \SimpleXMLElement;
 
                 if ($k_is_int && $v_is_simplexml) {
-                        return $attach_nodes([ dom_import_simplexml($v) ]);
+                        return $attach_nodes([dom_import_simplexml($v)]);
                 }
 
                 $v_is_fluidxml = $v instanceof FluidXml;
 
                 if ($k_is_int && $v_is_fluidxml) {
-                        return $attach_nodes([ $v->dom()->documentElement ]);
+                        return $attach_nodes([$v->dom()->documentElement]);
                 }
 
                 $v_is_fluidcontext = $v instanceof FluidContext;
@@ -1080,8 +1080,8 @@ 
 
         protected function insertElement(\Closure $fn, $element, ...$optionals)
         {
-                if (! \is_array($element)) {
-                        $element = [ $element ];
+                if (!\is_array($element)) {
+                        $element = [$element];
                 }
 
                 $switchContext = false;
@@ -1091,7 +1091,7 @@ 
                         if (\is_array($opt)) {
                                 $attributes = $opt;
 
-                        } else if (\is_bool($opt)){
+                        } else if (\is_bool($opt)) {
                                 $switchContext = $opt;
 
                         } else if (\is_string($opt)) {
@@ -1134,16 +1134,16 @@ 
 
 class FluidNamespace
 {
-        const ID   = 'id'  ;
-        const URI  = 'uri' ;
+        const ID   = 'id';
+        const URI  = 'uri';
         const MODE = 'mode';
 
         const MODE_IMPLICIT = 0;
         const MODE_EXPLICIT = 1;
 
-        private $config = [ self::ID   => '',
+        private $config = [self::ID   => '',
                             self::URI  => '',
-                            self::MODE => self::MODE_EXPLICIT ];
+                            self::MODE => self::MODE_EXPLICIT];
 
         public function __construct($id, $uri, $mode = 1)
         {

Braces +1 added lines, -1 removed lines

@@ -1091,7 +1091,7 @@
                         if (\is_array($opt)) {
                                 $attributes = $opt;
 
-                        } else if (\is_bool($opt)){
+                        } else if (\is_bool($opt)) {
                                 $switchContext = $opt;
 
                         } else if (\is_string($opt)) {