dallgoot / yaml

yaml/Loader.php

Doc Comments +6 added lines

@@ -37,6 +37,9 @@ 
     private const EXCEPTION_READ_ERROR = self::class.": file '%s' failed to be loaded (permission denied ?)";
     private const EXCEPTION_LINE_SPLIT = self::class.": content is not a string(maybe a file error?)";
 
+    /**
+     * @param string $absolutePath
+     */
     public function __construct($absolutePath = null, $options = null, $debug = 0)
     {
         $this->debug   = is_int($debug) ? min($debug, 3) : 1;
@@ -73,6 +76,9 @@ 
         return $this;
     }
 
+    /**
+     * @param string $strContent
+     */
     private function getSourceIterator($strContent = null)
     {
         $source = $this->content ?? preg_split("/\n/m", preg_replace('/(\r\n|\r)/', "\n", $strContent), 0, PREG_SPLIT_DELIM_CAPTURE);

Spacing +7 added lines, -7 removed lines

@@ -17,10 +17,10 @@ 
     //public
     /* @var null|string */
     public static $error;
-    public const IGNORE_DIRECTIVES = 1;//DONT include_directive
-    public const IGNORE_COMMENTS    = 2;//DONT include_comments
-    public const NO_PARSING_EXCEPTIONS = 4;//DONT throw Exception on parsing errors
-    public const NO_OBJECT_FOR_DATE = 8;//DONT import date strings as dateTime Object
+    public const IGNORE_DIRECTIVES = 1; //DONT include_directive
+    public const IGNORE_COMMENTS    = 2; //DONT include_comments
+    public const NO_PARSING_EXCEPTIONS = 4; //DONT throw Exception on parsing errors
+    public const NO_OBJECT_FOR_DATE = 8; //DONT import date strings as dateTime Object
 
     //privates
     /* @var null|false|array */
@@ -28,7 +28,7 @@ 
     /* @var null|string */
     private $filePath;
     /* @var integer */
-    private $debug = 0;///TODO: determine levels
+    private $debug = 0; ///TODO: determine levels
     /* @var integer */
     private $options = 0;
     //Exceptions messages
@@ -78,7 +78,7 @@ 
         $source = $this->content ?? preg_split("/\n/m", preg_replace('/(\r\n|\r)/', "\n", $strContent), 0, PREG_SPLIT_DELIM_CAPTURE);
         //TODO : be more permissive on $strContent values
         if (!is_array($source) || !count($source)) throw new \Exception(self::EXCEPTION_LINE_SPLIT);
-        return function () use($source) {
+        return function() use($source) {
             foreach ($source as $key => $value) {
                 yield ++$key => $value;
             }
@@ -120,7 +120,7 @@ 
                     case 0:
                         if ($n->type & Y::KEY && $n->indent === 0) {
                             $target = $root;
-                        } elseif($n->type & Y::ITEM && $deepest->type & Y::KEY && is_null($deepest->value)) {
+                        } elseif ($n->type & Y::ITEM && $deepest->type & Y::KEY && is_null($deepest->value)) {
                             $target = $deepest;
                         } else {
                             $target = $previous->getParent();

Braces +15 added lines, -5 removed lines

@@ -77,7 +77,9 @@ 
     {
         $source = $this->content ?? preg_split("/\n/m", preg_replace('/(\r\n|\r)/', "\n", $strContent), 0, PREG_SPLIT_DELIM_CAPTURE);
         //TODO : be more permissive on $strContent values
-        if (!is_array($source) || !count($source)) throw new \Exception(self::EXCEPTION_LINE_SPLIT);
+        if (!is_array($source) || !count($source)) {
+            throw new \Exception(self::EXCEPTION_LINE_SPLIT);
+        }
         return function () use($source) {
             foreach ($source as $key => $value) {
                 yield ++$key => $value;
@@ -105,7 +107,9 @@ 
                 $n = new Node($lineString, $lineNb);
                 $deepest = $previous->getDeepestNode();
                 if ($n->type & (Y::LITTERALS|Y::BLANK|Y::COMMENT|Y::TAG) || $deepest->type & Y::PARTIAL) {
-                    if ($this->onSpecialType($n, $previous, $emptyLines, $lineString)) continue;
+                    if ($this->onSpecialType($n, $previous, $emptyLines, $lineString)) {
+                        continue;
+                    }
                 }
                 //Note: 6.6 comments: Note that outside scalar content, a line containing only white space characters is taken to be a comment line.
                 foreach ($emptyLines as $blankNode) {
@@ -134,7 +138,9 @@ 
                             }
                         }
                 }
-                if ($this->onContextType($n, $target, $lineString)) continue;
+                if ($this->onContextType($n, $target, $lineString)) {
+                    continue;
+                }
                 $target->add($n);
                 $previous = $n;
             }
@@ -171,8 +177,12 @@ 
             return true;
         }
         if ($n->type & Y::BLANK) {
-            if ($previous->type & Y::SCALAR)   $emptyLines[] = $n->setParent($previous->getParent());
-            if ($deepest->type & Y::LITTERALS) $emptyLines[] = $n->setParent($deepest);
+            if ($previous->type & Y::SCALAR) {
+                $emptyLines[] = $n->setParent($previous->getParent());
+            }
+            if ($deepest->type & Y::LITTERALS) {
+                $emptyLines[] = $n->setParent($deepest);
+            }
             return true;
         } elseif ($n->type & Y::COMMENT
                   && !($previous->getParent()->value->type & Y::LITTERALS)

yaml/NodeList.php

Spacing +5 added lines, -5 removed lines

@@ -45,16 +45,16 @@
     public function forceType()
     {
         if (is_null($this->type)) {
-            $childTypes  = $this->getTypes();
-            if ($childTypes & (Y::KEY|Y::SET_KEY)) {
-                if ($childTypes & Y::ITEM) {
+            $childTypes = $this->getTypes();
+            if ($childTypes&(Y::KEY|Y::SET_KEY)) {
+                if ($childTypes&Y::ITEM) {
                     throw new \ParseError(self::class.": Error conflicting types found");
                 }
                 $this->type = Y::MAPPING;
             } else {
-                if ($childTypes & Y::ITEM) {
+                if ($childTypes&Y::ITEM) {
                     $this->type = Y::SEQUENCE;
-                } elseif (!($childTypes & Y::COMMENT)) {
+                } elseif (!($childTypes&Y::COMMENT)) {
                     $this->type = Y::LITT_FOLDED;
                 }
             }

yaml/Node.php

Indentation +3 added lines, -3 removed lines

@@ -181,9 +181,9 @@
             $this->value = $nodeValue;
             return;
         } elseif (in_array($first, ['{', '['])) {
-             $this->onCompact(trim($nodeValue));
-             return;
-         } elseif (in_array($first, ['!', '&', '*'])) {
+                $this->onCompact(trim($nodeValue));
+                return;
+            } elseif (in_array($first, ['!', '&', '*'])) {
             $this->onNodeAction($nodeValue);
             return;
         } elseif(in_array($first, ['?', ':'])) {// Note : php don't like '?' as an array key -_-'

Spacing +8 added lines, -8 removed lines

@@ -186,7 +186,7 @@ 
          } elseif (in_array($first, ['!', '&', '*'])) {
             $this->onNodeAction($nodeValue);
             return;
-        } elseif(in_array($first, ['?', ':'])) {// Note : php don't like '?' as an array key -_-'
+        } elseif (in_array($first, ['?', ':'])) {// Note : php don't like '?' as an array key -_-'
             $this->type = $first === '?' ? Y::SET_KEY : Y::SET_VALUE;
             if (!empty(trim($v))) {
                 $this->value = new NodeList;
@@ -197,7 +197,7 @@ 
             $this->onHyphen($nodeValue);
             return;
         }
-        $characters = [ '#' =>  [Y::COMMENT, $v],
+        $characters = ['#' =>  [Y::COMMENT, $v],
                         '%' =>  [Y::DIRECTIVE, $v],
                         '>' =>  [Y::LITT_FOLDED, null],
                         '|' =>  [Y::LITT, null]
@@ -249,28 +249,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 +13 added lines, -5 removed lines

@@ -71,7 +71,9 @@ 
         if ($this->type === Y::ROOT) {
             return $this;
         }
-        if (!is_int($indent)) return $this->parent ?? $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) {
@@ -103,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;
@@ -113,9 +115,15 @@ 
         }
         //modify type according to child
         if (is_null($this->value->type)) {
-            if ($child->type & Y::SET_KEY)   $this->value->type = Y::SET;
-            if ($child->type & Y::KEY)       $this->value->type = Y::MAPPING;
-            if ($child->type & Y::ITEM)      $this->value->type = Y::SEQUENCE;
+            if ($child->type & Y::SET_KEY) {
+                $this->value->type = Y::SET;
+            }
+            if ($child->type & Y::KEY) {
+                $this->value->type = Y::MAPPING;
+            }
+            if ($child->type & Y::ITEM) {
+                $this->value->type = Y::SEQUENCE;
+            }
         }
         $this->value->push($child);
     }

yaml/YamlObject.php

Spacing +2 added lines, -2 removed lines

@@ -43,9 +43,9 @@
     public function __call($funcName, $arguments)
     {
         $reflectAPI = new \ReflectionClass(get_class($this->__yaml__object__api));
-        $getName = function ($o) { return $o->name; };
+        $getName = function($o) { return $o->name; };
         $publicApi  = array_map($getName, $reflectAPI->getMethods(\ReflectionMethod::IS_PUBLIC));
-        if (!in_array($funcName, $publicApi) ) {
+        if (!in_array($funcName, $publicApi)) {
             throw new \BadMethodCallException(sprintf(self::UNDEFINED_METHOD, $funcName, implode(",", $publicApi)), 1);
         }
         return call_user_func_array([$this->__yaml__object__api, $funcName], $arguments);

yaml/Builder.php

Spacing +15 added lines, -15 removed lines

@@ -80,13 +80,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)) {
@@ -95,7 +95,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));
@@ -125,7 +125,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 {
@@ -134,10 +134,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',
@@ -160,7 +160,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)) {
@@ -178,7 +178,7 @@ 
             }
             if ($value instanceof NodeList) {
                 $childTypes = $value->getTypes();
-                if (is_null($value->type) && $childTypes & Y::SCALAR && !($childTypes & Y::COMMENT)) {
+                if (is_null($value->type) && $childTypes&Y::SCALAR && !($childTypes&Y::COMMENT)) {
                     $result = self::buildLitteral($value, Y::LITT_FOLDED);
                 } else {
                     $result = self::buildNodeList($value);
@@ -215,7 +215,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) {
@@ -250,14 +250,14 @@ 
         }
         $result = '';
         $separator = '';
-        if ($type & Y::LITT)         $separator = "\n";
-        if ($type & Y::LITT_FOLDED)  $separator = ' ';
+        if ($type&Y::LITT)         $separator = "\n";
+        if ($type&Y::LITT_FOLDED)  $separator = ' ';
         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")
@@ -281,7 +281,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;
@@ -297,7 +297,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)) {
             $nl = new NodeList;
             $nl->push($node->value);
             $node->value = $nl;

Braces +30 added lines, -12 removed lines

@@ -40,10 +40,14 @@ 
         }
         $_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 = [];
@@ -68,7 +72,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);
     }
 
@@ -131,13 +137,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',
@@ -250,18 +260,24 @@ 
         }
         $result = '';
         $separator = '';
-        if ($type & Y::LITT)         $separator = "\n";
-        if ($type & Y::LITT_FOLDED)  $separator = ' ';
+        if ($type & Y::LITT) {
+            $separator = "\n";
+        }
+        if ($type & Y::LITT_FOLDED) {
+            $separator = ' ';
+        }
         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 ($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;
@@ -283,7 +299,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;
     }
 

yaml/Compact.php

Spacing +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
         $prop = get_object_vars($this);
         if (count($prop) > 0) return $prop;
         if (count($this) > 0) return iterator_to_array($this);
-        return $this;//new \Stdclass;
+        return $this; //new \Stdclass;
     }
 
     /**

Braces +6 added lines, -2 removed lines

@@ -30,8 +30,12 @@
     public function jsonSerialize():array
     {
         $prop = get_object_vars($this);
-        if (count($prop) > 0) return $prop;
-        if (count($this) > 0) return iterator_to_array($this);
+        if (count($prop) > 0) {
+            return $prop;
+        }
+        if (count($this) > 0) {
+            return iterator_to_array($this);
+        }
         return $this;//new \Stdclass;
     }
 

yaml/Node2PHP.php

Indentation +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
         if ($n->type & (Y::REF_CALL|Y::SCALAR)) return self::getScalar((string) $n->value);
         if ($n->type & Y::JSON) return $n->value;
         $expected = [Y::QUOTED => trim((string) $n->value, "\"'"),
-                     Y::RAW    => strval((string) $n->value)];
+                        Y::RAW    => strval((string) $n->value)];
         return $expected[$n->type] ?? null;
     }
 

Braces +21 added lines, -7 removed lines

@@ -23,9 +23,15 @@ 
      */
     public static function get(Node $n)
     {
-        if (is_null($n->value)) return null;
-        if ($n->type & (Y::REF_CALL|Y::SCALAR)) return self::getScalar((string) $n->value);
-        if ($n->type & Y::JSON) return $n->value;
+        if (is_null($n->value)) {
+            return null;
+        }
+        if ($n->type & (Y::REF_CALL|Y::SCALAR)) {
+            return self::getScalar((string) $n->value);
+        }
+        if ($n->type & Y::JSON) {
+            return $n->value;
+        }
         $expected = [Y::QUOTED => trim((string) $n->value, "\"'"),
                      Y::RAW    => strval((string) $n->value)];
         return $expected[$n->type] ?? null;
@@ -41,8 +47,12 @@ 
      */
     private static function getScalar(string $v)
     {
-        if (R::isDate($v))   return self::$dateAsString ? $v : date_create($v);
-        if (R::isNumber($v)) return self::getNumber($v);
+        if (R::isDate($v)) {
+            return self::$dateAsString ? $v : date_create($v);
+        }
+        if (R::isNumber($v)) {
+            return self::getNumber($v);
+        }
         $types = ['yes'   => true,
                     'no'    => false,
                     'true'  => true,
@@ -64,8 +74,12 @@ 
      */
     private static function getNumber(string $v)
     {
-        if (preg_match(R::OCTAL_NUM, $v)) return intval(base_convert($v, 8, 10));
-        if (preg_match(R::HEX_NUM, $v))   return intval(base_convert($v, 16, 10));
+        if (preg_match(R::OCTAL_NUM, $v)) {
+            return intval(base_convert($v, 8, 10));
+        }
+        if (preg_match(R::HEX_NUM, $v)) {
+            return intval(base_convert($v, 16, 10));
+        }
         return is_bool(strpos($v, '.')) ? intval($v) : floatval($v);
     }
 }
\ No newline at end of file