Dallgoot\Yaml\API

Complexity

Total Complexity

12

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

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

<?php

Missing file doc comment

namespace Dallgoot\Yaml;

use Dallgoot\Yaml\Yaml as Y;

/**
 * TODO
 *
 * @author  Stéphane Rebai <stephane.rebai@gmail.com>
 * @license Apache 2.0
 * @link    TODO : url to specific online doc
 */

Missing @category tag in class comment

Missing @package tag in class comment

class API
{
    /** @var null|bool */

Missing short description in doc comment

    private $hasDocStart; // null = no docstart, true = docstart before document comments, false = docstart after document comments

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

    private $_references = [];
    private $_comments   = [];
    // private $_documents  = [];
    private $_tags = [];

    public $type = Y::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 reference name
     * @param mixed  $value The reference value
     *
     * @throws \UnexpectedValueException  (description)
     */

Missing @return tag in function comment

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

    /**
     * Return the reference saved by $name
     *
     * @param string $name Name of the reference
     *
     * @return mixed Value of the reference
     * @throws \UnexpectedValueException    if there's no reference by that $name
     */
    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;
    }

    /**
     * Adds a comment.
     *
     * @param int    $lineNumber The line number at which thecomment should appear
     * @param string $value      The comment
     */

Missing @return tag in function comment

    public function addComment(int $lineNumber, $value)
    {
        $this->_comments[$lineNumber] = $value;
    }

    /**
     * Gets the comment at $lineNumber
     *
     * @param int|null $lineNumber The line number
     *
     * @return string|array The comment at $lineNumber OR ALL comments.
     */
    public function getComment(int $lineNumber = null)
    {
        if (array_key_exists((int) $lineNumber, $this->_comments)) {
            return $this->_comments[$lineNumber];
        }
        return $this->_comments;
    }

    /**
     * Sets the text when the content is *only* a litteral
     *
     * @param string $value The value
     */

Missing @return tag in function comment

    public function setText(string $value)
    {
        $this->value .= $value;
    }

    /**
     * TODO:  what to do with these tags ???
     * Adds a tag.
     *
     * @param string $value The value
     */

Missing @return tag in function comment

    public function addTag(string $value)
    {
        $this->_tags[] = $value;
    }

    /**
     * Determines if it has YAML document start string => '---'.
     *
     * @return     boolean  True if has document start, False otherwise.
     */
    public function hasDocStart()
    {
        return is_bool($this->hasDocStart);
    }

    /**
     * Sets the document start.
     *
     * @param      null|bool  $value  The value : null = no docstart, true = docstart before document comments, false = docstart after document comments
     */

Missing @return tag in function comment

    public function setDocStart($value)
    {
        $this->hasDocStart = $value;
    }
}