class Drupal_Sniffs_WhiteSpace_ScopeClosingBraceSniff in Coder 7.2
Copied from PEAR_Sniffs_WhiteSpace_ScopeClosingBraceSniff to allow empty methods and classes.
Checks that the closing braces of scopes are aligned correctly.
@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer
Hierarchy
- class \Drupal_Sniffs_WhiteSpace_ScopeClosingBraceSniff implements \PHP_CodeSniffer_Sniff
Expanded class hierarchy of Drupal_Sniffs_WhiteSpace_ScopeClosingBraceSniff
File
- coder_sniffer/
Drupal/ Sniffs/ WhiteSpace/ ScopeClosingBraceSniff.php, line 22
View source
class Drupal_Sniffs_WhiteSpace_ScopeClosingBraceSniff implements PHP_CodeSniffer_Sniff {
/**
* The number of spaces code should be indented.
*
* @var int
*/
public $indent = 2;
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register() {
return PHP_CodeSniffer_Tokens::$scopeOpeners;
}
//end register()
/**
* Processes this test, when one of its tokens is encountered.
*
* @param PHP_CodeSniffer_File $phpcsFile All the tokens found in the document.
* @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) {
$tokens = $phpcsFile
->getTokens();
// If this is an inline condition (ie. there is no scope opener), then
// return, as this is not a new scope.
if (isset($tokens[$stackPtr]['scope_closer']) === false) {
return;
}
$scopeStart = $tokens[$stackPtr]['scope_opener'];
$scopeEnd = $tokens[$stackPtr]['scope_closer'];
// If the scope closer doesn't think it belongs to this scope opener
// then the opener is sharing its closer ith other tokens. We only
// want to process the closer once, so skip this one.
if ($tokens[$scopeEnd]['scope_condition'] !== $stackPtr) {
return;
}
// We need to actually find the first piece of content on this line,
// because if this is a method with tokens before it (public, static etc)
// or an if with an else before it, then we need to start the scope
// checking from there, rather than the current token.
$lineStart = $stackPtr - 1;
for ($lineStart; $lineStart > 0; $lineStart--) {
if (strpos($tokens[$lineStart]['content'], $phpcsFile->eolChar) !== false) {
break;
}
}
// We found a new line, now go forward and find the first non-whitespace
// token.
$lineStart = $phpcsFile
->findNext(array(
T_WHITESPACE,
), $lineStart + 1, null, true);
$startColumn = $tokens[$lineStart]['column'];
// Check that the closing brace is on it's own line.
$lastContent = $phpcsFile
->findPrevious(array(
T_WHITESPACE,
), $scopeEnd - 1, $scopeStart, true);
if ($tokens[$lastContent]['line'] === $tokens[$scopeEnd]['line']) {
// Only allow empty classes and methods.
if ($tokens[$tokens[$scopeEnd]['scope_condition']]['code'] !== T_CLASS && !in_array(T_CLASS, $tokens[$scopeEnd]['conditions']) || $tokens[$lastContent]['code'] !== T_OPEN_CURLY_BRACKET) {
$error = 'Closing brace must be on a line by itself';
$phpcsFile
->addError($error, $scopeEnd);
}
return;
}
// Check now that the closing brace is lined up correctly.
$braceIndent = $tokens[$scopeEnd]['column'];
if (in_array($tokens[$stackPtr]['code'], array(
T_CASE,
T_DEFAULT,
)) === true) {
// BREAK statements should be indented n spaces from the
// CASE or DEFAULT statement.
if ($braceIndent !== $startColumn + $this->indent) {
$error = 'Case breaking statement indented incorrectly; expected %s spaces, found %s';
$data = array(
$startColumn + $this->indent - 1,
$braceIndent - 1,
);
$phpcsFile
->addError($error, $scopeEnd, 'BreakIdent', $data);
}
}
else {
if ($braceIndent !== $startColumn) {
$error = 'Closing brace indented incorrectly; expected %s spaces, found %s';
$data = array(
$startColumn - 1,
$braceIndent - 1,
);
$phpcsFile
->addError($error, $scopeEnd, 'Indent', $data);
}
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Drupal_Sniffs_WhiteSpace_ScopeClosingBraceSniff:: |
public | property | The number of spaces code should be indented. | |
Drupal_Sniffs_WhiteSpace_ScopeClosingBraceSniff:: |
public | function | Processes this test, when one of its tokens is encountered. | |
Drupal_Sniffs_WhiteSpace_ScopeClosingBraceSniff:: |
public | function | Returns an array of tokens this test wants to listen for. |