Dallgoot\Yaml\Tag

Complexity

Total Complexity

4

Size/Duplication

Total Lines	32
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	checkNameValidity()	0	2	1
A	__construct()	0	7	2
A	jsonSerialize()	0	3	1

<?php
namespace Dallgoot\Yaml;

Missing file doc comment

/**
 * 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 Tag implements \JsonSerializable
{
    /** @var string */

Missing short description in doc comment

    public $tagName;
    /** @var Node|null|string */

Missing short description in doc comment

    public $value;

    /**

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

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

     * Tag constructor.
     * @param $tagName

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

Missing parameter name

     * @param $value

Missing parameter name

     * @throws \Exception if $tagName is an invalid string or absent

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function __construct(string $tagName, $value)
    {
        if (is_null($tagName)) {

The condition is_null($tagName) is always false.

            throw new \Exception(self::class.": a tag MUST have a name", 1);
        }
        $this->tagName = $tagName;
        $this->value = $value;
    }

    private function checkNameValidity(string $providedName)

The parameter $providedName is not used and could be removed.

The method checkNameValidity() is not used, and could be removed.

Private method name "Tag::checkNameValidity" must be prefixed with an underscore

Missing function doc comment

    {
        /* TODO  implement and throw Exception if invalid (setName method ???)
         *The suffix must not contain any “!” character. This would cause the tag shorthand to be interpreted as having a named tag handle. In addition, the suffix must not contain the “[”, “]”, “{”, “}” and “,” characters. These characters would cause ambiguity with flow collection structures. If the suffix needs to specify any of the above restricted characters, they must be escaped using the “%” character. This behavior is consistent with the URI character escaping rules (specifically, section 2.3 of RFC2396).
        */
    }

    public function jsonSerialize()

Missing function doc comment

    {
        return ["tagName" => $this->tagName, "value" => $this->value];
    }
}