class Drupal_Sniffs_InfoFiles_RequiredSniff in Coder 7.2
"name", "description" and "core are required fields in Drupal info files. Also checks the "php" minimum requirement for Drupal 7.
@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer
Hierarchy
- class \Drupal_Sniffs_InfoFiles_RequiredSniff implements \PHP_CodeSniffer_Sniff
Expanded class hierarchy of Drupal_Sniffs_InfoFiles_RequiredSniff
File
- coder_sniffer/
Drupal/ Sniffs/ InfoFiles/ RequiredSniff.php, line 20
View source
class Drupal_Sniffs_InfoFiles_RequiredSniff implements PHP_CodeSniffer_Sniff {
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register() {
return array(
T_INLINE_HTML,
);
}
//end register()
/**
* Processes this test, when one of its tokens is encountered.
*
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token in the
* stack passed in $tokens.
*
* @return void
*/
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
$fileExtension = strtolower(substr($phpcsFile
->getFilename(), -4));
if ($fileExtension !== 'info') {
return;
}
$tokens = $phpcsFile
->getTokens();
// Only run this sniff once per info file.
if ($tokens[$stackPtr]['line'] !== 1) {
return;
}
$contents = file_get_contents($phpcsFile
->getFilename());
$info = Drupal_Sniffs_InfoFiles_ClassFilesSniff::drupalParseInfoFormat($contents);
if (isset($info['name']) === false) {
$error = '"name" property is missing in the info file';
$phpcsFile
->addError($error, $stackPtr, 'Name');
}
if (isset($info['description']) === false) {
$error = '"description" property is missing in the info file';
$phpcsFile
->addError($error, $stackPtr, 'Description');
}
if (isset($info['core']) === false) {
$error = '"core" property is missing in the info file';
$phpcsFile
->addError($error, $stackPtr, 'Core');
}
else {
if ($info['core'] === '7.x' && isset($info['php']) === true && $info['php'] <= '5.2') {
$error = 'Drupal 7 core already requires PHP 5.2';
$ptr = Drupal_Sniffs_InfoFiles_ClassFilesSniff::getPtr('php', $info['php'], $phpcsFile);
$phpcsFile
->addError($error, $ptr, 'D7PHPVersion');
}
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Drupal_Sniffs_InfoFiles_RequiredSniff:: |
public | function | Processes this test, when one of its tokens is encountered. | |
Drupal_Sniffs_InfoFiles_RequiredSniff:: |
public | function | Returns an array of tokens this test wants to listen for. |