BestIt\Sniffs\Commenting\ConstantDocSniff

Complexity

Total Complexity

3

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getListenedTokens()	0	6	1
A	getTagMetadata()	0	9	1
B	getDisallowedTags()	0	32	1

<?php

declare(strict_types=1);

namespace BestIt\Sniffs\Commenting;

/**
 * Class ConstantDocSniff
 *
 * @package BestIt\Sniffs\Commenting
 * @author Nick Lubisch <nick.lubisch@bestit-online.de>
 */
class ConstantDocSniff extends AbstractDocSniff
{
    /**
     * Returns which tokens should be listened to.
     *
     * @return int[] List of tokens which should be listened to
     */
    public function getListenedTokens(): array
    {
        return [
            T_CONST
        ];
    }

    /**
     * Returns allowed tag metadata.
     *
     * The order in which they appear in this array os the order for tags needed.
     *
     * @return array List of tag metadata
     */
    public function getTagMetadata(): array
    {
        return [
            '@var' => [
                'min' => 1,
                'max' => 1
            ],
        ];
    }

    /**
     * Returns an array of disallowed tokens.
     *
     * @return array List of disallowed tags
     */
    public function getDisallowedTags(): array
    {
        return [
            '@api',
            '@author',
            '@category',
            '@copyright',
            '@deprecated',
            '@example',
            '@filesource',
            '@global',
            '@ignore',
            '@internal',
            '@license',
            '@link',
            '@method',
            '@package',
            '@param',
            '@property',
            '@property-read',
            '@property-write',
            '@return',
            '@see',
            '@since',
            '@source',
            '@subpackage',
            '@throws',
            '@todo',
            '@uses',
            '@version',
        ];
    }
}