Dallgoot\Yaml

Complexity

Total Complexity

6

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

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

<?php
namespace Dallgoot\Yaml;

Missing file doc comment

use Dallgoot\Yaml as Y;
// declaring constants for Dallgoot\Yaml
$TYPES = ['DIRECTIVE',
            'DOC_START',
            'DOC_END',
            'COMMENT',
            'BLANK',
            'ROOT',
            'KEY',
            'ITEM',
            'MAPPING',
            'SEQUENCE',
            'MAPPING_SHORT',
            'SEQUENCE_SHORT',
            'PARTIAL',
            'LITT', //litteral
            'LITT_FOLDED',//litteral
            'SCALAR',
            'TAG',
            'JSON',
            'QUOTED',
            'RAW',
            'REF_DEF', //reference
            'REF_CALL', //reference
            'SET',
            'SET_KEY',
            'SET_VALUE'];


foreach ($TYPES as $power => $name) {
    define(__NAMESPACE__."\\$name", 2**$power);
}

const LITTERALS = Y\LITT | Y\LITT_FOLDED;

The constant Dallgoot\Yaml\Y\LITT was not found. Maybe you did not declare it correctly or list all dependencies?

The constant Dallgoot\Yaml\Y\LITT_FOLDED was not found. Maybe you did not declare it correctly or list all dependencies?

// print_r(get_defined_constants(true)['user']);

namespace Dallgoot;

class Yaml

Missing class doc comment

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

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

    /**
     * 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; 2 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($typeInteger)
    {
        if(is_null(self::$TYPE_NAMES)) {

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

            $f = function ($v) { return str_replace('Dallgoot\Yaml\\', '', $v);};

Opening brace must be the last content on the line

Closing brace must be on a line by itself

            self::$TYPE_NAMES = array_map($f, array_flip(get_defined_constants(true)['user']));
        }
        return self::$TYPE_NAMES[$typeInteger];
    }

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

Expected 1 spaces after parameter type; 2 found

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 1 spaces but found 6

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

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

Tag value indented incorrectly; expected 1 spaces but found 5

     * documents as an array of YamlObject )
     */
    public static function parse(string $someYaml)
    {
        return (new Yaml\Loader)->parse($someYaml);

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

    }

    /**

Parameter $fileName 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; 2 found

Tag value indented incorrectly; expected 1 spaces but found 6

     *
     * @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 parseFile(string $fileName)
    {
        return (new Yaml\Loader($fileName))->parse();

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

    }

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

Expected 1 spaces after parameter type; 2 found

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 1 spaces but found 6

     *
     * @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):string
    {
        return Yaml\Dumper::toString($somePhpVar);

The call to Dallgoot\Yaml\Dumper::toString() has too few arguments starting with 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 1 spaces after parameter type; 3 found

Expected 3 spaces after parameter name; 4 found

Tag value indented incorrectly; expected 1 spaces but found 6

     * @param      mixed   $somePhpVar  Some php variable

Expected 2 spaces after parameter type; 3 found

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 1 spaces but found 6

     *
     * @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):boolean

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

    {
        return Yaml\Dumper::toFile($fileName, $somePhpVar);

The expression return Dallgoot\Yaml\Dumper::toFile($fileName, $somePhpVar) returns the type boolean which is incompatible with the type-hinted return Dallgoot\boolean.

The call to Dallgoot\Yaml\Dumper::toFile() has too few arguments starting with options.

    }
}