FormAlterDocSniff.php

<?php


/**
 * \DrupalPractice\Sniffs\FunctionDefinitions\FormAlterDocSniff.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
namespace DrupalPractice\Sniffs\FunctionDefinitions;

use PHP_CodeSniffer\Files\File;
use Drupal\Sniffs\Semantics\FunctionDefinition;
use DrupalPractice\Project;

/**
 * Checks that the comment "Implements hook_form_alter()." actually matches the
 * function signature.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
class FormAlterDocSniff extends FunctionDefinition {
    
    /**
     * Process this function definition.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile   The file being scanned.
     * @param int                         $stackPtr    The position of the function name
     *                                                 in the stack.
     * @param int                         $functionPtr The position of the function keyword
     *                                                 in the stack.
     *
     * @return void
     */
    public function processFunction(File $phpcsFile, $stackPtr, $functionPtr) {
        $tokens = $phpcsFile->getTokens();
        $docCommentEnd = $phpcsFile->findPrevious(T_WHITESPACE, $functionPtr - 1, null, true);
        // If there is no doc comment there is nothing we can check.
        if ($docCommentEnd === false || $tokens[$docCommentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG) {
            return;
        }
        $commentLine = $docCommentEnd - 1;
        $commentFound = false;
        while ($tokens[$commentLine]['code'] !== T_DOC_COMMENT_OPEN_TAG) {
            if (strpos($tokens[$commentLine]['content'], 'Implements hook_form_alter().') === 0) {
                $commentFound = true;
                break;
            }
            $commentLine--;
        }
        if ($commentFound === false) {
            return;
        }
        $projectName = Project::getName($phpcsFile);
        if ($projectName === false) {
            return;
        }
        if ($tokens[$stackPtr]['content'] !== $projectName . '_form_alter') {
            $warning = 'Doc comment indicates hook_form_alter() but function signature is "%s" instead of "%s". Did you mean hook_form_FORM_ID_alter()?';
            $data = [
                $tokens[$stackPtr]['content'],
                $projectName . '_form_alter',
            ];
            $phpcsFile->addWarning($warning, $commentLine, 'Different', $data);
        }
    }
    
    //end processFunction()

}

//end class