class AccessAdminPagesSniff
Throws a warning if the "access administration pages" string is found in hook_menu().
@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer
Hierarchy
- class \Drupal\Sniffs\Semantics\FunctionDefinition implements \PHP_CodeSniffer\Sniffs\Sniff
- class \DrupalPractice\Sniffs\General\AccessAdminPagesSniff extends \Drupal\Sniffs\Semantics\FunctionDefinition
Expanded class hierarchy of AccessAdminPagesSniff
File
-
vendor/
drupal/ coder/ coder_sniffer/ DrupalPractice/ Sniffs/ General/ AccessAdminPagesSniff.php, line 23
Namespace
DrupalPractice\Sniffs\GeneralView source
class AccessAdminPagesSniff 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) {
$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
}
//end processFunction()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
AccessAdminPagesSniff::processFunction | public | function | Process this function definition. | Overrides FunctionDefinition::processFunction |
FunctionDefinition::process | public | function | Processes this test, when one of its tokens is encountered. | Overrides Sniff::process |
FunctionDefinition::register | public | function | Returns an array of tokens this test wants to listen for. | Overrides Sniff::register |