Dallgoot\Yaml\API

Complexity

Total Complexity

10

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getComment()	0	6	2
A	addComment()	0	3	1
A	addTag()	0	3	1
A	addReference()	0	6	2
A	getReference()	0	6	2
A	getAllReferences()	0	3	1
A	setText()	0	3	1

<?php
namespace Dallgoot\Yaml;

Missing file doc comment

use Dallgoot\Yaml\Types as T;

/**
 * the return Object representing a YAML file content

Doc comment short description must start with a capital letter

 *  consider dumping datetime as date strings according to a format provided by user or default
 */

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 API
{
    private $_references = [];
    private $_comments   = [];
    // private $_documents  = [];
    private $tags = [];

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

    public $type = T::MAPPING;
    public $value = null;

    const UNKNOWN_REFERENCE = self::class.": no reference named '%s'";
    const UNAMED_REFERENCE  = self::class.": reference MUST have a name";


    /**
     * Adds a reference.
     *
     * @param   string                    $name   The name

Expected 1 spaces after parameter type; 20 found

Expected 2 spaces after parameter name; 3 found

Tag value indented incorrectly; expected 2 spaces but found 3

     * @param   mixed                     $value  The value

Expected 2 spaces after parameter type; 21 found

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 2 spaces but found 3

     * @throws  \UnexpectedValueException  (description)

Tag cannot be grouped with parameter tags in a doc comment

Tag value indented incorrectly; expected 1 spaces but found 2

     */

Missing @return tag in function comment

    public function addReference($name, $value):void
    {
        if (empty($name)) {
            throw new \UnexpectedValueException(self::UNAMED_REFERENCE, 1);
        }
        $this->_references[$name] = $value;
    }

    /**
     *  return the reference saved by $name

Doc comment short description must start with a capital letter

     *  @param  string  $name of the reference

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

Expected 1 spaces after parameter type; 2 found

     *  @return mixed   the value of the reference

Tag cannot be grouped with parameter tags in a doc comment

     *  @throws UnexpectedValueException    if there's no reference by that $name

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function &getReference($name)
    {
        if (array_key_exists($name, $this->_references)) {
            return $this->_references[$name];
        }
        throw new \UnexpectedValueException(sprintf(self::UNKNOWN_REFERENCE, $name), 1);
    }

    public function getAllReferences():array

Missing function doc comment

    {
        return $this->_references;
    }

    public function addComment($index, $value):void

Missing function doc comment

    {
        $this->_comments[(int) $index] = $value;
    }

    public function getComment(int $lineNumber = null)

Missing function doc comment

    {
        if (array_key_exists((int) $lineNumber, $this->_comments)) {
            return $this->_comments[$lineNumber];
        }
        return $this->_comments;
    }

    public function setText(string $value):void

Missing function doc comment

    {
        $this->value .= $value;
    }

    public function addTag(string $value):void

Missing function doc comment

    {
        $this->tags[] = $value;
    }
}