function UselessFunctionDocCommentSniff::process

* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint *

Parameters

int $functionPointer:

Overrides Sniff::process

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/UselessFunctionDocCommentSniff.php, line 45

Class

UselessFunctionDocCommentSniff

Namespace

SlevomatCodingStandard\Sniffs\Commenting

Code

public function process(File $phpcsFile, $functionPointer) : void {
    if (!DocCommentHelper::hasDocComment($phpcsFile, $functionPointer)) {
        return;
    }
    if (DocCommentHelper::hasInheritdocAnnotation($phpcsFile, $functionPointer)) {
        return;
    }
    if (DocCommentHelper::hasDocCommentDescription($phpcsFile, $functionPointer)) {
        return;
    }
    $returnTypeHint = FunctionHelper::findReturnTypeHint($phpcsFile, $functionPointer);
    $returnAnnotation = FunctionHelper::findReturnAnnotation($phpcsFile, $functionPointer);
    if ($returnAnnotation !== null && !AnnotationHelper::isAnnotationUseless($phpcsFile, $functionPointer, $returnTypeHint, $returnAnnotation, $this->getTraversableTypeHints())) {
        return;
    }
    $parameterTypeHints = FunctionHelper::getParametersTypeHints($phpcsFile, $functionPointer);
    $parametersAnnotations = FunctionHelper::getValidParametersAnnotations($phpcsFile, $functionPointer);
    foreach ($parametersAnnotations as $parameterName => $parameterAnnotation) {
        if (!array_key_exists($parameterName, $parameterTypeHints)) {
            return;
        }
        if (!AnnotationHelper::isAnnotationUseless($phpcsFile, $functionPointer, $parameterTypeHints[$parameterName], $parameterAnnotation, $this->getTraversableTypeHints())) {
            return;
        }
    }
    foreach (AnnotationHelper::getAnnotations($phpcsFile, $functionPointer) as $annotation) {
        if (!in_array($annotation->getName(), [
            '@param',
            '@return',
        ], true)) {
            return;
        }
    }
    $fix = $phpcsFile->addFixableError(sprintf('%s %s() does not need documentation comment.', FunctionHelper::getTypeLabel($phpcsFile, $functionPointer), FunctionHelper::getFullyQualifiedName($phpcsFile, $functionPointer)), $functionPointer, self::CODE_USELESS_DOC_COMMENT);
    if (!$fix) {
        return;
    }
    
    /** @var int $docCommentOpenPointer */
    $docCommentOpenPointer = DocCommentHelper::findDocCommentOpenPointer($phpcsFile, $functionPointer);
    $docCommentClosePointer = $phpcsFile->getTokens()[$docCommentOpenPointer]['comment_closer'];
    $changeStart = $docCommentOpenPointer;
    
    /** @var int $changeEnd */
    $changeEnd = TokenHelper::findNextEffective($phpcsFile, $docCommentClosePointer + 1) - 1;
    $phpcsFile->fixer
        ->beginChangeset();
    FixerHelper::removeBetweenIncluding($phpcsFile, $changeStart, $changeEnd);
    $phpcsFile->fixer
        ->endChangeset();
}