servo-php / fluidxml

source/FluidXml.php

Doc Comments +65 added lines, -5 removed lines

@@ -69,7 +69,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)
 {
@@ -86,6 +86,9 @@ 
         return new FluidNamespace(...$arguments);
 }
 
+/**
+ * @param string $string
+ */
 function is_an_xml_string($string)
 {
         // Removes any empty new line at the beginning,
@@ -536,7 +539,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.
          */
@@ -558,9 +561,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.
          */
@@ -575,6 +575,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);
@@ -636,6 +640,9 @@ 
         private $context;
         private $times;
 
+        /**
+         * @param FluidContext $context
+         */
         public function __construct($document, $context, $times)
         {
                 $this->document = $document;
@@ -1072,6 +1079,9 @@ 
                 return [ $element, $attributes, $switch_context ];
         }
 
+        /**
+         * @param \Closure $fn
+         */
         protected function insertElement($element, &$optionals, $fn)
         {
                 list($element, $attributes, $switch_context) = $this->handleOptionals($element, $optionals);
@@ -1277,6 +1287,10 @@ 
                 return $context;
         }
 
+        /**
+         * @param string $k
+         * @param string $v
+         */
         protected function insertSpecialContent($parent, $k, $v)
         {
                 // The user has passed an element text content:
@@ -1294,6 +1308,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:
@@ -1305,6 +1323,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:
@@ -1316,6 +1338,9 @@ 
                 return [ $el ];
         }
 
+        /**
+         * @param string $k
+         */
         protected function insertStringMixed($parent, $k, $v, $fn, &$optionals)
         {
                 // The user has passed one of these two cases:
@@ -1332,6 +1357,9 @@ 
                 return [ $el ];
         }
 
+        /**
+         * @param integer $k
+         */
         protected function insertIntegerArray($parent, $k, $v, $fn, &$optionals)
         {
                 // The user has passed a wrapper array:
@@ -1348,6 +1376,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:
@@ -1359,6 +1391,10 @@ 
                 return [ $el ];
         }
 
+        /**
+         * @param integer $k
+         * @param string $v
+         */
         protected function insertIntegerXml($parent, $k, $v, $fn)
         {
                 // The user has passed an XML document instance:
@@ -1388,6 +1424,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.
@@ -1399,26 +1439,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);

Indentation +12 added lines, -14 removed lines

@@ -133,8 +133,8 @@ 
 class FluidXml implements FluidInterface
 {
         use 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';
 
@@ -168,9 +168,9 @@ 
                 $doc = $this->document;
 
                 $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
@@ -196,9 +196,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);
@@ -447,8 +447,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)
         {
@@ -529,7 +529,6 @@ 
          *
          * ```php
          * $xml = fluidxml();
-
          * $xml->query("/doc/book[@id='123']");
          *
          * // Relative queries are valid.
@@ -549,7 +548,6 @@ 
          *
          * ```php
          * $xml = fluidxml();
-
          * $xml->appendChild('title', 'The Theory Of Everything');
          * $xml->appendChild([ 'author' => 'S. Hawking' ]);
          *
@@ -664,8 +662,8 @@ 
 class FluidContext implements FluidInterface, \ArrayAccess, \Iterator
 {
         use 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 $document;
         private $nodes = [];