dallgoot / yaml

Builder.php

<?php

Missing file doc comment

namespace Dallgoot\Yaml;

use Dallgoot\Yaml\{Node as Node, Types as T, YamlObject, Tag, Builder};

This use statement conflicts with another class in this namespace, Dallgoot\Yaml\Tag. Consider defining an alias.

This use statement conflicts with another class in this namespace, Dallgoot\Yaml\Builder. Consider defining an alias.

This use statement conflicts with another class in this namespace, Dallgoot\Yaml\YamlObject. Consider defining an alias.

This use statement conflicts with another class in this namespace, Dallgoot\Yaml\Node. Consider defining an alias.

use \SplDoublyLinkedList as DLL;

/**

Doc comment is empty

 *
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Builder
{
    private static $root;

Private member variable "root" must be prefixed with an underscore

    private static $debug;

Private member variable "debug" must be prefixed with an underscore

    const ERROR_NO_KEYNAME = self::class.": key has NO IDENTIFIER on line %d";
    const INVALID_DOCUMENT = self::class.": DOCUMENT %d can NOT be a mapping AND a sequence";


    private static function build(object $node, &$parent = null)

Missing function doc comment

Private method name "Builder::build" must be prefixed with an underscore

    {
        if ($node instanceof DLL) return self::buildDLL($node, $parent);

Inline control structures are discouraged

        return self::buildNode($node, $parent);
    }

    private static function buildDLL(DLL $node, &$parent)

Missing function doc comment

Private method name "Builder::buildDLL" must be prefixed with an underscore

    {
        $type = property_exists($node, "type") ? $node->type : null;
        if (in_array($type, [T::RAW, T::LITTERAL, T::LITTERAL_FOLDED])) {
            return self::litteral($node, $type);
        }
        $p = $parent;
        switch ($type) {
            case T::MAPPING: //fall through

Line indented incorrectly; expected 8 spaces, found 12

            case T::SET:      $p = new \StdClass;break;

Line indented incorrectly; expected 8 spaces, found 12

Closing brace must be on a line by itself

            case T::SEQUENCE: $p = [];break;

Line indented incorrectly; expected 8 spaces, found 12

Closing brace must be on a line by itself

            // case T::KEY: $p = $parent;break;
        }
        $out = null;
        foreach ($node as $child) {
            $result = self::build($child, $p);
            if (!is_null($result)) {
                if (is_string($result)) {
                    $out .= $result.' ';
                } else {
                    return $result;
                }
            }
        }
        return is_null($out) ? $p : rtrim($out);
    }

    private static function buildNode(Node $node, &$parent)

Missing function doc comment

Private method name "Builder::buildNode" must be prefixed with an underscore

    {
        list($line, $type, $value, $identifier) = [$node->line, $node->type, $node->value, $node->identifier];
        switch ($type) {
            case T::COMMENT: self::$root->addComment($line, $value);return;

Line indented incorrectly; expected 8 spaces, found 12

Closing brace must be on a line by itself

            case T::DIRECTIVE: return;//TODO

Line indented incorrectly; expected 8 spaces, found 12

Closing brace must be on a line by itself

            case T::ITEM: self::buildItem($value, $parent);return;

Line indented incorrectly; expected 8 spaces, found 12

Closing brace must be on a line by itself

            case T::KEY:  self::buildKey($node, $parent);return;

Line indented incorrectly; expected 8 spaces, found 12

Closing brace must be on a line by itself

            case T::REF_DEF: //fall through

Line indented incorrectly; expected 8 spaces, found 12

            case T::REF_CALL://TODO: self::build returns what ?

Line indented incorrectly; expected 8 spaces, found 12

                $tmp = is_object($value) ? self::build($value, $parent) : $node->getPhpValue();

Are you sure the usage of self::build($value, $parent) targeting Dallgoot\Yaml\Builder::build() seems to always return null.

                if ($type === T::REF_DEF) self::$root->addReference($identifier, $tmp);

Inline control structures are discouraged

                return self::$root->getReference($identifier);
            case T::SET_KEY:

Line indented incorrectly; expected 8 spaces, found 12

                $key = json_encode(self::build($value, $parent), JSON_PARTIAL_OUTPUT_ON_ERROR|JSON_UNESCAPED_SLASHES);

Are you sure the usage of self::build($value, $parent) targeting Dallgoot\Yaml\Builder::build() seems to always return null.

It seems like $value can also be of type null and string; however, parameter $node of Dallgoot\Yaml\Builder::build() does only seem to accept object, maybe add an additional type check?

                if (empty($key))

Inline control structures are discouraged

                    throw new \Exception("Cant serialize complex key: ".var_export($value, true), 1);
                $parent->{$key} = null;
                return;
            case T::SET_VALUE:

Line indented incorrectly; expected 8 spaces, found 12

                $prop = array_keys(get_object_vars($parent));
                $key = end($prop);
                if (property_exists($value, "type") && in_array($value->type, [T::ITEM, T::MAPPING])) {

Line indented incorrectly; expected 12 spaces, found 16

                    $p = $value->type === T::ITEM  ? [] : new \StdClass;
                    self::build($value, $p);
                } else {

Line indented incorrectly; expected 12 spaces, found 16

                    $p = self::build($value, $parent->{$key});

Are you sure the assignment to $p is correct as self::build($value, $parent->$key) targeting Dallgoot\Yaml\Builder::build() seems to always return null.

                }

Line indented incorrectly; expected 12 spaces, found 16

                $parent->{$key} = $p;
                return;
            case T::TAG:

Line indented incorrectly; expected 8 spaces, found 12

                if ($parent === self::$root) {

Line indented incorrectly; expected 12 spaces, found 16

                    $parent->addTag($identifier);return;
                } else {

Line indented incorrectly; expected 12 spaces, found 16

                    if (in_array($identifier, ['!binary', '!str'])) {

Line indented incorrectly; expected 16 spaces, found 20

                        if ($value->value instanceof DLL) $value->value->type = T::RAW;

The property type does not seem to exist on SplDoublyLinkedList.

The property value does not seem to exist on SplDoublyLinkedList.

Inline control structures are discouraged

                        else $value->type = T::RAW;

Inline control structures are discouraged

Line indented incorrectly; expected 20 spaces, found 24

                    }

Line indented incorrectly; expected 16 spaces, found 20

                    $val = is_null($value) ? null : self::build($value, $node);

It seems like $value can also be of type string; however, parameter $node of Dallgoot\Yaml\Builder::build() does only seem to accept object, maybe add an additional type check?

                    return new Tag($identifier, $val);
                }

Line indented incorrectly; expected 12 spaces, found 16

            default:

Line indented incorrectly; expected 8 spaces, found 12

                return is_object($value) ? self::build($value, $parent) : $node->getPhpValue();

Are you sure the usage of self::build($value, $parent) targeting Dallgoot\Yaml\Builder::build() seems to always return null.

        }
    }

    /**
     * Builds a key and set the property + value to the parent given
     *
     * @param      Node   $node    The node

Expected 9 spaces after parameter type; 3 found

Expected 3 spaces after parameter name; 4 found

Tag value indented incorrectly; expected 2 spaces but found 6

     * @param      object|array  $parent  The parent

Expected 1 spaces after parameter type; 2 found

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 2 spaces but found 6

     * @throws \ParseError if Key has no name(identifier)

Tag cannot be grouped with parameter tags in a doc comment

     */

