Dallgoot\Yaml\Loader

Complexity

Total Complexity

45

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
D	parse()	0	54	16
A	load()	0	17	6
A	__construct()	0	8	4
B	onSpecialType()	0	17	8
B	onDeepestType()	0	26	11

<?php
declare(strict_types=1);

Missing file doc comment

namespace Dallgoot\Yaml;

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

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

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

class Loader

Missing class doc comment

{
    public $errors = [];
    //options
    public const EXCLUDE_DIRECTIVES = 0001;//DONT include_directive
    public const IGNORE_COMMENTS    = 0010;//DONT include_comments
    public const EXCEPTIONS_PARSING = 0100;//THROW Exception on parsing Errors
    public const NO_OBJECT_FOR_DATE = 1000;//DONT import date strings as dateTime Object
    //
    private $content;

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

    private $filePath;

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

    private $debug  = 0;//TODO: determine levels

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

    private $options = 0;

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

    //Exceptions
    const INVALID_VALUE        = self::class.": at line %d";
    const EXCEPTION_NO_FILE    = self::class.": file '%s' does not exists (or path is incorrect?)";
    const EXCEPTION_READ_ERROR = self::class.": file '%s' failed to be loaded (permission denied ?)";
    const EXCEPTION_LINE_SPLIT = self::class.": content is not a string(maybe a file error?)";

    public function __construct($absolutePath = null, $options = null, $debug = 0)

Missing function doc comment

    {
        $this->debug = is_int($debug) ? min($debug, 3) : 1;
        if (!is_null($options)) {
            $this->options = $options;
        }
        if (!is_null($absolutePath)) {
            $this->load($absolutePath);
        }
    }

    public function load(String $absolutePath):Loader

Missing function doc comment

    {
        $this->debug && var_dump($absolutePath);

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

        $this->filePath = $absolutePath;
        if (!file_exists($absolutePath)) {
            throw new \Exception(sprintf(self::EXCEPTION_NO_FILE, $absolutePath));
        }
        $adle = "auto_detect_line_endings";
        $prevADLE = ini_get($adle);
        !$prevADLE && ini_set($adle, "true");
        $content = file($absolutePath, FILE_IGNORE_NEW_LINES);
        !$prevADLE && ini_set($adle, "false");
        if (is_bool($content)) {
            throw new \Exception(sprintf(self::EXCEPTION_READ_ERROR, $absolutePath));
        }
        $this->content = $content;
        return $this;
    }

    /**
     * Parse Yaml lines into an hierarchy of Node
     *
     * @param      string       $strContent  The Yaml string or null to parse loaded content

Expected 1 spaces after parameter type; 7 found

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 2 spaces but found 6

     * @throws     \Exception    if content is not available as $strContent or as $this->content (from file)

Tag cannot be grouped with parameter tags in a doc comment

Tag value indented incorrectly; expected 1 spaces but found 5

     * @throws     \ParseError  if any error during parsing or building

Tag cannot be grouped with parameter tags in a doc comment

Tag value indented incorrectly; expected 1 spaces but found 5

     *
     * @return     array|YamlObject      the hierarchy built an array of YamlObject or just YamlObject

Tag value indented incorrectly; expected 1 spaces but found 5

     */
    public function parse($strContent = null)
    {
        $source = $this->content;
        if (is_null($source)) $source = preg_split("/([^\n\r]+)/um", $strContent, 0, PREG_SPLIT_DELIM_CAPTURE);

Inline control structures are discouraged

        //TODO : be more permissive on $strContent values
        if (!is_array($source)) throw new \Exception(self::EXCEPTION_LINE_SPLIT);

Inline control structures are discouraged

        $previous = $root = new Node();
        $emptyLines = [];
        $specialTypes = [T::LITTERAL, T::LITTERAL_FOLDED, T::EMPTY];
        try {
            foreach ($source as $lineNb => $lineString) {
                $n = new Node($lineString, $lineNb + 1);//TODO: useful???-> $this->debug && var_dump($n);
                $parent  = $previous;
                $deepest = $previous->getDeepestNode();
                if ($deepest->type === T::PARTIAL) {
                    //TODO:verify this edge case
                    // if ($n->type === T::KEY && $n->indent === $previous->indent) {
                    //     throw new \ParseError(sprintf(self::INVALID_VALUE, $lineNb), 1);
                    // }
                    $deepest->parse($deepest->value.' '.ltrim($lineString));
                } else {
                    if (in_array($n->type, $specialTypes)) {
                        if ($this->onSpecialType($n, $parent, $previous, $emptyLines)) continue;

Inline control structures are discouraged

                    }
                    foreach ($emptyLines as $key => $node) {
                        $node->getParent()->add($node);
                    }
                    $emptyLines = [];
                    if ($n->indent < $previous->indent) {
                        $parent = $previous->getParent($n->indent);
                    } elseif ($n->indent === $previous->indent) {
                        $parent = $previous->getParent();
                    } elseif ($n->indent > $previous->indent) {
                        if ($this->onDeepestType($n, $parent, $previous, $lineString)) continue;

Inline control structures are discouraged

                    }
                    $parent->add($n);
                    $previous = $n;
                }
            }
            if ($this->debug === 2) {
                var_dump("\033[33mParsed Structure\033[0m\n", $root);

var_dump('Parsed Structure ', $root) looks like debug code. Are you sure you do not want to remove it?

                exit(0);

Using exit here is not recommended.

            }
            $out = Builder::buildContent($root, $this->debug);
            return $out;
        } catch (\ParseError $pe) {
            $message = $pe->getMessage()." on line ".$pe->getLine();
            if ($this->options & self::EXCEPTIONS_PARSING) {
                var_dump($root);
                throw new \Exception($message, 1);
            }
            $this->errors[] = $message;
        } catch (\Error|\Exception $e) {
            throw new \Exception($e->getMessage()." for '$this->filePath'", 1);
        }
    }

    private function onSpecialType(&$n, &$parent, &$previous, &$emptyLines):bool

Missing function doc comment

Private method name "Loader::onSpecialType" must be prefixed with an underscore

    {
        $deepest = $previous->getDeepestNode();
        switch ($n->type) {
            case T::EMPTY:

Line indented incorrectly; expected 8 spaces, found 12

                if ($previous->type === T::SCALAR) $emptyLines[] = $n->setParent($previous->getParent());

Inline control structures are discouraged

                if (in_array($deepest->type, T::$LITTERALS)) $emptyLines[] = $n->setParent($deepest);

Inline control structures are discouraged

                return true;
            case T::LITTERAL://fall through

Line indented incorrectly; expected 8 spaces, found 12

            case T::LITTERAL_FOLDED://var_dump($deepest);exit();

Line indented incorrectly; expected 8 spaces, found 12

                if ($deepest->type === T::KEY && is_null($deepest->value)) {

Line indented incorrectly; expected 12 spaces, found 16

                    $deepest->add($n);
                    $previous = $n;
                    return true;
                }

Line indented incorrectly; expected 12 spaces, found 16

            default:

Line indented incorrectly; expected 8 spaces, found 12

                return false;
        }
    }

    private function onDeepestType(&$n, &$parent, &$previous, $lineString):bool

Missing function doc comment

Private method name "Loader::onDeepestType" must be prefixed with an underscore

    {
        $deepest = $previous->getDeepestNode();
        switch ($deepest->type) {
            case T::LITTERAL:

Line indented incorrectly; expected 8 spaces, found 12

            case T::LITTERAL_FOLDED:

Line indented incorrectly; expected 8 spaces, found 12

                $n->value = trim($lineString);//fall through
            case T::REF_DEF://fall through

Line indented incorrectly; expected 8 spaces, found 12

            case T::SET_VALUE://fall through

Line indented incorrectly; expected 8 spaces, found 12

            case T::TAG:

Line indented incorrectly; expected 8 spaces, found 12

                $parent = $deepest;
                break;
            case T::EMPTY:

Line indented incorrectly; expected 8 spaces, found 12

            case T::SCALAR:

Line indented incorrectly; expected 8 spaces, found 12

                if ($n->type === T::SCALAR &&

Line indented incorrectly; expected 12 spaces, found 16

                    !in_array($deepest->getParent()->type, T::$LITTERALS) ) {

Each line in a multi-line IF statement must begin with a boolean operator

Closing parenthesis of a multi-line IF statement must be on a new line

                    $deepest->type = T::SCALAR;
                    $deepest->value .= "\n".$n->value;
                    return true;
                } else {

Line indented incorrectly; expected 12 spaces, found 16

                    if (!in_array($previous->type, [T::ITEM, T::SET_KEY])) {

Line indented incorrectly; expected 16 spaces, found 20

                        $parent = $deepest->getParent();
                    }

Line indented incorrectly; expected 16 spaces, found 20

                }

Line indented incorrectly; expected 12 spaces, found 16

        }
        return false;
    }
}