dallgoot / yaml

yaml/Node.php

Doc Comments +8 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
      * Create the Node object and parses $nodeString IF not null (else assume a root type Node)
      *
      * @param string|null $nodeString The node string
-     * @param int|null    $line       The line
+     * @param integer    $line       The line
      */
     public function __construct($nodeString = null, $line = 0)
     {
@@ -200,12 +200,18 @@ 
         }
     }
 
+    /**
+     * @param string $nodeValue
+     */
     private function onQuoted($nodeValue)
     {
         $this->type = R::isProperlyQuoted($nodeValue) ? Y::QUOTED : Y::PARTIAL;
         $this->value = $nodeValue;
     }
 
+    /**
+     * @param string $nodeValue
+     */
     private function onSetElement($nodeValue)
     {
         $this->type = $nodeValue[0] === '?' ? Y::SET_KEY : Y::SET_VALUE;
@@ -220,7 +226,7 @@ 
      * Process when a "key: value" syntax is found in the parsed string
      * Note : key is match 1, value is match 2 as per regex from R::KEY
      *
-     * @param array $matches The matches provided by 'preg_match' function in Node::parse
+     * @param string[] $matches The matches provided by 'preg_match' function in Node::parse
      */
     private function onKey(array $matches)
     {

Spacing +7 added lines, -7 removed lines

@@ -185,7 +185,7 @@ 
         elseif (in_array($first, ['?', ':']))      $this->onSetElement($nodeValue);
         elseif (in_array($first, ['!', '&', '*'])) $this->onNodeAction($nodeValue);
         else {
-            $characters = [ '#' =>  [Y::COMMENT, $v],
+            $characters = ['#' =>  [Y::COMMENT, $v],
                             '%' =>  [Y::DIRECTIVE, $v],
                             '>' =>  [Y::LITT_FOLDED, null],
                             '|' =>  [Y::LITT, null]
@@ -254,28 +254,28 @@ 
     private function onCompact($value)
     {
         $this->value = json_decode($value, false, 512, JSON_PARTIAL_OUTPUT_ON_ERROR|JSON_UNESCAPED_SLASHES);
-        if (json_last_error() === JSON_ERROR_NONE){
+        if (json_last_error() === JSON_ERROR_NONE) {
             $this->type = Y::JSON;
             return;
         }
         $this->value = new NodeList();
-        if (preg_match(R::MAPPING, $value)){
+        if (preg_match(R::MAPPING, $value)) {
             $this->type = Y::COMPACT_MAPPING;
             $this->value->type = Y::COMPACT_MAPPING;
-            preg_match_all(R::MAPPING_VALUES, trim(substr($value, 1,-1)), $matches);
+            preg_match_all(R::MAPPING_VALUES, trim(substr($value, 1, -1)), $matches);
             foreach ($matches['k'] as $index => $property) {
                 $n = new Node('', $this->line);
                 $n->type = Y::KEY;
-                $n->identifier = trim($property, '"\' ');//TODO : maybe check for proper quoting first ?
+                $n->identifier = trim($property, '"\' '); //TODO : maybe check for proper quoting first ?
                 $n->value = new Node($matches['v'][$index], $this->line);
                 $this->value->push($n);
             }
             return;
         }
-        if (preg_match(R::SEQUENCE, $value)){
+        if (preg_match(R::SEQUENCE, $value)) {
             $this->type = Y::COMPACT_SEQUENCE;
             $this->value->type = Y::COMPACT_SEQUENCE;
-            $count = preg_match_all(R::SEQUENCE_VALUES, trim(substr($value, 1,-1)), $matches);
+            $count = preg_match_all(R::SEQUENCE_VALUES, trim(substr($value, 1, -1)), $matches);
             foreach ($matches['item'] as $key => $item) {
                 $i = new Node('', $this->line);
                 $i->type = Y::ITEM;

Braces +18 added lines, -9 removed lines

@@ -68,8 +68,12 @@ 
      */
     public function getParent(int $indent = null, $type = 0):Node
     {
-        if ($this->type === Y::ROOT) return $this;
-        if (!is_int($indent)) return $this->parent ?? $this;
+        if ($this->type === Y::ROOT) {
+            return $this;
+        }
+        if (!is_int($indent)) {
+            return $this->parent ?? $this;
+        }
         $cursor = $this;
         while ($cursor instanceof Node && $cursor->indent >= $indent) {
             if ($cursor->indent === $indent && $cursor->type !== $type) {
@@ -101,7 +105,7 @@ 
         if (is_null($current)) {
             $this->value = $child;
             return;
-        }elseif ($current instanceof Node) {
+        } elseif ($current instanceof Node) {
             $this->value = new NodeList();
             if ($current->type & Y::LITTERALS) {
                 $this->value->type = $current->type;
@@ -179,12 +183,17 @@ 
     {
         $v = ltrim(substr($nodeValue, 1));
         $first = $nodeValue[0];
-        if ($first === "-")                        $this->onHyphen($nodeValue);
-        elseif (in_array($first, ['"', "'"]))      $this->onQuoted($nodeValue);
-        elseif (in_array($first, ['{', '[']))      $this->onCompact($nodeValue);
-        elseif (in_array($first, ['?', ':']))      $this->onSetElement($nodeValue);
-        elseif (in_array($first, ['!', '&', '*'])) $this->onNodeAction($nodeValue);
-        else {
+        if ($first === "-") {
+            $this->onHyphen($nodeValue);
+        } elseif (in_array($first, ['"', "'"])) {
+            $this->onQuoted($nodeValue);
+        } elseif (in_array($first, ['{', '['])) {
+            $this->onCompact($nodeValue);
+        } elseif (in_array($first, ['?', ':'])) {
+            $this->onSetElement($nodeValue);
+        } elseif (in_array($first, ['!', '&', '*'])) {
+            $this->onNodeAction($nodeValue);
+        } else {
             $characters = [ '#' =>  [Y::COMMENT, $v],
                             '%' =>  [Y::DIRECTIVE, $v],
                             '>' =>  [Y::LITT_FOLDED, null],

yaml/Builder.php

Spacing +13 added lines, -13 removed lines

@@ -75,13 +75,13 @@ 
      *
      * @return mixed    The parent (object|array) or a string representing the NodeList.
      */
-    private static function buildNodeList(NodeList $node, &$parent=null)
+    private static function buildNodeList(NodeList $node, &$parent = null)
     {
         $node->forceType();
-        if ($node->type & (Y::RAW | Y::LITTERALS)) {
+        if ($node->type & (Y::RAW|Y::LITTERALS)) {
             return self::buildLitteral($node, (int) $node->type);
         }
-        $action = function ($child, &$parent, &$out) {
+        $action = function($child, &$parent, &$out) {
             self::build($child, $out);
         };
         if ($node->type & (Y::COMPACT_MAPPING|Y::MAPPING|Y::SET)) {
@@ -90,7 +90,7 @@ 
             $out = $parent ?? [];
         } else {
             $out = '';
-            $action = function ($child, &$parent, &$out) {
+            $action = function($child, &$parent, &$out) {
                 if ($child->type & (Y::SCALAR|Y::QUOTED)) {
                     if ($parent) {
                         $parent->setText(self::build($child));
@@ -120,7 +120,7 @@ 
     private static function buildNode(Node $node, &$parent)
     {
         extract((array) $node, EXTR_REFS);
-        if ($type & (Y::REF_DEF | Y::REF_CALL)) {
+        if ($type&(Y::REF_DEF|Y::REF_CALL)) {
             if (is_object($value)) {
                 $tmp = self::build($value, $parent) ?? $parent;
             } else {
@@ -129,10 +129,10 @@ 
             if ($type === Y::REF_DEF) self::$_root->addReference($identifier, $tmp);
             return self::$_root->getReference($identifier);
         }
-        if ($type & (Y::COMPACT_MAPPING|Y::COMPACT_SEQUENCE)) {
+        if ($type&(Y::COMPACT_MAPPING|Y::COMPACT_SEQUENCE)) {
             return self::buildNodeList($node->value, $parent);
         }
-        if ($type & Y::COMMENT) self::$_root->addComment($node->line, $node->value);
+        if ($type&Y::COMMENT) self::$_root->addComment($node->line, $node->value);
         $typesActions = [Y::DIRECTIVE => 'buildDirective',
                          Y::ITEM      => 'buildItem',
                          Y::KEY       => 'buildKey',
@@ -155,7 +155,7 @@ 
      * @throws \ParseError if Key has no name(identifier) Note: empty string is allowed
      * @return null
      */
-    private static function buildKey(Node $node, &$parent=null)
+    private static function buildKey(Node $node, &$parent = null)
     {
         extract((array) $node, EXTR_REFS);
         if (is_null($identifier)) {
@@ -202,7 +202,7 @@ 
         $numKeys = array_filter(array_keys($ref), 'is_int');
         $key = count($numKeys) > 0 ? max($numKeys) + 1 : 0;
         if ($value instanceof Node) {
-            if($value->type & Y::KEY) {
+            if ($value->type & Y::KEY) {
                 self::buildKey($node->value, $parent);
                 return;
             } elseif ($value->type & Y::ITEM) {
@@ -231,13 +231,13 @@ 
         //remove trailing blank
         while ($list->top()->type & Y::BLANK) $list->pop();
         $result = '';
-        $separator = [ 0 => '', Y::LITT => "\n", Y::LITT_FOLDED => ' '][(int) $type];
+        $separator = [0 => '', Y::LITT => "\n", Y::LITT_FOLDED => ' '][(int) $type];
         foreach ($list as $child) {
             if ($child->value instanceof NodeList) {
                 $result .= self::buildLitteral($child->value, $type).$separator;
             } else {
                 $val = $child->type & (Y::SCALAR|Y::BLANK) ? $child->value : substr($child->raw, $refIndent);
-                if ($type & Y::LITT_FOLDED && ($child->indent > $refIndent || ($child->type & Y::BLANK))) {
+                if ($type&Y::LITT_FOLDED && ($child->indent > $refIndent || ($child->type & Y::BLANK))) {
                     if ($result[-1] === $separator)
                         $result[-1] = "\n";
                     if ($result[-1] === "\n")
@@ -261,7 +261,7 @@ 
     private function buildSetKey(Node $node, &$parent)
     {
         $built = is_object($node->value) ? self::build($node->value) : null;
-        $stringKey = is_string($built) && Regex::isProperlyQuoted($built) ? trim($built, '\'" '): $built;
+        $stringKey = is_string($built) && Regex::isProperlyQuoted($built) ? trim($built, '\'" ') : $built;
         $key = json_encode($stringKey, JSON_PARTIAL_OUTPUT_ON_ERROR|JSON_UNESCAPED_SLASHES);
         if (empty($key)) throw new \Exception("Cant serialize complex key: ".var_export($node->value, true), 1);
         $parent->{trim($key, '\'" ')} = null;
@@ -277,7 +277,7 @@ 
     {
         $prop = array_keys(get_object_vars($parent));
         $key = end($prop);
-        if ($node->value->type & (Y::ITEM|Y::KEY )) {
+        if ($node->value->type & (Y::ITEM|Y::KEY)) {
             $node->value = new NodeList($node->value);
         }
         $parent->{$key} = self::build($node->value);

Braces +27 added lines, -11 removed lines

@@ -35,10 +35,14 @@ 
         $documents = [];
         $_root->value instanceof NodeList && $_root->value->setIteratorMode(NodeList::IT_MODE_DELETE);
         foreach ($_root->value as $child) {
-            if ($child->type & Y::DOC_START) $totalDocStart++;
+            if ($child->type & Y::DOC_START) {
+                $totalDocStart++;
+            }
             //if 0 or 1 DOC_START = we are still in first document
             $currentDoc = $totalDocStart > 1 ? $totalDocStart - 1 : 0;
-            if (!isset($documents[$currentDoc])) $documents[$currentDoc] = new NodeList();
+            if (!isset($documents[$currentDoc])) {
+                $documents[$currentDoc] = new NodeList();
+            }
             $documents[$currentDoc]->push($child);
         }
         $content = [];
@@ -63,7 +67,9 @@ 
      */
     private static function build(object $node, &$parent = null)
     {
-        if ($node instanceof NodeList) return self::buildNodeList($node, $parent);
+        if ($node instanceof NodeList) {
+            return self::buildNodeList($node, $parent);
+        }
         return self::buildNode($node, $parent);
     }
 
@@ -126,13 +132,17 @@ 
             } else {
                 $tmp = Node2PHP::get($node);
             }
-            if ($type === Y::REF_DEF) self::$_root->addReference($identifier, $tmp);
+            if ($type === Y::REF_DEF) {
+                self::$_root->addReference($identifier, $tmp);
+            }
             return self::$_root->getReference($identifier);
         }
         if ($type & (Y::COMPACT_MAPPING|Y::COMPACT_SEQUENCE)) {
             return self::buildNodeList($node->value, $parent);
         }
-        if ($type & Y::COMMENT) self::$_root->addComment($node->line, $node->value);
+        if ($type & Y::COMMENT) {
+            self::$_root->addComment($node->line, $node->value);
+        }
         $typesActions = [Y::DIRECTIVE => 'buildDirective',
                          Y::ITEM      => 'buildItem',
                          Y::KEY       => 'buildKey',
@@ -229,7 +239,9 @@ 
         $list->rewind();
         $refIndent = $list->current()->indent;
         //remove trailing blank
-        while ($list->top()->type & Y::BLANK) $list->pop();
+        while ($list->top()->type & Y::BLANK) {
+            $list->pop();
+        }
         $result = '';
         $separator = [ 0 => '', Y::LITT => "\n", Y::LITT_FOLDED => ' '][(int) $type];
         foreach ($list as $child) {
@@ -238,10 +250,12 @@ 
             } else {
                 $val = $child->type & (Y::SCALAR|Y::BLANK) ? $child->value : substr($child->raw, $refIndent);
                 if ($type & Y::LITT_FOLDED && ($child->indent > $refIndent || ($child->type & Y::BLANK))) {
-                    if ($result[-1] === $separator)
-                        $result[-1] = "\n";
-                    if ($result[-1] === "\n")
-                        $result .= $val;
+                    if ($result[-1] === $separator) {
+                                            $result[-1] = "\n";
+                    }
+                    if ($result[-1] === "\n") {
+                                            $result .= $val;
+                    }
                     continue;
                 }
                 $result .= $val.$separator;
@@ -263,7 +277,9 @@ 
         $built = is_object($node->value) ? self::build($node->value) : null;
         $stringKey = is_string($built) && Regex::isProperlyQuoted($built) ? trim($built, '\'" '): $built;
         $key = json_encode($stringKey, JSON_PARTIAL_OUTPUT_ON_ERROR|JSON_UNESCAPED_SLASHES);
-        if (empty($key)) throw new \Exception("Cant serialize complex key: ".var_export($node->value, true), 1);
+        if (empty($key)) {
+            throw new \Exception("Cant serialize complex key: ".var_export($node->value, true), 1);
+        }
         $parent->{trim($key, '\'" ')} = null;
     }