Tag::jsonSerialize() - Code Metrics - Inspection of "scrutinizer fixes" - dallgoot/yaml - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8b4244...ea75f3 )

by stéphane

created 2018-12-14 12:16 UTC

Tag::jsonSerialize() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
namespace Dallgoot\Yaml;


/**
 * TODO
 *
 * @author  Stéphane Rebai <[email protected]>
 * @license Apache 2.0
 * @link    TODO : url to specific online doc
 */

class Tag implements \JsonSerializable
{
    /** @var string */

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

    public $value;

    /**

     * Tag constructor.
     * @param $tagName

     * @param $value

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

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

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

    /**
     * Should verify if the tag is correct
     *
     * @param      string  $providedName  The provided name
     * @todo is this useful ???

     */

    private function checkNameValidity(string $providedName)
    private function checkNameValidity(/** @scrutinizer ignore-unused */ string $providedName)
    {
        /* 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).
        */
    }
}


dallgoot / yaml

Push — master ( 8b4244...ea75f3 )

Tag::jsonSerialize() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like