servo-php / fluidxml

source/FluidXml.php

Doc Comments +21 added lines, -5 removed lines

@@ -61,7 +61,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)
 {
@@ -140,12 +140,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);
 
         /**
@@ -162,9 +166,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.
          */
@@ -179,6 +180,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);
@@ -513,6 +518,10 @@ 
                 return new FluidContext($context, $this->namespaces);
         }
 
+        /**
+         * @param FluidContext $help_context
+         * @param FluidContext $new_context
+         */
         protected function chooseContext($help_context, $new_context)
         {
                 // If the two contextes are diffent, the user has requested
@@ -1014,6 +1023,10 @@ 
                 throw new \Exception('XML document not supported.');
         }
 
+        /**
+         * @param string $name
+         * @param string $value
+         */
         protected function createElement($name, $value = null)
         {
                 // The DOMElement instance must be different for every node,
@@ -1342,6 +1355,9 @@ 
         private $context;
         private $times;
 
+        /**
+         * @param FluidContext $context
+         */
         public function __construct($context, $times)
         {
                 $this->context = $context;

Indentation +26 added lines, -28 removed lines

@@ -133,7 +133,6 @@ 
          *
          * ```php
          * $xml = fluidxml();
-
          * $xml->query("/doc/book[@id='123']");
          *
          * // Relative queries are valid.
@@ -153,7 +152,6 @@ 
          *
          * ```php
          * $xml = fluidxml();
-
          * $xml->appendChild('title', 'The Theory Of Everything');
          * $xml->appendChild([ 'author' => 'S. Hawking' ]);
          *
@@ -268,9 +266,9 @@ 
 class FluidXml implements FluidInterface
 {
         use FluidNamespaceTrait,
-            NewableTrait,
-            ReservedCallTrait,          // For compatibility with PHP 5.6.
-            ReservedCallStaticTrait;    // For compatibility with PHP 5.6.
+                NewableTrait,
+                ReservedCallTrait,          // For compatibility with PHP 5.6.
+                ReservedCallStaticTrait;    // For compatibility with PHP 5.6.
 
         const ROOT_NODE = 'doc';
 
@@ -301,9 +299,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
@@ -327,9 +325,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);
@@ -528,9 +526,9 @@ 
 class FluidContext implements FluidInterface, \ArrayAccess, \Iterator
 {
         use FluidNamespaceTrait,
-            NewableTrait,
-            ReservedCallTrait,          // For compatibility with PHP 5.6.
-            ReservedCallStaticTrait;    // For compatibility with PHP 5.6.
+                NewableTrait,
+                ReservedCallTrait,          // For compatibility with PHP 5.6.
+                ReservedCallStaticTrait;    // For compatibility with PHP 5.6.
 
         private $dom;
         private $nodes = [];
@@ -990,18 +988,18 @@ 
         protected function handleInsertion(...$arguments)
         {
                 $check_sequence = [ 'specialContentHandler',
-                                    'specialAttributeHandler',
-                                    'stringStringHandler',
-                                    'stringMixedHandler',
-                                    'integerArrayHandler',
-                                    'integerStringNotXmlHandler',
-                                    'integerXmlHandler',
-                                    'integerDomdocumentHandler',
-                                    'integerDomnodelistHandler',
-                                    'integerDomnodeHandler',
-                                    'integerSimplexmlHandler',
-                                    'integerFluidxmlHandler',
-                                    'integerFluidcontextHandler' ];
+                                        'specialAttributeHandler',
+                                        'stringStringHandler',
+                                        'stringMixedHandler',
+                                        'integerArrayHandler',
+                                        'integerStringNotXmlHandler',
+                                        'integerXmlHandler',
+                                        'integerDomdocumentHandler',
+                                        'integerDomnodelistHandler',
+                                        'integerDomnodeHandler',
+                                        'integerSimplexmlHandler',
+                                        'integerFluidxmlHandler',
+                                        'integerFluidcontextHandler' ];
 
                 foreach ($check_sequence as $check) {
                         $ret = $this->$check(...$arguments);
@@ -1273,8 +1271,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 +48 added lines, -48 removed lines

@@ -80,7 +80,7 @@ 
 
 function is_an_xml_string($string)
 {
-        if (! \is_string($string)) {
+        if (!\is_string($string)) {
                 return false;
         }
 
@@ -244,7 +244,7 @@ 
                 $namespaces = [];
 
                 if (\is_string($arguments[0])) {
-                        $args = [ $arguments[0], $arguments[1] ];
+                        $args = [$arguments[0], $arguments[1]];
 
                         if (isset($arguments[2])) {
                                 $args[] = $arguments[2];
@@ -269,8 +269,8 @@ 
 {
         use FluidNamespaceTrait,
             NewableTrait,
-            ReservedCallTrait,          // For compatibility with PHP 5.6.
-            ReservedCallStaticTrait;    // For compatibility with PHP 5.6.
+            ReservedCallTrait, // For compatibility with PHP 5.6.
+            ReservedCallStaticTrait; // For compatibility with PHP 5.6.
 
         const ROOT_NODE = 'doc';
 
@@ -278,7 +278,7 @@ 
 
         public static function load($document)
         {
-                if (\is_string($document) && ! is_an_xml_string($document)) {
+                if (\is_string($document) && !is_an_xml_string($document)) {
                         // Removes any empty new line at the beginning,
                         // otherwise the first character check fails.
 
@@ -290,7 +290,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.");
                         }
                 }
@@ -300,10 +300,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
@@ -497,14 +497,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;
@@ -529,8 +529,8 @@ 
 {
         use FluidNamespaceTrait,
             NewableTrait,
-            ReservedCallTrait,          // For compatibility with PHP 5.6.
-            ReservedCallStaticTrait;    // For compatibility with PHP 5.6.
+            ReservedCallTrait, // For compatibility with PHP 5.6.
+            ReservedCallStaticTrait; // For compatibility with PHP 5.6.
 
         private $dom;
         private $nodes = [];
@@ -538,8 +538,8 @@ 
 
         public function __construct($context, array $namespaces = [])
         {
-                if (! \is_array($context)) {
-                        $context = [ $context ];
+                if (!\is_array($context)) {
+                        $context = [$context];
                 }
 
                 foreach ($context as $n) {
@@ -560,7 +560,7 @@ 
                         }
                 }
 
-                if (! empty($namespaces)) {
+                if (!empty($namespaces)) {
                         $this->namespace(...\array_values($namespaces));
                 }
         }
@@ -689,7 +689,7 @@ 
                                 }
                         }
 
-                        if (! $found) {
+                        if (!$found) {
                                 $unique_results[] = $r;
                         }
                 }
@@ -744,7 +744,7 @@ 
         // appendChild($child, $value?, $attributes? = [], $switchContext? = false)
         public function appendChild($child, ...$optionals)
         {
-                return $this->insertElement($child, $optionals, [ static::class, 'doAppendChild' ]);
+                return $this->insertElement($child, $optionals, [static::class, 'doAppendChild']);
         }
 
         // Alias of appendChild().
@@ -760,7 +760,7 @@ 
 
         public function prependSibling($sibling, ...$optionals)
         {
-                return $this->insertElement($sibling, $optionals, [ static::class, 'doPrependSibling' ]);
+                return $this->insertElement($sibling, $optionals, [static::class, 'doPrependSibling']);
         }
 
         // Alias of prependSibling().
@@ -783,7 +783,7 @@ 
 
         public function appendSibling($sibling, ...$optionals)
         {
-                return $this->insertElement($sibling, $optionals, [ static::class, 'doAppendSibling' ]);
+                return $this->insertElement($sibling, $optionals, [static::class, 'doAppendSibling']);
         }
 
         // Alias of appendSibling().
@@ -811,7 +811,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]];
                 }
 
@@ -935,8 +935,8 @@ 
 
         protected function handleOptionals($element, array $optionals)
         {
-                if (! \is_array($element)) {
-                        $element = [ $element ];
+                if (!\is_array($element)) {
+                        $element = [$element];
                 }
 
                 $switch_context = false;
@@ -959,7 +959,7 @@ 
                         }
                 }
 
-                return [ $element, $attributes, $switch_context ];
+                return [$element, $attributes, $switch_context];
         }
 
         protected function insertElement($element, array $optionals, callable $fn)
@@ -983,7 +983,7 @@ 
                 // offers to the user and is the same of:
                 // 1. appending a child switching the context
                 // 2. setting the attributes over the new context.
-                if (! empty($attributes)) {
+                if (!empty($attributes)) {
                         $context->setAttribute($attributes);
                 }
 
@@ -996,7 +996,7 @@ 
 
         protected function handleInsertion(...$arguments)
         {
-                $check_sequence = [ 'specialContentHandler',
+                $check_sequence = ['specialContentHandler',
                                     'specialAttributeHandler',
                                     'stringStringHandler',
                                     'stringMixedHandler',
@@ -1008,7 +1008,7 @@ 
                                     'integerDomnodeHandler',
                                     'integerSimplexmlHandler',
                                     'integerFluidxmlHandler',
-                                    'integerFluidcontextHandler' ];
+                                    'integerFluidcontextHandler'];
 
                 foreach ($check_sequence as $check) {
                         $ret = $this->$check(...$arguments);
@@ -1055,8 +1055,8 @@ 
 
         protected function attachNodes($parent, $nodes, $fn)
         {
-                if (! \is_array($nodes) && ! $nodes instanceof \Traversable) {
-                        $nodes = [ $nodes ];
+                if (!\is_array($nodes) && !$nodes instanceof \Traversable) {
+                        $nodes = [$nodes];
                 }
 
                 $context = [];
@@ -1071,7 +1071,7 @@ 
 
         protected function specialContentHandler($parent, $k, $v)
         {
-                if (! \is_string($k) || $k !== '@'|| ! \is_string($v)) {
+                if (!\is_string($k) || $k !== '@' || !\is_string($v)) {
                         return false;
                 }
 
@@ -1092,7 +1092,7 @@ 
 
         protected function specialAttributeHandler($parent, $k, $v)
         {
-                if (! \is_string($k) || $k[0] !== '@' || ! \is_string($v)) {
+                if (!\is_string($k) || $k[0] !== '@' || !\is_string($v)) {
                         return false;
                 }
 
@@ -1107,7 +1107,7 @@ 
 
         protected function stringStringHandler($parent, $k, $v, $fn)
         {
-                if (! \is_string($k) || ! \is_string($v)) {
+                if (!\is_string($k) || !\is_string($v)) {
                         return false;
                 }
 
@@ -1117,12 +1117,12 @@ 
                 $el = $this->createElement($k, $v);
                 $el = \call_user_func($fn, $parent, $el);
 
-                return [ $el ];
+                return [$el];
         }
 
         protected function stringMixedHandler($parent, $k, $v, $fn, $optionals)
         {
-                if (! \is_string($k) || \is_string($v)) {
+                if (!\is_string($k) || \is_string($v)) {
                         return false;
                 }
 
@@ -1137,12 +1137,12 @@ 
                 // they are supplied, so 'appendChild' is the perfect operation.
                 $this->newContext($el)->appendChild($v, ...$optionals);
 
-                return [ $el ];
+                return [$el];
         }
 
         protected function integerArrayHandler($parent, $k, $v, $fn, $optionals)
         {
-                if (! \is_int($k) || ! \is_array($v)) {
+                if (!\is_int($k) || !\is_array($v)) {
                         return false;
                 }
 
@@ -1162,7 +1162,7 @@ 
 
         protected function integerStringNotXmlHandler($parent, $k, $v, $fn)
         {
-                if (! \is_int($k) || ! \is_string($v) || is_an_xml_string($v)) {
+                if (!\is_int($k) || !\is_string($v) || is_an_xml_string($v)) {
                         return false;
                 }
 
@@ -1172,12 +1172,12 @@ 
                 $el = $this->createElement($v);
                 $el = \call_user_func($fn, $parent, $el);
 
-                return [ $el ];
+                return [$el];
         }
 
         protected function integerXmlHandler($parent, $k, $v, $fn)
         {
-                if (! \is_int($k) || ! is_an_xml_string($v)) {
+                if (!\is_int($k) || !is_an_xml_string($v)) {
                         return false;
                 }
 
@@ -1210,7 +1210,7 @@ 
 
         protected function integerDomdocumentHandler($parent, $k, $v, $fn)
         {
-                if (! \is_int($k) || ! $v instanceof \DOMDocument) {
+                if (!\is_int($k) || !$v instanceof \DOMDocument) {
                         return false;
                 }
 
@@ -1225,7 +1225,7 @@ 
 
         protected function integerDomnodelistHandler($parent, $k, $v, $fn)
         {
-                if (! \is_int($k) || ! $v instanceof \DOMNodeList) {
+                if (!\is_int($k) || !$v instanceof \DOMNodeList) {
                         return false;
                 }
 
@@ -1234,7 +1234,7 @@ 
 
         protected function integerDomnodeHandler($parent, $k, $v, $fn)
         {
-                if (! \is_int($k) || ! $v instanceof \DOMNode) {
+                if (!\is_int($k) || !$v instanceof \DOMNode) {
                         return false;
                 }
 
@@ -1243,7 +1243,7 @@ 
 
         protected function integerSimplexmlHandler($parent, $k, $v, $fn)
         {
-                if (! \is_int($k) || ! $v instanceof \SimpleXMLElement) {
+                if (!\is_int($k) || !$v instanceof \SimpleXMLElement) {
                         return false;
                 }
 
@@ -1252,7 +1252,7 @@ 
 
         protected function integerFluidxmlHandler($parent, $k, $v, $fn)
         {
-                if (! \is_int($k) || ! $v instanceof FluidXml) {
+                if (!\is_int($k) || !$v instanceof FluidXml) {
                         return false;
                 }
 
@@ -1261,7 +1261,7 @@ 
 
         protected function integerFluidcontextHandler($parent, $k, $v, $fn)
         {
-                if (! \is_int($k) || ! $v instanceof FluidContext) {
+                if (!\is_int($k) || !$v instanceof FluidContext) {
                         return false;
                 }
 
@@ -1271,16 +1271,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)
         {