Dallgoot\Yaml\Loader

Complexity

Total Complexity

35

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
C	parse()	0	47	15
A	onSpecialType()	0	9	4
B	onContextType()	0	20	7
A	load()	0	16	5
A	__construct()	0	6	4

<?php
declare(strict_types=1);

Missing file doc comment

namespace Dallgoot\Yaml;

use Dallgoot\Yaml\Yaml as Y;

/**
 * TODO
 * @category tag in class comment

There must be exactly one blank line before the tags in a doc comment

Category name "tag in class comment" is not valid; consider "Tag_In_Class_Comment" instead

 * @package tag in class comment

Package name "tag in class comment" is not valid; consider "Tag_In_Class_Comment" instead

Tag value indented incorrectly; expected 2 spaces but found 1

 * @author tag in class comment

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value indented incorrectly; expected 3 spaces but found 1

 * @license tag in class comment

Tag value indented incorrectly; expected 2 spaces but found 1

 */

Missing @link tag in class comment

final class Loader
{
    //public

    /* @var null|string */
    public $error;

    public const EXCLUDE_DIRECTIVES = 1;//DONT include_directive
    public const IGNORE_COMMENTS    = 2;//DONT include_comments
    public const NO_PARSING_EXCEPTIONS = 4;//THROW Exception on parsing Errors
    public const NO_OBJECT_FOR_DATE = 8;//DONT import date strings as dateTime Object
    //privates
    /* @var null|string */
    private $content;

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

    /* @var null|string */
    private $filePath;

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

    /* @var integer */
    private $debug = 0;///TODO: determine levels

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

    /* @var integer */
    private $options = 0;

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

    //Exceptions messages
    private const INVALID_VALUE        = self::class.": at line %d";
    private const EXCEPTION_NO_FILE    = self::class.": file '%s' does not exists (or path is incorrect?)";
    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?)";

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

Missing function doc comment

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

    /**
     * load a file and save its content as $content

Doc comment short description must start with a capital letter

     *
     * @param      string       $absolutePath  The absolute path of a file

Expected 1 spaces after parameter type; 7 found

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 1 spaces but found 6

     *
     * @throws     \Exception   if file don't exist OR reading failed

Tag value indented incorrectly; expected 1 spaces but found 5

     *
     * @return     self  ( returns the same Loader  )

Tag value indented incorrectly; expected 1 spaces but found 5

     */
    public function load(string $absolutePath):Loader
    {
        $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;

It seems like $content of type array is incompatible with the declared type null|string of property $content.

        return $this;
    }

    /**
     * Parse Yaml lines into a 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|null      null on errors if NO_PARSING_EXCEPTIONS is set, otherwise 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 ?? preg_split("/([^\n\r]+)/um", $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);
        $previous = $root = new Node();
        $emptyLines = [];
        try {
            $gen = function() use($source) {

Expected 1 space after FUNCTION keyword; 0 found

Expected 1 space after USE keyword; found 0

                foreach ($source as $key => $value) {
                    yield ++$key => $value;
                }
            };
            foreach ($gen() as $lineNb => $lineString) {
                $n = new Node($lineString, $lineNb);
                if ($n->type & (Y::LITTERALS|Y::BLANK)) {
                    if ($this->onSpecialType($n, $previous, $emptyLines)) continue;
                } else {
                    foreach ($emptyLines as $blankNode) {
                        $blankNode->getParent()->add($blankNode);
                    }
                }
                $emptyLines = [];
                switch ($n->indent <=> $previous->indent) {
                    case -1: $target = $previous->getParent($n->indent);

Line indented incorrectly; expected 16 spaces, found 20

                        break;
                    case 0:  $target = $previous->getParent();

Line indented incorrectly; expected 16 spaces, found 20

                        break;
                    default: $target = $previous;

Line indented incorrectly; expected 16 spaces, found 20

                }
                if ($this->onContextType($n, $target, $lineString)) continue;
                $target->add($n);
                $previous = $n;
            }
            if ($this->debug === 2) echo "\033[33mParsed Structure\033[0m\n",var_export($root, true);
            $out = Builder::buildContent($root, $this->debug);
            return $out;
        } catch (\Error|\Exception|\ParseError $e) {
            $file = basename($this->filePath);
            $message = basename($e->getFile())."@".$e->getLine().":".$e->getMessage()." in '$file' @".($lineNb)."\n";

The variable $lineNb seems to be defined by a foreach iteration on line 99. Are you sure the iterator is never empty, otherwise this variable is not defined?

            if ($e instanceof \ParseError && ($this->options & self::NO_PARSING_EXCEPTIONS)) {
                trigger_error($message, E_USER_WARNING);
                $this->error = $message;
                return null;
            }
            var_dump($root);

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

            throw new \Exception($message, 3);
        }
    }

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

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

Missing function doc comment

    {
        $deepest = $previous->getDeepestNode();
        if ($n->type & Y::BLANK) {
            if ($previous->type & Y::SCALAR) $emptyLines[] = $n->setParent($previous->getParent());
            if ($deepest->type & Y::LITTERALS) $emptyLines[] = $n->setParent($deepest);
            return true;
        }
        return false;
    }

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

Missing function doc comment

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

    {
        $deepest = $previous->getDeepestNode();
        if ($deepest->type & Y::PARTIAL) {
            //TODO:verify this edge case
            // if ($n->type === Y::KEY && $n->indent === $previous->indent) {
            //     throw new \ParseError(sprintf(self::INVALID_VALUE, $lineNb), 1);
            // }
            $deepest->parse($deepest->value.' '.ltrim($lineString));
            return true;
        }
        if(($previous->type & Y::LITTERALS) || (($deepest->type & Y::LITTERALS) && is_null($deepest->value))) {

Expected "if (...) {\n"; found "if(...) {\n"

            $n->type = Y::SCALAR;
            $n->identifier = null;
            $n->value = trim($lineString);
        }
        if (($deepest->type & (Y::LITTERALS|Y::REF_DEF|Y::SET_VALUE|Y::TAG)) && is_null($deepest->value)) {
            $previous = $deepest;
        }
        return false;
    }
}