servo-php / fluidxml

source/FluidXml.php

Doc Comments +72 added lines, -2 removed lines

@@ -71,7 +71,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)
 {
@@ -88,6 +88,9 @@ 
         return new FluidNamespace(...$arguments);
 }
 
+/**
+ * @param string $string
+ */
 function is_an_xml_string($string)
 {
         // Removes any empty new line at the beginning,
@@ -534,7 +537,7 @@ 
          * $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.
          */
@@ -573,8 +576,16 @@ 
         public function appendCdata($text);
         public function remove(...$xpath);
         public function xml($strip = false);
+
+        /**
+         * @return SaveableTrait
+         */
         public function save($file, $strip = false);
         // Aliases:
+
+        /**
+         * @return FluidContext
+         */
         public function add($child, ...$optionals);
         public function prepend($sibling, ...$optionals);
         public function insertSiblingBefore($sibling, ...$optionals);
@@ -651,6 +662,9 @@ 
         private $context;
         private $times;
 
+        /**
+         * @param FluidContext $context
+         */
         public function __construct($document, $handler, $context, $times)
         {
                 $this->document = $document;
@@ -683,6 +697,9 @@ 
         private $dom;
         private $namespaces;
 
+        /**
+         * @param FluidDocument $document
+         */
         public function __construct($document)
         {
                 $this->document   = $document;
@@ -924,6 +941,10 @@ 
                 return $context;
         }
 
+        /**
+         * @param string $k
+         * @param string $v
+         */
         protected function insertSpecialContent($parent, $k, $v)
         {
                 // The user has passed an element text content:
@@ -941,6 +962,10 @@ 
                 return [];
         }
 
+        /**
+         * @param string $k
+         * @param string $v
+         */
         protected function insertSpecialAttribute($parent, $k, $v)
         {
                 // The user has passed an attribute name and an attribute value:
@@ -952,6 +977,10 @@ 
                 return [];
         }
 
+        /**
+         * @param string $k
+         * @param string $v
+         */
         protected function insertStringString($parent, $k, $v, $fn)
         {
                 // The user has passed an element name and an element value:
@@ -963,6 +992,9 @@ 
                 return [ $el ];
         }
 
+        /**
+         * @param string $k
+         */
         protected function insertStringMixed($parent, $k, $v, $fn, &$optionals)
         {
                 // The user has passed one of these two cases:
@@ -979,6 +1011,9 @@ 
                 return [ $el ];
         }
 
+        /**
+         * @param integer $k
+         */
         protected function insertIntegerArray($parent, $k, $v, $fn, &$optionals)
         {
                 // The user has passed a wrapper array:
@@ -995,6 +1030,10 @@ 
                 return $context;
         }
 
+        /**
+         * @param integer $k
+         * @param string $v
+         */
         protected function insertIntegerString($parent, $k, $v, $fn)
         {
                 // The user has passed a node name without a node value:
@@ -1006,6 +1045,10 @@ 
                 return [ $el ];
         }
 
+        /**
+         * @param integer $k
+         * @param string $v
+         */
         protected function insertIntegerXml($parent, $k, $v, $fn)
         {
                 // The user has passed an XML document instance:
@@ -1035,6 +1078,10 @@ 
                 return $this->attachNodes($parent, $nodes, $fn);
         }
 
+        /**
+         * @param integer $k
+         * @param \DOMDocument $v
+         */
         protected function insertIntegerDomdocument($parent, $k, $v, $fn)
         {
                 // A DOMDocument can have multiple root nodes.
@@ -1046,26 +1093,46 @@ 
                 // return $this->attachNodes($parent, $v->documentElement, $fn);
         }
 
+        /**
+         * @param integer $k
+         * @param \DOMNodeList $v
+         */
         protected function insertIntegerDomnodelist($parent, $k, $v, $fn)
         {
                 return $this->attachNodes($parent, $v, $fn);
         }
 
+        /**
+         * @param integer $k
+         * @param \DOMNode $v
+         */
         protected function insertIntegerDomnode($parent, $k, $v, $fn)
         {
                 return $this->attachNodes($parent, $v, $fn);
         }
 
+        /**
+         * @param integer $k
+         * @param \SimpleXMLElement $v
+         */
         protected function insertIntegerSimplexml($parent, $k, $v, $fn)
         {
                 return $this->attachNodes($parent, \dom_import_simplexml($v), $fn);
         }
 
+        /**
+         * @param integer $k
+         * @param FluidXml $v
+         */
         protected function insertIntegerFluidxml($parent, $k, $v, $fn)
         {
                 return $this->attachNodes($parent, $v->dom()->documentElement, $fn);
         }
 
+        /**
+         * @param integer $k
+         * @param FluidContext $v
+         */
         protected function insertIntegerFluidcontext($parent, $k, $v, $fn)
         {
                 return $this->attachNodes($parent, $v->asArray(), $fn);
@@ -1450,6 +1517,9 @@ 
                 return $set;
         }
 
+        /**
+         * @param callable $fn
+         */
         protected function callfn($fn, $args)
         {
                 if ($fn instanceof \Closure) {

Indentation +14 added lines, -16 removed lines

@@ -138,9 +138,9 @@ 
 class FluidXml implements FluidInterface
 {
         use NewableTrait,
-            SaveableTrait,
-            ReservedCallTrait,          // For compatibility with PHP 5.6.
-            ReservedCallStaticTrait;    // For compatibility with PHP 5.6.
+                SaveableTrait,
+                ReservedCallTrait,          // For compatibility with PHP 5.6.
+                ReservedCallStaticTrait;    // For compatibility with PHP 5.6.
 
         const ROOT_NODE = 'doc';
 
@@ -165,9 +165,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
@@ -198,9 +198,9 @@ 
 
                 if (! empty($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);
 
                         $doc->dom->insertBefore($stylesheet, $doc->dom->documentElement);
@@ -445,8 +445,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)
         {
@@ -527,7 +527,6 @@ 
          *
          * ```php
          * $xml = fluidxml();
-
          * $xml->query("/doc/book[@id='123']");
          *
          * // Relative queries are valid.
@@ -547,7 +546,6 @@ 
          *
          * ```php
          * $xml = fluidxml();
-
          * $xml->appendChild('title', 'The Theory Of Everything');
          * $xml->appendChild([ 'author' => 'S. Hawking' ]);
          *
@@ -1075,9 +1073,9 @@ 
 class FluidContext implements FluidInterface, \ArrayAccess, \Iterator
 {
         use NewableTrait,
-            SaveableTrait,
-            ReservedCallTrait,          // For compatibility with PHP 5.6.
-            ReservedCallStaticTrait;    // For compatibility with PHP 5.6.
+                SaveableTrait,
+                ReservedCallTrait,          // For compatibility with PHP 5.6.
+                ReservedCallStaticTrait;    // For compatibility with PHP 5.6.
 
         private $document;
         private $handler;

Spacing +38 added lines, -38 removed lines

@@ -139,8 +139,8 @@ 
 {
         use NewableTrait,
             SaveableTrait,
-            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';
 
@@ -149,12 +149,12 @@ 
 
         public static function load($document)
         {
-                if (\is_string($document) && ! is_an_xml_string($document)) {
+                if (\is_string($document) && !is_an_xml_string($document)) {
                         $file     = $document;
                         $document = \file_get_contents($file);
 
                         // file_get_contents returns false if it can't read.
-                        if (! $document) {
+                        if (!$document) {
                                 throw new \Exception("File '$file' not accessible.");
                         }
                 }
@@ -164,10 +164,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
@@ -192,11 +192,11 @@ 
 
                 $this->handler = new FluidInsertionHandler($doc);
 
-                if (! empty($opts['root'])) {
+                if (!empty($opts['root'])) {
                         $this->appendSibling($opts['root']);
                 }
 
-                if (! empty($opts['stylesheet'])) {
+                if (!empty($opts['stylesheet'])) {
                         $attrs = 'type="text/xsl" '
                                . "encoding=\"{$opts['encoding']}\" "
                                . 'indent="yes" '
@@ -234,7 +234,7 @@ 
                 $namespaces = [];
 
                 if (\is_string($arguments[0])) {
-                        $args = [ $arguments[0], $arguments[1] ];
+                        $args = [$arguments[0], $arguments[1]];
 
                         if (isset($arguments[2])) {
                                 $args[] = $arguments[2];
@@ -437,16 +437,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)
         {
@@ -484,7 +484,7 @@ 
         {
                 $id = $this->id();
 
-                if (! empty($id)) {
+                if (!empty($id)) {
                         $id .= ':';
                 }
 
@@ -495,7 +495,7 @@ 
                 $nodes = \explode('/', $xpath);
 
                 foreach ($nodes as $node) {
-                        if (! empty($node)) {
+                        if (!empty($node)) {
                                 // An XPath query can have multiple slashes.
                                 // Example: //target
                                 $new_xpath .= "{$id}{$node}";
@@ -629,7 +629,7 @@ 
         {
                 $status = \file_put_contents($file, $this->xml($strip));
 
-                if (! $status) {
+                if (!$status) {
                         throw new \Exception("The file '$file' is not writable.");
                 }
 
@@ -687,7 +687,7 @@ 
         {
                 $this->document   = $document;
                 $this->dom        = $document->dom;
-                $this->namespaces =& $document->namespaces;
+                $this->namespaces = & $document->namespaces;
         }
 
         public function insertElement(&$nodes, $element, &$optionals, $fn, $orig_context)
@@ -709,7 +709,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)) {
                         $new_context->setAttribute($attributes);
                 }
 
@@ -723,8 +723,8 @@ 
 
         protected function handleOptionals($element, &$optionals)
         {
-                if (! \is_array($element)) {
-                        $element = [ $element ];
+                if (!\is_array($element)) {
+                        $element = [$element];
                 }
 
                 $switch_context = false;
@@ -747,7 +747,7 @@ 
                         }
                 }
 
-                return [ $element, $attributes, $switch_context ];
+                return [$element, $attributes, $switch_context];
         }
 
 
@@ -768,9 +768,9 @@ 
                 $v_is_string    = \is_string($v);
                 $v_is_xml       = $v_is_string && is_an_xml_string($v);
                 $k_is_special   = $k_is_string && $k[0] === '@';
-                $k_isnt_special = ! $k_is_special;
-                $v_isnt_string  = ! $v_is_string;
-                $v_isnt_xml     = ! $v_is_xml;
+                $k_isnt_special = !$k_is_special;
+                $v_isnt_string  = !$v_is_string;
+                $v_isnt_xml     = !$v_is_xml;
                 ///////////////////////////////////////////////////////
 
                 if ($k_is_string && $k_isnt_special && $v_is_string && $v_isnt_xml) {
@@ -790,7 +790,7 @@ 
                 }
 
                 /////////////////////////////////////////////////////
-                $k_is_special_a = $k_is_special && ! $k_is_special_c;
+                $k_is_special_a = $k_is_special && !$k_is_special_c;
                 /////////////////////////////////////////////////////
 
                 if ($k_is_special_a && $v_is_string) {
@@ -842,7 +842,7 @@ 
                 $v_is_domnode = $v instanceof \DOMNode;
                 ///////////////////////////////////////
 
-                if ($k_is_integer && ! $v_is_domdoc && $v_is_domnode) {
+                if ($k_is_integer && !$v_is_domdoc && $v_is_domnode) {
                         return $this->insertIntegerDomnode($parent, $k, $v, $fn, $optionals);
                 }
 
@@ -910,8 +910,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 = [];
@@ -960,7 +960,7 @@ 
                 $el = $this->createElement($k, $v);
                 $el = $fn($parent, $el);
 
-                return [ $el ];
+                return [$el];
         }
 
         protected function insertStringMixed($parent, $k, $v, $fn, &$optionals)
@@ -976,7 +976,7 @@ 
                 // they are supplied, so 'appendChild' is the perfect operation.
                 $this->newContext($el)->appendChild($v, ...$optionals);
 
-                return [ $el ];
+                return [$el];
         }
 
         protected function insertIntegerArray($parent, $k, $v, $fn, &$optionals)
@@ -1003,7 +1003,7 @@ 
                 $el = $this->createElement($v);
                 $el = $fn($parent, $el);
 
-                return [ $el ];
+                return [$el];
         }
 
         protected function insertIntegerXml($parent, $k, $v, $fn)
@@ -1076,8 +1076,8 @@ 
 {
         use NewableTrait,
             SaveableTrait,
-            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 $document;
         private $handler;
@@ -1089,14 +1089,14 @@ 
                 $this->document = $document;
                 $this->handler  = $handler;
 
-                if (! \is_array($context) && ! $context instanceof \Traversable) {
+                if (!\is_array($context) && !$context instanceof \Traversable) {
                         // DOMDocument, DOMElement and DOMNode are not iterable.
                         // DOMNodeList and FluidContext are iterable.
-                        $context = [ $context ];
+                        $context = [$context];
                 }
 
                 foreach ($context as $n) {
-                        if (! $n instanceof \DOMNode) {
+                        if (!$n instanceof \DOMNode) {
                                 throw new \Exception('Node type not recognized.');
                         }
 
@@ -1309,7 +1309,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]];
                 }
 
@@ -1442,7 +1442,7 @@ 
                                 $found = ($r === $u) || $found;
                         }
 
-                        if (! $found) {
+                        if (!$found) {
                                 $set[] = $r;
                         }
                 }