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