Dallgoot\Yaml\Yaml

Complexity

Total Complexity

6

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	dump()	0	3	1
A	parseFile()	0	3	1
A	parse()	0	3	1
A	getName()	0	9	2
A	dumpFile()	0	3	1

<?php

Missing file doc comment

namespace Dallgoot\Yaml;

/**
 * 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 Yaml
{
    const BLANK            = 1;
    const COMMENT          = 2;
    const COMPACT_MAPPING  = 4;
    const COMPACT_SEQUENCE = 8;
    const DIRECTIVE        = 16;
    const DOC_END          = 32;
    const DOC_START        = 64;
    const ITEM             = 128;
    const JSON             = 256;
    const KEY              = 512;
    const LITT             = 1024;//litteral
    const LITT_FOLDED      = 2048;//litteral
    const MAPPING          = 4096;
    const PARTIAL          = 8192;
    const QUOTED           = 16384;
    const RAW              = 32768;
    const REF_CALL         = 65536;//reference
    const REF_DEF          = 131072;//reference
    const ROOT             = 262144;
    const SCALAR           = 524288;
    const SEQUENCE         = 1048576;
    const SET              = 2097152;
    const SET_KEY          = 4194304;
    const SET_VALUE        = 8388608;
    const TAG              = 16777216;

    const LITTERALS = self::LITT|self::LITT_FOLDED;

    /* @var null|array */
    public static $TYPE_NAMES = null;

    /**
     * Gets the name for a given constant declared in the Dallgoot\Yaml namespace
     * @param      integer  $typeInteger       The constant value

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

Expected 1 spaces after parameter type; 2 found

Expected 1 spaces after parameter name; 7 found

Tag value indented incorrectly; expected 1 spaces but found 6

     *
     * @return     string    The name.

Tag value indented incorrectly; expected 1 spaces but found 5

     */
    public static function getName(int $typeInteger):string
    {
        if (is_null(self::$TYPE_NAMES)) {
            $oClass = new \ReflectionClass(__CLASS__);
            self::$TYPE_NAMES = array_flip($oClass->getConstants());
            // $f = function ($v) { return str_replace('Dallgoot\Yaml\\', '', $v);};
            // self::$TYPE_NAMES = array_map($f, array_flip(get_defined_constants(true)['user']));
        }
        return self::$TYPE_NAMES[$typeInteger];
    }

    /**

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

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

     * Parse the given Yaml string to a PHP type
     *
     * @param      string  $someYaml        Some yaml

Expected 1 spaces after parameter type; 2 found

Tag value indented incorrectly; expected 1 spaces but found 6

Expected 1 spaces after parameter name; 8 found

     *
     * @return     YamlObject|array    ( return a PHP type representation with Yaml document as YamlObject and multiple

Tag value indented incorrectly; expected 1 spaces but found 5

     * documents as an array of YamlObject )
     */
    public static function parse(string $someYaml, $options = null, $debug = null)
    {
        return (new Loader(null, $options, $debug))->parse($someYaml);
    }

    /**

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

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

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

     * Load the given file and parse its content (assumed YAML) to a PHP type
     *
     * @param string  $someYaml      Some yaml

Expected 1 spaces after parameter type; 2 found

Doc comment for parameter $someYaml does not match actual variable name $fileName

Expected 1 spaces after parameter name; 6 found

     *
     * @return Yaml\YamlObject|array    ( return a PHP type representation with Yaml document as YamlObject and multiple

The type Dallgoot\Yaml\Yaml\YamlObject was not found. Maybe you did not declare it correctly or list all dependencies?

     * documents as an array of YamlObject )
     */
    public static function parseFile(string $fileName, $options = null, $debug = null)
    {
        return (new Loader($fileName, $options, $debug))->parse();

The expression return new Dallgoot\Yaml\Loader($fileName, $options, $debug)->parse() also could return the type Dallgoot\Yaml\YamlObject which is incompatible with the documented return type array|Dallgoot\Yaml\Yaml\YamlObject.

    }

    /**
     * Returns the YAML representation corresponding to given PHP variable
     *
     * @param mixed  $somePhpVar       Some php variable

Expected 4 spaces after parameter type; 2 found

Expected 1 spaces after parameter name; 7 found

     * @param int|null $options       Dumper::constants as options

Expected 4 spaces after parameter name; 7 found

     *
     * @return     string  ( the representation of $somePhpVar as a YAML content (single or multiple document according to argument) )

Tag value indented incorrectly; expected 1 spaces but found 5

     * @throws   Exception on errors during building YAML string

Tag value indented incorrectly; expected 1 spaces but found 3

     * @see Dumper::toString

Tag value indented incorrectly; expected 4 spaces but found 1

     */
    public static function dump($somePhpVar, $options = null):string
    {
        return Dumper::toString($somePhpVar, $options);
    }

    /**
     * Builds the YAML representation corresponding to given PHP variable ($somePhpVar)
     * AND save it as file with the $fileName provided.
     *
     * @param string   $fileName       The file name

Expected 3 spaces after parameter name; 7 found

     * @param mixed   $somePhpVar     Some php variable

Expected 4 spaces after parameter type; 3 found

Expected 1 spaces after parameter name; 5 found

     * @param int|null $options       Dumper::constants as options

Expected 4 spaces after parameter name; 7 found

     *
     * @return     boolean  true if YAML built and saved , false otherwise

Tag value indented incorrectly; expected 1 spaces but found 5

     * @throws   Exception on errors during building YAML string

Tag value indented incorrectly; expected 1 spaces but found 3

     */
    public static function dumpFile(string $fileName, $somePhpVar, $options = null):bool
    {
        return Dumper::toFile($fileName, $somePhpVar, $options);
    }
}