Missing @return tag in function comment

    private static function buildKey($node, &$parent):void

Private method name "Builder::buildKey" must be prefixed with an underscore

    {
        list($identifier, $value) = [$node->identifier, $node->value];
        if (is_null($identifier)) {
            throw new \ParseError(sprintf(self::ERROR_NO_KEYNAME, $node->line));
        } else {
            if ($value instanceof Node && in_array($value->type, [T::KEY, T::ITEM])) {
                $parent->{$identifier} = $value->type === T::KEY ? new \StdClass : [];
                self::build($value, $parent->{$identifier});
            } elseif (is_object($value)) {
                $parent->{$identifier} = self::build($value, $parent->{$identifier});

Are you sure the assignment to $parent->$identifier is correct as self::build($value, $parent->$identifier) targeting Dallgoot\Yaml\Builder::build() seems to always return null.

            } else {
                $parent->{$identifier} = $node->getPhpValue();
            }
        }
    }

    private static function buildItem($value, &$parent):void

Missing function doc comment

Private method name "Builder::buildItem" must be prefixed with an underscore

    {
        if ($value instanceof Node && $value->type === T::KEY) {
            $parent[$value->identifier] = self::build($value->value, $parent[$value->identifier]);

It seems like $value->value can also be of type null and string; however, parameter $node of Dallgoot\Yaml\Builder::build() does only seem to accept object, maybe add an additional type check?

Are you sure the assignment to $parent[$value->identifier] is correct as self::build($value->value, $parent[$value->identifier]) targeting Dallgoot\Yaml\Builder::build() seems to always return null.

        } else {
            $index = count($parent);
            $parent[$index] = self::build($value, $parent[$index]);
        }
    }

    /**

Parameter $debug should have a doc-comment as per coding-style.

     * Builds a file.  check multiple documents & split if more than one documents
     *
     * @param      Node   $root   The root node

Expected 1 spaces after parameter type; 3 found

Expected 1 spaces after parameter name; 3 found

Tag value indented incorrectly; expected 2 spaces but found 6

     * @return     array|YamlObject  list of documents or juste one.

Tag cannot be grouped with parameter tags in a doc comment

Tag value indented incorrectly; expected 1 spaces but found 5

     */
    public static function buildContent(Node $root, int $debug)
    {
        self::$debug = $debug;
        $totalDocStart = 0;
        $documents = [];
        if ($root->value instanceof Node) {
            $q = new DLL;
            $q->push($root->value);
            return [self::buildDocument($q, 0)];
        }
        $root->value->setIteratorMode(DLL::IT_MODE_DELETE);

The method setIteratorMode() does not exist on null.

        foreach ($root->value as $child) {
            if ($child->type === T::DOC_START) $totalDocStart++;

Inline control structures are discouraged

            //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 DLL();

Inline control structures are discouraged

            $documents[$currentDoc]->push($child);
        }
        $debug >= 2 && var_dump($documents);

var_dump($documents) looks like debug code. Are you sure you do not want to remove it?

        $content = array_map([self::class, 'buildDocument'], $documents, array_keys($documents));
        return count($content) === 1 ? $content[0] : $content;
    }

    private static function buildDocument(DLL $list, int $key):YamlObject

