BestIt\Sniffs\Commenting\MethodDocSniff

Complexity

Total Complexity

3

Size/Duplication

Total Lines	83
Duplicated Lines	34.94 %

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
B	getTagMetadata()	0	28	1
B	getDisallowedTags()	29	29	1

<?php

namespace BestIt\Sniffs\Commenting;

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

    /**
     * Returns allowed tag metadata.
     *
     * @return array List of tag metadata
     */
    public function getTagMetadata()
    {
        return [
            '@param' => [
                'min' => 0,
                'max' => null,
                'lineAfter' => true
            ],
            '@return' => [
                'min' => 1,
                'max' => 1,
                'if' => [$this->getTagHelper(), 'isNoWhitelistedFunction'],
                'lineAfter' => true
            ],
            '@throws' => [
                'min' => 0,
                'max' => null
            ],
            '@deprecated' => [
                'min' => 0,
                'max' => 1
            ],
            '@link' => [
                'min' => 0,
                'max' => null
            ]
        ];
    }

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

This method seems to be duplicated in your project.

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