BestIt\Sniffs\Commenting\ClassDocSniff

Complexity

Total Complexity

3

Size/Duplication

Total Lines	85
Duplicated Lines	34.12 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getListenedTokens()	0	8	1
B	getTagMetadata()	0	26	1
B	getDisallowedTags()	29	29	1

<?php

namespace BestIt\Sniffs\Commenting;

use BestIt\AbstractDocSniff;

/**
 * Class ClassDocSniff
 *
 * @package BestIt\Sniffs\Commenting
 * @author Nick Lubisch <nick.lubisch@bestit-online.de>
 */
class ClassDocSniff extends AbstractDocSniff
{
    /**
     * Returns which tokens should be listened to.
     *
     * @return array|int Tokens which should be listened to
     */
    public function getListenedTokens()
    {
        return [
            T_CLASS,
            T_INTERFACE,
            T_TRAIT
        ];
    }

    /**
     * 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()
    {
        return [
            '@package' => [
                'min' => 1,
                'max' => 1,
                'if' => [$this->getTagHelper(), 'hasNamespace']
            ],
            '@author' => [
                'min' => 1,
                'max' => null
            ],
            '@version' => [
                'min' => 0,
                'max' => 1
            ],
            '@deprecated' => [
                'min' => 0,
                'max' => 1
            ],
            '@link' => [
                'min' => 0,
                'max' => null
            ]
        ];
    }

    /**
     * Returns an array of disallowed tokens.
     *
     * @return array List of disallowed tokens
     */
    public function getDisallowedTags()

This method seems to be duplicated in your project.

    {
        return [
            '@api',
            '@category',
            '@copyright',
            '@example',
            '@filesource',
            '@global',
            '@ignore',
            '@internal',
            '@license',
            '@method',
            '@param',
            '@property',
            '@property-read',
            '@property-write',
            '@return',
            '@see',
            '@since',
            '@source',
            '@subpackage',
            '@throws',
            '@todo',
            '@uses',
            '@var',
            '@inheritdoc'
        ];
    }
}