AccessAdminPagesSniff.php in Coder 8.3
File
coder_sniffer/DrupalPractice/Sniffs/General/AccessAdminPagesSniff.php
View source
<?php
namespace DrupalPractice\Sniffs\General;
use PHP_CodeSniffer\Files\File;
use Drupal\Sniffs\Semantics\FunctionDefinition;
class AccessAdminPagesSniff extends FunctionDefinition {
public function processFunction(File $phpcsFile, $stackPtr, $functionPtr) {
$fileExtension = strtolower(substr($phpcsFile
->getFilename(), -6));
if ($fileExtension !== 'module') {
return;
}
$tokens = $phpcsFile
->getTokens();
$fileName = substr(basename($phpcsFile
->getFilename()), 0, -7);
if ($tokens[$stackPtr]['content'] !== $fileName . '_menu') {
return;
}
$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']);
}
}
}