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)
         {