Missing function doc comment

Private method name "Builder::buildDocument" must be prefixed with an underscore

    {
        self::$root = new YamlObject();
        $childTypes = self::getChildrenTypes($list);
        $isMapping  = count(array_intersect($childTypes, [T::KEY, T::MAPPING])) > 0;
        $isSequence = in_array(T::ITEM, $childTypes);
        $isSet      = in_array(T::SET_VALUE, $childTypes);
        if ($isMapping && $isSequence) {
            throw new \ParseError(sprintf(self::INVALID_DOCUMENT, $key));
        } else {
            switch (true) {
                case $isSequence: $list->type = T::SEQUENCE;break;

The property type does not seem to exist on SplDoublyLinkedList.

Line indented incorrectly; expected 12 spaces, found 16

Closing brace must be on a line by itself

                case $isSet: $list->type = T::SET;break;

Line indented incorrectly; expected 12 spaces, found 16

Closing brace must be on a line by itself

                case $isMapping://fall through

Line indented incorrectly; expected 12 spaces, found 16

                default:$list->type = T::MAPPING;

Line indented incorrectly; expected 12 spaces, found 16

            }
        }
        self::$debug >= 3 && var_dump(self::$root, $list);

var_dump(self::root, $list) looks like debug code. Are you sure you do not want to remove it?

        $string = '';
        foreach ($list as $child) {
            $result = self::build($child, self::$root);
            if (is_string($result)) {
                $string .= $result.' ';
            }
        }
        if (!empty($string)) {
            self::$root->setText(rtrim($string));
        }
        return self::$root;
    }

    private static function litteral(DLL $children, $type):string

Missing function doc comment

Private method name "Builder::litteral" must be prefixed with an underscore

    {
        $children->rewind();
        $refIndent = $children->current()->indent;
        $separator = $type === T::RAW ? '' : "\n";
        $action = function ($c) { return $c->value; };

Opening brace must be the last content on the line

Closing brace must be on a line by itself

        if ($type === T::LITTERAL_FOLDED) {
            $separator = ' ';
            $action = function ($c) use ($refIndent) {
                return $c->indent > $refIndent || $c->type === T::EMPTY ? "\n".$c->value : $c->value;
            };
        }
        $tmp = [];
        $children->rewind();
        foreach ($children as $child) {
            $tmp[] = $action($child);
        }
        return implode($separator, $tmp);
    }

    private static function getChildrenTypes(DLL $children):array

Missing function doc comment

Private method name "Builder::getChildrenTypes" must be prefixed with an underscore

    {
        $types = [];
        foreach ($children as $child) {
            $types[] = $child->type;
        }
        return array_unique($types);
    }
}