function AccessAdminPagesSniff::processFunction

Process this function definition.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

int $stackPtr The position of the function: name in the stack.

int $functionPtr The position of the function: keyword in the stack.

Return value

void

Overrides FunctionDefinition::processFunction

File

vendor/drupal/coder/coder_sniffer/DrupalPractice/Sniffs/General/AccessAdminPagesSniff.php, line 38

Class

AccessAdminPagesSniff

Throws a warning if the "access administration pages" string is found in hook_menu().

Namespace

DrupalPractice\Sniffs\General

Code

public function processFunction(File $phpcsFile, $stackPtr, $functionPtr) {
    $fileExtension = strtolower(substr($phpcsFile->getFilename(), -6));
    // Only check in *.module files.
    if ($fileExtension !== 'module') {
        return;
    }
    $tokens = $phpcsFile->getTokens();
    $fileName = substr(basename($phpcsFile->getFilename()), 0, -7);
    if ($tokens[$stackPtr]['content'] !== $fileName . '_menu') {
        return;
    }
    // Search in the function body for "access administration pages" strings.
    $string = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, $tokens[$functionPtr]['scope_opener'], $tokens[$functionPtr]['scope_closer']);
    while ($string !== false) {
        if (substr($tokens[$string]['content'], 1, -1) === 'access administration pages') {
            $warning = 'The administration menu callback should probably use "administer site configuration" - which implies the user can change something - rather than "access administration pages" which is about viewing but not changing configurations.';
            $phpcsFile->addWarning($warning, $string, 'PermissionFound');
        }
        $string = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, $string + 1, $tokens[$functionPtr]['scope_closer']);
    }
    
    //end while
}