Initial Commit
This commit is contained in:
Riley Schneider
@@ -0,0 +1,925 @@
|
||||
<?php
|
||||
/**
|
||||
* Processes pattern strings and checks that the code conforms to the pattern.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
if (class_exists('PHP_CodeSniffer_Standards_IncorrectPatternException', true) === false) {
|
||||
$error = 'Class PHP_CodeSniffer_Standards_IncorrectPatternException not found';
|
||||
throw new PHP_CodeSniffer_Exception($error);
|
||||
}
|
||||
|
||||
/**
|
||||
* Processes pattern strings and checks that the code conforms to the pattern.
|
||||
*
|
||||
* This test essentially checks that code is correctly formatted with whitespace.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
abstract class PHP_CodeSniffer_Standards_AbstractPatternSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* The current file being checked.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $currFile = '';
|
||||
|
||||
/**
|
||||
* The parsed patterns array.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private $_parsedPatterns = array();
|
||||
|
||||
/**
|
||||
* Tokens that this sniff wishes to process outside of the patterns.
|
||||
*
|
||||
* @var array(int)
|
||||
* @see registerSupplementary()
|
||||
* @see processSupplementary()
|
||||
*/
|
||||
private $_supplementaryTokens = array();
|
||||
|
||||
/**
|
||||
* If true, comments will be ignored if they are found in the code.
|
||||
*
|
||||
* @var boolean
|
||||
*/
|
||||
private $_ignoreComments = false;
|
||||
|
||||
/**
|
||||
* Positions in the stack where errors have occured.
|
||||
*
|
||||
* @var array()
|
||||
*/
|
||||
private $_errorPos = array();
|
||||
|
||||
|
||||
/**
|
||||
* Constructs a PHP_CodeSniffer_Standards_AbstractPatternSniff.
|
||||
*
|
||||
* @param boolean $ignoreComments If true, comments will be ignored.
|
||||
*/
|
||||
public function __construct($ignoreComments=false)
|
||||
{
|
||||
$this->_ignoreComments = $ignoreComments;
|
||||
$this->_supplementaryTokens = $this->registerSupplementary();
|
||||
|
||||
}//end __construct()
|
||||
|
||||
|
||||
/**
|
||||
* Registers the tokens to listen to.
|
||||
*
|
||||
* Classes extending <i>AbstractPatternTest</i> should implement the
|
||||
* <i>getPatterns()</i> method to register the patterns they wish to test.
|
||||
*
|
||||
* @return array(int)
|
||||
* @see process()
|
||||
*/
|
||||
public final function register()
|
||||
{
|
||||
$listenTypes = array();
|
||||
$patterns = $this->getPatterns();
|
||||
|
||||
foreach ($patterns as $pattern) {
|
||||
$parsedPattern = $this->_parse($pattern);
|
||||
|
||||
// Find a token position in the pattern that we can use
|
||||
// for a listener token.
|
||||
$pos = $this->_getListenerTokenPos($parsedPattern);
|
||||
$tokenType = $parsedPattern[$pos]['token'];
|
||||
$listenTypes[] = $tokenType;
|
||||
|
||||
$patternArray = array(
|
||||
'listen_pos' => $pos,
|
||||
'pattern' => $parsedPattern,
|
||||
'pattern_code' => $pattern,
|
||||
);
|
||||
|
||||
if (isset($this->_parsedPatterns[$tokenType]) === false) {
|
||||
$this->_parsedPatterns[$tokenType] = array();
|
||||
}
|
||||
|
||||
$this->_parsedPatterns[$tokenType][] = $patternArray;
|
||||
|
||||
}//end foreach
|
||||
|
||||
return array_unique(array_merge($listenTypes, $this->_supplementaryTokens));
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Returns the token types that the specified pattern is checking for.
|
||||
*
|
||||
* Returned array is in the format:
|
||||
* <code>
|
||||
* array(
|
||||
* T_WHITESPACE => 0, // 0 is the position where the T_WHITESPACE token
|
||||
* // should occur in the pattern.
|
||||
* );
|
||||
* </code>
|
||||
*
|
||||
* @param array $pattern The parsed pattern to find the acquire the token
|
||||
* types from.
|
||||
*
|
||||
* @return array(int => int)
|
||||
*/
|
||||
private function _getPatternTokenTypes($pattern)
|
||||
{
|
||||
$tokenTypes = array();
|
||||
foreach ($pattern as $pos => $patternInfo) {
|
||||
if ($patternInfo['type'] === 'token') {
|
||||
if (isset($tokenTypes[$patternInfo['token']]) === false) {
|
||||
$tokenTypes[$patternInfo['token']] = $pos;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $tokenTypes;
|
||||
|
||||
}//end _getPatternTokenTypes()
|
||||
|
||||
|
||||
/**
|
||||
* Returns the position in the pattern that this test should register as
|
||||
* a listener for the pattern.
|
||||
*
|
||||
* @param array $pattern The pattern to acquire the listener for.
|
||||
*
|
||||
* @return int The postition in the pattern that this test should register
|
||||
* as the listener.
|
||||
* @throws PHP_CodeSniffer_Exception If we could not determine a token
|
||||
* to listen for.
|
||||
*/
|
||||
private function _getListenerTokenPos($pattern)
|
||||
{
|
||||
$tokenTypes = $this->_getPatternTokenTypes($pattern);
|
||||
$tokenCodes = array_keys($tokenTypes);
|
||||
$token = PHP_CodeSniffer_Tokens::getHighestWeightedToken($tokenCodes);
|
||||
|
||||
// If we could not get a token.
|
||||
if ($token === false) {
|
||||
$error = 'Could not determine a token to listen for';
|
||||
throw new PHP_CodeSniffer_Exception($error);
|
||||
}
|
||||
|
||||
return $tokenTypes[$token];
|
||||
|
||||
}//end _getListenerTokenPos()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the test.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where the
|
||||
* token occured.
|
||||
* @param int $stackPtr The postion in the tokens stack
|
||||
* where the listening token type was
|
||||
* found.
|
||||
*
|
||||
* @return void
|
||||
* @see register()
|
||||
*/
|
||||
public final function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
$file = $phpcsFile->getFilename();
|
||||
if ($this->currFile !== $file) {
|
||||
// We have changed files, so clean up.
|
||||
$this->_errorPos = array();
|
||||
$this->currFile = $file;
|
||||
}
|
||||
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
if (in_array($tokens[$stackPtr]['code'], $this->_supplementaryTokens) === true) {
|
||||
$this->processSupplementary($phpcsFile, $stackPtr);
|
||||
}
|
||||
|
||||
$type = $tokens[$stackPtr]['code'];
|
||||
|
||||
// If the type is not set, then it must have been a token registered
|
||||
// with registerSupplementary().
|
||||
if (isset($this->_parsedPatterns[$type]) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$allErrors = array();
|
||||
|
||||
// Loop over each pattern that is listening to the current token type
|
||||
// that we are processing.
|
||||
foreach ($this->_parsedPatterns[$type] as $patternInfo) {
|
||||
// If processPattern returns false, then the pattern that we are
|
||||
// checking the code with must not be designed to check that code.
|
||||
$errors = $this->processPattern($patternInfo, $phpcsFile, $stackPtr);
|
||||
if ($errors === false) {
|
||||
// The pattern didn't match.
|
||||
continue;
|
||||
} else if (empty($errors) === true) {
|
||||
// The pattern matched, but there were no errors.
|
||||
break;
|
||||
}
|
||||
|
||||
foreach ($errors as $stackPtr => $error) {
|
||||
if (isset($this->_errorPos[$stackPtr]) === false) {
|
||||
$this->_errorPos[$stackPtr] = true;
|
||||
$allErrors[$stackPtr] = $error;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($allErrors as $stackPtr => $error) {
|
||||
$phpcsFile->addError($error, $stackPtr);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the pattern and verifies the code at $stackPtr.
|
||||
*
|
||||
* @param array $patternInfo Information about the pattern used
|
||||
* for checking, which includes are
|
||||
* parsed token representation of the
|
||||
* pattern.
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where the
|
||||
* token occured.
|
||||
* @param int $stackPtr The postion in the tokens stack where
|
||||
* the listening token type was found.
|
||||
*
|
||||
* @return array(errors)
|
||||
*/
|
||||
protected function processPattern(
|
||||
$patternInfo,
|
||||
PHP_CodeSniffer_File $phpcsFile,
|
||||
$stackPtr
|
||||
) {
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$pattern = $patternInfo['pattern'];
|
||||
$patternCode = $patternInfo['pattern_code'];
|
||||
$errors = array();
|
||||
$found = '';
|
||||
|
||||
$ignoreTokens = array(T_WHITESPACE);
|
||||
|
||||
if ($this->_ignoreComments === true) {
|
||||
$ignoreTokens
|
||||
= array_merge($ignoreTokens, PHP_CodeSniffer_Tokens::$commentTokens);
|
||||
}
|
||||
|
||||
$origStackPtr = $stackPtr;
|
||||
$hasError = false;
|
||||
|
||||
if ($patternInfo['listen_pos'] > 0) {
|
||||
$stackPtr--;
|
||||
|
||||
for ($i = ($patternInfo['listen_pos'] - 1); $i >= 0; $i--) {
|
||||
if ($pattern[$i]['type'] === 'token') {
|
||||
if ($pattern[$i]['token'] === T_WHITESPACE) {
|
||||
if ($tokens[$stackPtr]['code'] === T_WHITESPACE) {
|
||||
$found = $tokens[$stackPtr]['content'].$found;
|
||||
}
|
||||
|
||||
// Only check the size of the whitespace if this is not
|
||||
// the first token. We don't care about the size of
|
||||
// leading whitespace, just that there is some.
|
||||
if ($i !== 0) {
|
||||
if ($tokens[$stackPtr]['content'] !== $pattern[$i]['value']) {
|
||||
$hasError = true;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Check to see if this important token is the same as the
|
||||
// previous important token in the pattern. If it is not,
|
||||
// then the pattern cannot be for this piece of code.
|
||||
$prev = $phpcsFile->findPrevious(
|
||||
$ignoreTokens,
|
||||
$stackPtr,
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
if ($prev === false
|
||||
|| $tokens[$prev]['code'] !== $pattern[$i]['token']
|
||||
) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// If we skipped past some whitespace tokens, then add them
|
||||
// to the found string.
|
||||
if (($stackPtr - $prev) > 1) {
|
||||
for ($j = ($stackPtr - 1); $j > $prev; $j--) {
|
||||
$found = $tokens[$j]['content'].$found;
|
||||
}
|
||||
}
|
||||
|
||||
$found = $tokens[$prev]['content'].$found;
|
||||
|
||||
if (isset($pattern[($i - 1)]) === true
|
||||
&& $pattern[($i - 1)]['type'] === 'skip'
|
||||
) {
|
||||
$stackPtr = $prev;
|
||||
} else {
|
||||
$stackPtr = ($prev - 1);
|
||||
}
|
||||
}//end if
|
||||
} else if ($pattern[$i]['type'] === 'skip') {
|
||||
// Skip to next piece of relevant code.
|
||||
if ($pattern[$i]['to'] === 'parenthesis_closer') {
|
||||
$to = 'parenthesis_opener';
|
||||
} else {
|
||||
$to = 'scope_opener';
|
||||
}
|
||||
|
||||
// Find the previous opener.
|
||||
$next = $phpcsFile->findPrevious(
|
||||
$ignoreTokens,
|
||||
$stackPtr,
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
if ($next === false || isset($tokens[$next][$to]) === false) {
|
||||
// If there was not opener, then we must be
|
||||
// using the wrong pattern.
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($to === 'parenthesis_opener') {
|
||||
$found = '{'.$found;
|
||||
} else {
|
||||
$found = '('.$found;
|
||||
}
|
||||
|
||||
$found = '...'.$found;
|
||||
|
||||
// Skip to the opening token.
|
||||
$stackPtr = ($tokens[$next][$to] - 1);
|
||||
} else if ($pattern[$i]['type'] === 'string') {
|
||||
$found = 'abc';
|
||||
} else if ($pattern[$i]['type'] === 'newline') {
|
||||
if ($tokens[$stackPtr]['code'] === T_WHITESPACE) {
|
||||
if ($tokens[$stackPtr]['content'] !== $phpcsFile->eolChar) {
|
||||
$found = $tokens[$stackPtr]['content'].$found;
|
||||
|
||||
// This may just be an indent that comes after a newline
|
||||
// so check the token before to make sure. If it is a newline, we
|
||||
// can ignore the error here.
|
||||
if ($tokens[($stackPtr - 1)]['content'] !== $phpcsFile->eolChar) {
|
||||
$hasError = true;
|
||||
}
|
||||
} else {
|
||||
$found = 'EOL'.$found;
|
||||
}
|
||||
} else {
|
||||
$found = $tokens[$stackPtr]['content'].$found;
|
||||
$hasError = true;
|
||||
}
|
||||
}//end if
|
||||
}//end for
|
||||
}//end if
|
||||
|
||||
$stackPtr = $origStackPtr;
|
||||
$lastAddedStackPtr = null;
|
||||
$patternLen = count($pattern);
|
||||
|
||||
for ($i = $patternInfo['listen_pos']; $i < $patternLen; $i++) {
|
||||
if ($pattern[$i]['type'] === 'token') {
|
||||
if ($pattern[$i]['token'] === T_WHITESPACE) {
|
||||
if ($this->_ignoreComments === true) {
|
||||
// If we are ignoring comments, check to see if this current
|
||||
// token is a comment. If so skip it.
|
||||
if (in_array($tokens[$stackPtr]['code'], PHP_CodeSniffer_Tokens::$commentTokens) === true) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// If the next token is a comment, the we need to skip the
|
||||
// current token as we should allow a space before a
|
||||
// comment for readability.
|
||||
if (in_array($tokens[($stackPtr + 1)]['code'], PHP_CodeSniffer_Tokens::$commentTokens) === true) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
$tokenContent = '';
|
||||
if ($tokens[$stackPtr]['code'] === T_WHITESPACE) {
|
||||
if (isset($pattern[($i + 1)]) === false) {
|
||||
// This is the last token in the pattern, so just compare
|
||||
// the next token of content.
|
||||
$tokenContent = $tokens[$stackPtr]['content'];
|
||||
} else {
|
||||
// Get all the whitespace to the next token.
|
||||
$next = $phpcsFile->findNext(
|
||||
PHP_CodeSniffer_Tokens::$emptyTokens,
|
||||
$stackPtr,
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
$tokenContent = $phpcsFile->getTokensAsString(
|
||||
$stackPtr,
|
||||
($next - $stackPtr)
|
||||
);
|
||||
|
||||
$lastAddedStackPtr = $stackPtr;
|
||||
$stackPtr = $next;
|
||||
}
|
||||
|
||||
if ($stackPtr !== $lastAddedStackPtr) {
|
||||
$found .= $tokenContent;
|
||||
}
|
||||
} else {
|
||||
if ($stackPtr !== $lastAddedStackPtr) {
|
||||
$found .= $tokens[$stackPtr]['content'];
|
||||
$lastAddedStackPtr = $stackPtr;
|
||||
}
|
||||
}//end if
|
||||
|
||||
if (isset($pattern[($i + 1)]) === true
|
||||
&& $pattern[($i + 1)]['type'] === 'skip'
|
||||
) {
|
||||
// The next token is a skip token, so we just need to make
|
||||
// sure the whitespace we found has *at least* the
|
||||
// whitespace required.
|
||||
if (strpos($tokenContent, $pattern[$i]['value']) !== 0) {
|
||||
$hasError = true;
|
||||
}
|
||||
} else {
|
||||
if ($tokenContent !== $pattern[$i]['value']) {
|
||||
$hasError = true;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Check to see if this important token is the same as the
|
||||
// next important token in the pattern. If it is not, then
|
||||
// the pattern cannot be for this piece of code.
|
||||
$next = $phpcsFile->findNext(
|
||||
$ignoreTokens,
|
||||
$stackPtr,
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
if ($next === false
|
||||
|| $tokens[$next]['code'] !== $pattern[$i]['token']
|
||||
) {
|
||||
// The next important token did not match the pattern.
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($lastAddedStackPtr !== null) {
|
||||
if (($tokens[$next]['code'] === T_OPEN_CURLY_BRACKET
|
||||
|| $tokens[$next]['code'] === T_CLOSE_CURLY_BRACKET)
|
||||
&& isset($tokens[$next]['scope_condition']) === true
|
||||
&& $tokens[$next]['scope_condition'] > $lastAddedStackPtr
|
||||
) {
|
||||
// This is a brace, but the owner of it is after the current
|
||||
// token, which means it does not belong to any token in
|
||||
// our pattern. This means the pattern is not for us.
|
||||
return false;
|
||||
}
|
||||
|
||||
if (($tokens[$next]['code'] === T_OPEN_PARENTHESIS
|
||||
|| $tokens[$next]['code'] === T_CLOSE_PARENTHESIS)
|
||||
&& isset($tokens[$next]['parenthesis_owner']) === true
|
||||
&& $tokens[$next]['parenthesis_owner'] > $lastAddedStackPtr
|
||||
) {
|
||||
// This is a bracket, but the owner of it is after the current
|
||||
// token, which means it does not belong to any token in
|
||||
// our pattern. This means the pattern is not for us.
|
||||
return false;
|
||||
}
|
||||
}//end if
|
||||
|
||||
// If we skipped past some whitespace tokens, then add them
|
||||
// to the found string.
|
||||
if (($next - $stackPtr) > 0) {
|
||||
$hasComment = false;
|
||||
for ($j = $stackPtr; $j < $next; $j++) {
|
||||
$found .= $tokens[$j]['content'];
|
||||
if (in_array($tokens[$j]['code'], PHP_CodeSniffer_Tokens::$commentTokens) === true) {
|
||||
$hasComment = true;
|
||||
}
|
||||
}
|
||||
|
||||
// If we are not ignoring comments, this additional
|
||||
// whitespace or comment is not allowed. If we are
|
||||
// ignoring comments, there needs to be at least one
|
||||
// comment for this to be allowed.
|
||||
if ($this->_ignoreComments === false
|
||||
|| ($this->_ignoreComments === true
|
||||
&& $hasComment === false)
|
||||
) {
|
||||
$hasError = true;
|
||||
}
|
||||
|
||||
// Even when ignoring comments, we are not allowed to include
|
||||
// newlines without the pattern specifying them, so
|
||||
// everything should be on the same line.
|
||||
if ($tokens[$next]['line'] !== $tokens[$stackPtr]['line']) {
|
||||
$hasError = true;
|
||||
}
|
||||
}//end if
|
||||
|
||||
if ($next !== $lastAddedStackPtr) {
|
||||
$found .= $tokens[$next]['content'];
|
||||
$lastAddedStackPtr = $next;
|
||||
}
|
||||
|
||||
if (isset($pattern[($i + 1)]) === true
|
||||
&& $pattern[($i + 1)]['type'] === 'skip'
|
||||
) {
|
||||
$stackPtr = $next;
|
||||
} else {
|
||||
$stackPtr = ($next + 1);
|
||||
}
|
||||
}//end if
|
||||
} else if ($pattern[$i]['type'] === 'skip') {
|
||||
if ($pattern[$i]['to'] === 'unknown') {
|
||||
$next = $phpcsFile->findNext(
|
||||
$pattern[($i + 1)]['token'],
|
||||
$stackPtr
|
||||
);
|
||||
|
||||
if ($next === false) {
|
||||
// Couldn't find the next token, sowe we must
|
||||
// be using the wrong pattern.
|
||||
return false;
|
||||
}
|
||||
|
||||
$found .= '...';
|
||||
$stackPtr = $next;
|
||||
} else {
|
||||
// Find the previous opener.
|
||||
$next = $phpcsFile->findPrevious(
|
||||
PHP_CodeSniffer_Tokens::$blockOpeners,
|
||||
$stackPtr
|
||||
);
|
||||
|
||||
if ($next === false
|
||||
|| isset($tokens[$next][$pattern[$i]['to']]) === false
|
||||
) {
|
||||
// If there was not opener, then we must
|
||||
// be using the wrong pattern.
|
||||
return false;
|
||||
}
|
||||
|
||||
$found .= '...';
|
||||
if ($pattern[$i]['to'] === 'parenthesis_closer') {
|
||||
$found .= ')';
|
||||
} else {
|
||||
$found .= '}';
|
||||
}
|
||||
|
||||
// Skip to the closing token.
|
||||
$stackPtr = ($tokens[$next][$pattern[$i]['to']] + 1);
|
||||
}//end if
|
||||
} else if ($pattern[$i]['type'] === 'string') {
|
||||
if ($tokens[$stackPtr]['code'] !== T_STRING) {
|
||||
$hasError = true;
|
||||
}
|
||||
|
||||
if ($stackPtr !== $lastAddedStackPtr) {
|
||||
$found .= 'abc';
|
||||
$lastAddedStackPtr = $stackPtr;
|
||||
}
|
||||
|
||||
$stackPtr++;
|
||||
} else if ($pattern[$i]['type'] === 'newline') {
|
||||
// Find the next token that contains a newline character.
|
||||
$newline = 0;
|
||||
for ($j = $stackPtr; $j < $phpcsFile->numTokens; $j++) {
|
||||
if (strpos($tokens[$j]['content'], $phpcsFile->eolChar) !== false) {
|
||||
$newline = $j;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if ($newline === 0) {
|
||||
// We didn't find a newline character in the rest of the file.
|
||||
$next = ($phpcsFile->numTokens - 1);
|
||||
$hasError = true;
|
||||
} else {
|
||||
if ($this->_ignoreComments === false) {
|
||||
// The newline character cannot be part of a comment.
|
||||
if (in_array($tokens[$newline]['code'], PHP_CodeSniffer_Tokens::$commentTokens) === true) {
|
||||
$hasError = true;
|
||||
}
|
||||
}
|
||||
|
||||
if ($newline === $stackPtr) {
|
||||
$next = ($stackPtr + 1);
|
||||
} else {
|
||||
// Check that there were no significant tokens that we
|
||||
// skipped over to find our newline character.
|
||||
$next = $phpcsFile->findNext(
|
||||
$ignoreTokens,
|
||||
$stackPtr,
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
if ($next < $newline) {
|
||||
// We skipped a non-ignored token.
|
||||
$hasError = true;
|
||||
} else {
|
||||
$next = ($newline + 1);
|
||||
}
|
||||
}
|
||||
}//end if
|
||||
|
||||
if ($stackPtr !== $lastAddedStackPtr) {
|
||||
$found .= $phpcsFile->getTokensAsString(
|
||||
$stackPtr,
|
||||
($next - $stackPtr)
|
||||
);
|
||||
|
||||
$diff = ($next - $stackPtr);
|
||||
$lastAddedStackPtr = ($next - 1);
|
||||
}
|
||||
|
||||
$stackPtr = $next;
|
||||
}//end if
|
||||
}//end for
|
||||
|
||||
if ($hasError === true) {
|
||||
$error = $this->prepareError($found, $patternCode);
|
||||
$errors[$origStackPtr] = $error;
|
||||
}
|
||||
|
||||
return $errors;
|
||||
|
||||
}//end processPattern()
|
||||
|
||||
|
||||
/**
|
||||
* Prepares an error for the specified patternCode.
|
||||
*
|
||||
* @param string $found The actual found string in the code.
|
||||
* @param string $patternCode The expected pattern code.
|
||||
*
|
||||
* @return string The error message.
|
||||
*/
|
||||
protected function prepareError($found, $patternCode)
|
||||
{
|
||||
$found = str_replace("\r\n", '\n', $found);
|
||||
$found = str_replace("\n", '\n', $found);
|
||||
$found = str_replace("\r", '\n', $found);
|
||||
$found = str_replace('EOL', '\n', $found);
|
||||
$expected = str_replace('EOL', '\n', $patternCode);
|
||||
|
||||
$error = "Expected \"$expected\"; found \"$found\"";
|
||||
|
||||
return $error;
|
||||
|
||||
}//end prepareError()
|
||||
|
||||
|
||||
/**
|
||||
* Returns the patterns that should be checked.
|
||||
*
|
||||
* @return array(string)
|
||||
*/
|
||||
protected abstract function getPatterns();
|
||||
|
||||
|
||||
/**
|
||||
* Registers any supplementary tokens that this test might wish to process.
|
||||
*
|
||||
* A sniff may wish to register supplementary tests when it wishes to group
|
||||
* an arbitary validation that cannot be performed using a pattern, with
|
||||
* other pattern tests.
|
||||
*
|
||||
* @return array(int)
|
||||
* @see processSupplementary()
|
||||
*/
|
||||
protected function registerSupplementary()
|
||||
{
|
||||
return array();
|
||||
|
||||
}//end registerSupplementary()
|
||||
|
||||
|
||||
/**
|
||||
* Processes any tokens registered with registerSupplementary().
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where to
|
||||
* process the skip.
|
||||
* @param int $stackPtr The position in the tokens stack to
|
||||
* process.
|
||||
*
|
||||
* @return void
|
||||
* @see registerSupplementary()
|
||||
*/
|
||||
protected function processSupplementary(
|
||||
PHP_CodeSniffer_File $phpcsFile,
|
||||
$stackPtr
|
||||
) {
|
||||
return;
|
||||
|
||||
}//end processSupplementary()
|
||||
|
||||
|
||||
/**
|
||||
* Parses a pattern string into an array of pattern steps.
|
||||
*
|
||||
* @param string $pattern The pattern to parse.
|
||||
*
|
||||
* @return array The parsed pattern array.
|
||||
* @see _createSkipPattern()
|
||||
* @see _createTokenPattern()
|
||||
*/
|
||||
private function _parse($pattern)
|
||||
{
|
||||
$patterns = array();
|
||||
$length = strlen($pattern);
|
||||
$lastToken = 0;
|
||||
$firstToken = 0;
|
||||
|
||||
for ($i = 0; $i < $length; $i++) {
|
||||
|
||||
$specialPattern = false;
|
||||
$isLastChar = ($i === ($length - 1));
|
||||
$oldFirstToken = $firstToken;
|
||||
|
||||
if (substr($pattern, $i, 3) === '...') {
|
||||
// It's a skip pattern. The skip pattern requires the
|
||||
// content of the token in the "from" position and the token
|
||||
// to skip to.
|
||||
$specialPattern = $this->_createSkipPattern($pattern, ($i - 1));
|
||||
$lastToken = ($i - $firstToken);
|
||||
$firstToken = ($i + 3);
|
||||
$i = ($i + 2);
|
||||
|
||||
if ($specialPattern['to'] !== 'unknown') {
|
||||
$firstToken++;
|
||||
}
|
||||
} else if (substr($pattern, $i, 3) === 'abc') {
|
||||
$specialPattern = array('type' => 'string');
|
||||
$lastToken = ($i - $firstToken);
|
||||
$firstToken = ($i + 3);
|
||||
$i = ($i + 2);
|
||||
} else if (substr($pattern, $i, 3) === 'EOL') {
|
||||
$specialPattern = array('type' => 'newline');
|
||||
$lastToken = ($i - $firstToken);
|
||||
$firstToken = ($i + 3);
|
||||
$i = ($i + 2);
|
||||
}
|
||||
|
||||
if ($specialPattern !== false || $isLastChar === true) {
|
||||
// If we are at the end of the string, don't worry about a limit.
|
||||
if ($isLastChar === true) {
|
||||
// Get the string from the end of the last skip pattern, if any,
|
||||
// to the end of the pattern string.
|
||||
$str = substr($pattern, $oldFirstToken);
|
||||
} else {
|
||||
// Get the string from the end of the last special pattern,
|
||||
// if any, to the start of this special pattern.
|
||||
if ($lastToken === 0) {
|
||||
// Note that if the last special token was zero characters ago,
|
||||
// there will be nothing to process so we can skip this bit.
|
||||
// This happens if you have something like: EOL... in your pattern.
|
||||
$str = '';
|
||||
} else {
|
||||
$str = substr($pattern, $oldFirstToken, $lastToken);
|
||||
}
|
||||
}
|
||||
|
||||
if ($str !== '') {
|
||||
$tokenPatterns = $this->_createTokenPattern($str);
|
||||
foreach ($tokenPatterns as $tokenPattern) {
|
||||
$patterns[] = $tokenPattern;
|
||||
}
|
||||
}
|
||||
|
||||
// Make sure we don't skip the last token.
|
||||
if ($isLastChar === false && $i === ($length - 1)) {
|
||||
$i--;
|
||||
}
|
||||
}//end if
|
||||
|
||||
// Add the skip pattern *after* we have processed
|
||||
// all the tokens from the end of the last skip pattern
|
||||
// to the start of this skip pattern.
|
||||
if ($specialPattern !== false) {
|
||||
$patterns[] = $specialPattern;
|
||||
}
|
||||
}//end for
|
||||
|
||||
return $patterns;
|
||||
|
||||
}//end _parse()
|
||||
|
||||
|
||||
/**
|
||||
* Creates a skip pattern.
|
||||
*
|
||||
* @param string $pattern The pattern being parsed.
|
||||
* @param string $from The token content that the skip pattern starts from.
|
||||
*
|
||||
* @return array The pattern step.
|
||||
* @see _createTokenPattern()
|
||||
* @see _parse()
|
||||
*/
|
||||
private function _createSkipPattern($pattern, $from)
|
||||
{
|
||||
$skip = array('type' => 'skip');
|
||||
|
||||
$nestedParenthesis = 0;
|
||||
$nestedBraces = 0;
|
||||
for ($start = $from; $start >= 0; $start--) {
|
||||
switch ($pattern[$start]) {
|
||||
case '(':
|
||||
if ($nestedParenthesis === 0) {
|
||||
$skip['to'] = 'parenthesis_closer';
|
||||
}
|
||||
|
||||
$nestedParenthesis--;
|
||||
break;
|
||||
case '{':
|
||||
if ($nestedBraces === 0) {
|
||||
$skip['to'] = 'scope_closer';
|
||||
}
|
||||
|
||||
$nestedBraces--;
|
||||
break;
|
||||
case '}':
|
||||
$nestedBraces++;
|
||||
break;
|
||||
case ')':
|
||||
$nestedParenthesis++;
|
||||
break;
|
||||
}
|
||||
|
||||
if (isset($skip['to']) === true) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($skip['to']) === false) {
|
||||
$skip['to'] = 'unknown';
|
||||
}
|
||||
|
||||
return $skip;
|
||||
|
||||
}//end _createSkipPattern()
|
||||
|
||||
|
||||
/**
|
||||
* Creates a token pattern.
|
||||
*
|
||||
* @param string $str The tokens string that the pattern should match.
|
||||
*
|
||||
* @return array The pattern step.
|
||||
* @see _createSkipPattern()
|
||||
* @see _parse()
|
||||
*/
|
||||
private function _createTokenPattern($str)
|
||||
{
|
||||
// Don't add a space after the closing php tag as it will add a new
|
||||
// whitespace token.
|
||||
$tokens = token_get_all('<?php '.$str.'?>');
|
||||
|
||||
// Remove the <?php tag from the front and the end php tag from the back.
|
||||
$tokens = array_slice($tokens, 1, (count($tokens) - 2));
|
||||
|
||||
foreach ($tokens as &$token) {
|
||||
$token = PHP_CodeSniffer::standardiseToken($token);
|
||||
}
|
||||
|
||||
$patterns = array();
|
||||
foreach ($tokens as $patternInfo) {
|
||||
$patterns[] = array(
|
||||
'type' => 'token',
|
||||
'token' => $patternInfo['code'],
|
||||
'value' => $patternInfo['content'],
|
||||
);
|
||||
}
|
||||
|
||||
return $patterns;
|
||||
|
||||
}//end _createTokenPattern()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,238 @@
|
||||
<?php
|
||||
/**
|
||||
* An AbstractScopeTest allows for tests that extend from this class to
|
||||
* listen for tokens within a particluar scope.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* An AbstractScopeTest allows for tests that extend from this class to
|
||||
* listen for tokens within a particluar scope.
|
||||
*
|
||||
* Below is a test that listens to methods that exist only within classes:
|
||||
* <code>
|
||||
* class ClassScopeTest extends PHP_CodeSniffer_Standards_AbstractScopeSniff
|
||||
* {
|
||||
* public function __construct()
|
||||
* {
|
||||
* parent::__construct(array(T_CLASS), array(T_FUNCTION));
|
||||
* }
|
||||
*
|
||||
* protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $)
|
||||
* {
|
||||
* $className = $phpcsFile->getDeclarationName($currScope);
|
||||
* echo 'encountered a method within class '.$className;
|
||||
* }
|
||||
* }
|
||||
* </code>
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
abstract class PHP_CodeSniffer_Standards_AbstractScopeSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* The token types that this test wishes to listen to within the scope.
|
||||
*
|
||||
* @var array()
|
||||
*/
|
||||
private $_tokens = array();
|
||||
|
||||
/**
|
||||
* The type of scope opener tokens that this test wishes to listen to.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $_scopeTokens = array();
|
||||
|
||||
/**
|
||||
* The position in the tokens array that opened the current scope.
|
||||
*
|
||||
* @var array()
|
||||
*/
|
||||
protected $currScope = null;
|
||||
|
||||
/**
|
||||
* The current file being checked.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $currFile = '';
|
||||
|
||||
/**
|
||||
* True if this test should fire on tokens outside of the scope.
|
||||
*
|
||||
* @var boolean
|
||||
*/
|
||||
private $_listenOutside = false;
|
||||
|
||||
|
||||
/**
|
||||
* Constructs a new AbstractScopeTest.
|
||||
*
|
||||
* @param array $scopeTokens The type of scope the test wishes to listen to.
|
||||
* @param array $tokens The tokens that the test wishes to listen to
|
||||
* within the scope.
|
||||
* @param boolean $listenOutside If true this test will also alert the
|
||||
* extending class when a token is found outside
|
||||
* the scope, by calling the
|
||||
* processTokenOutideScope method.
|
||||
*
|
||||
* @see PHP_CodeSniffer.getValidScopeTokeners()
|
||||
* @throws PHP_CodeSniffer_Test_Exception If the specified tokens array is empty.
|
||||
*/
|
||||
public function __construct(
|
||||
array $scopeTokens,
|
||||
array $tokens,
|
||||
$listenOutside=false
|
||||
) {
|
||||
if (empty($scopeTokens) === true) {
|
||||
$error = 'The scope tokens list cannot be empty';
|
||||
throw new PHP_CodeSniffer_Test_Exception($error);
|
||||
}
|
||||
|
||||
if (empty($tokens) === true) {
|
||||
$error = 'The tokens list cannot be empty';
|
||||
throw new PHP_CodeSniffer_Test_Exception($error);
|
||||
}
|
||||
|
||||
$invalidScopeTokens = array_intersect($scopeTokens, $tokens);
|
||||
if (empty($invalidScopeTokens) === false) {
|
||||
$invalid = implode(', ', $invalidScopeTokens);
|
||||
$error = "Scope tokens [$invalid] cant be in the tokens array";
|
||||
throw new PHP_CodeSniffer_Test_Exception($error);
|
||||
}
|
||||
|
||||
$this->_listenOutside = $listenOutside;
|
||||
$this->_scopeTokens = $scopeTokens;
|
||||
$this->_tokens = $tokens;
|
||||
|
||||
}//end __construct()
|
||||
|
||||
|
||||
/**
|
||||
* The method that is called to register the tokens this test wishes to
|
||||
* listen to.
|
||||
*
|
||||
* DO NOT OVERRIDE THIS METHOD. Use the constructor of this class to register
|
||||
* for the desired tokens and scope.
|
||||
*
|
||||
* @return array(int)
|
||||
* @see __constructor()
|
||||
*/
|
||||
public final function register()
|
||||
{
|
||||
if ($this->_listenOutside === false) {
|
||||
return $this->_scopeTokens;
|
||||
} else {
|
||||
return array_merge($this->_scopeTokens, $this->_tokens);
|
||||
}
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the tokens that this test is listening for.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where this token was found.
|
||||
* @param int $stackPtr The position in the stack where this
|
||||
* token was found.
|
||||
*
|
||||
* @return void
|
||||
* @see processTokenWithinScope()
|
||||
*/
|
||||
public final function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
$file = $phpcsFile->getFilename();
|
||||
if ($this->currFile !== $file) {
|
||||
// We have changed files, so clean up.
|
||||
$this->currScope = null;
|
||||
$this->currFile = $file;
|
||||
}
|
||||
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
if (in_array($tokens[$stackPtr]['code'], $this->_scopeTokens) === true) {
|
||||
$this->currScope = $stackPtr;
|
||||
$phpcsFile->addTokenListener($this, $this->_tokens);
|
||||
} else if ($this->currScope !== null
|
||||
&& isset($tokens[$this->currScope]['scope_closer']) === true
|
||||
&& $stackPtr > $tokens[$this->currScope]['scope_closer']
|
||||
) {
|
||||
$this->currScope = null;
|
||||
if ($this->_listenOutside === true) {
|
||||
// This is a token outside the current scope, so notify the
|
||||
// extender as they wish to know about this.
|
||||
$this->processTokenOutsideScope($phpcsFile, $stackPtr);
|
||||
} else {
|
||||
// Don't remove the listener if the extender wants to know about
|
||||
// tokens that live outside the current scope.
|
||||
$phpcsFile->removeTokenListener($this, $this->_tokens);
|
||||
}
|
||||
} else if ($this->currScope !== null) {
|
||||
$this->processTokenWithinScope($phpcsFile, $stackPtr, $this->currScope);
|
||||
} else {
|
||||
$this->processTokenOutsideScope($phpcsFile, $stackPtr);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
/**
|
||||
* Processes a token that is found within the scope that this test is
|
||||
* listening to.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where this token was found.
|
||||
* @param int $stackPtr The position in the stack where this
|
||||
* token was found.
|
||||
* @param int $currScope The position in the tokens array that
|
||||
* opened the scope that this test is
|
||||
* listening for.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected abstract function processTokenWithinScope(
|
||||
PHP_CodeSniffer_File $phpcsFile,
|
||||
$stackPtr,
|
||||
$currScope
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
* Processes a token that is found within the scope that this test is
|
||||
* listening to.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where this token was found.
|
||||
* @param int $stackPtr The position in the stack where this
|
||||
* token was found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processTokenOutsideScope(
|
||||
PHP_CodeSniffer_File $phpcsFile,
|
||||
$stackPtr
|
||||
) {
|
||||
return;
|
||||
|
||||
}//end processTokenOutsideScope()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,245 @@
|
||||
<?php
|
||||
/**
|
||||
* A class to find T_VARIABLE tokens.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) {
|
||||
$error = 'Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found';
|
||||
throw new PHP_CodeSniffer_Exception($error);
|
||||
}
|
||||
|
||||
/**
|
||||
* A class to find T_VARIABLE tokens.
|
||||
*
|
||||
* This class can distingush between normal T_VARIABLE tokens, and those tokens
|
||||
* that represent class members. If a class member is encountered, then then
|
||||
* processMemberVar method is called so the extending class can process it. If
|
||||
* the token is found to be a normal T_VARIABLE token, then processVariable is
|
||||
* called.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
abstract class PHP_CodeSniffer_Standards_AbstractVariableSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff
|
||||
{
|
||||
|
||||
/**
|
||||
* The end token of the current function that we are in.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
private $_endFunction = -1;
|
||||
|
||||
/**
|
||||
* true if a function is currently open.
|
||||
*
|
||||
* @var boolean
|
||||
*/
|
||||
private $_functionOpen = false;
|
||||
|
||||
/**
|
||||
* The current PHP_CodeSniffer file that we are processing.
|
||||
*
|
||||
* @var PHP_CodeSniffer_File
|
||||
*/
|
||||
protected $currentFile = null;
|
||||
|
||||
|
||||
/**
|
||||
* Constructs an AbstractVariableTest.
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
$scopes = array(
|
||||
T_CLASS,
|
||||
T_INTERFACE,
|
||||
);
|
||||
|
||||
$listen = array(
|
||||
T_FUNCTION,
|
||||
T_VARIABLE,
|
||||
T_DOUBLE_QUOTED_STRING,
|
||||
T_HEREDOC,
|
||||
);
|
||||
|
||||
parent::__construct($scopes, $listen, true);
|
||||
|
||||
}//end __construct()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the token in the specified PHP_CodeSniffer_File.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this
|
||||
* token was found.
|
||||
* @param int $stackPtr The position where the token was found.
|
||||
* @param array $currScope The current scope opener token.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected final function processTokenWithinScope(
|
||||
PHP_CodeSniffer_File $phpcsFile,
|
||||
$stackPtr,
|
||||
$currScope
|
||||
) {
|
||||
if ($this->currentFile !== $phpcsFile) {
|
||||
$this->currentFile = $phpcsFile;
|
||||
$this->_functionOpen = false;
|
||||
$this->_endFunction = -1;
|
||||
}
|
||||
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
if ($stackPtr > $this->_endFunction) {
|
||||
$this->_functionOpen = false;
|
||||
}
|
||||
|
||||
if ($tokens[$stackPtr]['code'] === T_FUNCTION
|
||||
&& $this->_functionOpen === false
|
||||
) {
|
||||
$this->_functionOpen = true;
|
||||
|
||||
$methodProps = $phpcsFile->getMethodProperties($stackPtr);
|
||||
|
||||
// If the function is abstract, or is in an interface,
|
||||
// then set the end of the function to it's closing semicolon.
|
||||
if ($methodProps['is_abstract'] === true
|
||||
|| $tokens[$currScope]['code'] === T_INTERFACE
|
||||
) {
|
||||
$this->_endFunction
|
||||
= $phpcsFile->findNext(array(T_SEMICOLON), $stackPtr);
|
||||
} else {
|
||||
if (isset($tokens[$stackPtr]['scope_closer']) === false) {
|
||||
$error = 'Possible parse error: non-abstract method defined as abstract';
|
||||
$phpcsFile->addWarning($error, $stackPtr);
|
||||
return;
|
||||
}
|
||||
|
||||
$this->_endFunction = $tokens[$stackPtr]['scope_closer'];
|
||||
}
|
||||
}
|
||||
|
||||
if ($tokens[$stackPtr]['code'] === T_DOUBLE_QUOTED_STRING
|
||||
|| $tokens[$stackPtr]['code'] === T_HEREDOC
|
||||
) {
|
||||
// Check to see if this string has a variable in it.
|
||||
$pattern = '|(?<!\\\\)(?:\\\\{2})*\${?[a-zA-Z0-9_]+}?|';
|
||||
if (preg_match($pattern, $tokens[$stackPtr]['content']) !== 0) {
|
||||
$this->processVariableInString($phpcsFile, $stackPtr);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if ($this->_functionOpen === true) {
|
||||
if ($tokens[$stackPtr]['code'] === T_VARIABLE) {
|
||||
$this->processVariable($phpcsFile, $stackPtr);
|
||||
}
|
||||
} else {
|
||||
// What if we assign a member variable to another?
|
||||
// ie. private $_count = $this->_otherCount + 1;.
|
||||
$this->processMemberVar($phpcsFile, $stackPtr);
|
||||
}
|
||||
|
||||
}//end processTokenWithinScope()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the token outside the scope in the file.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this
|
||||
* token was found.
|
||||
* @param int $stackPtr The position where the token was found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected final function processTokenOutsideScope(
|
||||
PHP_CodeSniffer_File $phpcsFile,
|
||||
$stackPtr
|
||||
) {
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
// These variables are not member vars.
|
||||
if ($tokens[$stackPtr]['code'] === T_VARIABLE) {
|
||||
$this->processVariable($phpcsFile, $stackPtr);
|
||||
} else if ($tokens[$stackPtr]['code'] === T_DOUBLE_QUOTED_STRING
|
||||
|| $tokens[$stackPtr]['code'] === T_HEREDOC
|
||||
) {
|
||||
// Check to see if this string has a variable in it.
|
||||
$pattern = '|(?<!\\\\)(?:\\\\{2})*\${?[a-zA-Z0-9_]+}?|';
|
||||
if (preg_match($pattern, $tokens[$stackPtr]['content']) !== 0) {
|
||||
$this->processVariableInString($phpcsFile, $stackPtr);
|
||||
}
|
||||
}
|
||||
|
||||
}//end processTokenOutsideScope()
|
||||
|
||||
|
||||
/**
|
||||
* Called to process class member vars.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this
|
||||
* token was found.
|
||||
* @param int $stackPtr The position where the token was found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
abstract protected function processMemberVar(
|
||||
PHP_CodeSniffer_File $phpcsFile,
|
||||
$stackPtr
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
* Called to process normal member vars.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this
|
||||
* token was found.
|
||||
* @param int $stackPtr The position where the token was found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
abstract protected function processVariable(
|
||||
PHP_CodeSniffer_File $phpcsFile,
|
||||
$stackPtr
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
* Called to process variables found in duoble quoted strings or heredocs.
|
||||
*
|
||||
* Note that there may be more than one variable in the string, which will
|
||||
* result only in one call for the string or one call per line for heredocs.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this
|
||||
* token was found.
|
||||
* @param int $stackPtr The position where the double quoted
|
||||
* string was found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
abstract protected function processVariableInString(
|
||||
PHP_CodeSniffer_File
|
||||
$phpcsFile,
|
||||
$stackPtr
|
||||
);
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,7 @@
|
||||
<documentation title="Line Length">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
It is recommended to keep lines at approximately 80 characters long for better code readability.
|
||||
]]>
|
||||
</standard>
|
||||
</documentation>
|
||||
@@ -0,0 +1,56 @@
|
||||
<documentation title="Aligning Blocks of Assignments">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
There should be one space on either side of an equals sign used to assign a value to a variable. In the case of a block of related assignments, more space may be inserted to promote readability.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Equals signs aligned">
|
||||
<![CDATA[
|
||||
$shortVar <em>=</em> (1 + 2);
|
||||
$veryLongVarName <em>=</em> 'string';
|
||||
$var <em>=</em> foo($bar, $baz, $quux);
|
||||
]]>
|
||||
</code>
|
||||
<code title="Not aligned; harder to read">
|
||||
<![CDATA[
|
||||
$shortVar <em>=</em> (1 + 2);
|
||||
$veryLongVarName <em>=</em> 'string';
|
||||
$var <em>=</em> foo($bar, $baz, $quux);
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
<standard>
|
||||
<![CDATA[
|
||||
When using plus-equals, minus-equals etc. still ensure the equals signs are aligned to one space after the longest variable name.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Equals signs aligned; only one space after longest var name">
|
||||
<![CDATA[
|
||||
$shortVar <em>+= </em>1;
|
||||
$veryLongVarName<em> = </em>1;
|
||||
]]>
|
||||
</code>
|
||||
<code title="Two spaces after longest var name">
|
||||
<![CDATA[
|
||||
$shortVar <em> += </em>1;
|
||||
$veryLongVarName<em> = </em>1;
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
<code_comparison>
|
||||
<code title="Equals signs aligned">
|
||||
<![CDATA[
|
||||
$shortVar <em> = </em>1;
|
||||
$veryLongVarName<em> -= </em>1;
|
||||
]]>
|
||||
</code>
|
||||
<code title="Equals signs not aligned">
|
||||
<![CDATA[
|
||||
$shortVar <em> = </em>1;
|
||||
$veryLongVarName<em> -= </em>1;
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,24 @@
|
||||
<documentation title="Opening Brace in Function Declarations">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Function declarations follow the "BSD/Allman style". The function brace is on the line following the function declaration and is indented to the same column as the start of the function declaration.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: brace on next line">
|
||||
<![CDATA[
|
||||
function fooFunction($arg1, $arg2 = '')
|
||||
<em>{</em>
|
||||
...
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: brace on same line">
|
||||
<![CDATA[
|
||||
function fooFunction($arg1, $arg2 = '') <em>{</em>
|
||||
...
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,24 @@
|
||||
<documentation title="Opening Brace in Function Declarations">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Function declarations follow the "Kernighan/Ritchie style". The function brace is on the same line as the function declaration. One space is required between the closing parenthesis and the brace.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: brace on same line">
|
||||
<![CDATA[
|
||||
function fooFunction($arg1, $arg2 = '')<em> {</em>
|
||||
...
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: brace on next line">
|
||||
<![CDATA[
|
||||
function fooFunction($arg1, $arg2 = '')
|
||||
<em>{</em>
|
||||
...
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,29 @@
|
||||
<documentation title="Constant Names">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Constants should always be all-uppercase, with underscores to separate words.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: all uppercase">
|
||||
<![CDATA[
|
||||
define('<em>FOO_CONSTANT</em>', 'foo');
|
||||
|
||||
class FooClass
|
||||
{
|
||||
const <em>FOO_CONSTANT</em> = 'foo';
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: mixed case">
|
||||
<![CDATA[
|
||||
define('<em>Foo_Constant</em>', 'foo');
|
||||
|
||||
class FooClass
|
||||
{
|
||||
const <em>foo_constant</em> = 'foo';
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,7 @@
|
||||
<documentation title="PHP Code Tags">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Always use <?php ?> to delimit PHP code, not the <? ?> shorthand. This is the most portable way to include PHP code on differing operating systems and setups.
|
||||
]]>
|
||||
</standard>
|
||||
</documentation>
|
||||
@@ -0,0 +1,23 @@
|
||||
<documentation title="PHP Constants">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
The <em>true</em>, <em>false</em> and <em>null</em> constants must always be lowercase.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: lowercase constants">
|
||||
<![CDATA[
|
||||
if ($var === <em>false</em> || $var === <em>null</em>) {
|
||||
$var = <em>true</em>;
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: uppercase constants">
|
||||
<![CDATA[
|
||||
if ($var === <em>FALSE</em> || $var === <em>NULL</em>) {
|
||||
$var = <em>TRUE</em>;
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,23 @@
|
||||
<documentation title="PHP Constants">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
The <em>true</em>, <em>false</em> and <em>null</em> constants must always be uppercase.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: uppercase constants">
|
||||
<![CDATA[
|
||||
if ($var === <em>FALSE</em> || $var === <em>NULL</em>) {
|
||||
$var = <em>TRUE</em>;
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: lowercase constants">
|
||||
<![CDATA[
|
||||
if ($var === <em>false</em> || $var === <em>null</em>) {
|
||||
$var = <em>true</em>;
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,97 @@
|
||||
<?php
|
||||
/**
|
||||
* Reports errors if the same class or interface name is used in multiple files.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Reports errors if the same class or interface name is used in multiple files.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Classes_DuplicateClassNameSniff implements PHP_CodeSniffer_MultiFileSniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Called once per script run to allow for processing of this sniff.
|
||||
*
|
||||
* @param array(PHP_CodeSniffer_File) $files The PHP_CodeSniffer files processed
|
||||
* during the script run.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function process(array $files)
|
||||
{
|
||||
$foundClasses = array();
|
||||
|
||||
foreach ($files as $phpcsFile) {
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$namespace = '';
|
||||
$stackPtr = $phpcsFile->findNext(array(T_CLASS, T_INTERFACE, T_NAMESPACE), 0);
|
||||
while ($stackPtr !== false) {
|
||||
// Keep track of what namespace we are in.
|
||||
if ($tokens[$stackPtr]['code'] === T_NAMESPACE) {
|
||||
$nsEnd = $phpcsFile->findNext(
|
||||
array(T_NS_SEPARATOR, T_STRING, T_WHITESPACE),
|
||||
($stackPtr + 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
$namespace = trim($phpcsFile->getTokensAsString(($stackPtr + 1), ($nsEnd - $stackPtr - 1)));
|
||||
$stackPtr = $nsEnd;
|
||||
} else {
|
||||
$nameToken = $phpcsFile->findNext(T_STRING, $stackPtr);
|
||||
$name = $tokens[$nameToken]['content'];
|
||||
if ($namespace !== '') {
|
||||
$name = $namespace.'\\'.$name;
|
||||
}
|
||||
|
||||
$compareName = strtolower($name);
|
||||
if (isset($foundClasses[$compareName]) === true) {
|
||||
$type = strtolower($tokens[$stackPtr]['content']);
|
||||
$file = $foundClasses[$compareName]['file'];
|
||||
$line = $foundClasses[$compareName]['line'];
|
||||
$error = 'Duplicate %s name "%s" found; first defined in %s on line %s';
|
||||
$data = array(
|
||||
$type,
|
||||
$name,
|
||||
$file,
|
||||
$line,
|
||||
);
|
||||
$phpcsFile->addWarning($error, $stackPtr, 'Found', $data);
|
||||
} else {
|
||||
$foundClasses[$compareName] = array(
|
||||
'file' => $phpcsFile->getFilename(),
|
||||
'line' => $tokens[$stackPtr]['line'],
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
$stackPtr = $phpcsFile->findNext(array(T_CLASS, T_INTERFACE, T_NAMESPACE), ($stackPtr + 1));
|
||||
}//end while
|
||||
|
||||
}//end foreach
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,128 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of the CodeAnalysis addon for PHP_CodeSniffer.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* This sniff class detected empty statement.
|
||||
*
|
||||
* This sniff implements the common algorithm for empty statement body detection.
|
||||
* A body is considered as empty if it is completely empty or it only contains
|
||||
* whitespace characters and|or comments.
|
||||
*
|
||||
* <code>
|
||||
* stmt {
|
||||
* // foo
|
||||
* }
|
||||
* stmt (conditions) {
|
||||
* // foo
|
||||
* }
|
||||
* </code>
|
||||
*
|
||||
* Statements covered by this sniff are <b>catch</b>, <b>do</b>, <b>else</b>,
|
||||
* <b>elsif</b>, <b>for</b>, <b>foreach<b>, <b>if</b>, <b>switch</b>, <b>try</b>
|
||||
* and <b>while</b>.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_CodeAnalysis_EmptyStatementSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* List of block tokens that this sniff covers.
|
||||
*
|
||||
* The key of this hash identifies the required token while the boolean
|
||||
* value says mark an error or mark a warning.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $checkedTokens = array(
|
||||
T_CATCH => true,
|
||||
T_DO => false,
|
||||
T_ELSE => false,
|
||||
T_ELSEIF => false,
|
||||
T_FOR => false,
|
||||
T_FOREACH => false,
|
||||
T_IF => false,
|
||||
T_SWITCH => false,
|
||||
T_TRY => false,
|
||||
T_WHILE => false,
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
* Registers the tokens that this sniff wants to listen for.
|
||||
*
|
||||
* @return array(integer)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array_keys($this->checkedTokens);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$token = $tokens[$stackPtr];
|
||||
|
||||
// Skip for-statements without body.
|
||||
if (isset($token['scope_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$next = ++$token['scope_opener'];
|
||||
$end = --$token['scope_closer'];
|
||||
|
||||
$emptyBody = true;
|
||||
for (; $next <= $end; ++$next) {
|
||||
if (in_array($tokens[$next]['code'], PHP_CodeSniffer_Tokens::$emptyTokens) === false) {
|
||||
$emptyBody = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if ($emptyBody === true) {
|
||||
// Get token identifier.
|
||||
$name = $phpcsFile->getTokensAsString($stackPtr, 1);
|
||||
$error = 'Empty %s statement detected';
|
||||
$data = array(strtoupper($name));
|
||||
if ($this->checkedTokens[$token['code']] === true) {
|
||||
$phpcsFile->addError($error, $stackPtr, 'NotAllowed', $data);
|
||||
} else {
|
||||
$phpcsFile->addWarning($error, $stackPtr, 'NotAllowedWarning', $data);
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,100 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of the CodeAnalysis addon for PHP_CodeSniffer.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Detects for-loops that can be simplified to a while-loop.
|
||||
*
|
||||
* This rule is based on the PMD rule catalog. Detects for-loops that can be
|
||||
* simplified as a while-loop.
|
||||
*
|
||||
* <code>
|
||||
* class Foo
|
||||
* {
|
||||
* public function bar($x)
|
||||
* {
|
||||
* for (;true;) true; // No Init or Update part, may as well be: while (true)
|
||||
* }
|
||||
* }
|
||||
* </code>
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_CodeAnalysis_ForLoopShouldBeWhileLoopSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Registers the tokens that this sniff wants to listen for.
|
||||
*
|
||||
* @return array(integer)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_FOR);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$token = $tokens[$stackPtr];
|
||||
|
||||
// Skip invalid statement.
|
||||
if (isset($token['parenthesis_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$next = ++$token['parenthesis_opener'];
|
||||
$end = --$token['parenthesis_closer'];
|
||||
|
||||
$parts = array(0, 0, 0);
|
||||
$index = 0;
|
||||
|
||||
for (; $next <= $end; ++$next) {
|
||||
$code = $tokens[$next]['code'];
|
||||
if ($code === T_SEMICOLON) {
|
||||
++$index;
|
||||
} else if (in_array($code, PHP_CodeSniffer_Tokens::$emptyTokens) === false) {
|
||||
++$parts[$index];
|
||||
}
|
||||
}
|
||||
|
||||
if ($parts[0] === 0 && $parts[2] === 0 && $parts[1] > 0) {
|
||||
$error = 'This FOR loop can be simplified to a WHILE loop';
|
||||
$phpcsFile->addWarning($error, $stackPtr, 'CanSimplify');
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,113 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of the CodeAnalysis addon for PHP_CodeSniffer.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Detects for-loops that use a function call in the test expression.
|
||||
*
|
||||
* This rule is based on the PMD rule catalog. Detects for-loops that use a
|
||||
* function call in the test expression.
|
||||
*
|
||||
* <code>
|
||||
* class Foo
|
||||
* {
|
||||
* public function bar($x)
|
||||
* {
|
||||
* $a = array(1, 2, 3, 4);
|
||||
* for ($i = 0; $i < count($a); $i++) {
|
||||
* $a[$i] *= $i;
|
||||
* }
|
||||
* }
|
||||
* }
|
||||
* </code>
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_CodeAnalysis_ForLoopWithTestFunctionCallSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Registers the tokens that this sniff wants to listen for.
|
||||
*
|
||||
* @return array(integer)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_FOR);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$token = $tokens[$stackPtr];
|
||||
|
||||
// Skip invalid statement.
|
||||
if (isset($token['parenthesis_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$next = ++$token['parenthesis_opener'];
|
||||
$end = --$token['parenthesis_closer'];
|
||||
|
||||
$position = 0;
|
||||
|
||||
for (; $next <= $end; ++$next) {
|
||||
$code = $tokens[$next]['code'];
|
||||
if ($code === T_SEMICOLON) {
|
||||
++$position;
|
||||
}
|
||||
|
||||
if ($position < 1) {
|
||||
continue;
|
||||
} else if ($position > 1) {
|
||||
break;
|
||||
} else if ($code !== T_VARIABLE && $code !== T_STRING) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Find next non empty token, if it is a open curly brace we have a
|
||||
// function call.
|
||||
$index = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
|
||||
|
||||
if ($tokens[$index]['code'] === T_OPEN_PARENTHESIS) {
|
||||
$error = 'Avoid function calls in a FOR loop test part';
|
||||
$phpcsFile->addWarning($error, $stackPtr, 'NotAllowed');
|
||||
break;
|
||||
}
|
||||
}//end for
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,148 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of the CodeAnalysis addon for PHP_CodeSniffer.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Detects incrementer jumbling in for loops.
|
||||
*
|
||||
* This rule is based on the PMD rule catalog. The jumbling incrementer sniff
|
||||
* detects the usage of one and the same incrementer into an outer and an inner
|
||||
* loop. Even it is intended this is confusing code.
|
||||
*
|
||||
* <code>
|
||||
* class Foo
|
||||
* {
|
||||
* public function bar($x)
|
||||
* {
|
||||
* for ($i = 0; $i < 10; $i++)
|
||||
* {
|
||||
* for ($k = 0; $k < 20; $i++)
|
||||
* {
|
||||
* echo 'Hello';
|
||||
* }
|
||||
* }
|
||||
* }
|
||||
* }
|
||||
* </code>
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_CodeAnalysis_JumbledIncrementerSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Registers the tokens that this sniff wants to listen for.
|
||||
*
|
||||
* @return array(integer)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_FOR);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$token = $tokens[$stackPtr];
|
||||
|
||||
// Skip for-loop without body.
|
||||
if (isset($token['scope_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Find incrementors for outer loop.
|
||||
$outer = $this->findIncrementers($tokens, $token);
|
||||
|
||||
// Skip if empty.
|
||||
if (count($outer) === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Find nested for loops.
|
||||
$start = ++$token['scope_opener'];
|
||||
$end = --$token['scope_closer'];
|
||||
|
||||
for (; $start <= $end; ++$start) {
|
||||
if ($tokens[$start]['code'] !== T_FOR) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$inner = $this->findIncrementers($tokens, $tokens[$start]);
|
||||
$diff = array_intersect($outer, $inner);
|
||||
|
||||
if (count($diff) !== 0) {
|
||||
$error = 'Loop incrementor (%s) jumbling with inner loop';
|
||||
$data = array(join(', ', $diff));
|
||||
$phpcsFile->addWarning($error, $stackPtr, 'Found', $data);
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
/**
|
||||
* Get all used variables in the incrementer part of a for statement.
|
||||
*
|
||||
* @param array(integer=>array) $tokens Array with all code sniffer tokens.
|
||||
* @param array(string=>mixed) $token Current for loop token
|
||||
*
|
||||
* @return array(string) List of all found incrementer variables.
|
||||
*/
|
||||
protected function findIncrementers(array $tokens, array $token)
|
||||
{
|
||||
// Skip invalid statement.
|
||||
if (isset($token['parenthesis_opener']) === false) {
|
||||
return array();
|
||||
}
|
||||
|
||||
$start = ++$token['parenthesis_opener'];
|
||||
$end = --$token['parenthesis_closer'];
|
||||
|
||||
$incrementers = array();
|
||||
$semicolons = 0;
|
||||
for ($next = $start; $next <= $end; ++$next) {
|
||||
$code = $tokens[$next]['code'];
|
||||
if ($code === T_SEMICOLON) {
|
||||
++$semicolons;
|
||||
} else if ($semicolons === 2 && $code === T_VARIABLE) {
|
||||
$incrementers[] = $tokens[$next]['content'];
|
||||
}
|
||||
}
|
||||
|
||||
return $incrementers;
|
||||
|
||||
}//end findIncrementers()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,106 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of the CodeAnalysis addon for PHP_CodeSniffer.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Detects unconditional if- and elseif-statements.
|
||||
*
|
||||
* This rule is based on the PMD rule catalog. The Unconditional If Statment
|
||||
* sniff detects statement conditions that are only set to one of the constant
|
||||
* values <b>true</b> or <b>false</b>
|
||||
*
|
||||
* <code>
|
||||
* class Foo
|
||||
* {
|
||||
* public function close()
|
||||
* {
|
||||
* if (true)
|
||||
* {
|
||||
* // ...
|
||||
* }
|
||||
* }
|
||||
* }
|
||||
* </code>
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_CodeAnalysis_UnconditionalIfStatementSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Registers the tokens that this sniff wants to listen for.
|
||||
*
|
||||
* @return array(integer)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(
|
||||
T_IF,
|
||||
T_ELSEIF,
|
||||
);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$token = $tokens[$stackPtr];
|
||||
|
||||
// Skip for-loop without body.
|
||||
if (isset($token['parenthesis_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$next = ++$token['parenthesis_opener'];
|
||||
$end = --$token['parenthesis_closer'];
|
||||
|
||||
$goodCondition = false;
|
||||
for (; $next <= $end; ++$next) {
|
||||
$code = $tokens[$next]['code'];
|
||||
|
||||
if (in_array($code, PHP_CodeSniffer_Tokens::$emptyTokens) === true) {
|
||||
continue;
|
||||
} else if ($code !== T_TRUE && $code !== T_FALSE) {
|
||||
$goodCondition = true;
|
||||
}
|
||||
}
|
||||
|
||||
if ($goodCondition === false) {
|
||||
$error = 'Avoid IF statements that are always true or false';
|
||||
$phpcsFile->addWarning($error, $stackPtr, 'Found');
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,98 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of the CodeAnalysis addon for PHP_CodeSniffer.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Detects unnecessary final modifiers inside of final classes.
|
||||
*
|
||||
* This rule is based on the PMD rule catalog. The Unnecessary Final Modifier
|
||||
* sniff detects the use of the final modifier inside of a final class which
|
||||
* is unnecessary.
|
||||
*
|
||||
* <code>
|
||||
* final class Foo
|
||||
* {
|
||||
* public final function bar()
|
||||
* {
|
||||
* }
|
||||
* }
|
||||
* </code>
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_CodeAnalysis_UnnecessaryFinalModifierSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Registers the tokens that this sniff wants to listen for.
|
||||
*
|
||||
* @return array(integer)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_CLASS);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$token = $tokens[$stackPtr];
|
||||
|
||||
// Skip for-statements without body.
|
||||
if (isset($token['scope_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Fetch previous token.
|
||||
$prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
|
||||
|
||||
// Skip for non final class.
|
||||
if ($prev === false || $tokens[$prev]['code'] !== T_FINAL) {
|
||||
return;
|
||||
}
|
||||
|
||||
$next = ++$token['scope_opener'];
|
||||
$end = --$token['scope_closer'];
|
||||
|
||||
for (; $next <= $end; ++$next) {
|
||||
if ($tokens[$next]['code'] === T_FINAL) {
|
||||
$error = 'Unnecessary FINAL modifier in FINAL class';
|
||||
$phpcsFile->addWarning($error, $next, 'Found');
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,150 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of the CodeAnalysis addon for PHP_CodeSniffer.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Checks the for unused function parameters.
|
||||
*
|
||||
* This sniff checks that all function parameters are used in the function body.
|
||||
* One exception is made for empty function bodies or function bodies that only
|
||||
* contain comments. This could be usefull for the classes that implement an
|
||||
* interface that defines multiple methods but the implementation only needs some
|
||||
* of them.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_CodeAnalysis_UnusedFunctionParameterSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_FUNCTION);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$token = $tokens[$stackPtr];
|
||||
|
||||
// Skip broken function declarations.
|
||||
if (isset($token['scope_opener']) === false || isset($token['parenthesis_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$params = array();
|
||||
foreach ($phpcsFile->getMethodParameters($stackPtr) as $param) {
|
||||
$params[$param['name']] = $stackPtr;
|
||||
}
|
||||
|
||||
$next = ++$token['scope_opener'];
|
||||
$end = --$token['scope_closer'];
|
||||
|
||||
$emptyBody = true;
|
||||
|
||||
for (; $next <= $end; ++$next) {
|
||||
$token = $tokens[$next];
|
||||
$code = $token['code'];
|
||||
|
||||
// Ingorable tokens.
|
||||
if (in_array($code, PHP_CodeSniffer_Tokens::$emptyTokens) === true) {
|
||||
continue;
|
||||
} else if ($code === T_THROW && $emptyBody === true) {
|
||||
// Throw statement and an empty body indicate an interface method.
|
||||
return;
|
||||
} else if ($code === T_RETURN && $emptyBody === true) {
|
||||
// Return statement and an empty body indicate an interface method.
|
||||
$tmp = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
|
||||
if ($tmp === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
// There is a return.
|
||||
if ($tokens[$tmp]['code'] === T_SEMICOLON) {
|
||||
return;
|
||||
}
|
||||
|
||||
$tmp = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($tmp + 1), null, true);
|
||||
|
||||
// There is a return <token>.
|
||||
if ($tmp !== false && $tokens[$tmp]['code'] === T_SEMICOLON) {
|
||||
return;
|
||||
}
|
||||
}//end if
|
||||
|
||||
$emptyBody = false;
|
||||
|
||||
if ($code === T_VARIABLE && isset($params[$token['content']]) === true) {
|
||||
unset($params[$token['content']]);
|
||||
} else if ($code === T_DOUBLE_QUOTED_STRING || $code === T_HEREDOC) {
|
||||
// Tokenize strings that can contain variables.
|
||||
// Make sure the string is re-joined if it occurs over multiple lines.
|
||||
$string = $token['content'];
|
||||
for ($i = ($next + 1); $i <= $end; $i++) {
|
||||
if ($tokens[$i]['code'] === $code) {
|
||||
$string .= $tokens[$i]['content'];
|
||||
$next++;
|
||||
}
|
||||
}
|
||||
|
||||
$strTokens = token_get_all(sprintf('<?php %s;?>', $string));
|
||||
|
||||
foreach ($strTokens as $tok) {
|
||||
if (is_array($tok) === false || $tok[0] !== T_VARIABLE ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (isset($params[$tok[1]]) === true) {
|
||||
unset($params[$tok[1]]);
|
||||
}
|
||||
}
|
||||
}//end if
|
||||
}//end for
|
||||
|
||||
if ($emptyBody === false && count($params) > 0) {
|
||||
foreach ($params as $paramName => $position) {
|
||||
$error = 'The method parameter %s is never used';
|
||||
$data = array($paramName);
|
||||
$phpcsFile->addWarning($error, $position, 'Found', $data);
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,180 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of the CodeAnalysis addon for PHP_CodeSniffer.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Detects unnecessary overriden methods that simply call their parent.
|
||||
*
|
||||
* This rule is based on the PMD rule catalog. The Useless Overriding Method
|
||||
* sniff detects the use of methods that only call their parent classes's method
|
||||
* with the same name and arguments. These methods are not required.
|
||||
*
|
||||
* <code>
|
||||
* class FooBar {
|
||||
* public function __construct($a, $b) {
|
||||
* parent::__construct($a, $b);
|
||||
* }
|
||||
* }
|
||||
* </code>
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Manuel Pichler <mapi@manuel-pichler.de>
|
||||
* @copyright 2007-2008 Manuel Pichler. All rights reserved.
|
||||
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_CodeAnalysis_UselessOverridingMethodSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Registers the tokens that this sniff wants to listen for.
|
||||
*
|
||||
* @return array(integer)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_FUNCTION);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$token = $tokens[$stackPtr];
|
||||
|
||||
// Skip function without body.
|
||||
if (isset($token['scope_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Get function name.
|
||||
$methodName = $phpcsFile->getDeclarationName($stackPtr);
|
||||
|
||||
// Get all parameters from method signature.
|
||||
$signature = array();
|
||||
foreach ($phpcsFile->getMethodParameters($stackPtr) as $param) {
|
||||
$signature[] = $param['name'];
|
||||
}
|
||||
|
||||
$next = ++$token['scope_opener'];
|
||||
$end = --$token['scope_closer'];
|
||||
|
||||
for (; $next <= $end; ++$next) {
|
||||
$code = $tokens[$next]['code'];
|
||||
|
||||
if (in_array($code, PHP_CodeSniffer_Tokens::$emptyTokens) === true) {
|
||||
continue;
|
||||
} else if ($code === T_RETURN) {
|
||||
continue;
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
// Any token except 'parent' indicates correct code.
|
||||
if ($tokens[$next]['code'] !== T_PARENT) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Find next non empty token index, should be double colon.
|
||||
$next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
|
||||
|
||||
// Skip for invalid code.
|
||||
if ($next === false || $tokens[$next]['code'] !== T_DOUBLE_COLON) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Find next non empty token index, should be the function name.
|
||||
$next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
|
||||
|
||||
// Skip for invalid code or other method.
|
||||
if ($next === false || $tokens[$next]['content'] !== $methodName) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Find next non empty token index, should be the open parenthesis.
|
||||
$next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
|
||||
|
||||
// Skip for invalid code.
|
||||
if ($next === false || $tokens[$next]['code'] !== T_OPEN_PARENTHESIS) {
|
||||
return;
|
||||
}
|
||||
|
||||
$validParameterTypes = array(
|
||||
T_VARIABLE,
|
||||
T_LNUMBER,
|
||||
T_CONSTANT_ENCAPSED_STRING,
|
||||
);
|
||||
|
||||
$parameters = array('');
|
||||
$parenthesisCount = 1;
|
||||
$count = count($tokens);
|
||||
for (++$next; $next < $count; ++$next) {
|
||||
$code = $tokens[$next]['code'];
|
||||
|
||||
if ($code === T_OPEN_PARENTHESIS) {
|
||||
++$parenthesisCount;
|
||||
} else if ($code === T_CLOSE_PARENTHESIS) {
|
||||
--$parenthesisCount;
|
||||
} else if ($parenthesisCount === 1 && $code === T_COMMA) {
|
||||
$parameters[] = '';
|
||||
} else if (in_array($code, PHP_CodeSniffer_Tokens::$emptyTokens) === false) {
|
||||
$parameters[(count($parameters) - 1)] .= $tokens[$next]['content'];
|
||||
}
|
||||
|
||||
if ($parenthesisCount === 0) {
|
||||
break;
|
||||
}
|
||||
}//end for
|
||||
|
||||
$next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true);
|
||||
if ($next === false || $tokens[$next]['code'] !== T_SEMICOLON) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Check rest of the scope.
|
||||
for (++$next; $next <= $end; ++$next) {
|
||||
$code = $tokens[$next]['code'];
|
||||
// Skip for any other content.
|
||||
if (in_array($code, PHP_CodeSniffer_Tokens::$emptyTokens) === false) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
$parameters = array_map('trim', $parameters);
|
||||
$parameters = array_filter($parameters);
|
||||
|
||||
if (count($parameters) === count($signature) && $parameters === $signature) {
|
||||
$phpcsFile->addWarning('Useless method overriding detected', $stackPtr, 'Found');
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,90 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Commenting_TodoSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Commenting_TodoSniff.
|
||||
*
|
||||
* Warns about TODO comments.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Commenting_TodoSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array(
|
||||
'PHP',
|
||||
'JS',
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return PHP_CodeSniffer_Tokens::$commentTokens;
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, 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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$content = $tokens[$stackPtr]['content'];
|
||||
$matches = Array();
|
||||
if (preg_match('|[^a-z]+todo[^a-z]+(.*)|i', $content, $matches) !== 0) {
|
||||
// Clear whitespace and some common characters not required at
|
||||
// the end of a to-do message to make the warning more informative.
|
||||
$type = 'CommentFound';
|
||||
$todoMessage = trim($matches[1]);
|
||||
$todoMessage = trim($todoMessage, '[]().');
|
||||
$error = 'Comment refers to a TODO task';
|
||||
$data = array($todoMessage);
|
||||
if ($todoMessage !== '') {
|
||||
$type = 'TaskFound';
|
||||
$error .= ' "%s"';
|
||||
}
|
||||
|
||||
$phpcsFile->addWarning($error, $stackPtr, $type, $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,120 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_ControlStructures_InlineControlStructureSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_ControlStructures_InlineControlStructureSniff.
|
||||
*
|
||||
* Verifies that inline control statements are not present.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_ControlStructures_InlineControlStructureSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array(
|
||||
'PHP',
|
||||
'JS',
|
||||
);
|
||||
|
||||
/**
|
||||
* If true, an error will be thrown; otherwise a warning.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
public $error = true;
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(
|
||||
T_IF,
|
||||
T_ELSE,
|
||||
T_FOREACH,
|
||||
T_WHILE,
|
||||
T_DO,
|
||||
T_SWITCH,
|
||||
T_FOR,
|
||||
);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
if (isset($tokens[$stackPtr]['scope_opener']) === false) {
|
||||
// Ignore the ELSE in ELSE IF. We'll process the IF part later.
|
||||
if (($tokens[$stackPtr]['code'] === T_ELSE) && ($tokens[($stackPtr + 2)]['code'] === T_IF)) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($tokens[$stackPtr]['code'] === T_WHILE) {
|
||||
// This could be from a DO WHILE, which doesn't have an opening brace.
|
||||
$lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
|
||||
if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) {
|
||||
$brace = $tokens[$lastContent];
|
||||
if (isset($brace['scope_condition']) === true) {
|
||||
$condition = $tokens[$brace['scope_condition']];
|
||||
if ($condition['code'] === T_DO) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// This is a control structure without an opening brace,
|
||||
// so it is an inline statement.
|
||||
if ($this->error === true) {
|
||||
$phpcsFile->addError('Inline control structures are not allowed', $stackPtr, 'NotAllowed');
|
||||
} else {
|
||||
$phpcsFile->addWarning('Inline control structures are discouraged', $stackPtr, 'Discouraged');
|
||||
}
|
||||
|
||||
return;
|
||||
}//end if
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,139 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Debug_ClosureLinterSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Debug_ClosureLinterSniff.
|
||||
*
|
||||
* Runs gjslint on the file.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Debug_ClosureLinterSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of error codes that should show errors.
|
||||
*
|
||||
* All other error codes will show warnings.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $errorCodes = array();
|
||||
|
||||
/**
|
||||
* A list of error codes to ignore.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $ignoreCodes = array();
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array('JS');
|
||||
|
||||
|
||||
/**
|
||||
* Returns the token types that this sniff is interested in.
|
||||
*
|
||||
* @return array(int)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_OPEN_TAG);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the tokens that this sniff is interested in.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
|
||||
* @param int $stackPtr The position in the stack where
|
||||
* the token was found.
|
||||
*
|
||||
* @return void
|
||||
* @throws PHP_CodeSniffer_Exception If jslint.js could not be run
|
||||
*/
|
||||
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
$fileName = $phpcsFile->getFilename();
|
||||
|
||||
$lintPath = PHP_CodeSniffer::getConfigData('gjslint_path');
|
||||
if ($lintPath === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
$cmd = "$lintPath --nosummary --notime --unix_mode \"$fileName\"";
|
||||
$msg = exec($cmd, $output, $retval);
|
||||
|
||||
if (is_array($output) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
foreach ($output as $finding) {
|
||||
$matches = array();
|
||||
$numMatches = preg_match('/^(.*):([0-9]+):\(([0-9]+)\)(.*)$/', $finding, $matches);
|
||||
if ($numMatches === 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Skip error codes we are ignoring.
|
||||
$code = $matches[3];
|
||||
if (in_array($code, $this->ignoreCodes) === true) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$line = (int) $matches[2];
|
||||
$error = trim($matches[4]);
|
||||
|
||||
// Find the token at the start of the line.
|
||||
$lineToken = null;
|
||||
foreach ($tokens as $ptr => $info) {
|
||||
if ($info['line'] === $line) {
|
||||
$lineToken = $ptr;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if ($lineToken !== null) {
|
||||
$message = 'gjslint says: (%s) %s';
|
||||
$data = array(
|
||||
$code,
|
||||
$error,
|
||||
);
|
||||
if (in_array($code, $this->errorCodes) === true) {
|
||||
$phpcsFile->addError($message, $lineToken, 'ExternalToolError', $data);
|
||||
} else {
|
||||
$phpcsFile->addWarning($message, $lineToken, 'ExternalTool', $data);
|
||||
}
|
||||
}
|
||||
}//end foreach
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,109 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Debug_JSHintSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Alexander Wei<65> <aweisswa@gmx.de>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Debug_JSHintSniff.
|
||||
*
|
||||
* Runs jshint.js on the file.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Alexander Wei<65> <aweisswa@gmx.de>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Debug_JSHintSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array('JS');
|
||||
|
||||
|
||||
/**
|
||||
* Returns the token types that this sniff is interested in.
|
||||
*
|
||||
* @return array(int)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_OPEN_TAG);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the tokens that this sniff is interested in.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
|
||||
* @param int $stackPtr The position in the stack where
|
||||
* the token was found.
|
||||
*
|
||||
* @return void
|
||||
* @throws PHP_CodeSniffer_Exception If jshint.js could not be run
|
||||
*/
|
||||
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
$fileName = $phpcsFile->getFilename();
|
||||
|
||||
$rhinoPath = PHP_CodeSniffer::getConfigData('rhino_path');
|
||||
$jshintPath = PHP_CodeSniffer::getConfigData('jshint_path');
|
||||
if ($rhinoPath === null || $jshintPath === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
$cmd = "$rhinoPath \"$jshintPath\" \"$fileName\"";
|
||||
$msg = exec($cmd, $output, $retval);
|
||||
|
||||
if (is_array($output) === true) {
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
foreach ($output as $finding) {
|
||||
$matches = array();
|
||||
$numMatches = preg_match('/^(.+)\(.+:([0-9]+).*:[0-9]+\)$/', $finding, $matches);
|
||||
if ($numMatches === 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$line = (int) $matches[2];
|
||||
$message = 'jshint says: '.trim($matches[1]);
|
||||
|
||||
// Find the token at the start of the line.
|
||||
$lineToken = null;
|
||||
foreach ($tokens as $ptr => $info) {
|
||||
if ($info['line'] === $line) {
|
||||
$lineToken = $ptr;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if ($lineToken !== null) {
|
||||
$phpcsFile->addWarning($message, $lineToken, 'ExternalTool');
|
||||
}
|
||||
}//end foreach
|
||||
}//end if
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,93 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Files_ByteOrderMarkSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Files_ByteOrderMarkSniff.
|
||||
*
|
||||
* A simple sniff for detecting BOMs that may corrupt application work.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Piotr Karas <office@mediaself.pl>
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2010-2011 mediaSELF Sp. z o.o.
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
* @see http://en.wikipedia.org/wiki/Byte_order_mark
|
||||
*/
|
||||
class Generic_Sniffs_Files_ByteOrderMarkSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* List of supported BOM definitions.
|
||||
*
|
||||
* Use encoding names as keys and hex BOM representations as values.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $bomDefinitions = array(
|
||||
'UTF-8' => 'efbbbf',
|
||||
'UTF-16 (BE)' => 'feff',
|
||||
'UTF-16 (LE)' => 'fffe',
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
* 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 sniff, 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 )
|
||||
{
|
||||
// The BOM will be the very first token in the file.
|
||||
if ($stackPtr !== 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
foreach ($this->bomDefinitions as $bomName => $expectedBomHex) {
|
||||
$bomByteLength = (strlen($expectedBomHex) / 2);
|
||||
$htmlBomHex = bin2hex(substr($tokens[$stackPtr]['content'], 0, $bomByteLength));
|
||||
if ($htmlBomHex === $expectedBomHex) {
|
||||
$errorData = array($bomName);
|
||||
$error = 'File contains %s byte order mark, which may corrupt your application';
|
||||
$phpcsFile->addError($error, $stackPtr, 'Found', $errorData);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,103 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Files_LineEndingsSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Files_LineEndingsSniff.
|
||||
*
|
||||
* Checks that end of line characters are correct.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Files_LineEndingsSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array(
|
||||
'PHP',
|
||||
'JS',
|
||||
'CSS',
|
||||
);
|
||||
|
||||
/**
|
||||
* The valid EOL character.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public $eolChar = '\n';
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_OPEN_TAG);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, 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)
|
||||
{
|
||||
// We are only interested if this is the first open tag.
|
||||
if ($stackPtr !== 0) {
|
||||
if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
$found = $phpcsFile->eolChar;
|
||||
$found = str_replace("\n", '\n', $found);
|
||||
$found = str_replace("\r", '\r', $found);
|
||||
|
||||
if ($found !== $this->eolChar) {
|
||||
$error = 'End of line character is invalid; expected "%s" but found "%s"';
|
||||
$expected = $this->eolChar;
|
||||
$expected = str_replace("\n", '\n', $expected);
|
||||
$expected = str_replace("\r", '\r', $expected);
|
||||
$data = array(
|
||||
$expected,
|
||||
$found,
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'InvalidEOLChar', $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,161 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Files_LineLengthSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Files_LineLengthSniff.
|
||||
*
|
||||
* Checks all lines in the file, and throws warnings if they are over 80
|
||||
* characters in length and errors if they are over 100. Both these
|
||||
* figures can be changed by extending this sniff in your own standard.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Files_LineLengthSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* The limit that the length of a line should not exceed.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $lineLimit = 80;
|
||||
|
||||
/**
|
||||
* The limit that the length of a line must not exceed.
|
||||
*
|
||||
* Set to zero (0) to disable.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $absoluteLineLimit = 100;
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_OPEN_TAG);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Make sure this is the first open tag.
|
||||
$previousOpenTag = $phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1));
|
||||
if ($previousOpenTag !== false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$tokenCount = 0;
|
||||
$currentLineContent = '';
|
||||
$currentLine = 1;
|
||||
|
||||
$trim = (strlen($phpcsFile->eolChar) * -1);
|
||||
for (; $tokenCount < $phpcsFile->numTokens; $tokenCount++) {
|
||||
if ($tokens[$tokenCount]['line'] === $currentLine) {
|
||||
$currentLineContent .= $tokens[$tokenCount]['content'];
|
||||
} else {
|
||||
$currentLineContent = substr($currentLineContent, 0, $trim);
|
||||
$this->checkLineLength($phpcsFile, ($tokenCount - 1), $currentLineContent);
|
||||
$currentLineContent = $tokens[$tokenCount]['content'];
|
||||
$currentLine++;
|
||||
}
|
||||
}
|
||||
|
||||
$currentLineContent = substr($currentLineContent, 0, $trim);
|
||||
$this->checkLineLength($phpcsFile, ($tokenCount - 1), $currentLineContent);
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
/**
|
||||
* Checks if a line is too long.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
||||
* @param int $stackPtr The token at the end of the line.
|
||||
* @param string $lineContent The content of the line.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function checkLineLength(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $lineContent)
|
||||
{
|
||||
// If the content is a CVS or SVN id in a version tag, or it is
|
||||
// a license tag with a name and URL, there is nothing the
|
||||
// developer can do to shorten the line, so don't throw errors.
|
||||
if (preg_match('|@version[^\$]+\$Id|', $lineContent) !== 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (preg_match('|@license|', $lineContent) !== 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (PHP_CODESNIFFER_ENCODING !== 'iso-8859-1') {
|
||||
// Not using the detault encoding, so take a bit more care.
|
||||
$lineLength = iconv_strlen($lineContent, PHP_CODESNIFFER_ENCODING);
|
||||
if ($lineLength === false) {
|
||||
// String contained invalid characters, so revert to default.
|
||||
$lineLength = strlen($lineContent);
|
||||
}
|
||||
} else {
|
||||
$lineLength = strlen($lineContent);
|
||||
}
|
||||
|
||||
if ($this->absoluteLineLimit > 0
|
||||
&& $lineLength > $this->absoluteLineLimit
|
||||
) {
|
||||
$data = array(
|
||||
$this->absoluteLineLimit,
|
||||
$lineLength,
|
||||
);
|
||||
|
||||
$error = 'Line exceeds maximum limit of %s characters; contains %s characters';
|
||||
$phpcsFile->addError($error, $stackPtr, 'MaxExceeded', $data);
|
||||
} else if ($lineLength > $this->lineLimit) {
|
||||
$data = array(
|
||||
$this->lineLimit,
|
||||
$lineLength,
|
||||
);
|
||||
|
||||
$warning = 'Line exceeds %s characters; contains %s characters';
|
||||
$phpcsFile->addWarning($warning, $stackPtr, 'TooLong', $data);
|
||||
}
|
||||
}//end checkLineLength()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
@@ -0,0 +1,88 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Formatting_DisallowMultipleStatementsSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Formatting_DisallowMultipleStatementsSniff.
|
||||
*
|
||||
* Ensures each statement is on a line by itself.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Formatting_DisallowMultipleStatementsSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_SEMICOLON);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$prev = $phpcsFile->findPrevious(T_SEMICOLON, ($stackPtr - 1));
|
||||
if ($prev === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Ignore multiple statements in a FOR condition.
|
||||
if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
|
||||
foreach ($tokens[$stackPtr]['nested_parenthesis'] as $bracket) {
|
||||
if (isset($tokens[$bracket]['parenthesis_owner']) === false) {
|
||||
// Probably a closure sitting inside a function call.
|
||||
continue;
|
||||
}
|
||||
|
||||
$owner = $tokens[$bracket]['parenthesis_owner'];
|
||||
if ($tokens[$owner]['code'] === T_FOR) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
|
||||
$error = 'Each PHP statement must be on a line by itself';
|
||||
$phpcsFile->addError($error, $stackPtr, 'SameLine');
|
||||
return;
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,304 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Formatting_MultipleStatementAlignmentSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Formatting_MultipleStatementAlignmentSniff.
|
||||
*
|
||||
* Checks alignment of assignments. If there are multiple adjacent assignments,
|
||||
* it will check that the equals signs of each assignment are aligned. It will
|
||||
* display a warning to advise that the signs should be aligned.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Formatting_MultipleStatementAlignmentSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array(
|
||||
'PHP',
|
||||
'JS',
|
||||
);
|
||||
|
||||
/**
|
||||
* If true, an error will be thrown; otherwise a warning.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
public $error = false;
|
||||
|
||||
/**
|
||||
* The maximum amount of padding before the alignment is ignored.
|
||||
*
|
||||
* If the amount of padding required to align this assignment with the
|
||||
* surrounding assignments exceeds this number, the assignment will be
|
||||
* ignored and no errors or warnings will be thrown.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $maxPadding = 1000;
|
||||
|
||||
/**
|
||||
* If true, multi-line assignments are not checked.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $ignoreMultiLine = false;
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return PHP_CodeSniffer_Tokens::$assignmentTokens;
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Ignore assignments used in a condition, like an IF or FOR.
|
||||
if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
|
||||
foreach ($tokens[$stackPtr]['nested_parenthesis'] as $start => $end) {
|
||||
if (isset($tokens[$start]['parenthesis_owner']) === true) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
By this stage, it is known that there is an assignment on this line.
|
||||
We only want to process the block once we reach the last assignment,
|
||||
so we need to determine if there are more to follow.
|
||||
*/
|
||||
|
||||
// The assignment may span over multiple lines, so look for the
|
||||
// end of the assignment so we can check assignment blocks correctly.
|
||||
$lineEnd = $phpcsFile->findNext(T_SEMICOLON, ($stackPtr + 1));
|
||||
|
||||
$nextAssign = $phpcsFile->findNext(
|
||||
PHP_CodeSniffer_Tokens::$assignmentTokens,
|
||||
($lineEnd + 1)
|
||||
);
|
||||
|
||||
if ($nextAssign !== false) {
|
||||
$isAssign = true;
|
||||
if ($tokens[$nextAssign]['line'] === ($tokens[$lineEnd]['line'] + 1)) {
|
||||
// Assignment may be in the same block as this one. Just make sure
|
||||
// it is not used in a condition, like an IF or FOR.
|
||||
if (isset($tokens[$nextAssign]['nested_parenthesis']) === true) {
|
||||
foreach ($tokens[$nextAssign]['nested_parenthesis'] as $start => $end) {
|
||||
if (isset($tokens[$start]['parenthesis_owner']) === true) {
|
||||
// Not an assignment.
|
||||
$isAssign = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if ($isAssign === true) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Getting here means that this is the last in a block of statements.
|
||||
$assignments = array();
|
||||
$assignments[] = $stackPtr;
|
||||
$prevAssignment = $stackPtr;
|
||||
$lastLine = $tokens[$stackPtr]['line'];
|
||||
|
||||
while (($prevAssignment = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$assignmentTokens, ($prevAssignment - 1))) !== false) {
|
||||
|
||||
// We are not interested in double arrows as they assign values inside
|
||||
// arrays and loops and do not use the same indentation rules.
|
||||
if ($tokens[$prevAssignment]['code'] === T_DOUBLE_ARROW) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// The assignment's end token must be on the line directly
|
||||
// above the current one to be in the same assignment block.
|
||||
$lineEnd = $phpcsFile->findNext(T_SEMICOLON, ($prevAssignment + 1));
|
||||
|
||||
// And the end token must actually belong to this assignment.
|
||||
$nextOpener = $phpcsFile->findNext(
|
||||
PHP_CodeSniffer_Tokens::$scopeOpeners,
|
||||
($prevAssignment + 1)
|
||||
);
|
||||
|
||||
if ($nextOpener !== false && $nextOpener < $lineEnd) {
|
||||
break;
|
||||
}
|
||||
|
||||
if ($tokens[$lineEnd]['line'] !== ($lastLine - 1)) {
|
||||
break;
|
||||
}
|
||||
|
||||
// Make sure it is not assigned inside a condition (eg. IF, FOR).
|
||||
if (isset($tokens[$prevAssignment]['nested_parenthesis']) === true) {
|
||||
foreach ($tokens[$prevAssignment]['nested_parenthesis'] as $start => $end) {
|
||||
if (isset($tokens[$start]['parenthesis_owner']) === true) {
|
||||
break(2);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$assignments[] = $prevAssignment;
|
||||
$lastLine = $tokens[$prevAssignment]['line'];
|
||||
}//end while
|
||||
|
||||
$assignmentData = array();
|
||||
$maxAssignmentLength = 0;
|
||||
$maxVariableLength = 0;
|
||||
|
||||
foreach ($assignments as $assignment) {
|
||||
$prev = $phpcsFile->findPrevious(
|
||||
PHP_CodeSniffer_Tokens::$emptyTokens,
|
||||
($assignment - 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
$endColumn = $tokens[($prev + 1)]['column'];
|
||||
|
||||
if ($maxVariableLength < $endColumn) {
|
||||
$maxVariableLength = $endColumn;
|
||||
}
|
||||
|
||||
if ($maxAssignmentLength < strlen($tokens[$assignment]['content'])) {
|
||||
$maxAssignmentLength = strlen($tokens[$assignment]['content']);
|
||||
}
|
||||
|
||||
$assignmentData[$assignment]
|
||||
= array(
|
||||
'variable_length' => $endColumn,
|
||||
'assignment_length' => strlen($tokens[$assignment]['content']),
|
||||
);
|
||||
}//end foreach
|
||||
|
||||
foreach ($assignmentData as $assignment => $data) {
|
||||
if ($data['assignment_length'] === $maxAssignmentLength) {
|
||||
if ($data['variable_length'] === $maxVariableLength) {
|
||||
// The assignment is the longest possible, so the column that
|
||||
// everything has to align to is based on it.
|
||||
$column = ($maxVariableLength + 1);
|
||||
break;
|
||||
} else {
|
||||
// The assignment token is the longest out of all of the
|
||||
// assignments, but the variable name is not, so the column
|
||||
// the start at can go back more to cover the space
|
||||
// between the variable name and the assigment operator.
|
||||
$column = ($maxVariableLength - ($maxAssignmentLength - 1) + 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Determine the actual position that each equals sign should be in.
|
||||
foreach ($assignments as $assignment) {
|
||||
// Actual column takes into account the length of the assignment operator.
|
||||
$actualColumn = ($column + $maxAssignmentLength - strlen($tokens[$assignment]['content']));
|
||||
if ($tokens[$assignment]['column'] !== $actualColumn) {
|
||||
$prev = $phpcsFile->findPrevious(
|
||||
PHP_CodeSniffer_Tokens::$emptyTokens,
|
||||
($assignment - 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
$expected = ($actualColumn - $tokens[($prev + 1)]['column']);
|
||||
|
||||
if ($tokens[$assignment]['line'] !== $tokens[$prev]['line']) {
|
||||
// Instead of working out how many spaces there are
|
||||
// across new lines, the error message becomes more
|
||||
// generic below.
|
||||
$found = null;
|
||||
} else {
|
||||
$found = ($tokens[$assignment]['column'] - $tokens[($prev + 1)]['column']);
|
||||
}
|
||||
|
||||
// If the expected number of spaces for alignment exceeds the
|
||||
// maxPadding rule, we just check for a single space as no
|
||||
// alignment is required.
|
||||
if ($expected > $this->maxPadding) {
|
||||
if ($found === 1) {
|
||||
continue;
|
||||
} else {
|
||||
$expected = 1;
|
||||
}
|
||||
}
|
||||
|
||||
// Skip multi-line assignments if required.
|
||||
if ($found === null && $this->ignoreMultiLine === true) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$expected .= ($expected === 1) ? ' space' : ' spaces';
|
||||
if ($found === null) {
|
||||
$found = 'a new line';
|
||||
} else {
|
||||
$found .= ($found === 1) ? ' space' : ' spaces';
|
||||
}
|
||||
|
||||
if (count($assignments) === 1) {
|
||||
$type = 'Incorrect';
|
||||
$error = 'Equals sign not aligned correctly; expected %s but found %s';
|
||||
} else {
|
||||
$type = 'NotSame';
|
||||
$error = 'Equals sign not aligned with surrounding assignments; expected %s but found %s';
|
||||
}
|
||||
|
||||
$errorData = array(
|
||||
$expected,
|
||||
$found,
|
||||
);
|
||||
|
||||
if ($this->error === true) {
|
||||
$phpcsFile->addError($error, $assignment, $type, $errorData);
|
||||
} else {
|
||||
$phpcsFile->addWarning($error, $assignment, $type.'Warning', $errorData);
|
||||
}
|
||||
}//end if
|
||||
}//end foreach
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,69 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Formatting_NoSpaceAfterCastSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Formatting_NoSpaceAfterCastSniff.
|
||||
*
|
||||
* Ensures there is no space after cast tokens.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Formatting_NoSpaceAfterCastSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return PHP_CodeSniffer_Tokens::$castTokens;
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) {
|
||||
$error = 'A cast statement must not be followed by a space';
|
||||
$phpcsFile->addError($error, $stackPtr, 'SpaceFound');
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,75 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Formatting_SpaceAfterCastSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Formatting_SpaceAfterCastSniff.
|
||||
*
|
||||
* Ensures there is a single space after cast tokens.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Formatting_SpaceAfterCastSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return PHP_CodeSniffer_Tokens::$castTokens;
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) {
|
||||
$error = 'A cast statement must be followed by a single space';
|
||||
$phpcsFile->addError($error, $stackPtr, 'NoSpace');
|
||||
return;
|
||||
}
|
||||
|
||||
if ($tokens[($stackPtr + 1)]['content'] !== ' ') {
|
||||
$error = 'A cast statement must be followed by a single space';
|
||||
$phpcsFile->addError($error, $stackPtr, 'TooMuchSpace');
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,148 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Functions_CallTimePassByReferenceSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Florian Grandel <jerico.dev@gmail.com>
|
||||
* @copyright 2009 Florian Grandel
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Functions_CallTimePassByReferenceSniff.
|
||||
*
|
||||
* Ensures that variables are not passed by reference when calling a function.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Florian Grandel <jerico.dev@gmail.com>
|
||||
* @copyright 2009 Florian Grandel
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Functions_CallTimePassByReferenceSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_STRING);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Skip tokens that are the names of functions or classes
|
||||
// within their definitions. For example: function myFunction...
|
||||
// "myFunction" is T_STRING but we should skip because it is not a
|
||||
// function or method *call*.
|
||||
$functionName = $stackPtr;
|
||||
$findTokens = array_merge(
|
||||
PHP_CodeSniffer_Tokens::$emptyTokens,
|
||||
array(T_BITWISE_AND)
|
||||
);
|
||||
|
||||
$functionKeyword = $phpcsFile->findPrevious(
|
||||
$findTokens,
|
||||
($stackPtr - 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
if ($tokens[$functionKeyword]['code'] === T_FUNCTION
|
||||
|| $tokens[$functionKeyword]['code'] === T_CLASS
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
// If the next non-whitespace token after the function or method call
|
||||
// is not an opening parenthesis then it cant really be a *call*.
|
||||
$openBracket = $phpcsFile->findNext(
|
||||
PHP_CodeSniffer_Tokens::$emptyTokens,
|
||||
($functionName + 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
|
||||
return;
|
||||
}
|
||||
|
||||
$closeBracket = $tokens[$openBracket]['parenthesis_closer'];
|
||||
|
||||
$nextSeparator = $openBracket;
|
||||
while (($nextSeparator = $phpcsFile->findNext(T_VARIABLE, ($nextSeparator + 1), $closeBracket)) !== false) {
|
||||
// Make sure the variable belongs directly to this function call
|
||||
// and is not inside a nested function call or array.
|
||||
$brackets = $tokens[$nextSeparator]['nested_parenthesis'];
|
||||
$lastBracket = array_pop($brackets);
|
||||
if ($lastBracket !== $closeBracket) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Checking this: $value = my_function(...[*]$arg...).
|
||||
$tokenBefore = $phpcsFile->findPrevious(
|
||||
PHP_CodeSniffer_Tokens::$emptyTokens,
|
||||
($nextSeparator - 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
if ($tokens[$tokenBefore]['code'] === T_BITWISE_AND) {
|
||||
// Checking this: $value = my_function(...[*]&$arg...).
|
||||
$tokenBefore = $phpcsFile->findPrevious(
|
||||
PHP_CodeSniffer_Tokens::$emptyTokens,
|
||||
($tokenBefore - 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
// We have to exclude all uses of T_BITWISE_AND that are not
|
||||
// references. We use a blacklist approach as we prefer false
|
||||
// positives to not identifiying a pass-by-reference call at all.
|
||||
// The blacklist may not yet be complete.
|
||||
switch ($tokens[$tokenBefore]['code']) {
|
||||
case T_VARIABLE:
|
||||
case T_CLOSE_PARENTHESIS:
|
||||
// In these cases T_BITWISE_AND represents
|
||||
// the bitwise and operator.
|
||||
continue;
|
||||
break;
|
||||
|
||||
default:
|
||||
// T_BITWISE_AND represents a pass-by-reference.
|
||||
$error = 'Call-time pass-by-reference calls are prohibited';
|
||||
$phpcsFile->addError($error, $tokenBefore, 'NotAllowed');
|
||||
break;
|
||||
}
|
||||
}//end if
|
||||
}//end while
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,136 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Functions_FunctionCallArgumentSpacingSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Functions_FunctionCallArgumentSpacingSniff.
|
||||
*
|
||||
* Checks that calls to methods and functions are spaced correctly.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Functions_FunctionCallArgumentSpacingSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_STRING);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Skip tokens that are the names of functions or classes
|
||||
// within their definitions. For example:
|
||||
// function myFunction...
|
||||
// "myFunction" is T_STRING but we should skip because it is not a
|
||||
// function or method *call*.
|
||||
$functionName = $stackPtr;
|
||||
$ignoreTokens = PHP_CodeSniffer_Tokens::$emptyTokens;
|
||||
$ignoreTokens[] = T_BITWISE_AND;
|
||||
$functionKeyword = $phpcsFile->findPrevious($ignoreTokens, ($stackPtr - 1), null, true);
|
||||
if ($tokens[$functionKeyword]['code'] === T_FUNCTION || $tokens[$functionKeyword]['code'] === T_CLASS) {
|
||||
return;
|
||||
}
|
||||
|
||||
// If the next non-whitespace token after the function or method call
|
||||
// is not an opening parenthesis then it cant really be a *call*.
|
||||
$openBracket = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($functionName + 1), null, true);
|
||||
if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
|
||||
return;
|
||||
}
|
||||
|
||||
$closeBracket = $tokens[$openBracket]['parenthesis_closer'];
|
||||
|
||||
$nextSeperator = $openBracket;
|
||||
while (($nextSeperator = $phpcsFile->findNext(array(T_COMMA, T_VARIABLE), ($nextSeperator + 1), $closeBracket)) !== false) {
|
||||
// Make sure the comma or variable belongs directly to this function call,
|
||||
// and is not inside a nested function call or array.
|
||||
$brackets = $tokens[$nextSeperator]['nested_parenthesis'];
|
||||
$lastBracket = array_pop($brackets);
|
||||
if ($lastBracket !== $closeBracket) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($tokens[$nextSeperator]['code'] === T_COMMA) {
|
||||
if ($tokens[($nextSeperator - 1)]['code'] === T_WHITESPACE) {
|
||||
$error = 'Space found before comma in function call';
|
||||
$phpcsFile->addError($error, $stackPtr, 'SpaceBeforeComma');
|
||||
}
|
||||
|
||||
if ($tokens[($nextSeperator + 1)]['code'] !== T_WHITESPACE) {
|
||||
$error = 'No space found after comma in function call';
|
||||
$phpcsFile->addError($error, $stackPtr, 'NoSpaceAfterComma');
|
||||
} else {
|
||||
// If there is a newline in the space, then the must be formatting
|
||||
// each argument on a newline, which is valid, so ignore it.
|
||||
if (strpos($tokens[($nextSeperator + 1)]['content'], $phpcsFile->eolChar) === false) {
|
||||
$space = strlen($tokens[($nextSeperator + 1)]['content']);
|
||||
if ($space > 1) {
|
||||
$error = 'Expected 1 space after comma in function call; %s found';
|
||||
$data = array($space);
|
||||
$phpcsFile->addError($error, $stackPtr, 'TooMuchSpaceAfterComma', $data);
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Token is a variable.
|
||||
$nextToken = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($nextSeperator + 1), $closeBracket, true);
|
||||
if ($nextToken !== false) {
|
||||
if ($tokens[$nextToken]['code'] === T_EQUAL) {
|
||||
if (($tokens[($nextToken - 1)]['code']) !== T_WHITESPACE) {
|
||||
$error = 'Expected 1 space before = sign of default value';
|
||||
$phpcsFile->addError($error, $stackPtr, 'NoSpaceBeforeEquals');
|
||||
}
|
||||
|
||||
if ($tokens[($nextToken + 1)]['code'] !== T_WHITESPACE) {
|
||||
$error = 'Expected 1 space after = sign of default value';
|
||||
$phpcsFile->addError($error, $stackPtr, 'NoSpaceAfterEquals');
|
||||
}
|
||||
}
|
||||
}
|
||||
}//end if
|
||||
}//end while
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,121 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Methods_OpeningMethodBraceBsdAllmanSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff.
|
||||
*
|
||||
* Checks that the opening brace of a function is on the line after the
|
||||
* function declaration.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Registers the tokens that this sniff wants to listen for.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_FUNCTION);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
if (isset($tokens[$stackPtr]['scope_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$openingBrace = $tokens[$stackPtr]['scope_opener'];
|
||||
|
||||
// The end of the function occurs at the end of the argument list. Its
|
||||
// like this because some people like to break long function declarations
|
||||
// over multiple lines.
|
||||
$functionLine = $tokens[$tokens[$stackPtr]['parenthesis_closer']]['line'];
|
||||
$braceLine = $tokens[$openingBrace]['line'];
|
||||
|
||||
$lineDifference = ($braceLine - $functionLine);
|
||||
|
||||
if ($lineDifference === 0) {
|
||||
$error = 'Opening brace should be on a new line';
|
||||
$phpcsFile->addError($error, $openingBrace, 'BraceOnSameLine');
|
||||
return;
|
||||
}
|
||||
|
||||
if ($lineDifference > 1) {
|
||||
$error = 'Opening brace should be on the line after the declaration; found %s blank line(s)';
|
||||
$data = array(($lineDifference - 1));
|
||||
$phpcsFile->addError($error, $openingBrace, 'BraceSpacing', $data);
|
||||
return;
|
||||
}
|
||||
|
||||
// We need to actually find the first piece of content on this line,
|
||||
// as 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;
|
||||
while (($lineStart = $phpcsFile->findPrevious(array(T_WHITESPACE), ($lineStart - 1), null, false)) !== false) {
|
||||
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, null, true);
|
||||
|
||||
// The opening brace is on the correct line, now it needs to be
|
||||
// checked to be correctly indented.
|
||||
$startColumn = $tokens[$lineStart]['column'];
|
||||
$braceIndent = $tokens[$openingBrace]['column'];
|
||||
|
||||
if ($braceIndent !== $startColumn) {
|
||||
$error = 'Opening brace indented incorrectly; expected %s spaces, found %s';
|
||||
$data = array(
|
||||
($startColumn - 1),
|
||||
($braceIndent - 1),
|
||||
);
|
||||
$phpcsFile->addError($error, $openingBrace, 'BraceIndent', $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,109 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff.
|
||||
*
|
||||
* Checks that the opening brace of a function is on the same line
|
||||
* as the function declaration.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Registers the tokens that this sniff wants to listen for.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_FUNCTION);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
if (isset($tokens[$stackPtr]['scope_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$openingBrace = $tokens[$stackPtr]['scope_opener'];
|
||||
|
||||
// The end of the function occurs at the end of the argument list. Its
|
||||
// like this because some people like to break long function declarations
|
||||
// over multiple lines.
|
||||
$functionLine = $tokens[$tokens[$stackPtr]['parenthesis_closer']]['line'];
|
||||
$braceLine = $tokens[$openingBrace]['line'];
|
||||
|
||||
$lineDifference = ($braceLine - $functionLine);
|
||||
|
||||
if ($lineDifference > 0) {
|
||||
$error = 'Opening brace should be on the same line as the declaration';
|
||||
$phpcsFile->addError($error, $openingBrace, 'BraceOnNewLine');
|
||||
return;
|
||||
}
|
||||
|
||||
// Checks that the closing parenthesis and the opening brace are
|
||||
// separated by a whitespace character.
|
||||
$closerColumn = $tokens[$tokens[$stackPtr]['parenthesis_closer']]['column'];
|
||||
$braceColumn = $tokens[$openingBrace]['column'];
|
||||
|
||||
$columnDifference = ($braceColumn - $closerColumn);
|
||||
|
||||
if ($columnDifference !== 2) {
|
||||
$error = 'Expected 1 space between the closing parenthesis and the opening brace; found %s';
|
||||
$data = array(($columnDifference - 1));
|
||||
$phpcsFile->addError($error, $openingBrace, 'SpaceBeforeBrace', $data);
|
||||
return;
|
||||
}
|
||||
|
||||
// Check that a tab was not used instead of a space.
|
||||
$spaceTokenPtr = ($tokens[$stackPtr]['parenthesis_closer'] + 1);
|
||||
$spaceContent = $tokens[$spaceTokenPtr]['content'];
|
||||
if ($spaceContent !== ' ') {
|
||||
$error = 'Expected a single space character between closing parenthesis and opening brace; found %s';
|
||||
$data = array($spaceContent);
|
||||
$phpcsFile->addError($error, $openingBrace, 'SpaceBeforeBrace', $data);
|
||||
return;
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,131 @@
|
||||
<?php
|
||||
/**
|
||||
* Checks the cyclomatic complexity (McCabe) for functions.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Checks the cyclomatic complexity (McCabe) for functions.
|
||||
*
|
||||
* The cyclomatic complexity (also called McCabe code metrics)
|
||||
* indicates the complexity within a function by counting
|
||||
* the different paths the function includes.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Johann-Peter Hartmann <hartmann@mayflower.de>
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2007 Mayflower GmbH
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Metrics_CyclomaticComplexitySniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A complexity higher than this value will throw a warning.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $complexity = 10;
|
||||
|
||||
/**
|
||||
* A complexity higer than this value will throw an error.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $absoluteComplexity = 20;
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_FUNCTION);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$this->currentFile = $phpcsFile;
|
||||
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Ignore abstract methods.
|
||||
if (isset($tokens[$stackPtr]['scope_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Detect start and end of this function definition.
|
||||
$start = $tokens[$stackPtr]['scope_opener'];
|
||||
$end = $tokens[$stackPtr]['scope_closer'];
|
||||
|
||||
// Predicate nodes for PHP.
|
||||
$find = array(
|
||||
'T_CASE',
|
||||
'T_DEFAULT',
|
||||
'T_CATCH',
|
||||
'T_IF',
|
||||
'T_FOR',
|
||||
'T_FOREACH',
|
||||
'T_WHILE',
|
||||
'T_DO',
|
||||
'T_ELSEIF',
|
||||
);
|
||||
|
||||
$complexity = 1;
|
||||
|
||||
// Iterate from start to end and count predicate nodes.
|
||||
for ($i = ($start + 1); $i < $end; $i++) {
|
||||
if (in_array($tokens[$i]['type'], $find) === true) {
|
||||
$complexity++;
|
||||
}
|
||||
}
|
||||
|
||||
if ($complexity > $this->absoluteComplexity) {
|
||||
$error = 'Function\'s cyclomatic complexity (%s) exceeds allowed maximum of %s';
|
||||
$data = array(
|
||||
$complexity,
|
||||
$this->absoluteComplexity,
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'MaxExceeded', $data);
|
||||
} else if ($complexity > $this->complexity) {
|
||||
$warning = 'Function\'s cyclomatic complexity (%s) exceeds %s; consider refactoring the function';
|
||||
$data = array(
|
||||
$complexity,
|
||||
$this->complexity,
|
||||
);
|
||||
$phpcsFile->addWarning($warning, $stackPtr, 'TooHigh', $data);
|
||||
}
|
||||
|
||||
return;
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,114 @@
|
||||
<?php
|
||||
/**
|
||||
* Checks the nesting level for methods.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Checks the nesting level for methods.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Johann-Peter Hartmann <hartmann@mayflower.de>
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2007 Mayflower GmbH
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Metrics_NestingLevelSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A nesting level than this value will throw a warning.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $nestingLevel = 5;
|
||||
|
||||
/**
|
||||
* A nesting level than this value will throw an error.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $absoluteNestingLevel = 10;
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_FUNCTION);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Ignore abstract methods.
|
||||
if (isset($tokens[$stackPtr]['scope_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Detect start and end of this function definition.
|
||||
$start = $tokens[$stackPtr]['scope_opener'];
|
||||
$end = $tokens[$stackPtr]['scope_closer'];
|
||||
|
||||
$nestingLevel = 0;
|
||||
|
||||
// Find the maximum nesting level of any token in the function.
|
||||
for ($i = ($start + 1); $i < $end; $i++) {
|
||||
$level = $tokens[$i]['level'];
|
||||
if ($nestingLevel < $level) {
|
||||
$nestingLevel = $level;
|
||||
}
|
||||
}
|
||||
|
||||
// We subtract the nesting level of the function itself.
|
||||
$nestingLevel = ($nestingLevel - $tokens[$stackPtr]['level'] - 1);
|
||||
|
||||
if ($nestingLevel > $this->absoluteNestingLevel) {
|
||||
$error = 'Function\'s nesting level (%s) exceeds allowed maximum of %s';
|
||||
$data = array(
|
||||
$nestingLevel,
|
||||
$this->absoluteNestingLevel,
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'MaxExceeded', $data);
|
||||
} else if ($nestingLevel > $this->nestingLevel) {
|
||||
$warning = 'Function\'s nesting level (%s) exceeds %s; consider refactoring the function';
|
||||
$data = array(
|
||||
$nestingLevel,
|
||||
$this->nestingLevel,
|
||||
);
|
||||
$phpcsFile->addWarning($warning, $stackPtr, 'TooHigh', $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,101 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_NamingConventions_ConstructorNameSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Leif Wickland <lwickland@rightnow.com>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) {
|
||||
$error = 'Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found';
|
||||
throw new PHP_CodeSniffer_Exception($error);
|
||||
}
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_NamingConventions_ConstructorNameSniff.
|
||||
*
|
||||
* Favor PHP 5 constructor syntax, which uses "function __construct()".
|
||||
* Avoid PHP 4 constructor syntax, which uses "function ClassName()".
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Leif Wickland <lwickland@rightnow.com>
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_NamingConventions_ConstructorNameSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Constructs the test with the tokens it wishes to listen for.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION), true);
|
||||
|
||||
}//end __construct()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this test when one of its tokens is encountered.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The current file being scanned.
|
||||
* @param int $stackPtr The position of the current token
|
||||
* in the stack passed in $tokens.
|
||||
* @param int $currScope A pointer to the start of the scope.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processTokenWithinScope(
|
||||
PHP_CodeSniffer_File $phpcsFile,
|
||||
$stackPtr,
|
||||
$currScope
|
||||
) {
|
||||
$className = $phpcsFile->getDeclarationName($currScope);
|
||||
$methodName = $phpcsFile->getDeclarationName($stackPtr);
|
||||
|
||||
if (strcasecmp($methodName, $className) === 0) {
|
||||
$error = 'PHP4 style constructors are not allowed; use "__construct()" instead';
|
||||
$phpcsFile->addError($error, $stackPtr, 'OldStyle');
|
||||
} else if (strcasecmp($methodName, '__construct') !== 0) {
|
||||
// Not a constructor.
|
||||
return;
|
||||
}
|
||||
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$parentClassName = $phpcsFile->findExtendedClassName($currScope);
|
||||
if ($parentClassName === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$endFunctionIndex = $tokens[$stackPtr]['scope_closer'];
|
||||
$startIndex = $stackPtr;
|
||||
while ($doubleColonIndex = $phpcsFile->findNext(array(T_DOUBLE_COLON), $startIndex, $endFunctionIndex)) {
|
||||
if ($tokens[($doubleColonIndex + 1)]['code'] === T_STRING
|
||||
&& $tokens[($doubleColonIndex + 1)]['content'] === $parentClassName
|
||||
) {
|
||||
$error = 'PHP4 style calls to parent constructors are not allowed; use "parent::__construct()" instead';
|
||||
$phpcsFile->addError($error, ($doubleColonIndex + 1), 'OldStyleCall');
|
||||
}
|
||||
|
||||
$startIndex = ($doubleColonIndex + 1);
|
||||
}
|
||||
|
||||
}//end processTokenWithinScope()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,198 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_NamingConventions_UpperCaseConstantNameSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_NamingConventions_UpperCaseConstantNameSniff.
|
||||
*
|
||||
* Ensures that constant names are all uppercase.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_NamingConventions_UpperCaseConstantNameSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_STRING);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$constName = $tokens[$stackPtr]['content'];
|
||||
|
||||
// If this token is in a heredoc, ignore it.
|
||||
if ($phpcsFile->hasCondition($stackPtr, T_START_HEREDOC) === true) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Special case for PHPUnit.
|
||||
if ($constName === 'PHPUnit_MAIN_METHOD') {
|
||||
return;
|
||||
}
|
||||
|
||||
// If the next non-whitespace token after this token
|
||||
// is not an opening parenthesis then it is not a function call.
|
||||
$openBracket = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
|
||||
if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
|
||||
$functionKeyword = $phpcsFile->findPrevious(array(T_WHITESPACE, T_COMMA, T_COMMENT, T_STRING, T_NS_SEPARATOR), ($stackPtr - 1), null, true);
|
||||
|
||||
$declarations = array(
|
||||
T_FUNCTION,
|
||||
T_CLASS,
|
||||
T_INTERFACE,
|
||||
T_IMPLEMENTS,
|
||||
T_EXTENDS,
|
||||
T_INSTANCEOF,
|
||||
T_NEW,
|
||||
T_NAMESPACE,
|
||||
T_USE,
|
||||
T_AS,
|
||||
);
|
||||
|
||||
if (in_array($tokens[$functionKeyword]['code'], $declarations) === true) {
|
||||
// This is just a declaration; no constants here.
|
||||
return;
|
||||
}
|
||||
|
||||
if ($tokens[$functionKeyword]['code'] === T_CONST) {
|
||||
// This is a class constant.
|
||||
if (strtoupper($constName) !== $constName) {
|
||||
$error = 'Class constants must be uppercase; expected %s but found %s';
|
||||
$data = array(
|
||||
strtoupper($constName),
|
||||
$constName,
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'ClassConstantNotUpperCase', $data);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// Is this a class name?
|
||||
$nextPtr = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
|
||||
if ($tokens[$nextPtr]['code'] === T_DOUBLE_COLON) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Is this a namespace name?
|
||||
if ($tokens[$nextPtr]['code'] === T_NS_SEPARATOR) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Is this a type hint?
|
||||
if ($tokens[$nextPtr]['code'] === T_VARIABLE
|
||||
|| $phpcsFile->isReference($nextPtr) === true
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Is this a member var name?
|
||||
$prevPtr = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
|
||||
if ($tokens[$prevPtr]['code'] === T_OBJECT_OPERATOR) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Is this a namespace name?
|
||||
if ($tokens[$prevPtr]['code'] === T_NS_SEPARATOR) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Is this an instance of declare()
|
||||
$prevPtr = $phpcsFile->findPrevious(array(T_WHITESPACE, T_OPEN_PARENTHESIS), ($stackPtr - 1), null, true);
|
||||
if ($tokens[$prevPtr]['code'] === T_DECLARE) {
|
||||
return;
|
||||
}
|
||||
|
||||
// This is a real constant.
|
||||
if (strtoupper($constName) !== $constName) {
|
||||
$error = 'Constants must be uppercase; expected %s but found %s';
|
||||
$data = array(
|
||||
strtoupper($constName),
|
||||
$constName,
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'ConstantNotUpperCase', $data);
|
||||
}
|
||||
|
||||
} else if (strtolower($constName) === 'define' || strtolower($constName) === 'constant') {
|
||||
|
||||
/*
|
||||
This may be a "define" or "constant" function call.
|
||||
*/
|
||||
|
||||
// Make sure this is not a method call.
|
||||
$prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
|
||||
if ($tokens[$prev]['code'] === T_OBJECT_OPERATOR
|
||||
|| $tokens[$prev]['code'] === T_DOUBLE_COLON
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
// The next non-whitespace token must be the constant name.
|
||||
$constPtr = $phpcsFile->findNext(T_WHITESPACE, ($openBracket + 1), null, true);
|
||||
if ($tokens[$constPtr]['code'] !== T_CONSTANT_ENCAPSED_STRING) {
|
||||
return;
|
||||
}
|
||||
|
||||
$constName = $tokens[$constPtr]['content'];
|
||||
|
||||
// Check for constants like self::CONSTANT.
|
||||
$prefix = '';
|
||||
$splitPos = strpos($constName, '::');
|
||||
if ($splitPos !== false) {
|
||||
$prefix = substr($constName, 0, ($splitPos + 2));
|
||||
$constName = substr($constName, ($splitPos + 2));
|
||||
}
|
||||
|
||||
if (strtoupper($constName) !== $constName) {
|
||||
$error = 'Constants must be uppercase; expected %s but found %s';
|
||||
$data = array(
|
||||
$prefix.strtoupper($constName),
|
||||
$prefix.$constName,
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'ConstantNotUpperCase', $data);
|
||||
}
|
||||
}//end if
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,94 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_PHP_DeprecatedFunctionsSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_PHP_DeprecatedFunctionsSniff.
|
||||
*
|
||||
* Discourages the use of deprecated functions that are kept in PHP for
|
||||
* compatibility with older versions.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_PHP_DeprecatedFunctionsSniff extends Generic_Sniffs_PHP_ForbiddenFunctionsSniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of forbidden functions with their alternatives.
|
||||
*
|
||||
* The value is NULL if no alternative exists. IE, the
|
||||
* function should just not be used.
|
||||
*
|
||||
* @var array(string => string|null)
|
||||
*/
|
||||
protected $forbiddenFunctions = array();
|
||||
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* Uses the Reflection API to get a list of deprecated functions.
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
$functions = get_defined_functions();
|
||||
|
||||
foreach ($functions['internal'] as $functionName) {
|
||||
$function = new ReflectionFunction($functionName);
|
||||
|
||||
if ($function->isDeprecated() === true) {
|
||||
$this->forbiddenFunctions[$functionName] = null;
|
||||
}
|
||||
}
|
||||
|
||||
}//end __construct()
|
||||
|
||||
|
||||
/**
|
||||
* Generates the error or wanrning for this sniff.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
||||
* @param int $stackPtr The position of the forbidden function
|
||||
* in the token array.
|
||||
* @param string $function The name of the forbidden function.
|
||||
* @param string $pattern The pattern used for the match.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function addError($phpcsFile, $stackPtr, $function, $pattern=null)
|
||||
{
|
||||
$data = array($function);
|
||||
$error = 'Function %s() has been deprecated';
|
||||
$type = 'Deprecated';
|
||||
|
||||
if ($this->error === true) {
|
||||
$phpcsFile->addError($error, $stackPtr, $type, $data);
|
||||
} else {
|
||||
$phpcsFile->addWarning($error, $stackPtr, $type, $data);
|
||||
}
|
||||
|
||||
}//end addError()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,85 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_PHP_DisallowShortOpenTagSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_PHP_DisallowShortOpenTagSniff.
|
||||
*
|
||||
* Makes sure that shorthand PHP open tags are not used.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_PHP_DisallowShortOpenTagSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(
|
||||
T_OPEN_TAG,
|
||||
T_OPEN_TAG_WITH_ECHO,
|
||||
);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$openTag = $tokens[$stackPtr];
|
||||
|
||||
if ($openTag['content'] === '<?') {
|
||||
$error = 'Short PHP opening tag used; expected "<?php" but found "%s"';
|
||||
$data = array($openTag['content']);
|
||||
$phpcsFile->addError($error, $stackPtr, 'Found', $data);
|
||||
}
|
||||
|
||||
if ($openTag['code'] === T_OPEN_TAG_WITH_ECHO) {
|
||||
$nextVar = $tokens[$phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true)];
|
||||
$error = 'Short PHP opening tag used with echo; expected "<?php echo %s ..." but found "%s %s ..."';
|
||||
$data = array(
|
||||
$nextVar['content'],
|
||||
$openTag['content'],
|
||||
$nextVar['content'],
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'EchoFound', $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,191 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_PHP_ForbiddenFunctionsSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_PHP_ForbiddenFunctionsSniff.
|
||||
*
|
||||
* Discourages the use of alias functions that are kept in PHP for compatibility
|
||||
* with older versions. Can be used to forbid the use of any function.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_PHP_ForbiddenFunctionsSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of forbidden functions with their alternatives.
|
||||
*
|
||||
* The value is NULL if no alternative exists. IE, the
|
||||
* function should just not be used.
|
||||
*
|
||||
* @var array(string => string|null)
|
||||
*/
|
||||
protected $forbiddenFunctions = array(
|
||||
'sizeof' => 'count',
|
||||
'delete' => 'unset',
|
||||
);
|
||||
|
||||
/**
|
||||
* A cache of forbidden function names, for faster lookups.
|
||||
*
|
||||
* @var array(string)
|
||||
*/
|
||||
protected $forbiddenFunctionNames = array();
|
||||
|
||||
/**
|
||||
* If true, forbidden functions will be considered regular expressions.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $patternMatch = false;
|
||||
|
||||
/**
|
||||
* If true, an error will be thrown; otherwise a warning.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
public $error = true;
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
// Everyone has had a chance to figure out what forbidden functions
|
||||
// they want to check for, so now we can cache out the list.
|
||||
$this->forbiddenFunctionNames = array_keys($this->forbiddenFunctions);
|
||||
|
||||
if ($this->patternMatch === true) {
|
||||
foreach ($this->forbiddenFunctionNames as $i => $name) {
|
||||
$this->forbiddenFunctionNames[$i] = '/'.$name.'/i';
|
||||
}
|
||||
}
|
||||
|
||||
return array(T_STRING);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$ignore = array(
|
||||
T_DOUBLE_COLON,
|
||||
T_OBJECT_OPERATOR,
|
||||
T_FUNCTION,
|
||||
T_CONST,
|
||||
);
|
||||
|
||||
$prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
|
||||
if (in_array($tokens[$prevToken]['code'], $ignore) === true) {
|
||||
// Not a call to a PHP function.
|
||||
return;
|
||||
}
|
||||
|
||||
$function = strtolower($tokens[$stackPtr]['content']);
|
||||
$pattern = null;
|
||||
|
||||
if ($this->patternMatch === true) {
|
||||
$count = 0;
|
||||
$pattern = preg_replace(
|
||||
$this->forbiddenFunctionNames,
|
||||
$this->forbiddenFunctionNames,
|
||||
$function,
|
||||
1,
|
||||
$count
|
||||
);
|
||||
|
||||
if ($count === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Remove the pattern delimiters and modifier.
|
||||
$pattern = substr($pattern, 1, -2);
|
||||
} else {
|
||||
if (in_array($function, $this->forbiddenFunctionNames) === false) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
$this->addError($phpcsFile, $stackPtr, $function, $pattern);
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
/**
|
||||
* Generates the error or wanrning for this sniff.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
||||
* @param int $stackPtr The position of the forbidden function
|
||||
* in the token array.
|
||||
* @param string $function The name of the forbidden function.
|
||||
* @param string $pattern The pattern used for the match.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function addError($phpcsFile, $stackPtr, $function, $pattern=null)
|
||||
{
|
||||
$data = array($function);
|
||||
$error = 'The use of function %s() is ';
|
||||
if ($this->error === true) {
|
||||
$type = 'Found';
|
||||
$error .= 'forbidden';
|
||||
} else {
|
||||
$type = 'Discouraged';
|
||||
$error .= 'discouraged';
|
||||
}
|
||||
|
||||
if ($pattern === null) {
|
||||
$pattern = $function;
|
||||
}
|
||||
|
||||
if ($this->forbiddenFunctions[$pattern] !== null) {
|
||||
$type .= 'WithAlternative';
|
||||
$data[] = $this->forbiddenFunctions[$pattern];
|
||||
$error .= '; use %s() instead';
|
||||
}
|
||||
|
||||
if ($this->error === true) {
|
||||
$phpcsFile->addError($error, $stackPtr, $type, $data);
|
||||
} else {
|
||||
$phpcsFile->addWarning($error, $stackPtr, $type, $data);
|
||||
}
|
||||
|
||||
}//end addError()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,93 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_PHP_LowerCaseConstantSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_PHP_LowerCaseConstantSniff.
|
||||
*
|
||||
* Checks that all uses of true, false and null are lowerrcase.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_PHP_LowerCaseConstantSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array(
|
||||
'PHP',
|
||||
'JS',
|
||||
);
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(
|
||||
T_TRUE,
|
||||
T_FALSE,
|
||||
T_NULL,
|
||||
);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, 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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Is this a member var name?
|
||||
$prevPtr = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
|
||||
if ($tokens[$prevPtr]['code'] === T_OBJECT_OPERATOR) {
|
||||
return;
|
||||
}
|
||||
|
||||
$keyword = $tokens[$stackPtr]['content'];
|
||||
if (strtolower($keyword) !== $keyword) {
|
||||
$error = 'TRUE, FALSE and NULL must be lowercase; expected "%s" but found "%s"';
|
||||
$data = array(
|
||||
strtolower($keyword),
|
||||
$keyword,
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'Found', $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,81 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_PHP_NoSilencedErrorsSniff
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Andy Brockhurst <abrock@yahoo-inc.com>
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_PHP_NoSilencedErrorsSniff.
|
||||
*
|
||||
* Throws an error or warning when any code prefixed with an asperand is encountered.
|
||||
*
|
||||
* <code>
|
||||
* if (@in_array($array, $needle))
|
||||
* {
|
||||
* doSomething();
|
||||
* }
|
||||
* </code>
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Andy Brockhurst <abrock@yahoo-inc.com>
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_PHP_NoSilencedErrorsSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* If true, an error will be thrown; otherwise a warning.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
public $error = false;
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_ASPERAND);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$error = 'Silencing errors is forbidden';
|
||||
if ($this->error === true) {
|
||||
$error = 'Silencing errors is forbidden';
|
||||
$phpcsFile->addError($error, $stackPtr, 'Forbidden');
|
||||
} else {
|
||||
$error = 'Silencing errors is discouraged';
|
||||
$phpcsFile->addWarning($error, $stackPtr, 'Discouraged');
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,84 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_PHP_UpperCaseConstantSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_PHP_UpperCaseConstantSniff.
|
||||
*
|
||||
* Checks that all uses of TRUE, FALSE and NULL are uppercase.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_PHP_UpperCaseConstantSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(
|
||||
T_TRUE,
|
||||
T_FALSE,
|
||||
T_NULL,
|
||||
);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, 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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Is this a member var name?
|
||||
$prevPtr = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
|
||||
if ($tokens[$prevPtr]['code'] === T_OBJECT_OPERATOR) {
|
||||
return;
|
||||
}
|
||||
|
||||
$keyword = $tokens[$stackPtr]['content'];
|
||||
if (strtoupper($keyword) !== $keyword) {
|
||||
$error = 'TRUE, FALSE and NULL must be uppercase; expected "%s" but found "%s"';
|
||||
$data = array(
|
||||
strtoupper($keyword),
|
||||
$keyword,
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'Found', $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,125 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Strings_UnnecessaryStringConcatSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Strings_UnnecessaryStringConcatSniff.
|
||||
*
|
||||
* Checks that two strings are not concatenated together; suggests
|
||||
* using one string instead.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_Strings_UnnecessaryStringConcatSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array(
|
||||
'PHP',
|
||||
'JS',
|
||||
);
|
||||
|
||||
/**
|
||||
* If true, an error will be thrown; otherwise a warning.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
public $error = true;
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(
|
||||
T_STRING_CONCAT,
|
||||
T_PLUS,
|
||||
);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, 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)
|
||||
{
|
||||
// Work out which type of file this is for.
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
if ($tokens[$stackPtr]['code'] === T_STRING_CONCAT) {
|
||||
if ($phpcsFile->tokenizerType === 'JS') {
|
||||
return;
|
||||
}
|
||||
} else {
|
||||
if ($phpcsFile->tokenizerType === 'PHP') {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
$prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
|
||||
$next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
|
||||
if ($prev === false || $next === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$stringTokens = PHP_CodeSniffer_Tokens::$stringTokens;
|
||||
if (in_array($tokens[$prev]['code'], $stringTokens) === true
|
||||
&& in_array($tokens[$next]['code'], $stringTokens) === true
|
||||
) {
|
||||
if ($tokens[$prev]['content'][0] === $tokens[$next]['content'][0]) {
|
||||
// Before we throw an error for PHP, allow strings to be
|
||||
// combined if they would have < and ? next to each other because
|
||||
// this trick is sometimes required in PHP strings.
|
||||
if ($phpcsFile->tokenizerType === 'PHP') {
|
||||
$prevChar = substr($tokens[$prev]['content'], -2, 1);
|
||||
$nextChar = $tokens[$next]['content'][1];
|
||||
$combined = $prevChar.$nextChar;
|
||||
if ($combined === '?'.'>' || $combined === '<'.'?') {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
$error = 'String concat is not required here; use a single string instead';
|
||||
if ($this->error === true) {
|
||||
$phpcsFile->addError($error, $stackPtr, 'Found');
|
||||
} else {
|
||||
$phpcsFile->addWarning($error, $stackPtr, 'Found');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,206 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_VersionControl_SubversionPropertiesSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Jack Bates <ms419@freezone.co.uk>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_VersionControl_SubversionPropertiesSniff.
|
||||
*
|
||||
* Tests that the correct Subversion properties are set.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Jack Bates <ms419@freezone.co.uk>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_VersionControl_SubversionPropertiesSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* The Subversion properties that should be set.
|
||||
*
|
||||
* Key of array is the SVN property and the value is the
|
||||
* exact value the property should have or NULL if the
|
||||
* property should just be set but the value is not fixed.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $properties = array(
|
||||
'svn:keywords' => 'Author Id Revision',
|
||||
'svn:eol-style' => 'native',
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_OPEN_TAG);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Make sure this is the first PHP open tag so we don't process the
|
||||
// same file twice.
|
||||
$prevOpenTag = $phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1));
|
||||
if ($prevOpenTag !== false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$path = $phpcsFile->getFileName();
|
||||
$properties = $this->getProperties($path);
|
||||
if ($properties === null) {
|
||||
// Not under version control.
|
||||
return;
|
||||
}
|
||||
|
||||
$properties += $this->properties;
|
||||
foreach ($properties as $key => $value) {
|
||||
if (isset($properties[$key]) === true
|
||||
&& isset($this->properties[$key]) === false
|
||||
) {
|
||||
$error = 'Unexpected Subversion property "%s" = "%s"';
|
||||
$data = array(
|
||||
$key,
|
||||
$properties[$key],
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'Unexpected', $data);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (isset($properties[$key]) === false
|
||||
&& isset($this->properties[$key]) === true
|
||||
) {
|
||||
$error = 'Missing Subversion property "%s" = "%s"';
|
||||
$data = array(
|
||||
$key,
|
||||
$this->properties[$key],
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'Missing', $data);
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($properties[$key] !== null
|
||||
&& $properties[$key] !== $this->properties[$key]
|
||||
) {
|
||||
$error = 'Subversion property "%s" = "%s" does not match "%s"';
|
||||
$data = array(
|
||||
$key,
|
||||
$properties[$key],
|
||||
$this->properties[$key],
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'NoMatch', $data);
|
||||
}
|
||||
}//end foreach
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
/**
|
||||
* Returns the Subversion properties which are actually set on a path.
|
||||
*
|
||||
* Returns NULL if the file is not under version control.
|
||||
*
|
||||
* @param string $path The path to return Subversion properties on.
|
||||
*
|
||||
* @return array
|
||||
* @throws PHP_CodeSniffer_Exception If Subversion properties file could
|
||||
* not be opened.
|
||||
*/
|
||||
protected function getProperties($path)
|
||||
{
|
||||
$properties = array();
|
||||
|
||||
$paths = array();
|
||||
$paths[] = dirname($path).'/.svn/props/'.basename($path).'.svn-work';
|
||||
$paths[] = dirname($path).'/.svn/prop-base/'.basename($path).'.svn-base';
|
||||
|
||||
$foundPath = false;
|
||||
foreach ($paths as $path) {
|
||||
if (file_exists($path) === true) {
|
||||
$foundPath = true;
|
||||
|
||||
$handle = fopen($path, 'r');
|
||||
if ($handle === false) {
|
||||
$error = 'Error opening file; could not get Subversion properties';
|
||||
throw new PHP_CodeSniffer_Exception($error);
|
||||
}
|
||||
|
||||
while (feof($handle) === false) {
|
||||
// Read a key length line. Might be END, though.
|
||||
$buffer = trim(fgets($handle));
|
||||
|
||||
// Check for the end of the hash.
|
||||
if ($buffer === 'END') {
|
||||
break;
|
||||
}
|
||||
|
||||
// Now read that much into a buffer.
|
||||
$key = fread($handle, substr($buffer, 2));
|
||||
|
||||
// Suck up extra newline after key data.
|
||||
fgetc($handle);
|
||||
|
||||
// Read a value length line.
|
||||
$buffer = trim(fgets($handle));
|
||||
|
||||
// Now read that much into a buffer.
|
||||
$length = substr($buffer, 2);
|
||||
if ($length === '0') {
|
||||
// Length of value is ZERO characters, so
|
||||
// value is actually empty.
|
||||
$value = '';
|
||||
} else {
|
||||
$value = fread($handle, $length);
|
||||
}
|
||||
|
||||
// Suck up extra newline after value data.
|
||||
fgetc($handle);
|
||||
|
||||
$properties[$key] = $value;
|
||||
}//end while
|
||||
|
||||
fclose($handle);
|
||||
}//end if
|
||||
}//end foreach
|
||||
|
||||
if ($foundPath === false) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $properties;
|
||||
|
||||
}//end getProperties()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,86 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_WhiteSpace_DisallowTabIndentSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_WhiteSpace_DisallowTabIndentSniff.
|
||||
*
|
||||
* Throws errors if tabs are used for indentation.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_WhiteSpace_DisallowTabIndentSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array(
|
||||
'PHP',
|
||||
'JS',
|
||||
'CSS',
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_WHITESPACE);
|
||||
|
||||
}//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();
|
||||
|
||||
// Make sure this is whitespace used for indentation.
|
||||
$line = $tokens[$stackPtr]['line'];
|
||||
if ($stackPtr > 0 && $tokens[($stackPtr - 1)]['line'] === $line) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (strpos($tokens[$stackPtr]['content'], "\t") !== false) {
|
||||
$error = 'Spaces must be used to indent lines; tabs are not allowed';
|
||||
$phpcsFile->addError($error, $stackPtr, 'TabsUsed');
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,346 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic_Sniffs_Whitespace_ScopeIndentSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Generic_Sniffs_Whitespace_ScopeIndentSniff.
|
||||
*
|
||||
* Checks that control structures are structured correctly, and their content
|
||||
* is indented correctly. This sniff will throw errors if tabs are used
|
||||
* for indentation rather than spaces.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Generic_Sniffs_WhiteSpace_ScopeIndentSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* The number of spaces code should be indented.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $indent = 4;
|
||||
|
||||
/**
|
||||
* Does the indent need to be exactly right.
|
||||
*
|
||||
* If TRUE, indent needs to be exactly $ident spaces. If FALSE,
|
||||
* indent needs to be at least $ident spaces (but can be more).
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
public $exact = false;
|
||||
|
||||
/**
|
||||
* Any scope openers that should not cause an indent.
|
||||
*
|
||||
* @var array(int)
|
||||
*/
|
||||
protected $nonIndentingScopes = array();
|
||||
|
||||
|
||||
/**
|
||||
* 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_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($tokens[$stackPtr]['code'] === T_ELSE) {
|
||||
$next = $phpcsFile->findNext(
|
||||
PHP_CodeSniffer_Tokens::$emptyTokens,
|
||||
($stackPtr + 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
// We will handle the T_IF token in another call to process.
|
||||
if ($tokens[$next]['code'] === T_IF) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// Find the first token on this line.
|
||||
$firstToken = $stackPtr;
|
||||
for ($i = $stackPtr; $i >= 0; $i--) {
|
||||
// Record the first code token on the line.
|
||||
if (in_array($tokens[$i]['code'], PHP_CodeSniffer_Tokens::$emptyTokens) === false) {
|
||||
$firstToken = $i;
|
||||
}
|
||||
|
||||
// It's the start of the line, so we've found our first php token.
|
||||
if ($tokens[$i]['column'] === 1) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Based on the conditions that surround this token, determine the
|
||||
// indent that we expect this current content to be.
|
||||
$expectedIndent = $this->calculateExpectedIndent($tokens, $firstToken);
|
||||
|
||||
// Don't process the first token if it is a closure because they have
|
||||
// different indentation rules as they are often used as function arguments
|
||||
// for multi-line function calls. But continue to process the content of the
|
||||
// closure because it should be indented as normal.
|
||||
if ($tokens[$firstToken]['code'] !== T_CLOSURE
|
||||
&& $tokens[$firstToken]['column'] !== $expectedIndent
|
||||
) {
|
||||
$error = 'Line indented incorrectly; expected %s spaces, found %s';
|
||||
$data = array(
|
||||
($expectedIndent - 1),
|
||||
($tokens[$firstToken]['column'] - 1),
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'Incorrect', $data);
|
||||
}
|
||||
|
||||
$scopeOpener = $tokens[$stackPtr]['scope_opener'];
|
||||
$scopeCloser = $tokens[$stackPtr]['scope_closer'];
|
||||
|
||||
// Some scopes are expected not to have indents.
|
||||
if (in_array($tokens[$firstToken]['code'], $this->nonIndentingScopes) === false) {
|
||||
$indent = ($expectedIndent + $this->indent);
|
||||
} else {
|
||||
$indent = $expectedIndent;
|
||||
}
|
||||
|
||||
$newline = false;
|
||||
$commentOpen = false;
|
||||
$inHereDoc = false;
|
||||
|
||||
// Only loop over the content between the opening and closing brace, not
|
||||
// the braces themselves.
|
||||
for ($i = ($scopeOpener + 1); $i < $scopeCloser; $i++) {
|
||||
|
||||
// If this token is another scope, skip it as it will be handled by
|
||||
// another call to this sniff.
|
||||
if (in_array($tokens[$i]['code'], PHP_CodeSniffer_Tokens::$scopeOpeners) === true) {
|
||||
if (isset($tokens[$i]['scope_opener']) === true) {
|
||||
$i = $tokens[$i]['scope_closer'];
|
||||
|
||||
// If the scope closer is followed by a semi-colon, the semi-colon is part
|
||||
// of the closer and should also be ignored. This most commonly happens with
|
||||
// CASE statements that end with "break;", where we don't want to stop
|
||||
// ignoring at the break, but rather at the semi-colon.
|
||||
$nextToken = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($i + 1), null, true);
|
||||
if ($tokens[$nextToken]['code'] === T_SEMICOLON) {
|
||||
$i = $nextToken;
|
||||
}
|
||||
} else {
|
||||
// If this token does not have a scope_opener indice, then
|
||||
// it's probably an inline scope, so let's skip to the next
|
||||
// semicolon. Inline scopes include inline if's, abstract
|
||||
// methods etc.
|
||||
$nextToken = $phpcsFile->findNext(T_SEMICOLON, $i, $scopeCloser);
|
||||
if ($nextToken !== false) {
|
||||
$i = $nextToken;
|
||||
}
|
||||
}
|
||||
|
||||
continue;
|
||||
}//end if
|
||||
|
||||
// If this is a HEREDOC then we need to ignore it as the
|
||||
// whitespace before the contents within the HEREDOC are
|
||||
// considered part of the content.
|
||||
if ($tokens[$i]['code'] === T_START_HEREDOC) {
|
||||
$inHereDoc = true;
|
||||
continue;
|
||||
} else if ($inHereDoc === true) {
|
||||
if ($tokens[$i]['code'] === T_END_HEREDOC) {
|
||||
$inHereDoc = false;
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($tokens[$i]['column'] === 1) {
|
||||
// We started a newline.
|
||||
$newline = true;
|
||||
}
|
||||
|
||||
if ($newline === true && $tokens[$i]['code'] !== T_WHITESPACE) {
|
||||
// If we started a newline and we find a token that is not
|
||||
// whitespace, then this must be the first token on the line that
|
||||
// must be indented.
|
||||
$newline = false;
|
||||
$firstToken = $i;
|
||||
|
||||
$column = $tokens[$firstToken]['column'];
|
||||
|
||||
// Special case for non-PHP code.
|
||||
if ($tokens[$firstToken]['code'] === T_INLINE_HTML) {
|
||||
$trimmedContentLength
|
||||
= strlen(ltrim($tokens[$firstToken]['content']));
|
||||
if ($trimmedContentLength === 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$contentLength = strlen($tokens[$firstToken]['content']);
|
||||
$column = ($contentLength - $trimmedContentLength + 1);
|
||||
}
|
||||
|
||||
// Check to see if this constant string spans multiple lines.
|
||||
// If so, then make sure that the strings on lines other than the
|
||||
// first line are indented appropriately, based on their whitespace.
|
||||
if (in_array($tokens[$firstToken]['code'], PHP_CodeSniffer_Tokens::$stringTokens) === true) {
|
||||
if (in_array($tokens[($firstToken - 1)]['code'], PHP_CodeSniffer_Tokens::$stringTokens) === true) {
|
||||
// If we find a string that directly follows another string
|
||||
// then its just a string that spans multiple lines, so we
|
||||
// don't need to check for indenting.
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
// This is a special condition for T_DOC_COMMENT and C-style
|
||||
// comments, which contain whitespace between each line.
|
||||
$comments = array(
|
||||
T_COMMENT,
|
||||
T_DOC_COMMENT
|
||||
);
|
||||
|
||||
if (in_array($tokens[$firstToken]['code'], $comments) === true) {
|
||||
$content = trim($tokens[$firstToken]['content']);
|
||||
if (preg_match('|^/\*|', $content) !== 0) {
|
||||
// Check to see if the end of the comment is on the same line
|
||||
// as the start of the comment. If it is, then we don't
|
||||
// have to worry about opening a comment.
|
||||
if (preg_match('|\*/$|', $content) === 0) {
|
||||
// We don't have to calculate the column for the
|
||||
// start of the comment as there is a whitespace
|
||||
// token before it.
|
||||
$commentOpen = true;
|
||||
}
|
||||
} else if ($commentOpen === true) {
|
||||
if ($content === '') {
|
||||
// We are in a comment, but this line has nothing on it
|
||||
// so let's skip it.
|
||||
continue;
|
||||
}
|
||||
|
||||
$contentLength = strlen($tokens[$firstToken]['content']);
|
||||
$trimmedContentLength
|
||||
= strlen(ltrim($tokens[$firstToken]['content']));
|
||||
|
||||
$column = ($contentLength - $trimmedContentLength + 1);
|
||||
if (preg_match('|\*/$|', $content) !== 0) {
|
||||
$commentOpen = false;
|
||||
}
|
||||
}//end if
|
||||
}//end if
|
||||
|
||||
// The token at the start of the line, needs to have its' column
|
||||
// greater than the relative indent we set above. If it is less,
|
||||
// an error should be shown.
|
||||
if ($column !== $indent) {
|
||||
if ($this->exact === true || $column < $indent) {
|
||||
$type = 'IncorrectExact';
|
||||
$error = 'Line indented incorrectly; expected ';
|
||||
if ($this->exact === false) {
|
||||
$error .= 'at least ';
|
||||
$type = 'Incorrect';
|
||||
}
|
||||
|
||||
$error .= '%s spaces, found %s';
|
||||
$data = array(
|
||||
($indent - 1),
|
||||
($column - 1),
|
||||
);
|
||||
$phpcsFile->addError($error, $firstToken, $type, $data);
|
||||
}
|
||||
}//end if
|
||||
}//end if
|
||||
}//end for
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
/**
|
||||
* Calculates the expected indent of a token.
|
||||
*
|
||||
* Returns the column at which the token should be indented to, so 1 means
|
||||
* that the token should not be indented at all.
|
||||
*
|
||||
* @param array $tokens The stack of tokens for this file.
|
||||
* @param int $stackPtr The position of the token to get indent for.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
protected function calculateExpectedIndent(array $tokens, $stackPtr)
|
||||
{
|
||||
$conditionStack = array();
|
||||
|
||||
// Empty conditions array (top level structure).
|
||||
if (empty($tokens[$stackPtr]['conditions']) === true) {
|
||||
if (isset($tokens[$stackPtr]['nested_parenthesis']) === true
|
||||
&& empty($tokens[$stackPtr]['nested_parenthesis']) === false
|
||||
) {
|
||||
// Wrapped in parenthesis means it is probably in a
|
||||
// function call (like a closure) so we have to assume indent
|
||||
// is correct here and someone else will check it more
|
||||
// carefully in another sniff.
|
||||
return $tokens[$stackPtr]['column'];
|
||||
} else {
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
|
||||
$tokenConditions = $tokens[$stackPtr]['conditions'];
|
||||
foreach ($tokenConditions as $id => $condition) {
|
||||
// If it's an indenting scope ie. it's not in our array of
|
||||
// scopes that don't indent, add it to our condition stack.
|
||||
if (in_array($condition, $this->nonIndentingScopes) === false) {
|
||||
$conditionStack[$id] = $condition;
|
||||
}
|
||||
}
|
||||
|
||||
$indent = ((count($conditionStack) * $this->indent) + 1);
|
||||
return $indent;
|
||||
|
||||
}//end calculateExpectedIndent()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,4 @@
|
||||
<?xml version="1.0"?>
|
||||
<ruleset name="Generic">
|
||||
<description>A collection of generic sniffs. This standard is not designed to be used to check code.</description>
|
||||
</ruleset>
|
||||
@@ -0,0 +1,35 @@
|
||||
<?php
|
||||
/**
|
||||
* An exception thrown if the pattern being processed is not supposed to be
|
||||
* validating the code in question.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* An exception thrown if the pattern being processed is not supposed to be
|
||||
* validating the code in question.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PHP_CodeSniffer_Standards_IncorrectPatternException extends Exception
|
||||
{
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,102 @@
|
||||
<?php
|
||||
/**
|
||||
* MySource_Sniffs_CSS_BrowserSpecificStylesSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* MySource_Sniffs_CSS_BrowserSpecificStylesSniff.
|
||||
*
|
||||
* Ensure that browser-specific styles are not used.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_CSS_BrowserSpecificStylesSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array('CSS');
|
||||
|
||||
/**
|
||||
* A list of specific stylsheet suffixes we allow.
|
||||
*
|
||||
* These stylsheets contain browser specific styles
|
||||
* so this sniff ignore them files in the form:
|
||||
* *_moz.css and *_ie7.css etc.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $specificStylesheets = array(
|
||||
'moz',
|
||||
'ie',
|
||||
'ie7',
|
||||
'ie8',
|
||||
'webkit',
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
* Returns the token types that this sniff is interested in.
|
||||
*
|
||||
* @return array(int)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_STYLE);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the tokens that this sniff is interested in.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
|
||||
* @param int $stackPtr The position in the stack where
|
||||
* the token was found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
// Ignore files with browser-specific suffixes.
|
||||
$filename = $phpcsFile->getFilename();
|
||||
$breakChar = strrpos($filename, '_');
|
||||
if ($breakChar !== false && substr($filename, -4) === '.css') {
|
||||
$specific = substr($filename, ($breakChar + 1), -4);
|
||||
if (in_array($specific, $this->specificStylesheets) === true) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$content = $tokens[$stackPtr]['content'];
|
||||
|
||||
if ($content{0} === '-') {
|
||||
$error = 'Browser-specific styles are not allowed';
|
||||
$phpcsFile->addError($error, $stackPtr, 'ForbiddenStyle');
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,76 @@
|
||||
<?php
|
||||
/**
|
||||
* Ensures that all action classes throw ChannelExceptions only.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ensures that all action classes throw ChannelExceptions only.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_Channels_ChannelExceptionSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_THROW);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, 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)
|
||||
{
|
||||
$fileName = strtolower($phpcsFile->getFilename());
|
||||
$matches = array();
|
||||
if (preg_match('|/systems/(.*)/([^/]+)?actions.inc$|', $fileName, $matches) === 0) {
|
||||
// This is not an actions.inc file.
|
||||
return;
|
||||
}
|
||||
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$exception = $phpcsFile->findNext(array(T_STRING, T_VARIABLE), ($stackPtr + 1));
|
||||
$exceptionName = $tokens[$exception]['content'];
|
||||
|
||||
if ($exceptionName !== 'ChannelException') {
|
||||
$data = array($exceptionName);
|
||||
$error = 'Channel actions can only throw ChannelException; found "%s"';
|
||||
$phpcsFile->addError($error, $exception, 'WrongExceptionType', $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,131 @@
|
||||
<?php
|
||||
/**
|
||||
* Ensures that self is not used to call public method in action classes.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ensures that self is not used to call public method in action classes.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_Channels_DisallowSelfActionsSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_CLASS);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, 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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// We are not interested in abstract classes.
|
||||
$prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
|
||||
if ($prev !== false && $tokens[$prev]['code'] === T_ABSTRACT) {
|
||||
return;
|
||||
}
|
||||
|
||||
// We are only interested in Action classes.
|
||||
$classNameToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
|
||||
$className = $tokens[$classNameToken]['content'];
|
||||
if (substr($className, -7) !== 'Actions') {
|
||||
return;
|
||||
}
|
||||
|
||||
$foundFunctions = array();
|
||||
$foundCalls = array();
|
||||
|
||||
// Find all static method calls in the form self::method() in the class.
|
||||
$classEnd = $tokens[$stackPtr]['scope_closer'];
|
||||
for ($i = ($classNameToken + 1); $i < $classEnd; $i++) {
|
||||
if ($tokens[$i]['code'] !== T_DOUBLE_COLON) {
|
||||
if ($tokens[$i]['code'] === T_FUNCTION) {
|
||||
// Cache the function information.
|
||||
$funcName = $phpcsFile->findNext(T_STRING, ($i + 1));
|
||||
$funcScope = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$scopeModifiers, ($i - 1));
|
||||
|
||||
$foundFunctions[$tokens[$funcName]['content']] = strtolower($tokens[$funcScope]['content']);
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
$prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($i - 1), null, true);
|
||||
if ($tokens[$prevToken]['content'] !== 'self') {
|
||||
continue;
|
||||
}
|
||||
|
||||
$funcNameToken = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), null, true);
|
||||
if ($tokens[$funcNameToken]['code'] === T_VARIABLE) {
|
||||
// We are only interested in function calls.
|
||||
continue;
|
||||
}
|
||||
|
||||
$funcName = $tokens[$funcNameToken]['content'];
|
||||
|
||||
// We've found the function, now we need to find it and see if it is
|
||||
// public, private or protected. If it starts with an underscore we
|
||||
// can assume it is private.
|
||||
if ($funcName{0} === '_') {
|
||||
continue;
|
||||
}
|
||||
|
||||
$foundCalls[$i] = $funcName;
|
||||
}//end for
|
||||
|
||||
$errorClassName = substr($className, 0, -7);
|
||||
|
||||
foreach ($foundCalls as $token => $funcName) {
|
||||
if (isset($foundFunctions[$funcName]) === false) {
|
||||
// Function was not in this class, might have come from the parent.
|
||||
// Either way, we can't really check this.
|
||||
continue;
|
||||
} else if ($foundFunctions[$funcName] === 'public') {
|
||||
$error = 'Static calls to public methods in Action classes must not use the self keyword; use %s::%s() instead';
|
||||
$data = array(
|
||||
$errorClassName,
|
||||
$funcName,
|
||||
);
|
||||
$phpcsFile->addError($error, $token, 'Found', $data);
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,329 @@
|
||||
<?php
|
||||
/**
|
||||
* Ensures that systems, asset types and libs are included before they are used.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) {
|
||||
$error = 'Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found';
|
||||
throw new PHP_CodeSniffer_Exception($error);
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures that systems, asset types and libs are included before they are used.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_Channels_IncludeSystemSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of classes that don't need to be included.
|
||||
*
|
||||
* @var array(string)
|
||||
*/
|
||||
private $_ignore = array(
|
||||
'self',
|
||||
'parent',
|
||||
'channels',
|
||||
'basesystem',
|
||||
'dal',
|
||||
'init',
|
||||
'pdo',
|
||||
'util',
|
||||
'ziparchive',
|
||||
'phpunit_framework_assert',
|
||||
'abstractmysourceunittest',
|
||||
'abstractdatacleanunittest',
|
||||
'exception',
|
||||
'abstractwidgetwidgettype',
|
||||
'domdocument',
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
* Constructs a Squiz_Sniffs_Scope_MethodScopeSniff.
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
parent::__construct(array(T_FUNCTION), array(T_DOUBLE_COLON, T_EXTENDS), true);
|
||||
|
||||
}//end __construct()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the function tokens within the class.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where this token was found.
|
||||
* @param integer $stackPtr The position where the token was found.
|
||||
* @param integer $currScope The current scope opener token.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processTokenWithinScope(
|
||||
PHP_CodeSniffer_File $phpcsFile,
|
||||
$stackPtr,
|
||||
$currScope
|
||||
) {
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Determine the name of the class that the static function
|
||||
// is being called on.
|
||||
$classNameToken = $phpcsFile->findPrevious(
|
||||
T_WHITESPACE,
|
||||
($stackPtr - 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
$className = $tokens[$classNameToken]['content'];
|
||||
if (in_array(strtolower($className), $this->_ignore) === true) {
|
||||
return;
|
||||
}
|
||||
|
||||
$includedClasses = array();
|
||||
|
||||
$fileName = strtolower($phpcsFile->getFilename());
|
||||
$matches = array();
|
||||
if (preg_match('|/systems/(.*)/([^/]+)?actions.inc$|', $fileName, $matches) !== 0) {
|
||||
// This is an actions file, which means we don't
|
||||
// have to include the system in which it exists.
|
||||
$includedClasses[] = $matches[2];
|
||||
|
||||
// Or a system it implements.
|
||||
$class = $phpcsFile->getCondition($stackPtr, T_CLASS);
|
||||
$implements = $phpcsFile->findNext(T_IMPLEMENTS, $class, ($class + 10));
|
||||
if ($implements !== false) {
|
||||
$implementsClass = $phpcsFile->findNext(T_STRING, $implements);
|
||||
$implementsClassName = strtolower($tokens[$implementsClass]['content']);
|
||||
if (substr($implementsClassName, -7) === 'actions') {
|
||||
$includedClasses[] = substr($implementsClassName, 0, -7);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Go searching for includeSystem and includeAsset calls within this
|
||||
// function, or the inclusion of .inc files, which
|
||||
// would be library files.
|
||||
for ($i = ($currScope + 1); $i < $stackPtr; $i++) {
|
||||
$name = $this->getIncludedClassFromToken($phpcsFile, $tokens, $i);
|
||||
if ($name !== false) {
|
||||
$includedClasses[] = $name;
|
||||
// Special case for Widgets cause they are, well, special.
|
||||
} else if (strtolower($tokens[$i]['content']) === 'includewidget') {
|
||||
$typeName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($i + 1));
|
||||
$typeName = trim($tokens[$typeName]['content'], " '");
|
||||
$includedClasses[] = strtolower($typeName).'widgettype';
|
||||
}
|
||||
}
|
||||
|
||||
// Now go searching for includeSystem, includeAsset or require/include
|
||||
// calls outside our scope. If we are in a class, look outside the
|
||||
// class. If we are not, look outside the function.
|
||||
$condPtr = $currScope;
|
||||
if ($phpcsFile->hasCondition($stackPtr, T_CLASS) === true) {
|
||||
foreach ($tokens[$stackPtr]['conditions'] as $condPtr => $condType) {
|
||||
if ($condType === T_CLASS) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for ($i = 0; $i < $condPtr; $i++) {
|
||||
// Skip other scopes.
|
||||
if (isset($tokens[$i]['scope_closer']) === true) {
|
||||
$i = $tokens[$i]['scope_closer'];
|
||||
continue;
|
||||
}
|
||||
|
||||
$name = $this->getIncludedClassFromToken($phpcsFile, $tokens, $i);
|
||||
if ($name !== false) {
|
||||
$includedClasses[] = $name;
|
||||
}
|
||||
}//end for
|
||||
|
||||
// If we are in a testing class, we might have also included
|
||||
// some systems and classes in our setUp() method.
|
||||
$setupFunction = null;
|
||||
if ($phpcsFile->hasCondition($stackPtr, T_CLASS) === true) {
|
||||
foreach ($tokens[$stackPtr]['conditions'] as $condPtr => $condType) {
|
||||
if ($condType === T_CLASS) {
|
||||
// Is this is a testing class?
|
||||
$name = $phpcsFile->findNext(T_STRING, $condPtr);
|
||||
$name = $tokens[$name]['content'];
|
||||
if (substr($name, -8) === 'UnitTest') {
|
||||
// Look for a method called setUp().
|
||||
$end = $tokens[$condPtr]['scope_closer'];
|
||||
$function = $phpcsFile->findNext(T_FUNCTION, ($condPtr + 1), $end);
|
||||
while ($function !== false) {
|
||||
$name = $phpcsFile->findNext(T_STRING, $function);
|
||||
if ($tokens[$name]['content'] === 'setUp') {
|
||||
$setupFunction = $function;
|
||||
break;
|
||||
}
|
||||
|
||||
$function = $phpcsFile->findNext(T_FUNCTION, ($function + 1), $end);
|
||||
}
|
||||
}
|
||||
}
|
||||
}//end foreach
|
||||
}//end if
|
||||
|
||||
if ($setupFunction !== null) {
|
||||
$start = ($tokens[$setupFunction]['scope_opener'] + 1);
|
||||
$end = $tokens[$setupFunction]['scope_closer'];
|
||||
for ($i = $start; $i < $end; $i++) {
|
||||
$name = $this->getIncludedClassFromToken($phpcsFile, $tokens, $i);
|
||||
if ($name !== false) {
|
||||
$includedClasses[] = $name;
|
||||
}
|
||||
}
|
||||
}//end if
|
||||
|
||||
if (in_array(strtolower($className), $includedClasses) === false) {
|
||||
$error = 'Static method called on non-included class or system "%s"; include system with Channels::includeSystem() or include class with require_once';
|
||||
$data = array($className);
|
||||
$phpcsFile->addError($error, $stackPtr, 'NotIncludedCall', $data);
|
||||
}
|
||||
|
||||
}//end processTokenWithinScope()
|
||||
|
||||
|
||||
/**
|
||||
* Processes a token within the scope that this test is listening to.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
|
||||
* @param int $stackPtr The position in the stack where
|
||||
* this token was found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processTokenOutsideScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
if ($tokens[$stackPtr]['code'] === T_EXTENDS) {
|
||||
// Find the class name.
|
||||
$classNameToken = $phpcsFile->findNext(T_STRING, ($stackPtr + 1));
|
||||
$className = $tokens[$classNameToken]['content'];
|
||||
} else {
|
||||
// Determine the name of the class that the static function
|
||||
// is being called on.
|
||||
$classNameToken = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
|
||||
$className = $tokens[$classNameToken]['content'];
|
||||
}
|
||||
|
||||
// Some systems are always available.
|
||||
if (in_array(strtolower($className), $this->_ignore) === true) {
|
||||
return;
|
||||
}
|
||||
|
||||
$includedClasses = array();
|
||||
|
||||
$fileName = strtolower($phpcsFile->getFilename());
|
||||
$matches = array();
|
||||
if (preg_match('|/systems/([^/]+)/([^/]+)?actions.inc$|', $fileName, $matches) !== 0) {
|
||||
// This is an actions file, which means we don't
|
||||
// have to include the system in which it exists
|
||||
// We know the system from the path.
|
||||
$includedClasses[] = $matches[1];
|
||||
}
|
||||
|
||||
// Go searching for includeSystem, includeAsset or require/include
|
||||
// calls outside our scope.
|
||||
for ($i = 0; $i < $stackPtr; $i++) {
|
||||
// Skip classes and functions as will we never get
|
||||
// into their scopes when including this file, although
|
||||
// we have a chance of getting into IF's, WHILE's etc.
|
||||
$ignoreTokens = array(
|
||||
T_CLASS,
|
||||
T_INTERFACE,
|
||||
T_FUNCTION,
|
||||
);
|
||||
|
||||
if (in_array($tokens[$i]['code'], $ignoreTokens) === true
|
||||
&& isset($tokens[$i]['scope_closer']) === true
|
||||
) {
|
||||
$i = $tokens[$i]['scope_closer'];
|
||||
continue;
|
||||
}
|
||||
|
||||
$name = $this->getIncludedClassFromToken($phpcsFile, $tokens, $i);
|
||||
if ($name !== false) {
|
||||
$includedClasses[] = $name;
|
||||
// Special case for Widgets cause they are, well, special.
|
||||
} else if (strtolower($tokens[$i]['content']) === 'includewidget') {
|
||||
$typeName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($i + 1));
|
||||
$typeName = trim($tokens[$typeName]['content'], " '");
|
||||
$includedClasses[] = strtolower($typeName).'widgettype';
|
||||
}
|
||||
}//end for
|
||||
|
||||
if (in_array(strtolower($className), $includedClasses) === false) {
|
||||
if ($tokens[$stackPtr]['code'] === T_EXTENDS) {
|
||||
$error = 'Class extends non-included class or system "%s"; include system with Channels::includeSystem() or include class with require_once';
|
||||
$data = array($className);
|
||||
$phpcsFile->addError($error, $stackPtr, 'NotIncludedExtends', $data);
|
||||
} else {
|
||||
$error = 'Static method called on non-included class or system "%s"; include system with Channels::includeSystem() or include class with require_once';
|
||||
$data = array($className);
|
||||
$phpcsFile->addError($error, $stackPtr, 'NotIncludedCall', $data);
|
||||
}
|
||||
}
|
||||
|
||||
}//end processTokenOutsideScope()
|
||||
|
||||
|
||||
/**
|
||||
* Determines the included class name from given token.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where this token was found.
|
||||
* @param array $tokens The array of file tokens.
|
||||
* @param int $stackPtr The position in the tokens array of the
|
||||
* potentially included class.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function getIncludedClassFromToken(
|
||||
PHP_CodeSniffer_File $phpcsFile,
|
||||
array $tokens,
|
||||
$stackPtr
|
||||
) {
|
||||
if (strtolower($tokens[$stackPtr]['content']) === 'includesystem') {
|
||||
$systemName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($stackPtr + 1));
|
||||
$systemName = trim($tokens[$systemName]['content'], " '");
|
||||
return strtolower($systemName);
|
||||
} else if (strtolower($tokens[$stackPtr]['content']) === 'includeasset') {
|
||||
$typeName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($stackPtr + 1));
|
||||
$typeName = trim($tokens[$typeName]['content'], " '");
|
||||
return strtolower($typeName).'assettype';
|
||||
} else if (in_array($tokens[$stackPtr]['code'], PHP_CodeSniffer_Tokens::$includeTokens) === true) {
|
||||
$filePath = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($stackPtr + 1));
|
||||
$filePath = $tokens[$filePath]['content'];
|
||||
$filePath = trim($filePath, " '");
|
||||
$filePath = basename($filePath, '.inc');
|
||||
return strtolower($filePath);
|
||||
}
|
||||
|
||||
return false;
|
||||
|
||||
}//end getIncludedClassFromToken()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,157 @@
|
||||
<?php
|
||||
/**
|
||||
* Ensures that systems, asset types and libs are included before they are used.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ensures that systems and asset types are used if they are included.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_Channels_UnusedSystemSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_DOUBLE_COLON);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, 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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Check if this is a call to includeSystem, includeAsset or includeWidget.
|
||||
$methodName = strtolower($tokens[($stackPtr + 1)]['content']);
|
||||
if (in_array($methodName, array('includesystem', 'includeasset', 'includewidget')) === true) {
|
||||
$systemName = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 3), null, true);
|
||||
if ($systemName === false || $tokens[$systemName]['code'] !== T_CONSTANT_ENCAPSED_STRING) {
|
||||
// Must be using a variable instead of a specific system name.
|
||||
// We can't accurately check that.
|
||||
return;
|
||||
}
|
||||
|
||||
$systemName = trim($tokens[$systemName]['content'], " '");
|
||||
} else {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($methodName === 'includeasset') {
|
||||
$systemName .= 'assettype';
|
||||
} else if ($methodName === 'includewidget') {
|
||||
$systemName .= 'widgettype';
|
||||
}
|
||||
|
||||
$systemName = strtolower($systemName);
|
||||
|
||||
// Now check if this system is used anywhere in this scope.
|
||||
$level = $tokens[$stackPtr]['level'];
|
||||
for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) {
|
||||
if ($tokens[$i]['level'] < $level) {
|
||||
// We have gone out of scope.
|
||||
// If the original include was inside an IF statement that
|
||||
// is checking if the system exists, check the outer scope
|
||||
// as well.
|
||||
if ($tokens[$stackPtr]['level'] === $level) {
|
||||
// We are still in the base level, so this is the first
|
||||
// time we have got here.
|
||||
$conditions = array_keys($tokens[$stackPtr]['conditions']);
|
||||
if (empty($conditions) === false) {
|
||||
$cond = array_pop($conditions);
|
||||
if ($tokens[$cond]['code'] === T_IF) {
|
||||
$i = $tokens[$cond]['scope_closer'];
|
||||
$level--;
|
||||
continue;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
break;
|
||||
}//end if
|
||||
|
||||
$validTokens = array(
|
||||
T_DOUBLE_COLON,
|
||||
T_EXTENDS,
|
||||
T_IMPLEMENTS,
|
||||
);
|
||||
|
||||
if (in_array($tokens[$i]['code'], $validTokens) === false) {
|
||||
continue;
|
||||
}
|
||||
|
||||
switch ($tokens[$i]['code']) {
|
||||
case T_DOUBLE_COLON:
|
||||
$usedName = strtolower($tokens[($i - 1)]['content']);
|
||||
if ($usedName === $systemName) {
|
||||
// The included system was used, so it is fine.
|
||||
return;
|
||||
}
|
||||
|
||||
break;
|
||||
case T_EXTENDS:
|
||||
$classNameToken = $phpcsFile->findNext(T_STRING, ($i + 1));
|
||||
$className = strtolower($tokens[$classNameToken]['content']);
|
||||
if ($className === $systemName) {
|
||||
// The included system was used, so it is fine.
|
||||
return;
|
||||
}
|
||||
|
||||
break;
|
||||
case T_IMPLEMENTS:
|
||||
$endImplements = $phpcsFile->findNext(array(T_EXTENDS, T_OPEN_CURLY_BRACKET), ($i + 1));
|
||||
for ($x = ($i + 1); $x < $endImplements; $x++) {
|
||||
if ($tokens[$x]['code'] === T_STRING) {
|
||||
$className = strtolower($tokens[$x]['content']);
|
||||
if ($className === $systemName) {
|
||||
// The included system was used, so it is fine.
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
break;
|
||||
}//end switch
|
||||
}//end for
|
||||
|
||||
// If we get to here, the system was not use.
|
||||
$error = 'Included system "%s" is never used';
|
||||
$data = array($systemName);
|
||||
$phpcsFile->addError($error, $stackPtr, 'Found', $data);
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,134 @@
|
||||
<?php
|
||||
/**
|
||||
* Parses and verifies the doc comments for functions.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
if (class_exists('Squiz_Sniffs_Commenting_FunctionCommentSniff', true) === false) {
|
||||
$error = 'Class Squiz_Sniffs_Commenting_FunctionCommentSniff not found';
|
||||
throw new PHP_CodeSniffer_Exception($error);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses and verifies the doc comments for functions.
|
||||
*
|
||||
* Same as the Squiz standard, but adds support for API tags.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_Commenting_FunctionCommentSniff extends Squiz_Sniffs_Commenting_FunctionCommentSniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Process a list of unknown tags.
|
||||
*
|
||||
* @param int $commentStart The position in the stack where the comment started.
|
||||
* @param int $commentEnd The position in the stack where the comment ended.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processUnknownTags($commentStart, $commentEnd)
|
||||
{
|
||||
$unknownTags = $this->commentParser->getUnknown();
|
||||
$words = $this->commentParser->getWords();
|
||||
$hasApiTag = false;
|
||||
$apiLength = 3;
|
||||
foreach ($unknownTags as $errorTag) {
|
||||
$pos = $errorTag['pos'];
|
||||
if ($errorTag['tag'] === 'api') {
|
||||
if ($hasApiTag === true) {
|
||||
// We've come across an API tag already, which means
|
||||
// we were not the first tag in the API list.
|
||||
$error = 'The @api tag must come first in the @api tag list in a function comment';
|
||||
$this->currentFile->addError($error, ($commentStart + $errorTag['line']), 'ApiNotFirst');
|
||||
}
|
||||
|
||||
$hasApiTag = true;
|
||||
|
||||
// There needs to be a blank line before the @api tag.
|
||||
// So expect a single space before the tag, then 2 newlines before
|
||||
// that, then some content.
|
||||
if (trim($words[($pos - 2)]) !== ''
|
||||
|| strpos($words[($pos - 2)], $this->currentFile->eolChar) === false
|
||||
|| strpos($words[($pos - 3)], $this->currentFile->eolChar) === false
|
||||
|| trim($words[($pos - 4)]) === ''
|
||||
) {
|
||||
$error = 'There must be one blank line before the @api tag in a function comment';
|
||||
$this->currentFile->addError($error, ($commentStart + $errorTag['line']), 'ApiSpacing');
|
||||
}
|
||||
} else if (substr($errorTag['tag'], 0, 4) === 'api-') {
|
||||
$hasApiTag = true;
|
||||
|
||||
$tagLength = strlen($errorTag['tag']);
|
||||
if ($tagLength > $apiLength) {
|
||||
$apiLength = $tagLength;
|
||||
}
|
||||
|
||||
if (trim($words[($pos - 2)]) !== ''
|
||||
|| strpos($words[($pos - 2)], $this->currentFile->eolChar) === false
|
||||
|| trim($words[($pos - 3)]) === ''
|
||||
) {
|
||||
$error = 'There must be no blank line before the @%s tag in a function comment';
|
||||
$data = array($errorTag['tag']);
|
||||
$this->currentFile->addError($error, ($commentStart + $errorTag['line']), 'ApiTagSpacing', $data);
|
||||
}
|
||||
} else {
|
||||
$error = '@%s tag is not allowed in function comment';
|
||||
$data = array($errorTag['tag']);
|
||||
$this->currentFile->addWarning($error, ($commentStart + $errorTag['line']), 'TagNotAllowed', $data);
|
||||
}//end if
|
||||
}//end foreach
|
||||
|
||||
if ($hasApiTag === true) {
|
||||
// API tags must be the last tags in a function comment.
|
||||
$order = $this->commentParser->getTagOrders();
|
||||
$lastTag = array_pop($order);
|
||||
if ($lastTag !== 'api'
|
||||
&& substr($lastTag, 0, 4) !== 'api-'
|
||||
) {
|
||||
$error = 'The @api tags must be the last tags in a function comment';
|
||||
$this->currentFile->addError($error, $commentEnd, 'ApiNotLast');
|
||||
}
|
||||
|
||||
// Check API tag indenting.
|
||||
foreach ($unknownTags as $errorTag) {
|
||||
if ($errorTag['tag'] === 'api'
|
||||
|| substr($errorTag['tag'], 0, 4) === 'api-'
|
||||
) {
|
||||
$expected = ($apiLength - strlen($errorTag['tag']) + 1);
|
||||
$found = strlen($words[($errorTag['pos'] + 1)]);
|
||||
if ($found !== $expected) {
|
||||
$error = '@%s tag indented incorrectly; expected %s spaces but found %s';
|
||||
$data = array(
|
||||
$errorTag['tag'],
|
||||
$expected,
|
||||
$found,
|
||||
);
|
||||
$this->currentFile->addError($error, ($commentStart + $errorTag['line']), 'ApiTagIndent', $data);
|
||||
}
|
||||
}
|
||||
}
|
||||
}//end if
|
||||
|
||||
}//end processUnknownTags()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,68 @@
|
||||
<?php
|
||||
/**
|
||||
* Warns about the use of debug code.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Warns about the use of debug code.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_Debug_DebugCodeSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_DOUBLE_COLON);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, 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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$className = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
|
||||
if (strtolower($tokens[$className]['content']) === 'debug') {
|
||||
$method = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
|
||||
$error = 'Call to debug function Debug::%s() must be removed';
|
||||
$data = array($tokens[$method]['content']);
|
||||
$phpcsFile->addError($error, $stackPtr, 'Found', $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,77 @@
|
||||
<?php
|
||||
/**
|
||||
* Ensures that console is not used for function or var names.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ensures that console is not used for function or var names.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_Debug_FirebugConsoleSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array('JS');
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(
|
||||
T_STRING,
|
||||
T_PROPERTY,
|
||||
T_LABEL,
|
||||
T_OBJECT,
|
||||
);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
if (strtolower($tokens[$stackPtr]['content']) === 'console') {
|
||||
$error = 'Variables, functions and labels must not be named "console"; name may conflict with Firebug internal variable';
|
||||
$phpcsFile->addError($error, $stackPtr, 'ConflictFound');
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,94 @@
|
||||
<?php
|
||||
/**
|
||||
* Ensures this is not assigned to any other var but self.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ensures this is not assigned to any other var but self.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_Objects_AssignThisSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array('JS');
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_THIS);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Ignore this.something and other uses of "this" that are not
|
||||
// direct assignments.
|
||||
$next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
|
||||
if ($tokens[$next]['code'] !== T_SEMICOLON) {
|
||||
if ($tokens[$next]['line'] === $tokens[$stackPtr]['line']) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// Something must be assigned to "this".
|
||||
$prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
|
||||
if ($tokens[$prev]['code'] !== T_EQUAL) {
|
||||
return;
|
||||
}
|
||||
|
||||
// A variable needs to be assigned to "this".
|
||||
$prev = $phpcsFile->findPrevious(T_WHITESPACE, ($prev - 1), null, true);
|
||||
if ($tokens[$prev]['code'] !== T_STRING) {
|
||||
return;
|
||||
}
|
||||
|
||||
// We can only assign "this" to a var called "self".
|
||||
if ($tokens[$prev]['content'] !== 'self' && $tokens[$prev]['content'] !== '_self') {
|
||||
$error = 'Keyword "this" can only be assigned to a variable called "self" or "_self"';
|
||||
$phpcsFile->addError($error, $prev, 'NotSelf');
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,228 @@
|
||||
<?php
|
||||
/**
|
||||
* Ensures the create() method of widget types properly uses callbacks.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ensures the create() method of widget types properly uses callbacks.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_Objects_CreateWidgetTypeCallbackSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array('JS');
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_OBJECT);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$className = $tokens[$stackPtr]['content'];
|
||||
if (substr(strtolower($className), -10) !== 'widgettype') {
|
||||
return;
|
||||
}
|
||||
|
||||
// Search for a create method.
|
||||
$start = ($tokens[$stackPtr]['scope_opener'] + 1);
|
||||
$end = ($tokens[$stackPtr]['scope_closer'] - 1);
|
||||
$create = $phpcsFile->findNext(T_PROPERTY, $start, $end, null, 'create');
|
||||
if ($create === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$function = $phpcsFile->findNext(array(T_WHITESPACE, T_COLON), ($create + 1), null, true);
|
||||
if ($tokens[$function]['code'] !== T_FUNCTION) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$start = ($tokens[$function]['scope_opener'] + 1);
|
||||
$end = ($tokens[$function]['scope_closer'] - 1);
|
||||
|
||||
// Check that the first argument is called "callback".
|
||||
$arg = $phpcsFile->findNext(T_WHITESPACE, ($tokens[$function]['parenthesis_opener'] + 1), null, true);
|
||||
if ($tokens[$arg]['content'] !== 'callback') {
|
||||
$error = 'The first argument of the create() method of a widget type must be called "callback"';
|
||||
$phpcsFile->addError($error, $arg, 'FirstArgNotCallback');
|
||||
}
|
||||
|
||||
/*
|
||||
Look for return statements within the function. They cannot return
|
||||
anything and must be preceeded by the callback.call() line. The
|
||||
callback itself must contain "self" or "this" as the first argument
|
||||
and there needs to be a call to the callback function somewhere
|
||||
in the create method. All calls to the callback function must be
|
||||
followed by a return statement or the end of the method.
|
||||
*/
|
||||
|
||||
$foundCallback = false;
|
||||
$passedCallback = false;
|
||||
$nestedFunction = null;
|
||||
for ($i = $start; $i <= $end; $i++) {
|
||||
// Keep track of nested functions.
|
||||
if ($nestedFunction !== null) {
|
||||
if ($i === $nestedFunction) {
|
||||
$nestedFunction = null;
|
||||
continue;
|
||||
}
|
||||
} else if ($tokens[$i]['code'] === T_FUNCTION
|
||||
&& isset($tokens[$i]['scope_closer']) === true
|
||||
) {
|
||||
$nestedFunction = $tokens[$i]['scope_closer'];
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($nestedFunction === null && $tokens[$i]['code'] === T_RETURN) {
|
||||
// Make sure return statements are not returning anything.
|
||||
if ($tokens[($i + 1)]['code'] !== T_SEMICOLON) {
|
||||
$error = 'The create() method of a widget type must not return a value';
|
||||
$phpcsFile->addError($error, $i, 'ReturnValue');
|
||||
}
|
||||
|
||||
continue;
|
||||
} else if ($tokens[$i]['code'] !== T_STRING
|
||||
|| $tokens[$i]['content'] !== 'callback'
|
||||
) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// If this is the form "callback.call(" then it is a call
|
||||
// to the callback function.
|
||||
if ($tokens[($i + 1)]['code'] !== T_OBJECT_OPERATOR
|
||||
|| $tokens[($i + 2)]['content'] !== 'call'
|
||||
|| $tokens[($i + 3)]['code'] !== T_OPEN_PARENTHESIS
|
||||
) {
|
||||
// One last chance; this might be the callback function
|
||||
// being passed to another function, like this
|
||||
// "this.init(something, callback, something)".
|
||||
if (isset($tokens[$i]['nested_parenthesis']) === false) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Just make sure those brackets dont belong to anyone,
|
||||
// like an IF or FOR statement.
|
||||
foreach ($tokens[$i]['nested_parenthesis'] as $bracket) {
|
||||
if (isset($tokens[$bracket]['parenthesis_owner']) === true) {
|
||||
continue(2);
|
||||
}
|
||||
}
|
||||
|
||||
// Note that we use this endBracket down further when checking
|
||||
// for a RETURN statement.
|
||||
$endBracket = end($tokens[$i]['nested_parenthesis']);
|
||||
$bracket = key($tokens[$i]['nested_parenthesis']);
|
||||
|
||||
$prev = $phpcsFile->findPrevious(
|
||||
PHP_CodeSniffer_Tokens::$emptyTokens,
|
||||
($bracket - 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
if ($tokens[$prev]['code'] !== T_STRING) {
|
||||
// This is not a function passing the callback.
|
||||
continue;
|
||||
}
|
||||
|
||||
$passedCallback = true;
|
||||
}//end if
|
||||
|
||||
$foundCallback = true;
|
||||
|
||||
if ($passedCallback === false) {
|
||||
// The first argument must be "this" or "self".
|
||||
$arg = $phpcsFile->findNext(T_WHITESPACE, ($i + 4), null, true);
|
||||
if ($tokens[$arg]['content'] !== 'this'
|
||||
&& $tokens[$arg]['content'] !== 'self'
|
||||
) {
|
||||
$error = 'The first argument passed to the callback function must be "this" or "self"';
|
||||
$phpcsFile->addError($error, $arg, 'FirstArgNotSelf');
|
||||
}
|
||||
}
|
||||
|
||||
// Now it must be followed by a return statement or the end of the function.
|
||||
if ($passedCallback === false) {
|
||||
$endBracket = $tokens[($i + 3)]['parenthesis_closer'];
|
||||
}
|
||||
|
||||
for ($next = $endBracket; $next <= $end; $next++) {
|
||||
// Skip whitespace so we find the next content after the call.
|
||||
if (in_array($tokens[$next]['code'], PHP_CodeSniffer_Tokens::$emptyTokens) === true) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Skip closing braces like END IF because it is not executable code.
|
||||
if ($tokens[$next]['code'] === T_CLOSE_CURLY_BRACKET) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// We don't care about anything on the current line, like a
|
||||
// semicolon. It doesn't matter if there are other statements on the
|
||||
// line because another sniff will check for those.
|
||||
if ($tokens[$next]['line'] === $tokens[$endBracket]['line']) {
|
||||
continue;
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
if ($next !== $tokens[$function]['scope_closer']
|
||||
&& $tokens[$next]['code'] !== T_RETURN
|
||||
) {
|
||||
$error = 'The call to the callback function must be followed by a return statement if it is not the last statement in the create() method';
|
||||
$phpcsFile->addError($error, $i, 'NoReturn');
|
||||
}
|
||||
}//end for
|
||||
|
||||
if ($foundCallback === false) {
|
||||
$error = 'The create() method of a widget type must call the callback function';
|
||||
$phpcsFile->addError($error, $create, 'CallbackNotCalled');
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,72 @@
|
||||
<?php
|
||||
/**
|
||||
* Ensures that widgets are not manually created.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ensures that widgets are not manually created.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_Objects_DisallowNewWidgetSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_NEW);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$className = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
|
||||
if ($tokens[$className]['code'] !== T_STRING) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (substr(strtolower($tokens[$className]['content']), -10) === 'widgettype') {
|
||||
$widgetType = substr($tokens[$className]['content'], 0, -10);
|
||||
$error = 'Manual creation of widget objects is banned; use Widget::getWidget(\'%s\'); instead';
|
||||
$data = array($widgetType);
|
||||
$phpcsFile->addError($error, $stackPtr, 'Found', $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,126 @@
|
||||
<?php
|
||||
/**
|
||||
* Ensures that eval() is not used to create objects.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ensures that eval() is not used to create objects.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_PHP_EvalObjectFactorySniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_EVAL);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, 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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
/*
|
||||
We need to find all strings that will be in the eval
|
||||
to determine if the "new" keyword is being used.
|
||||
*/
|
||||
|
||||
$openBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($stackPtr + 1));
|
||||
$closeBracket = $tokens[$openBracket]['parenthesis_closer'];
|
||||
|
||||
$strings = array();
|
||||
$vars = array();
|
||||
|
||||
for ($i = ($openBracket + 1); $i < $closeBracket; $i++) {
|
||||
if (in_array($tokens[$i]['code'], PHP_CodeSniffer_Tokens::$stringTokens) === true) {
|
||||
$strings[$i] = $tokens[$i]['content'];
|
||||
} else if ($tokens[$i]['code'] === T_VARIABLE) {
|
||||
$vars[$i] = $tokens[$i]['content'];
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
We now have some variables that we need to expand into
|
||||
the strings that were assigned to them, if any.
|
||||
*/
|
||||
|
||||
foreach ($vars as $varPtr => $varName) {
|
||||
while (($prev = $phpcsFile->findPrevious(T_VARIABLE, ($varPtr - 1))) !== false) {
|
||||
// Make sure this is an assignment of the variable. That means
|
||||
// it will be the first thing on the line.
|
||||
$prevContent = $phpcsFile->findPrevious(T_WHITESPACE, ($prev - 1), null, true);
|
||||
if ($tokens[$prevContent]['line'] === $tokens[$prev]['line']) {
|
||||
$varPtr = $prevContent;
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($tokens[$prev]['content'] !== $varName) {
|
||||
// This variable has a different name.
|
||||
$varPtr = $prevContent;
|
||||
continue;
|
||||
}
|
||||
|
||||
// We found one.
|
||||
break;
|
||||
}//end while
|
||||
|
||||
if ($prev !== false) {
|
||||
// Find all strings on the line.
|
||||
$lineEnd = $phpcsFile->findNext(T_SEMICOLON, ($prev + 1));
|
||||
for ($i = ($prev + 1); $i < $lineEnd; $i++) {
|
||||
if (in_array($tokens[$i]['code'], PHP_CodeSniffer_Tokens::$stringTokens) === true) {
|
||||
$strings[$i] = $tokens[$i]['content'];
|
||||
}
|
||||
}
|
||||
}
|
||||
}//end foreach
|
||||
|
||||
foreach ($strings as $string) {
|
||||
// If the string has "new" in it, it is not allowed.
|
||||
// We don't bother checking if the word "new" is echo'd
|
||||
// because that is unlikely to happen. We assume the use
|
||||
// of "new" is for object instantiation.
|
||||
if (strstr($string, ' new ') !== false) {
|
||||
$error = 'Do not use eval() to create objects dynamically; use reflection instead';
|
||||
$phpcsFile->addWarning($error, $stackPtr, 'Found');
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,119 @@
|
||||
<?php
|
||||
/**
|
||||
* Ensures that getRequestData() is used to access super globals.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ensures that getRequestData() is used to access super globals.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_PHP_GetRequestDataSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_VARIABLE);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, 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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$varName = $tokens[$stackPtr]['content'];
|
||||
if ($varName !== '$_REQUEST'
|
||||
&& $varName !== '$_GET'
|
||||
&& $varName !== '$_POST'
|
||||
&& $varName !== '$_FILES'
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
// The only place these super globals can be accessed directly is
|
||||
// in the getRequestData() method of the Security class.
|
||||
$inClass = false;
|
||||
foreach ($tokens[$stackPtr]['conditions'] as $i => $type) {
|
||||
if ($tokens[$i]['code'] === T_CLASS) {
|
||||
$className = $phpcsFile->findNext(T_STRING, $i);
|
||||
$className = $tokens[$className]['content'];
|
||||
if (strtolower($className) === 'security') {
|
||||
$inClass = true;
|
||||
} else {
|
||||
// We don't have nested classes.
|
||||
break;
|
||||
}
|
||||
} else if ($inClass === true && $tokens[$i]['code'] === T_FUNCTION) {
|
||||
$funcName = $phpcsFile->findNext(T_STRING, $i);
|
||||
$funcName = $tokens[$funcName]['content'];
|
||||
if (strtolower($funcName) === 'getrequestdata') {
|
||||
// This is valid.
|
||||
return;
|
||||
} else {
|
||||
// We don't have nested functions.
|
||||
break;
|
||||
}
|
||||
}//end if
|
||||
}//end foreach
|
||||
|
||||
// If we get to here, the super global was used incorrectly.
|
||||
// First find out how it is being used.
|
||||
$globalName = strtolower(substr($varName, 2));
|
||||
$usedVar = '';
|
||||
|
||||
$openBracket = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
|
||||
if ($tokens[$openBracket]['code'] === T_OPEN_SQUARE_BRACKET) {
|
||||
$closeBracket = $tokens[$openBracket]['bracket_closer'];
|
||||
$usedVar = $phpcsFile->getTokensAsString(($openBracket + 1), ($closeBracket - $openBracket - 1));
|
||||
}
|
||||
|
||||
$type = 'SuperglobalAccessed';
|
||||
$error = 'The %s super global must not be accessed directly; use Security::getRequestData(';
|
||||
$data = array($varName);
|
||||
if ($usedVar !== '') {
|
||||
$type .= 'WithVar';
|
||||
$error .= '%s, \'%s\'';
|
||||
$data[] = $usedVar;
|
||||
$data[] = $globalName;
|
||||
}
|
||||
|
||||
$error .= ') instead';
|
||||
$phpcsFile->addError($error, $stackPtr, $type, $data);
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,76 @@
|
||||
<?php
|
||||
/**
|
||||
* Warns when function values are returned directly.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Warns when function values are returned directly.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_PHP_ReturnFunctionValueSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_RETURN);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, 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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$functionName = $phpcsFile->findNext(T_STRING, ($stackPtr + 1), null, false, null, true);
|
||||
|
||||
while ($functionName !== false) {
|
||||
// Check if this is really a function.
|
||||
$bracket = $phpcsFile->findNext(T_WHITESPACE, ($functionName + 1), null, true);
|
||||
if ($tokens[$bracket]['code'] !== T_OPEN_PARENTHESIS) {
|
||||
// Not a function call.
|
||||
$functionName = $phpcsFile->findNext(T_STRING, ($functionName + 1), null, false, null, true);
|
||||
continue;
|
||||
}
|
||||
|
||||
$error = 'The result of a function call should be assigned to a variable before being returned';
|
||||
$phpcsFile->addWarning($error, $stackPtr, 'NotAssigned');
|
||||
break;
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,88 @@
|
||||
<?php
|
||||
/**
|
||||
* Ensures that strings are not joined using array.join().
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ensures that strings are not joined using array.join().
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer_MySource
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class MySource_Sniffs_Strings_JoinStringsSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array('JS');
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_STRING);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this test, when one of its tokens is encountered.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
||||
* @param integer $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 ($tokens[$stackPtr]['content'] !== 'join') {
|
||||
return;
|
||||
}
|
||||
|
||||
$prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
|
||||
if ($tokens[$prev]['code'] !== T_OBJECT_OPERATOR) {
|
||||
return;
|
||||
}
|
||||
|
||||
$prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($prev - 1), null, true);
|
||||
if ($tokens[$prev]['code'] === T_CLOSE_SQUARE_BRACKET) {
|
||||
$opener = $tokens[$prev]['bracket_opener'];
|
||||
if ($tokens[($opener - 1)]['code'] !== T_STRING) {
|
||||
// This means the array is declared inline, like x = [a,b,c].join()
|
||||
// and not elsewhere, like x = y[a].join()
|
||||
// The first is not allowed while the second is.
|
||||
$error = 'Joining strings using inline arrays is not allowed; use the + operator instead';
|
||||
$phpcsFile->addError($error, $stackPtr, 'ArrayNotAllowed');
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,15 @@
|
||||
<?xml version="1.0"?>
|
||||
<ruleset name="MySource">
|
||||
<description>The MySource coding standard builds on the Squiz coding standard. Currently used for MySource Mini development.</description>
|
||||
|
||||
<exclude-pattern>*/Tests/*</exclude-pattern>
|
||||
<exclude-pattern>*/Oven/*</exclude-pattern>
|
||||
<exclude-pattern>*/data/*</exclude-pattern>
|
||||
<exclude-pattern>DALConf.inc</exclude-pattern>
|
||||
|
||||
<!-- Include the whole Squiz standard except FunctionComment, which we override -->
|
||||
<rule ref="Squiz">
|
||||
<exclude name="Squiz.Commenting.FunctionComment"/>
|
||||
</rule>
|
||||
|
||||
</ruleset>
|
||||
@@ -0,0 +1,24 @@
|
||||
<documentation title="Including Code">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Anywhere you are unconditionally including a class file, use <em>require_once</em>. Anywhere you are conditionally including a class file (for example, factory methods), use <em>include_once</em>. Either of these will ensure that class files are included only once. They share the same file list, so you don't need to worry about mixing them - a file included with <em>require_once</em> will not be included again by <em>include_once</em>.
|
||||
]]>
|
||||
</standard>
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Note that <em>include_once</em> and <em>require_once</em> are statements, not functions. Parentheses should not surround the subject filename.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: used as statement">
|
||||
<![CDATA[
|
||||
require_once 'PHP/CodeSniffer.php';
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: used as function">
|
||||
<![CDATA[
|
||||
require_once<em>(</em>'PHP/CodeSniffer.php'<em>)</em>;
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,7 @@
|
||||
<documentation title="Line Length">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
It is recommended to keep lines at approximately 85 characters long for better code readability.
|
||||
]]>
|
||||
</standard>
|
||||
</documentation>
|
||||
@@ -0,0 +1,19 @@
|
||||
<documentation title="Function Calls">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Functions should be called with no spaces between the function name, the opening parenthesis, and the first parameter; and no space between the last parameter, the closing parenthesis, and the semicolon.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: spaces between parameters">
|
||||
<![CDATA[
|
||||
$var = foo($bar, $baz, $quux);
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: additional spaces used">
|
||||
<![CDATA[
|
||||
$var = foo<em> </em>(<em> </em>$bar, $baz, $quux<em> </em>)<em> </em>;
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,25 @@
|
||||
<documentation title="Default Values in Function Declarations">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Arguments with default values go at the end of the argument list.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: argument with default value at end of declaration">
|
||||
<![CDATA[
|
||||
function connect($dsn, <em>$persistent = false</em>)
|
||||
{
|
||||
...
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: argument with default value at start of declaration">
|
||||
<![CDATA[
|
||||
function connect(<em>$persistent = false</em>, $dsn)
|
||||
{
|
||||
...
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,23 @@
|
||||
<documentation title="Class Names">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Classes should be given descriptive names. Avoid using abbreviations where possible. Class names should always begin with an uppercase letter. The PEAR class hierarchy is also reflected in the class name, each level of the hierarchy separated with a single underscore.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Examples of valid class names">
|
||||
<![CDATA[
|
||||
Log
|
||||
Net_Finger
|
||||
HTML_Upload_Error
|
||||
]]>
|
||||
</code>
|
||||
<code title="Examples of invalid class names">
|
||||
<![CDATA[
|
||||
log
|
||||
NetFinger
|
||||
HTML-Upload-Error
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,23 @@
|
||||
<documentation title="Function and Method Names">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Functions and methods should be named using the "studly caps" style (also referred to as "bumpy case" or "camel caps"). Functions should in addition have the package name as a prefix, to avoid name collisions between packages. The initial letter of the name (after the prefix) is lowercase, and each letter that starts a new "word" is capitalized.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Examples of valid function names">
|
||||
<![CDATA[
|
||||
connect()
|
||||
getData()
|
||||
buildSomeWidget()
|
||||
XML_RPC_serializeData()
|
||||
]]>
|
||||
</code>
|
||||
<code title="Examples of invalid function names">
|
||||
<![CDATA[
|
||||
Connect()
|
||||
get_data()
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,125 @@
|
||||
<?php
|
||||
/**
|
||||
* Class Declaration Test.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Class Declaration Test.
|
||||
*
|
||||
* Checks the declaration of the class is correct.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_Classes_ClassDeclarationSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* The number of spaces code should be indented.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
public $indent = 4;
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(
|
||||
T_CLASS,
|
||||
T_INTERFACE,
|
||||
);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this test, when one of its tokens is encountered.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
||||
* @param integer $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();
|
||||
$errorData = array($tokens[$stackPtr]['content']);
|
||||
|
||||
if (isset($tokens[$stackPtr]['scope_opener']) === false) {
|
||||
$error = 'Possible parse error: %s missing opening or closing brace';
|
||||
$phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $errorData);
|
||||
return;
|
||||
}
|
||||
|
||||
$curlyBrace = $tokens[$stackPtr]['scope_opener'];
|
||||
$lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($curlyBrace - 1), $stackPtr, true);
|
||||
$classLine = $tokens[$lastContent]['line'];
|
||||
$braceLine = $tokens[$curlyBrace]['line'];
|
||||
if ($braceLine === $classLine) {
|
||||
$error = 'Opening brace of a %s must be on the line after the definition';
|
||||
$phpcsFile->addError($error, $curlyBrace, 'OpenBraceNewLine', $errorData);
|
||||
return;
|
||||
} else if ($braceLine > ($classLine + 1)) {
|
||||
$error = 'Opening brace of a %s must be on the line following the %s declaration; found %s line(s)';
|
||||
$data = array(
|
||||
$tokens[$stackPtr]['content'],
|
||||
$tokens[$stackPtr]['content'],
|
||||
($braceLine - $classLine - 1),
|
||||
);
|
||||
$phpcsFile->addError($error, $curlyBrace, 'OpenBraceWrongLine', $data);
|
||||
return;
|
||||
}
|
||||
|
||||
if ($tokens[($curlyBrace + 1)]['content'] !== $phpcsFile->eolChar) {
|
||||
$error = 'Opening %s brace must be on a line by itself';
|
||||
$phpcsFile->addError($error, $curlyBrace, 'OpenBraceNotAlone', $errorData);
|
||||
}
|
||||
|
||||
if ($tokens[($curlyBrace - 1)]['code'] === T_WHITESPACE) {
|
||||
$prevContent = $tokens[($curlyBrace - 1)]['content'];
|
||||
if ($prevContent === $phpcsFile->eolChar) {
|
||||
$spaces = 0;
|
||||
} else {
|
||||
$blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar));
|
||||
$spaces = strlen($blankSpace);
|
||||
}
|
||||
|
||||
$expected = ($tokens[$stackPtr]['level'] * $this->indent);
|
||||
if ($spaces !== $expected) {
|
||||
$error = 'Expected %s spaces before opening brace; %s found';
|
||||
$data = array(
|
||||
$expected,
|
||||
$spaces,
|
||||
);
|
||||
$phpcsFile->addError($error, $curlyBrace, 'SpaceBeforeBrace', $data);
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,233 @@
|
||||
<?php
|
||||
/**
|
||||
* Parses and verifies the doc comments for classes.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
if (class_exists('PHP_CodeSniffer_CommentParser_ClassCommentParser', true) === false) {
|
||||
$error = 'Class PHP_CodeSniffer_CommentParser_ClassCommentParser not found';
|
||||
throw new PHP_CodeSniffer_Exception($error);
|
||||
}
|
||||
|
||||
if (class_exists('PEAR_Sniffs_Commenting_FileCommentSniff', true) === false) {
|
||||
$error = 'Class PEAR_Sniffs_Commenting_FileCommentSniff not found';
|
||||
throw new PHP_CodeSniffer_Exception($error);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses and verifies the doc comments for classes.
|
||||
*
|
||||
* Verifies that :
|
||||
* <ul>
|
||||
* <li>A doc comment exists.</li>
|
||||
* <li>There is a blank newline after the short description.</li>
|
||||
* <li>There is a blank newline between the long and short description.</li>
|
||||
* <li>There is a blank newline between the long description and tags.</li>
|
||||
* <li>Check the order of the tags.</li>
|
||||
* <li>Check the indentation of each tag.</li>
|
||||
* <li>Check required and optional tags and the format of their content.</li>
|
||||
* </ul>
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_Commenting_ClassCommentSniff extends PEAR_Sniffs_Commenting_FileCommentSniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(
|
||||
T_CLASS,
|
||||
T_INTERFACE,
|
||||
);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$this->currentFile = $phpcsFile;
|
||||
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$type = strtolower($tokens[$stackPtr]['content']);
|
||||
$errorData = array($type);
|
||||
$find = array(
|
||||
T_ABSTRACT,
|
||||
T_WHITESPACE,
|
||||
T_FINAL,
|
||||
);
|
||||
|
||||
// Extract the class comment docblock.
|
||||
$commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);
|
||||
|
||||
if ($commentEnd !== false && $tokens[$commentEnd]['code'] === T_COMMENT) {
|
||||
$error = 'You must use "/**" style comments for a %s comment';
|
||||
$phpcsFile->addError($error, $stackPtr, 'WrongStyle', $errorData);
|
||||
return;
|
||||
} else if ($commentEnd === false
|
||||
|| $tokens[$commentEnd]['code'] !== T_DOC_COMMENT
|
||||
) {
|
||||
$phpcsFile->addError('Missing %s doc comment', $stackPtr, 'Missing', $errorData);
|
||||
return;
|
||||
}
|
||||
|
||||
$commentStart = ($phpcsFile->findPrevious(T_DOC_COMMENT, ($commentEnd - 1), null, true) + 1);
|
||||
$commentNext = $phpcsFile->findPrevious(T_WHITESPACE, ($commentEnd + 1), $stackPtr, false, $phpcsFile->eolChar);
|
||||
|
||||
// Distinguish file and class comment.
|
||||
$prevClassToken = $phpcsFile->findPrevious(T_CLASS, ($stackPtr - 1));
|
||||
if ($prevClassToken === false) {
|
||||
// This is the first class token in this file, need extra checks.
|
||||
$prevNonComment = $phpcsFile->findPrevious(T_DOC_COMMENT, ($commentStart - 1), null, true);
|
||||
if ($prevNonComment !== false) {
|
||||
$prevComment = $phpcsFile->findPrevious(T_DOC_COMMENT, ($prevNonComment - 1));
|
||||
if ($prevComment === false) {
|
||||
// There is only 1 doc comment between open tag and class token.
|
||||
$newlineToken = $phpcsFile->findNext(T_WHITESPACE, ($commentEnd + 1), $stackPtr, false, $phpcsFile->eolChar);
|
||||
if ($newlineToken !== false) {
|
||||
$newlineToken = $phpcsFile->findNext(
|
||||
T_WHITESPACE,
|
||||
($newlineToken + 1),
|
||||
$stackPtr,
|
||||
false,
|
||||
$phpcsFile->eolChar
|
||||
);
|
||||
|
||||
if ($newlineToken !== false) {
|
||||
// Blank line between the class and the doc block.
|
||||
// The doc block is most likely a file comment.
|
||||
$error = 'Missing %s doc comment';
|
||||
$phpcsFile->addError($error, ($stackPtr + 1), 'Missing', $errorData);
|
||||
return;
|
||||
}
|
||||
}//end if
|
||||
}//end if
|
||||
}//end if
|
||||
}//end if
|
||||
|
||||
$comment = $phpcsFile->getTokensAsString(
|
||||
$commentStart,
|
||||
($commentEnd - $commentStart + 1)
|
||||
);
|
||||
|
||||
// Parse the class comment.docblock.
|
||||
try {
|
||||
$this->commentParser = new PHP_CodeSniffer_CommentParser_ClassCommentParser($comment, $phpcsFile);
|
||||
$this->commentParser->parse();
|
||||
} catch (PHP_CodeSniffer_CommentParser_ParserException $e) {
|
||||
$line = ($e->getLineWithinComment() + $commentStart);
|
||||
$phpcsFile->addError($e->getMessage(), $line, 'FailedParse');
|
||||
return;
|
||||
}
|
||||
|
||||
$comment = $this->commentParser->getComment();
|
||||
if (is_null($comment) === true) {
|
||||
$error = 'Doc comment is empty for %s';
|
||||
$phpcsFile->addError($error, $commentStart, 'Empty', $errorData);
|
||||
return;
|
||||
}
|
||||
|
||||
// No extra newline before short description.
|
||||
$short = $comment->getShortComment();
|
||||
$newlineCount = 0;
|
||||
$newlineSpan = strspn($short, $phpcsFile->eolChar);
|
||||
if ($short !== '' && $newlineSpan > 0) {
|
||||
$error = 'Extra newline(s) found before %s comment short description';
|
||||
$phpcsFile->addError($error, ($commentStart + 1), 'SpacingBeforeShort', $errorData);
|
||||
}
|
||||
|
||||
$newlineCount = (substr_count($short, $phpcsFile->eolChar) + 1);
|
||||
|
||||
// Exactly one blank line between short and long description.
|
||||
$long = $comment->getLongComment();
|
||||
if (empty($long) === false) {
|
||||
$between = $comment->getWhiteSpaceBetween();
|
||||
$newlineBetween = substr_count($between, $phpcsFile->eolChar);
|
||||
if ($newlineBetween !== 2) {
|
||||
$error = 'There must be exactly one blank line between descriptions in %s comments';
|
||||
$phpcsFile->addError($error, ($commentStart + $newlineCount + 1), 'SpacingAfterShort', $errorData);
|
||||
}
|
||||
|
||||
$newlineCount += $newlineBetween;
|
||||
}
|
||||
|
||||
// Exactly one blank line before tags.
|
||||
$tags = $this->commentParser->getTagOrders();
|
||||
if (count($tags) > 1) {
|
||||
$newlineSpan = $comment->getNewlineAfter();
|
||||
if ($newlineSpan !== 2) {
|
||||
$error = 'There must be exactly one blank line before the tags in %s comments';
|
||||
if ($long !== '') {
|
||||
$newlineCount += (substr_count($long, $phpcsFile->eolChar) - $newlineSpan + 1);
|
||||
}
|
||||
|
||||
$phpcsFile->addError($error, ($commentStart + $newlineCount), 'SpacingBeforeTags', $errorData);
|
||||
$short = rtrim($short, $phpcsFile->eolChar.' ');
|
||||
}
|
||||
}
|
||||
|
||||
// Check each tag.
|
||||
$this->processTags($commentStart, $commentEnd);
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
/**
|
||||
* Process the version tag.
|
||||
*
|
||||
* @param int $errorPos The line number where the error occurs.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processVersion($errorPos)
|
||||
{
|
||||
$version = $this->commentParser->getVersion();
|
||||
if ($version !== null) {
|
||||
$content = $version->getContent();
|
||||
$matches = array();
|
||||
if (empty($content) === true) {
|
||||
$error = 'Content missing for @version tag in doc comment';
|
||||
$this->currentFile->addError($error, $errorPos, 'EmptyVersion');
|
||||
} else if ((strstr($content, 'Release:') === false)) {
|
||||
$error = 'Invalid version "%s" in doc comment; consider "Release: <package_version>" instead';
|
||||
$data = array($content);
|
||||
$this->currentFile->addWarning($error, $errorPos, 'InvalidVersion', $data);
|
||||
}
|
||||
}
|
||||
|
||||
}//end processVersion()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,791 @@
|
||||
<?php
|
||||
/**
|
||||
* Parses and verifies the doc comments for files.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
if (class_exists('PHP_CodeSniffer_CommentParser_ClassCommentParser', true) === false) {
|
||||
throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_CommentParser_ClassCommentParser not found');
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses and verifies the doc comments for files.
|
||||
*
|
||||
* Verifies that :
|
||||
* <ul>
|
||||
* <li>A doc comment exists.</li>
|
||||
* <li>There is a blank newline after the short description.</li>
|
||||
* <li>There is a blank newline between the long and short description.</li>
|
||||
* <li>There is a blank newline between the long description and tags.</li>
|
||||
* <li>A PHP version is specified.</li>
|
||||
* <li>Check the order of the tags.</li>
|
||||
* <li>Check the indentation of each tag.</li>
|
||||
* <li>Check required and optional tags and the format of their content.</li>
|
||||
* </ul>
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
class PEAR_Sniffs_Commenting_FileCommentSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* The header comment parser for the current file.
|
||||
*
|
||||
* @var PHP_CodeSniffer_Comment_Parser_ClassCommentParser
|
||||
*/
|
||||
protected $commentParser = null;
|
||||
|
||||
/**
|
||||
* The current PHP_CodeSniffer_File object we are processing.
|
||||
*
|
||||
* @var PHP_CodeSniffer_File
|
||||
*/
|
||||
protected $currentFile = null;
|
||||
|
||||
/**
|
||||
* Tags in correct order and related info.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $tags = array(
|
||||
'category' => array(
|
||||
'required' => true,
|
||||
'allow_multiple' => false,
|
||||
'order_text' => 'precedes @package',
|
||||
),
|
||||
'package' => array(
|
||||
'required' => true,
|
||||
'allow_multiple' => false,
|
||||
'order_text' => 'follows @category',
|
||||
),
|
||||
'subpackage' => array(
|
||||
'required' => false,
|
||||
'allow_multiple' => false,
|
||||
'order_text' => 'follows @package',
|
||||
),
|
||||
'author' => array(
|
||||
'required' => true,
|
||||
'allow_multiple' => true,
|
||||
'order_text' => 'follows @subpackage (if used) or @package',
|
||||
),
|
||||
'copyright' => array(
|
||||
'required' => false,
|
||||
'allow_multiple' => true,
|
||||
'order_text' => 'follows @author',
|
||||
),
|
||||
'license' => array(
|
||||
'required' => true,
|
||||
'allow_multiple' => false,
|
||||
'order_text' => 'follows @copyright (if used) or @author',
|
||||
),
|
||||
'version' => array(
|
||||
'required' => false,
|
||||
'allow_multiple' => false,
|
||||
'order_text' => 'follows @license',
|
||||
),
|
||||
'link' => array(
|
||||
'required' => true,
|
||||
'allow_multiple' => true,
|
||||
'order_text' => 'follows @version',
|
||||
),
|
||||
'see' => array(
|
||||
'required' => false,
|
||||
'allow_multiple' => true,
|
||||
'order_text' => 'follows @link',
|
||||
),
|
||||
'since' => array(
|
||||
'required' => false,
|
||||
'allow_multiple' => false,
|
||||
'order_text' => 'follows @see (if used) or @link',
|
||||
),
|
||||
'deprecated' => array(
|
||||
'required' => false,
|
||||
'allow_multiple' => false,
|
||||
'order_text' => 'follows @since (if used) or @see (if used) or @link',
|
||||
),
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_OPEN_TAG);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$this->currentFile = $phpcsFile;
|
||||
|
||||
// We are only interested if this is the first open tag.
|
||||
if ($stackPtr !== 0) {
|
||||
if ($phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)) !== false) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Find the next non whitespace token.
|
||||
$commentStart
|
||||
= $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
|
||||
|
||||
// Allow declare() statements at the top of the file.
|
||||
if ($tokens[$commentStart]['code'] === T_DECLARE) {
|
||||
$semicolon = $phpcsFile->findNext(T_SEMICOLON, ($commentStart + 1));
|
||||
$commentStart
|
||||
= $phpcsFile->findNext(T_WHITESPACE, ($semicolon + 1), null, true);
|
||||
}
|
||||
|
||||
// Ignore vim header.
|
||||
if ($tokens[$commentStart]['code'] === T_COMMENT) {
|
||||
if (strstr($tokens[$commentStart]['content'], 'vim:') !== false) {
|
||||
$commentStart = $phpcsFile->findNext(
|
||||
T_WHITESPACE,
|
||||
($commentStart + 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
$errorToken = ($stackPtr + 1);
|
||||
if (isset($tokens[$errorToken]) === false) {
|
||||
$errorToken--;
|
||||
}
|
||||
|
||||
if ($tokens[$commentStart]['code'] === T_CLOSE_TAG) {
|
||||
// We are only interested if this is the first open tag.
|
||||
return;
|
||||
} else if ($tokens[$commentStart]['code'] === T_COMMENT) {
|
||||
$error = 'You must use "/**" style comments for a file comment';
|
||||
$phpcsFile->addError($error, $errorToken, 'WrongStyle');
|
||||
return;
|
||||
} else if ($commentStart === false
|
||||
|| $tokens[$commentStart]['code'] !== T_DOC_COMMENT
|
||||
) {
|
||||
$phpcsFile->addError('Missing file doc comment', $errorToken, 'Missing');
|
||||
return;
|
||||
} else {
|
||||
|
||||
// Extract the header comment docblock.
|
||||
$commentEnd = $phpcsFile->findNext(
|
||||
T_DOC_COMMENT,
|
||||
($commentStart + 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
$commentEnd--;
|
||||
|
||||
// Check if there is only 1 doc comment between the
|
||||
// open tag and class token.
|
||||
$nextToken = array(
|
||||
T_ABSTRACT,
|
||||
T_CLASS,
|
||||
T_FUNCTION,
|
||||
T_DOC_COMMENT,
|
||||
);
|
||||
|
||||
$commentNext = $phpcsFile->findNext($nextToken, ($commentEnd + 1));
|
||||
if ($commentNext !== false
|
||||
&& $tokens[$commentNext]['code'] !== T_DOC_COMMENT
|
||||
) {
|
||||
// Found a class token right after comment doc block.
|
||||
$newlineToken = $phpcsFile->findNext(
|
||||
T_WHITESPACE,
|
||||
($commentEnd + 1),
|
||||
$commentNext,
|
||||
false,
|
||||
$phpcsFile->eolChar
|
||||
);
|
||||
|
||||
if ($newlineToken !== false) {
|
||||
$newlineToken = $phpcsFile->findNext(
|
||||
T_WHITESPACE,
|
||||
($newlineToken + 1),
|
||||
$commentNext,
|
||||
false,
|
||||
$phpcsFile->eolChar
|
||||
);
|
||||
|
||||
if ($newlineToken === false) {
|
||||
// No blank line between the class token and the doc block.
|
||||
// The doc block is most likely a class comment.
|
||||
$error = 'Missing file doc comment';
|
||||
$phpcsFile->addError($error, $errorToken, 'Missing');
|
||||
return;
|
||||
}
|
||||
}
|
||||
}//end if
|
||||
|
||||
$comment = $phpcsFile->getTokensAsString(
|
||||
$commentStart,
|
||||
($commentEnd - $commentStart + 1)
|
||||
);
|
||||
|
||||
// Parse the header comment docblock.
|
||||
try {
|
||||
$this->commentParser = new PHP_CodeSniffer_CommentParser_ClassCommentParser($comment, $phpcsFile);
|
||||
$this->commentParser->parse();
|
||||
} catch (PHP_CodeSniffer_CommentParser_ParserException $e) {
|
||||
$line = ($e->getLineWithinComment() + $commentStart);
|
||||
$phpcsFile->addError($e->getMessage(), $line, 'FailedParse');
|
||||
return;
|
||||
}
|
||||
|
||||
$comment = $this->commentParser->getComment();
|
||||
if (is_null($comment) === true) {
|
||||
$error = 'File doc comment is empty';
|
||||
$phpcsFile->addError($error, $commentStart, 'Empty');
|
||||
return;
|
||||
}
|
||||
|
||||
// No extra newline before short description.
|
||||
$short = $comment->getShortComment();
|
||||
$newlineCount = 0;
|
||||
$newlineSpan = strspn($short, $phpcsFile->eolChar);
|
||||
if ($short !== '' && $newlineSpan > 0) {
|
||||
$error = 'Extra newline(s) found before file comment short description';
|
||||
$phpcsFile->addError($error, ($commentStart + 1), 'SpacingBefore');
|
||||
}
|
||||
|
||||
$newlineCount = (substr_count($short, $phpcsFile->eolChar) + 1);
|
||||
|
||||
// Exactly one blank line between short and long description.
|
||||
$long = $comment->getLongComment();
|
||||
if (empty($long) === false) {
|
||||
$between = $comment->getWhiteSpaceBetween();
|
||||
$newlineBetween = substr_count($between, $phpcsFile->eolChar);
|
||||
if ($newlineBetween !== 2) {
|
||||
$error = 'There must be exactly one blank line between descriptions in file comment';
|
||||
$phpcsFile->addError($error, ($commentStart + $newlineCount + 1), 'DescriptionSpacing');
|
||||
}
|
||||
|
||||
$newlineCount += $newlineBetween;
|
||||
}
|
||||
|
||||
// Exactly one blank line before tags.
|
||||
$tags = $this->commentParser->getTagOrders();
|
||||
if (count($tags) > 1) {
|
||||
$newlineSpan = $comment->getNewlineAfter();
|
||||
if ($newlineSpan !== 2) {
|
||||
$error = 'There must be exactly one blank line before the tags in file comment';
|
||||
if ($long !== '') {
|
||||
$newlineCount += (substr_count($long, $phpcsFile->eolChar) - $newlineSpan + 1);
|
||||
}
|
||||
|
||||
$phpcsFile->addError($error, ($commentStart + $newlineCount), 'SpacingBeforeTags');
|
||||
$short = rtrim($short, $phpcsFile->eolChar.' ');
|
||||
}
|
||||
}
|
||||
|
||||
// Check the PHP Version.
|
||||
$this->processPHPVersion($commentStart, $commentEnd, $long);
|
||||
|
||||
// Check each tag.
|
||||
$this->processTags($commentStart, $commentEnd);
|
||||
}//end if
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
/**
|
||||
* Check that the PHP version is specified.
|
||||
*
|
||||
* @param int $commentStart Position in the stack where the comment started.
|
||||
* @param int $commentEnd Position in the stack where the comment ended.
|
||||
* @param string $commentText The text of the function comment.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processPHPVersion($commentStart, $commentEnd, $commentText)
|
||||
{
|
||||
if (strstr(strtolower($commentText), 'php version') === false) {
|
||||
$error = 'PHP version not specified';
|
||||
$this->currentFile->addWarning($error, $commentEnd, 'MissingVersion');
|
||||
}
|
||||
|
||||
}//end processPHPVersion()
|
||||
|
||||
|
||||
/**
|
||||
* Processes each required or optional tag.
|
||||
*
|
||||
* @param int $commentStart Position in the stack where the comment started.
|
||||
* @param int $commentEnd Position in the stack where the comment ended.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processTags($commentStart, $commentEnd)
|
||||
{
|
||||
$docBlock = (get_class($this) === 'PEAR_Sniffs_Commenting_FileCommentSniff') ? 'file' : 'class';
|
||||
$foundTags = $this->commentParser->getTagOrders();
|
||||
$orderIndex = 0;
|
||||
$indentation = array();
|
||||
$longestTag = 0;
|
||||
$errorPos = 0;
|
||||
|
||||
foreach ($this->tags as $tag => $info) {
|
||||
|
||||
// Required tag missing.
|
||||
if ($info['required'] === true && in_array($tag, $foundTags) === false) {
|
||||
$error = 'Missing @%s tag in %s comment';
|
||||
$data = array(
|
||||
$tag,
|
||||
$docBlock,
|
||||
);
|
||||
$this->currentFile->addError($error, $commentEnd, 'MissingTag', $data);
|
||||
continue;
|
||||
}
|
||||
|
||||
// Get the line number for current tag.
|
||||
$tagName = ucfirst($tag);
|
||||
if ($info['allow_multiple'] === true) {
|
||||
$tagName .= 's';
|
||||
}
|
||||
|
||||
$getMethod = 'get'.$tagName;
|
||||
$tagElement = $this->commentParser->$getMethod();
|
||||
if (is_null($tagElement) === true || empty($tagElement) === true) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$errorPos = $commentStart;
|
||||
if (is_array($tagElement) === false) {
|
||||
$errorPos = ($commentStart + $tagElement->getLine());
|
||||
}
|
||||
|
||||
// Get the tag order.
|
||||
$foundIndexes = array_keys($foundTags, $tag);
|
||||
|
||||
if (count($foundIndexes) > 1) {
|
||||
// Multiple occurance not allowed.
|
||||
if ($info['allow_multiple'] === false) {
|
||||
$error = 'Only 1 @%s tag is allowed in a %s comment';
|
||||
$data = array(
|
||||
$tag,
|
||||
$docBlock,
|
||||
);
|
||||
$this->currentFile->addError($error, $errorPos, 'DuplicateTag', $data);
|
||||
} else {
|
||||
// Make sure same tags are grouped together.
|
||||
$i = 0;
|
||||
$count = $foundIndexes[0];
|
||||
foreach ($foundIndexes as $index) {
|
||||
if ($index !== $count) {
|
||||
$errorPosIndex
|
||||
= ($errorPos + $tagElement[$i]->getLine());
|
||||
$error = '@%s tags must be grouped together';
|
||||
$data = array($tag);
|
||||
$this->currentFile->addError($error, $errorPosIndex, 'TagsNotGrouped', $data);
|
||||
}
|
||||
|
||||
$i++;
|
||||
$count++;
|
||||
}
|
||||
}
|
||||
}//end if
|
||||
|
||||
// Check tag order.
|
||||
if ($foundIndexes[0] > $orderIndex) {
|
||||
$orderIndex = $foundIndexes[0];
|
||||
} else {
|
||||
if (is_array($tagElement) === true && empty($tagElement) === false) {
|
||||
$errorPos += $tagElement[0]->getLine();
|
||||
}
|
||||
|
||||
$error = 'The @%s tag is in the wrong order; the tag %s';
|
||||
$data = array(
|
||||
$tag,
|
||||
$info['order_text'],
|
||||
);
|
||||
$this->currentFile->addError($error, $errorPos, 'WrongTagOrder', $data);
|
||||
}
|
||||
|
||||
// Store the indentation for checking.
|
||||
$len = strlen($tag);
|
||||
if ($len > $longestTag) {
|
||||
$longestTag = $len;
|
||||
}
|
||||
|
||||
if (is_array($tagElement) === true) {
|
||||
foreach ($tagElement as $key => $element) {
|
||||
$indentation[] = array(
|
||||
'tag' => $tag,
|
||||
'space' => $this->getIndentation($tag, $element),
|
||||
'line' => $element->getLine(),
|
||||
);
|
||||
}
|
||||
} else {
|
||||
$indentation[] = array(
|
||||
'tag' => $tag,
|
||||
'space' => $this->getIndentation($tag, $tagElement),
|
||||
);
|
||||
}
|
||||
|
||||
$method = 'process'.$tagName;
|
||||
if (method_exists($this, $method) === true) {
|
||||
// Process each tag if a method is defined.
|
||||
call_user_func(array($this, $method), $errorPos);
|
||||
} else {
|
||||
if (is_array($tagElement) === true) {
|
||||
foreach ($tagElement as $key => $element) {
|
||||
$element->process(
|
||||
$this->currentFile,
|
||||
$commentStart,
|
||||
$docBlock
|
||||
);
|
||||
}
|
||||
} else {
|
||||
$tagElement->process(
|
||||
$this->currentFile,
|
||||
$commentStart,
|
||||
$docBlock
|
||||
);
|
||||
}
|
||||
}
|
||||
}//end foreach
|
||||
|
||||
foreach ($indentation as $indentInfo) {
|
||||
if ($indentInfo['space'] !== 0
|
||||
&& $indentInfo['space'] !== ($longestTag + 1)
|
||||
) {
|
||||
$expected = (($longestTag - strlen($indentInfo['tag'])) + 1);
|
||||
$space = ($indentInfo['space'] - strlen($indentInfo['tag']));
|
||||
$error = '@%s tag comment indented incorrectly; expected %s spaces but found %s';
|
||||
$data = array(
|
||||
$indentInfo['tag'],
|
||||
$expected,
|
||||
$space,
|
||||
);
|
||||
|
||||
$getTagMethod = 'get'.ucfirst($indentInfo['tag']);
|
||||
|
||||
if ($this->tags[$indentInfo['tag']]['allow_multiple'] === true) {
|
||||
$line = $indentInfo['line'];
|
||||
} else {
|
||||
$tagElem = $this->commentParser->$getTagMethod();
|
||||
$line = $tagElem->getLine();
|
||||
}
|
||||
|
||||
$this->currentFile->addError($error, ($commentStart + $line), 'TagIndent', $data);
|
||||
}
|
||||
}
|
||||
|
||||
}//end processTags()
|
||||
|
||||
|
||||
/**
|
||||
* Get the indentation information of each tag.
|
||||
*
|
||||
* @param string $tagName The name of the
|
||||
* doc comment
|
||||
* element.
|
||||
* @param PHP_CodeSniffer_CommentParser_DocElement $tagElement The doc comment
|
||||
* element.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function getIndentation($tagName, $tagElement)
|
||||
{
|
||||
if ($tagElement instanceof PHP_CodeSniffer_CommentParser_SingleElement) {
|
||||
if ($tagElement->getContent() !== '') {
|
||||
return (strlen($tagName) + substr_count($tagElement->getWhitespaceBeforeContent(), ' '));
|
||||
}
|
||||
} else if ($tagElement instanceof PHP_CodeSniffer_CommentParser_PairElement) {
|
||||
if ($tagElement->getValue() !== '') {
|
||||
return (strlen($tagName) + substr_count($tagElement->getWhitespaceBeforeValue(), ' '));
|
||||
}
|
||||
}
|
||||
|
||||
return 0;
|
||||
|
||||
}//end getIndentation()
|
||||
|
||||
|
||||
/**
|
||||
* Process the category tag.
|
||||
*
|
||||
* @param int $errorPos The line number where the error occurs.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processCategory($errorPos)
|
||||
{
|
||||
$category = $this->commentParser->getCategory();
|
||||
if ($category !== null) {
|
||||
$content = $category->getContent();
|
||||
if ($content !== '') {
|
||||
if (PHP_CodeSniffer::isUnderscoreName($content) !== true) {
|
||||
$newContent = str_replace(' ', '_', $content);
|
||||
$nameBits = explode('_', $newContent);
|
||||
$firstBit = array_shift($nameBits);
|
||||
$newName = ucfirst($firstBit).'_';
|
||||
foreach ($nameBits as $bit) {
|
||||
$newName .= ucfirst($bit).'_';
|
||||
}
|
||||
|
||||
$error = 'Category name "%s" is not valid; consider "%s" instead';
|
||||
$validName = trim($newName, '_');
|
||||
$data = array(
|
||||
$content,
|
||||
$validName,
|
||||
);
|
||||
$this->currentFile->addError($error, $errorPos, 'InvalidCategory', $data);
|
||||
}
|
||||
} else {
|
||||
$error = '@category tag must contain a name';
|
||||
$this->currentFile->addError($error, $errorPos, 'EmptyCategory');
|
||||
}
|
||||
}
|
||||
|
||||
}//end processCategory()
|
||||
|
||||
|
||||
/**
|
||||
* Process the package tag.
|
||||
*
|
||||
* @param int $errorPos The line number where the error occurs.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processPackage($errorPos)
|
||||
{
|
||||
$package = $this->commentParser->getPackage();
|
||||
if ($package !== null) {
|
||||
$content = $package->getContent();
|
||||
if ($content !== '') {
|
||||
if (PHP_CodeSniffer::isUnderscoreName($content) !== true) {
|
||||
$newContent = str_replace(' ', '_', $content);
|
||||
$nameBits = explode('_', $newContent);
|
||||
$firstBit = array_shift($nameBits);
|
||||
$newName = strtoupper($firstBit{0}).substr($firstBit, 1).'_';
|
||||
foreach ($nameBits as $bit) {
|
||||
$newName .= strtoupper($bit{0}).substr($bit, 1).'_';
|
||||
}
|
||||
|
||||
$error = 'Package name "%s" is not valid; consider "%s" instead';
|
||||
$validName = trim($newName, '_');
|
||||
$data = array(
|
||||
$content,
|
||||
$validName,
|
||||
);
|
||||
$this->currentFile->addError($error, $errorPos, 'InvalidPackage', $data);
|
||||
}
|
||||
} else {
|
||||
$error = '@package tag must contain a name';
|
||||
$this->currentFile->addError($error, $errorPos, 'EmptyPackage');
|
||||
}
|
||||
}
|
||||
|
||||
}//end processPackage()
|
||||
|
||||
|
||||
/**
|
||||
* Process the subpackage tag.
|
||||
*
|
||||
* @param int $errorPos The line number where the error occurs.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processSubpackage($errorPos)
|
||||
{
|
||||
$package = $this->commentParser->getSubpackage();
|
||||
if ($package !== null) {
|
||||
$content = $package->getContent();
|
||||
if ($content !== '') {
|
||||
if (PHP_CodeSniffer::isUnderscoreName($content) !== true) {
|
||||
$newContent = str_replace(' ', '_', $content);
|
||||
$nameBits = explode('_', $newContent);
|
||||
$firstBit = array_shift($nameBits);
|
||||
$newName = strtoupper($firstBit{0}).substr($firstBit, 1).'_';
|
||||
foreach ($nameBits as $bit) {
|
||||
$newName .= strtoupper($bit{0}).substr($bit, 1).'_';
|
||||
}
|
||||
|
||||
$error = 'Subpackage name "%s" is not valid; consider "%s" instead';
|
||||
$validName = trim($newName, '_');
|
||||
$data = array(
|
||||
$content,
|
||||
$validName,
|
||||
);
|
||||
$this->currentFile->addError($error, $errorPos, 'InvalidSubpackage', $data);
|
||||
}
|
||||
} else {
|
||||
$error = '@subpackage tag must contain a name';
|
||||
$this->currentFile->addError($error, $errorPos, 'EmptySubpackage');
|
||||
}
|
||||
}
|
||||
|
||||
}//end processSubpackage()
|
||||
|
||||
|
||||
/**
|
||||
* Process the author tag(s) that this header comment has.
|
||||
*
|
||||
* This function is different from other _process functions
|
||||
* as $authors is an array of SingleElements, so we work out
|
||||
* the errorPos for each element separately
|
||||
*
|
||||
* @param int $commentStart The position in the stack where
|
||||
* the comment started.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processAuthors($commentStart)
|
||||
{
|
||||
$authors = $this->commentParser->getAuthors();
|
||||
// Report missing return.
|
||||
if (empty($authors) === false) {
|
||||
foreach ($authors as $author) {
|
||||
$errorPos = ($commentStart + $author->getLine());
|
||||
$content = $author->getContent();
|
||||
if ($content !== '') {
|
||||
$local = '\da-zA-Z-_+';
|
||||
// Dot character cannot be the first or last character
|
||||
// in the local-part.
|
||||
$localMiddle = $local.'.\w';
|
||||
if (preg_match('/^([^<]*)\s+<(['.$local.']['.$localMiddle.']*['.$local.']@[\da-zA-Z][-.\w]*[\da-zA-Z]\.[a-zA-Z]{2,7})>$/', $content) === 0) {
|
||||
$error = 'Content of the @author tag must be in the form "Display Name <username@example.com>"';
|
||||
$this->currentFile->addError($error, $errorPos, 'InvalidAuthors');
|
||||
}
|
||||
} else {
|
||||
$error = 'Content missing for @author tag in %s comment';
|
||||
$docBlock = (get_class($this) === 'PEAR_Sniffs_Commenting_FileCommentSniff') ? 'file' : 'class';
|
||||
$data = array($docBlock);
|
||||
$this->currentFile->addError($error, $errorPos, 'EmptyAuthors', $data);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}//end processAuthors()
|
||||
|
||||
|
||||
/**
|
||||
* Process the copyright tags.
|
||||
*
|
||||
* @param int $commentStart The position in the stack where
|
||||
* the comment started.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processCopyrights($commentStart)
|
||||
{
|
||||
$copyrights = $this->commentParser->getCopyrights();
|
||||
foreach ($copyrights as $copyright) {
|
||||
$errorPos = ($commentStart + $copyright->getLine());
|
||||
$content = $copyright->getContent();
|
||||
if ($content !== '') {
|
||||
$matches = array();
|
||||
if (preg_match('/^([0-9]{4})((.{1})([0-9]{4}))? (.+)$/', $content, $matches) !== 0) {
|
||||
// Check earliest-latest year order.
|
||||
if ($matches[3] !== '') {
|
||||
if ($matches[3] !== '-') {
|
||||
$error = 'A hyphen must be used between the earliest and latest year';
|
||||
$this->currentFile->addError($error, $errorPos, 'CopyrightHyphen');
|
||||
}
|
||||
|
||||
if ($matches[4] !== '' && $matches[4] < $matches[1]) {
|
||||
$error = "Invalid year span \"$matches[1]$matches[3]$matches[4]\" found; consider \"$matches[4]-$matches[1]\" instead";
|
||||
$this->currentFile->addWarning($error, $errorPos, 'InvalidCopyright');
|
||||
}
|
||||
}
|
||||
} else {
|
||||
$error = '@copyright tag must contain a year and the name of the copyright holder';
|
||||
$this->currentFile->addError($error, $errorPos, 'EmptyCopyright');
|
||||
}
|
||||
} else {
|
||||
$error = '@copyright tag must contain a year and the name of the copyright holder';
|
||||
$this->currentFile->addError($error, $errorPos, 'EmptyCopyright');
|
||||
}//end if
|
||||
}//end if
|
||||
|
||||
}//end processCopyrights()
|
||||
|
||||
|
||||
/**
|
||||
* Process the license tag.
|
||||
*
|
||||
* @param int $errorPos The line number where the error occurs.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processLicense($errorPos)
|
||||
{
|
||||
$license = $this->commentParser->getLicense();
|
||||
if ($license !== null) {
|
||||
$value = $license->getValue();
|
||||
$comment = $license->getComment();
|
||||
if ($value === '' || $comment === '') {
|
||||
$error = '@license tag must contain a URL and a license name';
|
||||
$this->currentFile->addError($error, $errorPos, 'EmptyLicense');
|
||||
}
|
||||
}
|
||||
|
||||
}//end processLicense()
|
||||
|
||||
|
||||
/**
|
||||
* Process the version tag.
|
||||
*
|
||||
* @param int $errorPos The line number where the error occurs.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processVersion($errorPos)
|
||||
{
|
||||
$version = $this->commentParser->getVersion();
|
||||
if ($version !== null) {
|
||||
$content = $version->getContent();
|
||||
$matches = array();
|
||||
if (empty($content) === true) {
|
||||
$error = 'Content missing for @version tag in file comment';
|
||||
$this->currentFile->addError($error, $errorPos, 'EmptyVersion');
|
||||
} else if (strstr($content, 'CVS:') === false
|
||||
&& strstr($content, 'SVN:') === false
|
||||
&& strstr($content, 'GIT:') === false
|
||||
) {
|
||||
$error = 'Invalid version "%s" in file comment; consider "CVS: <cvs_id>" or "SVN: <svn_id>" or "GIT: <git_id>" instead';
|
||||
$data = array($content);
|
||||
$this->currentFile->addWarning($error, $errorPos, 'InvalidVersion', $data);
|
||||
}
|
||||
}
|
||||
|
||||
}//end processVersion()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,490 @@
|
||||
<?php
|
||||
/**
|
||||
* Parses and verifies the doc comments for functions.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
if (class_exists('PHP_CodeSniffer_CommentParser_FunctionCommentParser', true) === false) {
|
||||
throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_CommentParser_FunctionCommentParser not found');
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses and verifies the doc comments for functions.
|
||||
*
|
||||
* Verifies that :
|
||||
* <ul>
|
||||
* <li>A comment exists</li>
|
||||
* <li>There is a blank newline after the short description.</li>
|
||||
* <li>There is a blank newline between the long and short description.</li>
|
||||
* <li>There is a blank newline between the long description and tags.</li>
|
||||
* <li>Parameter names represent those in the method.</li>
|
||||
* <li>Parameter comments are in the correct order</li>
|
||||
* <li>Parameter comments are complete</li>
|
||||
* <li>A space is present before the first and after the last parameter</li>
|
||||
* <li>A return type exists</li>
|
||||
* <li>There must be one blank line between body and headline comments.</li>
|
||||
* <li>Any throw tag must have an exception class.</li>
|
||||
* </ul>
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_Commenting_FunctionCommentSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* The name of the method that we are currently processing.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $_methodName = '';
|
||||
|
||||
/**
|
||||
* The position in the stack where the fucntion token was found.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
private $_functionToken = null;
|
||||
|
||||
/**
|
||||
* The position in the stack where the class token was found.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
private $_classToken = null;
|
||||
|
||||
/**
|
||||
* The function comment parser for the current method.
|
||||
*
|
||||
* @var PHP_CodeSniffer_Comment_Parser_FunctionCommentParser
|
||||
*/
|
||||
protected $commentParser = null;
|
||||
|
||||
/**
|
||||
* The current PHP_CodeSniffer_File object we are processing.
|
||||
*
|
||||
* @var PHP_CodeSniffer_File
|
||||
*/
|
||||
protected $currentFile = null;
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_FUNCTION);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$find = array(
|
||||
T_COMMENT,
|
||||
T_DOC_COMMENT,
|
||||
T_CLASS,
|
||||
T_FUNCTION,
|
||||
T_OPEN_TAG,
|
||||
);
|
||||
|
||||
$commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1));
|
||||
|
||||
if ($commentEnd === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->currentFile = $phpcsFile;
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// If the token that we found was a class or a function, then this
|
||||
// function has no doc comment.
|
||||
$code = $tokens[$commentEnd]['code'];
|
||||
|
||||
if ($code === T_COMMENT) {
|
||||
$error = 'You must use "/**" style comments for a function comment';
|
||||
$phpcsFile->addError($error, $stackPtr, 'WrongStyle');
|
||||
return;
|
||||
} else if ($code !== T_DOC_COMMENT) {
|
||||
$phpcsFile->addError('Missing function doc comment', $stackPtr, 'Missing');
|
||||
return;
|
||||
}
|
||||
|
||||
// If there is any code between the function keyword and the doc block
|
||||
// then the doc block is not for us.
|
||||
$ignore = PHP_CodeSniffer_Tokens::$scopeModifiers;
|
||||
$ignore[] = T_STATIC;
|
||||
$ignore[] = T_WHITESPACE;
|
||||
$ignore[] = T_ABSTRACT;
|
||||
$ignore[] = T_FINAL;
|
||||
$prevToken = $phpcsFile->findPrevious($ignore, ($stackPtr - 1), null, true);
|
||||
if ($prevToken !== $commentEnd) {
|
||||
$phpcsFile->addError('Missing function doc comment', $stackPtr, 'Missing');
|
||||
return;
|
||||
}
|
||||
|
||||
$this->_functionToken = $stackPtr;
|
||||
|
||||
$this->_classToken = null;
|
||||
foreach ($tokens[$stackPtr]['conditions'] as $condPtr => $condition) {
|
||||
if ($condition === T_CLASS || $condition === T_INTERFACE) {
|
||||
$this->_classToken = $condPtr;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// If the first T_OPEN_TAG is right before the comment, it is probably
|
||||
// a file comment.
|
||||
$commentStart = ($phpcsFile->findPrevious(T_DOC_COMMENT, ($commentEnd - 1), null, true) + 1);
|
||||
$prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($commentStart - 1), null, true);
|
||||
if ($tokens[$prevToken]['code'] === T_OPEN_TAG) {
|
||||
// Is this the first open tag?
|
||||
if ($stackPtr === 0 || $phpcsFile->findPrevious(T_OPEN_TAG, ($prevToken - 1)) === false) {
|
||||
$phpcsFile->addError('Missing function doc comment', $stackPtr, 'Missing');
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
$comment = $phpcsFile->getTokensAsString($commentStart, ($commentEnd - $commentStart + 1));
|
||||
$this->_methodName = $phpcsFile->getDeclarationName($stackPtr);
|
||||
|
||||
try {
|
||||
$this->commentParser = new PHP_CodeSniffer_CommentParser_FunctionCommentParser($comment, $phpcsFile);
|
||||
$this->commentParser->parse();
|
||||
} catch (PHP_CodeSniffer_CommentParser_ParserException $e) {
|
||||
$line = ($e->getLineWithinComment() + $commentStart);
|
||||
$phpcsFile->addError($e->getMessage(), $line, 'FailedParse');
|
||||
return;
|
||||
}
|
||||
|
||||
$comment = $this->commentParser->getComment();
|
||||
if (is_null($comment) === true) {
|
||||
$error = 'Function doc comment is empty';
|
||||
$phpcsFile->addError($error, $commentStart, 'Empty');
|
||||
return;
|
||||
}
|
||||
|
||||
$this->processParams($commentStart);
|
||||
$this->processReturn($commentStart, $commentEnd);
|
||||
$this->processThrows($commentStart);
|
||||
|
||||
// No extra newline before short description.
|
||||
$short = $comment->getShortComment();
|
||||
$newlineCount = 0;
|
||||
$newlineSpan = strspn($short, $phpcsFile->eolChar);
|
||||
if ($short !== '' && $newlineSpan > 0) {
|
||||
$error = 'Extra newline(s) found before function comment short description';
|
||||
$phpcsFile->addError($error, ($commentStart + 1), 'SpacingBeforeShort');
|
||||
}
|
||||
|
||||
$newlineCount = (substr_count($short, $phpcsFile->eolChar) + 1);
|
||||
|
||||
// Exactly one blank line between short and long description.
|
||||
$long = $comment->getLongComment();
|
||||
if (empty($long) === false) {
|
||||
$between = $comment->getWhiteSpaceBetween();
|
||||
$newlineBetween = substr_count($between, $phpcsFile->eolChar);
|
||||
if ($newlineBetween !== 2) {
|
||||
$error = 'There must be exactly one blank line between descriptions in function comment';
|
||||
$phpcsFile->addError($error, ($commentStart + $newlineCount + 1), 'SpacingAfterShort');
|
||||
}
|
||||
|
||||
$newlineCount += $newlineBetween;
|
||||
}
|
||||
|
||||
// Exactly one blank line before tags.
|
||||
$params = $this->commentParser->getTagOrders();
|
||||
if (count($params) > 1) {
|
||||
$newlineSpan = $comment->getNewlineAfter();
|
||||
if ($newlineSpan !== 2) {
|
||||
$error = 'There must be exactly one blank line before the tags in function comment';
|
||||
if ($long !== '') {
|
||||
$newlineCount += (substr_count($long, $phpcsFile->eolChar) - $newlineSpan + 1);
|
||||
}
|
||||
|
||||
$phpcsFile->addError($error, ($commentStart + $newlineCount), 'SpacingBeforeTags');
|
||||
$short = rtrim($short, $phpcsFile->eolChar.' ');
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
/**
|
||||
* Process any throw tags that this function comment has.
|
||||
*
|
||||
* @param int $commentStart The position in the stack where the
|
||||
* comment started.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processThrows($commentStart)
|
||||
{
|
||||
if (count($this->commentParser->getThrows()) === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
foreach ($this->commentParser->getThrows() as $throw) {
|
||||
|
||||
$exception = $throw->getValue();
|
||||
$errorPos = ($commentStart + $throw->getLine());
|
||||
|
||||
if ($exception === '') {
|
||||
$error = '@throws tag must contain the exception class name';
|
||||
$this->currentFile->addError($error, $errorPos, 'EmptyThrows');
|
||||
}
|
||||
}
|
||||
|
||||
}//end processThrows()
|
||||
|
||||
|
||||
/**
|
||||
* Process the return comment of this function comment.
|
||||
*
|
||||
* @param int $commentStart The position in the stack where the comment started.
|
||||
* @param int $commentEnd The position in the stack where the comment ended.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processReturn($commentStart, $commentEnd)
|
||||
{
|
||||
// Skip constructor and destructor.
|
||||
$className = '';
|
||||
if ($this->_classToken !== null) {
|
||||
$className = $this->currentFile->getDeclarationName($this->_classToken);
|
||||
$className = strtolower(ltrim($className, '_'));
|
||||
}
|
||||
|
||||
$methodName = strtolower(ltrim($this->_methodName, '_'));
|
||||
$isSpecialMethod = ($this->_methodName === '__construct' || $this->_methodName === '__destruct');
|
||||
|
||||
if ($isSpecialMethod === false && $methodName !== $className) {
|
||||
// Report missing return tag.
|
||||
if ($this->commentParser->getReturn() === null) {
|
||||
$error = 'Missing @return tag in function comment';
|
||||
$this->currentFile->addError($error, $commentEnd, 'MissingReturn');
|
||||
} else if (trim($this->commentParser->getReturn()->getRawContent()) === '') {
|
||||
$error = '@return tag is empty in function comment';
|
||||
$errorPos = ($commentStart + $this->commentParser->getReturn()->getLine());
|
||||
$this->currentFile->addError($error, $errorPos, 'EmptyReturn');
|
||||
}
|
||||
}
|
||||
|
||||
}//end processReturn()
|
||||
|
||||
|
||||
/**
|
||||
* Process the function parameter comments.
|
||||
*
|
||||
* @param int $commentStart The position in the stack where
|
||||
* the comment started.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processParams($commentStart)
|
||||
{
|
||||
$realParams = $this->currentFile->getMethodParameters($this->_functionToken);
|
||||
|
||||
$params = $this->commentParser->getParams();
|
||||
$foundParams = array();
|
||||
|
||||
if (empty($params) === false) {
|
||||
|
||||
$lastParm = (count($params) - 1);
|
||||
if (substr_count($params[$lastParm]->getWhitespaceAfter(), $this->currentFile->eolChar) !== 2) {
|
||||
$error = 'Last parameter comment requires a blank newline after it';
|
||||
$errorPos = ($params[$lastParm]->getLine() + $commentStart);
|
||||
$this->currentFile->addError($error, $errorPos, 'SpacingAfterParams');
|
||||
}
|
||||
|
||||
// Parameters must appear immediately after the comment.
|
||||
if ($params[0]->getOrder() !== 2) {
|
||||
$error = 'Parameters must appear immediately after the comment';
|
||||
$errorPos = ($params[0]->getLine() + $commentStart);
|
||||
$this->currentFile->addError($error, $errorPos, 'SpacingBeforeParams');
|
||||
}
|
||||
|
||||
$previousParam = null;
|
||||
$spaceBeforeVar = 10000;
|
||||
$spaceBeforeComment = 10000;
|
||||
$longestType = 0;
|
||||
$longestVar = 0;
|
||||
|
||||
foreach ($params as $param) {
|
||||
|
||||
$paramComment = trim($param->getComment());
|
||||
$errorPos = ($param->getLine() + $commentStart);
|
||||
|
||||
// Make sure that there is only one space before the var type.
|
||||
if ($param->getWhitespaceBeforeType() !== ' ') {
|
||||
$error = 'Expected 1 space before variable type';
|
||||
$this->currentFile->addError($error, $errorPos, 'SpacingBeforeParamType');
|
||||
}
|
||||
|
||||
$spaceCount = substr_count($param->getWhitespaceBeforeVarName(), ' ');
|
||||
if ($spaceCount < $spaceBeforeVar) {
|
||||
$spaceBeforeVar = $spaceCount;
|
||||
$longestType = $errorPos;
|
||||
}
|
||||
|
||||
$spaceCount = substr_count($param->getWhitespaceBeforeComment(), ' ');
|
||||
|
||||
if ($spaceCount < $spaceBeforeComment && $paramComment !== '') {
|
||||
$spaceBeforeComment = $spaceCount;
|
||||
$longestVar = $errorPos;
|
||||
}
|
||||
|
||||
// Make sure they are in the correct order,
|
||||
// and have the correct name.
|
||||
$pos = $param->getPosition();
|
||||
|
||||
$paramName = ($param->getVarName() !== '') ? $param->getVarName() : '[ UNKNOWN ]';
|
||||
|
||||
if ($previousParam !== null) {
|
||||
$previousName = ($previousParam->getVarName() !== '') ? $previousParam->getVarName() : 'UNKNOWN';
|
||||
|
||||
// Check to see if the parameters align properly.
|
||||
if ($param->alignsVariableWith($previousParam) === false) {
|
||||
$error = 'The variable names for parameters %s (%s) and %s (%s) do not align';
|
||||
$data = array(
|
||||
$previousName,
|
||||
($pos - 1),
|
||||
$paramName,
|
||||
$pos,
|
||||
);
|
||||
$this->currentFile->addError($error, $errorPos, 'ParameterNamesNotAligned', $data);
|
||||
}
|
||||
|
||||
if ($param->alignsCommentWith($previousParam) === false) {
|
||||
$error = 'The comments for parameters %s (%s) and %s (%s) do not align';
|
||||
$data = array(
|
||||
$previousName,
|
||||
($pos - 1),
|
||||
$paramName,
|
||||
$pos,
|
||||
);
|
||||
$this->currentFile->addError($error, $errorPos, 'ParameterCommentsNotAligned', $data);
|
||||
}
|
||||
}//end if
|
||||
|
||||
// Make sure the names of the parameter comment matches the
|
||||
// actual parameter.
|
||||
if (isset($realParams[($pos - 1)]) === true) {
|
||||
$realName = $realParams[($pos - 1)]['name'];
|
||||
$foundParams[] = $realName;
|
||||
|
||||
// Append ampersand to name if passing by reference.
|
||||
if ($realParams[($pos - 1)]['pass_by_reference'] === true) {
|
||||
$realName = '&'.$realName;
|
||||
}
|
||||
|
||||
if ($realName !== $paramName) {
|
||||
$code = 'ParamNameNoMatch';
|
||||
$data = array(
|
||||
$paramName,
|
||||
$realName,
|
||||
$pos,
|
||||
);
|
||||
|
||||
$error = 'Doc comment for var %s does not match ';
|
||||
if (strtolower($paramName) === strtolower($realName)) {
|
||||
$error .= 'case of ';
|
||||
$code = 'ParamNameNoCaseMatch';
|
||||
}
|
||||
|
||||
$error .= 'actual variable name %s at position %s';
|
||||
|
||||
$this->currentFile->addError($error, $errorPos, $code, $data);
|
||||
}
|
||||
} else {
|
||||
// We must have an extra parameter comment.
|
||||
$error = 'Superfluous doc comment at position '.$pos;
|
||||
$this->currentFile->addError($error, $errorPos, 'ExtraParamComment');
|
||||
}
|
||||
|
||||
if ($param->getVarName() === '') {
|
||||
$error = 'Missing parameter name at position '.$pos;
|
||||
$this->currentFile->addError($error, $errorPos, 'MissingParamName');
|
||||
}
|
||||
|
||||
if ($param->getType() === '') {
|
||||
$error = 'Missing type at position '.$pos;
|
||||
$this->currentFile->addError($error, $errorPos, 'MissingParamType');
|
||||
}
|
||||
|
||||
if ($paramComment === '') {
|
||||
$error = 'Missing comment for param "%s" at position %s';
|
||||
$data = array(
|
||||
$paramName,
|
||||
$pos,
|
||||
);
|
||||
$this->currentFile->addError($error, $errorPos, 'MissingParamComment', $data);
|
||||
}
|
||||
|
||||
$previousParam = $param;
|
||||
|
||||
}//end foreach
|
||||
|
||||
if ($spaceBeforeVar !== 1 && $spaceBeforeVar !== 10000 && $spaceBeforeComment !== 10000) {
|
||||
$error = 'Expected 1 space after the longest type';
|
||||
$this->currentFile->addError($error, $longestType, 'SpacingAfterLongType');
|
||||
}
|
||||
|
||||
if ($spaceBeforeComment !== 1 && $spaceBeforeComment !== 10000) {
|
||||
$error = 'Expected 1 space after the longest variable name';
|
||||
$this->currentFile->addError($error, $longestVar, 'SpacingAfterLongName');
|
||||
}
|
||||
|
||||
}//end if
|
||||
|
||||
$realNames = array();
|
||||
foreach ($realParams as $realParam) {
|
||||
$realNames[] = $realParam['name'];
|
||||
}
|
||||
|
||||
// Report and missing comments.
|
||||
$diff = array_diff($realNames, $foundParams);
|
||||
foreach ($diff as $neededParam) {
|
||||
if (count($params) !== 0) {
|
||||
$errorPos = ($params[(count($params) - 1)]->getLine() + $commentStart);
|
||||
} else {
|
||||
$errorPos = $commentStart;
|
||||
}
|
||||
|
||||
$error = 'Doc comment for "%s" missing';
|
||||
$data = array($neededParam);
|
||||
$this->currentFile->addError($error, $errorPos, 'MissingParamTag', $data);
|
||||
}
|
||||
|
||||
}//end processParams()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,70 @@
|
||||
<?php
|
||||
/**
|
||||
* PHP_CodeSniffer_Sniffs_PEAR_Commenting_InlineCommentSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* PHP_CodeSniffer_Sniffs_PEAR_Commenting_InlineCommentSniff.
|
||||
*
|
||||
* Checks that no perl-style comments are used.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_Commenting_InlineCommentSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_COMMENT);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
if ($tokens[$stackPtr]['content']{0} === '#') {
|
||||
$error = 'Perl-style comments are not allowed. Use "// Comment."';
|
||||
$error .= ' or "/* comment */" instead.';
|
||||
$phpcsFile->addError($error, $stackPtr, 'WrongStyle');
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,70 @@
|
||||
<?php
|
||||
/**
|
||||
* Verifies that control statements conform to their coding standards.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
if (class_exists('PHP_CodeSniffer_Standards_AbstractPatternSniff', true) === false) {
|
||||
throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractPatternSniff not found');
|
||||
}
|
||||
|
||||
/**
|
||||
* Verifies that control statements conform to their coding standards.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_ControlStructures_ControlSignatureSniff extends PHP_CodeSniffer_Standards_AbstractPatternSniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Constructs a PEAR_Sniffs_ControlStructures_ControlSignatureSniff.
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
parent::__construct(true);
|
||||
|
||||
}//end __construct()
|
||||
|
||||
|
||||
/**
|
||||
* Returns the patterns that this test wishes to verify.
|
||||
*
|
||||
* @return array(string)
|
||||
*/
|
||||
protected function getPatterns()
|
||||
{
|
||||
return array(
|
||||
'do {EOL...} while (...);EOL',
|
||||
'while (...) {EOL',
|
||||
'for (...) {EOL',
|
||||
'if (...) {EOL',
|
||||
'foreach (...) {EOL',
|
||||
'} else if (...) {EOL',
|
||||
'} elseif (...) {EOL',
|
||||
'} else {EOL',
|
||||
'do {EOL',
|
||||
);
|
||||
|
||||
}//end getPatterns()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,176 @@
|
||||
<?php
|
||||
/**
|
||||
* PEAR_Sniffs_ControlStructures_MultiLineConditionSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* PEAR_Sniffs_ControlStructures_MultiLineConditionSniff.
|
||||
*
|
||||
* Ensure multi-line IF conditions are defined correctly.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_ControlStructures_MultiLineConditionSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_IF);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// We need to work out how far indented the if statement
|
||||
// itself is, so we can work out how far to indent conditions.
|
||||
$statementIndent = 0;
|
||||
for ($i = ($stackPtr - 1); $i >= 0; $i--) {
|
||||
if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) {
|
||||
$i++;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if ($i >= 0 && $tokens[$i]['code'] === T_WHITESPACE) {
|
||||
$statementIndent = strlen($tokens[$i]['content']);
|
||||
}
|
||||
|
||||
// Each line between the parenthesis should be indented 4 spaces
|
||||
// and start with an operator, unless the line is inside a
|
||||
// function call, in which case it is ignored.
|
||||
$openBracket = $tokens[$stackPtr]['parenthesis_opener'];
|
||||
$closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
|
||||
$lastLine = $tokens[$openBracket]['line'];
|
||||
for ($i = ($openBracket + 1); $i < $closeBracket; $i++) {
|
||||
if ($tokens[$i]['line'] !== $lastLine) {
|
||||
if ($tokens[$i]['line'] === $tokens[$closeBracket]['line']) {
|
||||
$next = $phpcsFile->findNext(T_WHITESPACE, $i, null, true);
|
||||
if ($next !== $closeBracket) {
|
||||
// Closing bracket is on the same line as a condition.
|
||||
$error = 'Closing parenthesis of a multi-line IF statement must be on a new line';
|
||||
$phpcsFile->addError($error, $i, 'CloseBracketNewLine');
|
||||
$expectedIndent = ($statementIndent + 4);
|
||||
} else {
|
||||
// Closing brace needs to be indented to the same level
|
||||
// as the function.
|
||||
$expectedIndent = $statementIndent;
|
||||
}
|
||||
} else {
|
||||
$expectedIndent = ($statementIndent + 4);
|
||||
}
|
||||
|
||||
// We changed lines, so this should be a whitespace indent token.
|
||||
if ($tokens[$i]['code'] !== T_WHITESPACE) {
|
||||
$foundIndent = 0;
|
||||
} else {
|
||||
$foundIndent = strlen($tokens[$i]['content']);
|
||||
}
|
||||
|
||||
if ($expectedIndent !== $foundIndent) {
|
||||
$error = 'Multi-line IF statement not indented correctly; expected %s spaces but found %s';
|
||||
$data = array(
|
||||
$expectedIndent,
|
||||
$foundIndent,
|
||||
);
|
||||
$phpcsFile->addError($error, $i, 'Alignment', $data);
|
||||
}
|
||||
|
||||
if ($tokens[$i]['line'] !== $tokens[$closeBracket]['line']) {
|
||||
$next = $phpcsFile->findNext(T_WHITESPACE, $i, null, true);
|
||||
if (in_array($tokens[$next]['code'], PHP_CodeSniffer_Tokens::$booleanOperators) === false) {
|
||||
$error = 'Each line in a multi-line IF statement must begin with a boolean operator';
|
||||
$phpcsFile->addError($error, $i, 'StartWithBoolean');
|
||||
}
|
||||
}
|
||||
|
||||
$lastLine = $tokens[$i]['line'];
|
||||
}//end if
|
||||
|
||||
if ($tokens[$i]['code'] === T_STRING) {
|
||||
$next = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), null, true);
|
||||
if ($tokens[$next]['code'] === T_OPEN_PARENTHESIS) {
|
||||
// This is a function call, so skip to the end as they
|
||||
// have their own indentation rules.
|
||||
$i = $tokens[$next]['parenthesis_closer'];
|
||||
$lastLine = $tokens[$i]['line'];
|
||||
continue;
|
||||
}
|
||||
}
|
||||
}//end for
|
||||
|
||||
// From here on, we are checking the spacing of the opening and closing
|
||||
// braces. If this IF statement does not use braces, we end here.
|
||||
if (isset($tokens[$stackPtr]['scope_opener']) === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
// The opening brace needs to be one space away from the closing parenthesis.
|
||||
if ($tokens[($closeBracket + 1)]['code'] !== T_WHITESPACE) {
|
||||
$length = 0;
|
||||
} else if ($tokens[($closeBracket + 1)]['content'] === $phpcsFile->eolChar) {
|
||||
$length = -1;
|
||||
} else {
|
||||
$length = strlen($tokens[($closeBracket + 1)]['content']);
|
||||
}
|
||||
|
||||
if ($length !== 1) {
|
||||
$data = array($length);
|
||||
$code = 'SpaceBeforeOpenBrace';
|
||||
|
||||
$error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement; found ';
|
||||
if ($length === -1) {
|
||||
$error .= 'newline';
|
||||
$code = 'NewlineBeforeOpenBrace';
|
||||
} else {
|
||||
$error .= '%s spaces';
|
||||
}
|
||||
|
||||
$phpcsFile->addError($error, ($closeBracket + 1), $code, $data);
|
||||
}
|
||||
|
||||
// And just in case they do something funny before the brace...
|
||||
$next = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), null, true);
|
||||
if ($next !== false && $tokens[$next]['code'] !== T_OPEN_CURLY_BRACKET) {
|
||||
$error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement';
|
||||
$phpcsFile->addError($error, $next, 'NoSpaceBeforeOpenBrace');
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,137 @@
|
||||
<?php
|
||||
/**
|
||||
* PEAR_Sniffs_Files_IncludingFileSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* PEAR_Sniffs_Files_IncludingFileSniff.
|
||||
*
|
||||
* Checks that the include_once is used in conditional situations, and
|
||||
* require_once is used elsewhere. Also checks that brackets do not surround
|
||||
* the file being included.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_Files_IncludingFileSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* Conditions that should use include_once
|
||||
*
|
||||
* @var array(int)
|
||||
*/
|
||||
private static $_conditions = array(
|
||||
T_IF,
|
||||
T_ELSE,
|
||||
T_ELSEIF,
|
||||
T_SWITCH,
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(
|
||||
T_INCLUDE_ONCE,
|
||||
T_REQUIRE_ONCE,
|
||||
T_REQUIRE,
|
||||
T_INCLUDE,
|
||||
);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$nextToken = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true);
|
||||
if ($tokens[$nextToken]['code'] === T_OPEN_PARENTHESIS) {
|
||||
$error = '"%s" is a statement not a function; no parentheses are required';
|
||||
$data = array($tokens[$stackPtr]['content']);
|
||||
$phpcsFile->addError($error, $stackPtr, 'BracketsNotRequired', $data);
|
||||
}
|
||||
|
||||
$inCondition = (count($tokens[$stackPtr]['conditions']) !== 0) ? true : false;
|
||||
|
||||
// Check to see if this including statement is within the parenthesis
|
||||
// of a condition. If that's the case then we need to process it as being
|
||||
// within a condition, as they are checking the return value.
|
||||
if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
|
||||
foreach ($tokens[$stackPtr]['nested_parenthesis'] as $left => $right) {
|
||||
if (isset($tokens[$left]['parenthesis_owner']) === true) {
|
||||
$inCondition = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Check to see if they are assigning the return value of this
|
||||
// including call. If they are then they are probably checking it, so
|
||||
// it's conditional.
|
||||
$previous = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
|
||||
if (in_array($tokens[$previous]['code'], PHP_CodeSniffer_Tokens::$assignmentTokens) === true) {
|
||||
// The have assigned the return value to it, so its conditional.
|
||||
$inCondition = true;
|
||||
}
|
||||
|
||||
$tokenCode = $tokens[$stackPtr]['code'];
|
||||
if ($inCondition === true) {
|
||||
// We are inside a conditional statement. We need an include_once.
|
||||
if ($tokenCode === T_REQUIRE_ONCE) {
|
||||
$error = 'File is being conditionally included; ';
|
||||
$error .= 'use "include_once" instead';
|
||||
$phpcsFile->addError($error, $stackPtr, 'UseIncludeOnce');
|
||||
} else if ($tokenCode === T_REQUIRE) {
|
||||
$error = 'File is being conditionally included; ';
|
||||
$error .= 'use "include" instead';
|
||||
$phpcsFile->addError($error, $stackPtr, 'UseInclude');
|
||||
}
|
||||
} else {
|
||||
// We are unconditionally including, we need a require_once.
|
||||
if ($tokenCode === T_INCLUDE_ONCE) {
|
||||
$error = 'File is being unconditionally included; ';
|
||||
$error .= 'use "require_once" instead';
|
||||
$phpcsFile->addError($error, $stackPtr, 'UseRequireOnce');
|
||||
} else if ($tokenCode === T_INCLUDE) {
|
||||
$error = 'File is being unconditionally included; ';
|
||||
$error .= 'use "require" instead';
|
||||
$phpcsFile->addError($error, $stackPtr, 'UseRequire');
|
||||
}
|
||||
}//end if
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,113 @@
|
||||
<?php
|
||||
/**
|
||||
* PEAR_Sniffs_Functions_FunctionDeclarationSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* PEAR_Sniffs_Formatting_MultiLineAssignmentSniff.
|
||||
*
|
||||
* If an assignment goes over two lines, ensure the equal sign is indented.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_Formatting_MultiLineAssignmentSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_EQUAL);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Equal sign can't be the last thing on the line.
|
||||
$next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
|
||||
if ($next === false) {
|
||||
// Bad assignment.
|
||||
return;
|
||||
}
|
||||
|
||||
if ($tokens[$next]['line'] !== $tokens[$stackPtr]['line']) {
|
||||
$error = 'Multi-line assignments must have the equal sign on the second line';
|
||||
$phpcsFile->addError($error, $stackPtr, 'EqualSignLine');
|
||||
return;
|
||||
}
|
||||
|
||||
// Make sure it is the first thing on the line, otherwise we ignore it.
|
||||
$prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), false, true);
|
||||
if ($prev === false) {
|
||||
// Bad assignment.
|
||||
return;
|
||||
}
|
||||
|
||||
if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Find the required indent based on the ident of the previous line.
|
||||
$assignmentIndent = 0;
|
||||
$prevLine = $tokens[$prev]['line'];
|
||||
for ($i = ($prev - 1); $i >= 0; $i--) {
|
||||
if ($tokens[$i]['line'] !== $prevLine) {
|
||||
$i++;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if ($tokens[$i]['code'] === T_WHITESPACE) {
|
||||
$assignmentIndent = strlen($tokens[$i]['content']);
|
||||
}
|
||||
|
||||
// Find the actual indent.
|
||||
$prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1));
|
||||
|
||||
$expectedIndent = ($assignmentIndent + 4);
|
||||
$foundIndent = strlen($tokens[$prev]['content']);
|
||||
if ($foundIndent !== $expectedIndent) {
|
||||
$error = 'Multi-line assignment not indented correctly; expected %s spaces but found %s';
|
||||
$data = array(
|
||||
$expectedIndent,
|
||||
$foundIndent,
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'Indent', $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,259 @@
|
||||
<?php
|
||||
/**
|
||||
* PEAR_Sniffs_Functions_FunctionCallSignatureSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* PEAR_Sniffs_Functions_FunctionCallSignatureSniff.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_Functions_FunctionCallSignatureSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_STRING);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Find the next non-empty token.
|
||||
$openBracket = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true);
|
||||
|
||||
if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
|
||||
// Not a function call.
|
||||
return;
|
||||
}
|
||||
|
||||
if (isset($tokens[$openBracket]['parenthesis_closer']) === false) {
|
||||
// Not a function call.
|
||||
return;
|
||||
}
|
||||
|
||||
// Find the previous non-empty token.
|
||||
$search = PHP_CodeSniffer_Tokens::$emptyTokens;
|
||||
$search[] = T_BITWISE_AND;
|
||||
$previous = $phpcsFile->findPrevious($search, ($stackPtr - 1), null, true);
|
||||
if ($tokens[$previous]['code'] === T_FUNCTION) {
|
||||
// It's a function definition, not a function call.
|
||||
return;
|
||||
}
|
||||
|
||||
$closeBracket = $tokens[$openBracket]['parenthesis_closer'];
|
||||
|
||||
if (($stackPtr + 1) !== $openBracket) {
|
||||
// Checking this: $value = my_function[*](...).
|
||||
$error = 'Space before opening parenthesis of function call prohibited';
|
||||
$phpcsFile->addError($error, $stackPtr, 'SpaceBeforeOpenBracket');
|
||||
}
|
||||
|
||||
$next = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), null, true);
|
||||
if ($tokens[$next]['code'] === T_SEMICOLON) {
|
||||
if (in_array($tokens[($closeBracket + 1)]['code'], PHP_CodeSniffer_Tokens::$emptyTokens) === true) {
|
||||
$error = 'Space after closing parenthesis of function call prohibited';
|
||||
$phpcsFile->addError($error, $closeBracket, 'SpaceAfterCloseBracket');
|
||||
}
|
||||
}
|
||||
|
||||
// Check if this is a single line or multi-line function call.
|
||||
if ($tokens[$openBracket]['line'] === $tokens[$closeBracket]['line']) {
|
||||
$this->processSingleLineCall($phpcsFile, $stackPtr, $openBracket, $tokens);
|
||||
} else {
|
||||
$this->processMultiLineCall($phpcsFile, $stackPtr, $openBracket, $tokens);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
/**
|
||||
* Processes single-line calls.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
||||
* @param int $stackPtr The position of the current token
|
||||
* in the stack passed in $tokens.
|
||||
* @param int $openBracket The position of the openning bracket
|
||||
* in the stack passed in $tokens.
|
||||
* @param array $tokens The stack of tokens that make up
|
||||
* the file.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function processSingleLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
|
||||
{
|
||||
if ($tokens[($openBracket + 1)]['code'] === T_WHITESPACE) {
|
||||
// Checking this: $value = my_function([*]...).
|
||||
$error = 'Space after opening parenthesis of function call prohibited';
|
||||
$phpcsFile->addError($error, $stackPtr, 'SpaceAfterOpenBracket');
|
||||
}
|
||||
|
||||
$closer = $tokens[$openBracket]['parenthesis_closer'];
|
||||
|
||||
if ($tokens[($closer - 1)]['code'] === T_WHITESPACE) {
|
||||
// Checking this: $value = my_function(...[*]).
|
||||
$between = $phpcsFile->findNext(T_WHITESPACE, ($openBracket + 1), null, true);
|
||||
|
||||
// Only throw an error if there is some content between the parenthesis.
|
||||
// i.e., Checking for this: $value = my_function().
|
||||
// If there is no content, then we would have thrown an error in the
|
||||
// previous IF statement because it would look like this:
|
||||
// $value = my_function( ).
|
||||
if ($between !== $closer) {
|
||||
$error = 'Space before closing parenthesis of function call prohibited';
|
||||
$phpcsFile->addError($error, $closer, 'SpaceBeforeCloseBracket');
|
||||
}
|
||||
}
|
||||
|
||||
}//end processSingleLineCall()
|
||||
|
||||
|
||||
/**
|
||||
* Processes multi-line calls.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
||||
* @param int $stackPtr The position of the current token
|
||||
* in the stack passed in $tokens.
|
||||
* @param int $openBracket The position of the openning bracket
|
||||
* in the stack passed in $tokens.
|
||||
* @param array $tokens The stack of tokens that make up
|
||||
* the file.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function processMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens)
|
||||
{
|
||||
// We need to work out how far indented the function
|
||||
// call itself is, so we can work out how far to
|
||||
// indent the arguments.
|
||||
$functionIndent = 0;
|
||||
for ($i = ($stackPtr - 1); $i >= 0; $i--) {
|
||||
if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) {
|
||||
$i++;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if ($tokens[$i]['code'] === T_WHITESPACE) {
|
||||
$functionIndent = strlen($tokens[$i]['content']);
|
||||
}
|
||||
|
||||
// Each line between the parenthesis should be indented 4 spaces.
|
||||
$closeBracket = $tokens[$openBracket]['parenthesis_closer'];
|
||||
$lastLine = $tokens[$openBracket]['line'];
|
||||
for ($i = ($openBracket + 1); $i < $closeBracket; $i++) {
|
||||
// Skip nested function calls.
|
||||
if ($tokens[$i]['code'] === T_OPEN_PARENTHESIS) {
|
||||
$i = $tokens[$i]['parenthesis_closer'];
|
||||
$lastLine = $tokens[$i]['line'];
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($tokens[$i]['line'] !== $lastLine) {
|
||||
$lastLine = $tokens[$i]['line'];
|
||||
|
||||
// Ignore heredoc indentation.
|
||||
if (in_array($tokens[$i]['code'], PHP_CodeSniffer_Tokens::$heredocTokens) === true) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Ignore multi-line string indentation.
|
||||
if (in_array($tokens[$i]['code'], PHP_CodeSniffer_Tokens::$stringTokens) === true) {
|
||||
if ($tokens[$i]['code'] === $tokens[($i - 1)]['code']) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
// We changed lines, so this should be a whitespace indent token, but first make
|
||||
// sure it isn't a blank line because we don't need to check indent unless there
|
||||
// is actually some code to indent.
|
||||
$nextCode = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), ($closeBracket + 1), true);
|
||||
if ($tokens[$nextCode]['line'] !== $lastLine) {
|
||||
$error = 'Empty lines are not allowed in multi-line function calls';
|
||||
$phpcsFile->addError($error, $i, 'EmptyLine');
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($nextCode === $closeBracket) {
|
||||
// Closing brace needs to be indented to the same level
|
||||
// as the function call.
|
||||
$expectedIndent = $functionIndent;
|
||||
} else {
|
||||
$expectedIndent = ($functionIndent + 4);
|
||||
}
|
||||
|
||||
if ($tokens[$i]['code'] !== T_WHITESPACE) {
|
||||
$foundIndent = 0;
|
||||
} else {
|
||||
$foundIndent = strlen($tokens[$i]['content']);
|
||||
}
|
||||
|
||||
if ($expectedIndent !== $foundIndent) {
|
||||
$error = 'Multi-line function call not indented correctly; expected %s spaces but found %s';
|
||||
$data = array(
|
||||
$expectedIndent,
|
||||
$foundIndent,
|
||||
);
|
||||
$phpcsFile->addError($error, $i, 'Indent', $data);
|
||||
}
|
||||
}//end if
|
||||
|
||||
// Skip the rest of a closure.
|
||||
if ($tokens[$i]['code'] === T_CLOSURE) {
|
||||
$i = $tokens[$i]['scope_closer'];
|
||||
$lastLine = $tokens[$i]['line'];
|
||||
continue;
|
||||
}
|
||||
}//end for
|
||||
|
||||
if ($tokens[($openBracket + 1)]['content'] !== $phpcsFile->eolChar) {
|
||||
$error = 'Opening parenthesis of a multi-line function call must be the last content on the line';
|
||||
$phpcsFile->addError($error, $stackPtr, 'ContentAfterOpenBracket');
|
||||
}
|
||||
|
||||
$prev = $phpcsFile->findPrevious(T_WHITESPACE, ($closeBracket - 1), null, true);
|
||||
if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) {
|
||||
$error = 'Closing parenthesis of a multi-line function call must be on a line by itself';
|
||||
$phpcsFile->addError($error, $closeBracket, 'CloseBracketLine');
|
||||
}
|
||||
|
||||
}//end processMultiLineCall()
|
||||
|
||||
|
||||
}//end class
|
||||
?>
|
||||
@@ -0,0 +1,224 @@
|
||||
<?php
|
||||
/**
|
||||
* PEAR_Sniffs_Functions_FunctionDeclarationSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* PEAR_Sniffs_Functions_FunctionDeclarationSniff.
|
||||
*
|
||||
* Ensure single and multi-line function declarations are defined correctly.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_Functions_FunctionDeclarationSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_FUNCTION);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Check if this is a single line or multi-line declaration.
|
||||
$openBracket = $tokens[$stackPtr]['parenthesis_opener'];
|
||||
$closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
|
||||
if ($tokens[$openBracket]['line'] === $tokens[$closeBracket]['line']) {
|
||||
$this->processSingleLineDeclaration($phpcsFile, $stackPtr, $tokens);
|
||||
} else {
|
||||
$this->processMultiLineDeclaration($phpcsFile, $stackPtr, $tokens);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
/**
|
||||
* Processes single-line declarations.
|
||||
*
|
||||
* Just uses the Generic BSD-Allman brace sniff.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
||||
* @param int $stackPtr The position of the current token
|
||||
* in the stack passed in $tokens.
|
||||
* @param array $tokens The stack of tokens that make up
|
||||
* the file.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function processSingleLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens)
|
||||
{
|
||||
if (class_exists('Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff', true) === false) {
|
||||
throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff not found');
|
||||
}
|
||||
|
||||
$sniff = new Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff();
|
||||
$sniff->process($phpcsFile, $stackPtr);
|
||||
|
||||
}//end processSingleLineDeclaration()
|
||||
|
||||
|
||||
/**
|
||||
* Processes mutli-line declarations.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
||||
* @param int $stackPtr The position of the current token
|
||||
* in the stack passed in $tokens.
|
||||
* @param array $tokens The stack of tokens that make up
|
||||
* the file.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function processMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens)
|
||||
{
|
||||
// We need to work out how far indented the function
|
||||
// declaration itself is, so we can work out how far to
|
||||
// indent parameters.
|
||||
$functionIndent = 0;
|
||||
for ($i = ($stackPtr - 1); $i >= 0; $i--) {
|
||||
if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) {
|
||||
$i++;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if ($tokens[$i]['code'] === T_WHITESPACE) {
|
||||
$functionIndent = strlen($tokens[$i]['content']);
|
||||
}
|
||||
|
||||
// Each line between the parenthesis should be indented 4 spaces.
|
||||
$openBracket = $tokens[$stackPtr]['parenthesis_opener'];
|
||||
$closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
|
||||
$lastLine = $tokens[$openBracket]['line'];
|
||||
for ($i = ($openBracket + 1); $i < $closeBracket; $i++) {
|
||||
if ($tokens[$i]['line'] !== $lastLine) {
|
||||
if ($tokens[$i]['line'] === $tokens[$closeBracket]['line']) {
|
||||
// Closing brace needs to be indented to the same level
|
||||
// as the function.
|
||||
$expectedIndent = $functionIndent;
|
||||
} else {
|
||||
$expectedIndent = ($functionIndent + 4);
|
||||
}
|
||||
|
||||
// We changed lines, so this should be a whitespace indent token.
|
||||
if ($tokens[$i]['code'] !== T_WHITESPACE) {
|
||||
$foundIndent = 0;
|
||||
} else {
|
||||
$foundIndent = strlen($tokens[$i]['content']);
|
||||
}
|
||||
|
||||
if ($expectedIndent !== $foundIndent) {
|
||||
$error = 'Multi-line function declaration not indented correctly; expected %s spaces but found %s';
|
||||
$data = array(
|
||||
$expectedIndent,
|
||||
$foundIndent,
|
||||
);
|
||||
$phpcsFile->addError($error, $i, 'Indent', $data);
|
||||
}
|
||||
|
||||
$lastLine = $tokens[$i]['line'];
|
||||
}//end if
|
||||
|
||||
if ($tokens[$i]['code'] === T_ARRAY) {
|
||||
// Skip arrays as they have their own indentation rules.
|
||||
$i = $tokens[$i]['parenthesis_closer'];
|
||||
$lastLine = $tokens[$i]['line'];
|
||||
continue;
|
||||
}
|
||||
}//end for
|
||||
|
||||
if (isset($tokens[$stackPtr]['scope_opener']) === true) {
|
||||
// The openning brace needs to be one space away
|
||||
// from the closing parenthesis.
|
||||
$next = $tokens[($closeBracket + 1)];
|
||||
if ($next['code'] !== T_WHITESPACE) {
|
||||
$length = 0;
|
||||
} else if ($next['content'] === $phpcsFile->eolChar) {
|
||||
$length = -1;
|
||||
} else {
|
||||
$length = strlen($next['content']);
|
||||
}
|
||||
|
||||
if ($length !== 1) {
|
||||
$data = array($length);
|
||||
$code = 'SpaceBeforeOpenBrace';
|
||||
|
||||
$error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found ';
|
||||
if ($length === -1) {
|
||||
$error .= 'newline';
|
||||
$code = 'NewlineBeforeOpenBrace';
|
||||
} else {
|
||||
$error .= '%s spaces';
|
||||
}
|
||||
|
||||
$phpcsFile->addError($error, ($closeBracket + 1), $code, $data);
|
||||
return;
|
||||
}
|
||||
|
||||
// And just in case they do something funny before the brace...
|
||||
$next = $phpcsFile->findNext(
|
||||
T_WHITESPACE,
|
||||
($closeBracket + 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
if ($next !== false && $tokens[$next]['code'] !== T_OPEN_CURLY_BRACKET) {
|
||||
$error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration';
|
||||
$phpcsFile->addError($error, $next, 'NoSpaceBeforeOpenBrace');
|
||||
}
|
||||
}//end if
|
||||
|
||||
// The closing parenthesis must be on a new line, even
|
||||
// when checking abstract function definitions.
|
||||
$prev = $phpcsFile->findPrevious(
|
||||
T_WHITESPACE,
|
||||
($closeBracket - 1),
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) {
|
||||
$error = 'The closing parenthesis of a multi-line function declaration must be on a new line';
|
||||
$phpcsFile->addError($error, $closeBracket, 'CloseBracketLine');
|
||||
}
|
||||
|
||||
}//end processMultiLineDeclaration()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,108 @@
|
||||
<?php
|
||||
/**
|
||||
* PEAR_Sniffs_Functions_ValidDefaultValueSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* PEAR_Sniffs_Functions_ValidDefaultValueSniff.
|
||||
*
|
||||
* A Sniff to ensure that parameters defined for a function that have a default
|
||||
* value come at the end of the function signature.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_Functions_ValidDefaultValueSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_FUNCTION);
|
||||
|
||||
}//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)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$argStart = $tokens[$stackPtr]['parenthesis_opener'];
|
||||
$argEnd = $tokens[$stackPtr]['parenthesis_closer'];
|
||||
|
||||
// Flag for when we have found a default in our arg list.
|
||||
// If there is a value without a default after this, it is an error.
|
||||
$defaultFound = false;
|
||||
|
||||
$nextArg = $argStart;
|
||||
while (($nextArg = $phpcsFile->findNext(T_VARIABLE, ($nextArg + 1), $argEnd)) !== false) {
|
||||
$argHasDefault = self::_argHasDefault($phpcsFile, $nextArg);
|
||||
if (($argHasDefault === false) && ($defaultFound === true)) {
|
||||
$error = 'Arguments with default values must be at the end of the argument list';
|
||||
$phpcsFile->addError($error, $nextArg, 'NotAtEnd');
|
||||
return;
|
||||
}
|
||||
|
||||
if ($argHasDefault === true) {
|
||||
$defaultFound = true;
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
/**
|
||||
* Returns true if the passed argument has a default value.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
||||
* @param int $argPtr The position of the argument
|
||||
* in the stack.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private static function _argHasDefault(PHP_CodeSniffer_File $phpcsFile, $argPtr)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
$nextToken = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($argPtr + 1), null, true);
|
||||
if ($tokens[$nextToken]['code'] !== T_EQUAL) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
|
||||
}//end _argHasDefault()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,115 @@
|
||||
<?php
|
||||
/**
|
||||
* PEAR_Sniffs_NamingConventions_ValidClassNameSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* PEAR_Sniffs_NamingConventions_ValidClassNameSniff.
|
||||
*
|
||||
* Ensures class and interface names start with a capital letter
|
||||
* and use _ separators.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_NamingConventions_ValidClassNameSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(
|
||||
T_CLASS,
|
||||
T_INTERFACE,
|
||||
);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this test, when one of its tokens is encountered.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The current file being processed.
|
||||
* @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();
|
||||
|
||||
$className = $phpcsFile->findNext(T_STRING, $stackPtr);
|
||||
$name = trim($tokens[$className]['content']);
|
||||
$errorData = array(ucfirst($tokens[$stackPtr]['content']));
|
||||
|
||||
// Make sure the first letter is a capital.
|
||||
if (preg_match('|^[A-Z]|', $name) === 0) {
|
||||
$error = '%s name must begin with a capital letter';
|
||||
$phpcsFile->addError($error, $stackPtr, 'StartWithCaptial', $errorData);
|
||||
}
|
||||
|
||||
// Check that each new word starts with a capital as well, but don't
|
||||
// check the first word, as it is checked above.
|
||||
$validName = true;
|
||||
$nameBits = explode('_', $name);
|
||||
$firstBit = array_shift($nameBits);
|
||||
foreach ($nameBits as $bit) {
|
||||
if ($bit === '' || $bit{0} !== strtoupper($bit{0})) {
|
||||
$validName = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if ($validName === false) {
|
||||
// Strip underscores because they cause the suggested name
|
||||
// to be incorrect.
|
||||
$nameBits = explode('_', trim($name, '_'));
|
||||
$firstBit = array_shift($nameBits);
|
||||
if ($firstBit === '') {
|
||||
$error = '%s name is not valid';
|
||||
$phpcsFile->addError($error, $stackPtr, 'Invalid', $errorData);
|
||||
} else {
|
||||
$newName = strtoupper($firstBit{0}).substr($firstBit, 1).'_';
|
||||
foreach ($nameBits as $bit) {
|
||||
if ($bit !== '') {
|
||||
$newName .= strtoupper($bit{0}).substr($bit, 1).'_';
|
||||
}
|
||||
}
|
||||
|
||||
$newName = rtrim($newName, '_');
|
||||
$error = '%s name is not valid; consider %s instead';
|
||||
$data = $errorData;
|
||||
$data[] = $newName;
|
||||
$phpcsFile->addError($error, $stackPtr, 'Invalid', $data);
|
||||
}
|
||||
}//end if
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,285 @@
|
||||
<?php
|
||||
/**
|
||||
* PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) {
|
||||
throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found');
|
||||
}
|
||||
|
||||
/**
|
||||
* PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.
|
||||
*
|
||||
* Ensures method names are correct depending on whether they are public
|
||||
* or private, and that functions are named correctly.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of all PHP magic methods.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $magicMethods = array(
|
||||
'construct',
|
||||
'destruct',
|
||||
'call',
|
||||
'callStatic',
|
||||
'get',
|
||||
'set',
|
||||
'isset',
|
||||
'unset',
|
||||
'sleep',
|
||||
'wakeup',
|
||||
'toString',
|
||||
'set_state',
|
||||
'clone',
|
||||
'invoke',
|
||||
);
|
||||
|
||||
/**
|
||||
* A list of all PHP magic functions.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $magicFunctions = array('autoload');
|
||||
|
||||
|
||||
/**
|
||||
* Constructs a PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION), true);
|
||||
|
||||
}//end __construct()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the tokens within the scope.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file being processed.
|
||||
* @param int $stackPtr The position where this token was
|
||||
* found.
|
||||
* @param int $currScope The position of the current scope.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope)
|
||||
{
|
||||
$methodName = $phpcsFile->getDeclarationName($stackPtr);
|
||||
if ($methodName === null) {
|
||||
// Ignore closures.
|
||||
return;
|
||||
}
|
||||
|
||||
$className = $phpcsFile->getDeclarationName($currScope);
|
||||
$errorData = array($className.'::'.$methodName);
|
||||
|
||||
// Is this a magic method. IE. is prefixed with "__".
|
||||
if (preg_match('|^__|', $methodName) !== 0) {
|
||||
$magicPart = substr($methodName, 2);
|
||||
if (in_array($magicPart, $this->magicMethods) === false) {
|
||||
$error = 'Method name "%s" is invalid; only PHP magic methods should be prefixed with a double underscore';
|
||||
|
||||
$phpcsFile->addError($error, $stackPtr, 'MethodDoubleUnderscore', $errorData);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// PHP4 constructors are allowed to break our rules.
|
||||
if ($methodName === $className) {
|
||||
return;
|
||||
}
|
||||
|
||||
// PHP4 destructors are allowed to break our rules.
|
||||
if ($methodName === '_'.$className) {
|
||||
return;
|
||||
}
|
||||
|
||||
$methodProps = $phpcsFile->getMethodProperties($stackPtr);
|
||||
$isPublic = ($methodProps['scope'] === 'private') ? false : true;
|
||||
$scope = $methodProps['scope'];
|
||||
$scopeSpecified = $methodProps['scope_specified'];
|
||||
|
||||
// If it's a private method, it must have an underscore on the front.
|
||||
if ($isPublic === false && $methodName{0} !== '_') {
|
||||
$error = 'Private method name "%s" must be prefixed with an underscore';
|
||||
$phpcsFile->addError($error, $stackPtr, 'PrivateNoUnderscore', $errorData);
|
||||
return;
|
||||
}
|
||||
|
||||
// If it's not a private method, it must not have an underscore on the front.
|
||||
if ($isPublic === true && $scopeSpecified === true && $methodName{0} === '_') {
|
||||
$error = '%s method name "%s" must not be prefixed with an underscore';
|
||||
$data = array(
|
||||
ucfirst($scope),
|
||||
$errorData[0],
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'PublicUnderscore', $data);
|
||||
return;
|
||||
}
|
||||
|
||||
// If the scope was specified on the method, then the method must be
|
||||
// camel caps and an underscore should be checked for. If it wasn't
|
||||
// specified, treat it like a public method and remove the underscore
|
||||
// prefix if there is one because we cant determine if it is private or
|
||||
// public.
|
||||
$testMethodName = $methodName;
|
||||
if ($scopeSpecified === false && $methodName{0} === '_') {
|
||||
$testMethodName = substr($methodName, 1);
|
||||
}
|
||||
|
||||
if (PHP_CodeSniffer::isCamelCaps($testMethodName, false, $isPublic, false) === false) {
|
||||
if ($scopeSpecified === true) {
|
||||
$error = '%s method name "%s" is not in camel caps format';
|
||||
$data = array(
|
||||
ucfirst($scope),
|
||||
$errorData[0],
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'ScopeNotCamelCaps', $data);
|
||||
} else {
|
||||
$error = 'Method name "%s" is not in camel caps format';
|
||||
$phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $errorData);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
}//end processTokenWithinScope()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the tokens outside the scope.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file being processed.
|
||||
* @param int $stackPtr The position where this token was
|
||||
* found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processTokenOutsideScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
$functionName = $phpcsFile->getDeclarationName($stackPtr);
|
||||
if ($functionName === null) {
|
||||
// Ignore closures.
|
||||
return;
|
||||
}
|
||||
|
||||
$errorData = array($functionName);
|
||||
|
||||
// Is this a magic function. IE. is prefixed with "__".
|
||||
if (preg_match('|^__|', $functionName) !== 0) {
|
||||
$magicPart = substr($functionName, 2);
|
||||
if (in_array($magicPart, $this->magicFunctions) === false) {
|
||||
$error = 'Function name "%s" is invalid; only PHP magic methods should be prefixed with a double underscore';
|
||||
$phpcsFile->addError($error, $stackPtr, 'FunctionDoubleUnderscore', $errorData);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// Function names can be in two parts; the package name and
|
||||
// the function name.
|
||||
$packagePart = '';
|
||||
$camelCapsPart = '';
|
||||
$underscorePos = strrpos($functionName, '_');
|
||||
if ($underscorePos === false) {
|
||||
$camelCapsPart = $functionName;
|
||||
} else {
|
||||
$packagePart = substr($functionName, 0, $underscorePos);
|
||||
$camelCapsPart = substr($functionName, ($underscorePos + 1));
|
||||
|
||||
// We don't care about _'s on the front.
|
||||
$packagePart = ltrim($packagePart, '_');
|
||||
}
|
||||
|
||||
// If it has a package part, make sure the first letter is a capital.
|
||||
if ($packagePart !== '') {
|
||||
if ($functionName{0} === '_') {
|
||||
$error = 'Function name "%s" is invalid; only private methods should be prefixed with an underscore';
|
||||
$phpcsFile->addError($error, $stackPtr, 'FunctionUnderscore', $errorData);
|
||||
return;
|
||||
}
|
||||
|
||||
if ($functionName{0} !== strtoupper($functionName{0})) {
|
||||
$error = 'Function name "%s" is prefixed with a package name but does not begin with a capital letter';
|
||||
$phpcsFile->addError($error, $stackPtr, 'FunctionNoCaptial', $errorData);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// If it doesn't have a camel caps part, it's not valid.
|
||||
if (trim($camelCapsPart) === '') {
|
||||
$error = 'Function name "%s" is not valid; name appears incomplete';
|
||||
$phpcsFile->addError($error, $stackPtr, 'FunctionInvalid', $errorData);
|
||||
return;
|
||||
}
|
||||
|
||||
$validName = true;
|
||||
$newPackagePart = $packagePart;
|
||||
$newCamelCapsPart = $camelCapsPart;
|
||||
|
||||
// Every function must have a camel caps part, so check that first.
|
||||
if (PHP_CodeSniffer::isCamelCaps($camelCapsPart, false, true, false) === false) {
|
||||
$validName = false;
|
||||
$newCamelCapsPart = strtolower($camelCapsPart{0}).substr($camelCapsPart, 1);
|
||||
}
|
||||
|
||||
if ($packagePart !== '') {
|
||||
// Check that each new word starts with a capital.
|
||||
$nameBits = explode('_', $packagePart);
|
||||
foreach ($nameBits as $bit) {
|
||||
if ($bit{0} !== strtoupper($bit{0})) {
|
||||
$newPackagePart = '';
|
||||
foreach ($nameBits as $bit) {
|
||||
$newPackagePart .= strtoupper($bit{0}).substr($bit, 1).'_';
|
||||
}
|
||||
|
||||
$validName = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if ($validName === false) {
|
||||
$newName = rtrim($newPackagePart, '_').'_'.$newCamelCapsPart;
|
||||
if ($newPackagePart === '') {
|
||||
$newName = $newCamelCapsPart;
|
||||
} else {
|
||||
$newName = rtrim($newPackagePart, '_').'_'.$newCamelCapsPart;
|
||||
}
|
||||
|
||||
$error = 'Function name "%s" is invalid; consider "%s" instead';
|
||||
$data = $errorData;
|
||||
$data[] = $newName;
|
||||
$phpcsFile->addError($error, $stackPtr, 'FunctionNameInvalid', $data);
|
||||
}
|
||||
|
||||
}//end processTokenOutsideScope()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,116 @@
|
||||
<?php
|
||||
/**
|
||||
* PEAR_Sniffs_NamingConventions_ValidVariableNameSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
if (class_exists('PHP_CodeSniffer_Standards_AbstractVariableSniff', true) === false) {
|
||||
$error = 'Class PHP_CodeSniffer_Standards_AbstractVariableSniff not found';
|
||||
throw new PHP_CodeSniffer_Exception($error);
|
||||
}
|
||||
|
||||
/**
|
||||
* PEAR_Sniffs_NamingConventions_ValidVariableNameSniff.
|
||||
*
|
||||
* Checks the naming of member variables.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_NamingConventions_ValidVariableNameSniff extends PHP_CodeSniffer_Standards_AbstractVariableSniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Processes class member variables.
|
||||
*
|
||||
* @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
|
||||
*/
|
||||
protected function processMemberVar(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$memberProps = $phpcsFile->getMemberProperties($stackPtr);
|
||||
if (empty($memberProps) === true) {
|
||||
return;
|
||||
}
|
||||
|
||||
$memberName = ltrim($tokens[$stackPtr]['content'], '$');
|
||||
$isPublic = ($memberProps['scope'] === 'private') ? false : true;
|
||||
$scope = $memberProps['scope'];
|
||||
$scopeSpecified = $memberProps['scope_specified'];
|
||||
|
||||
// If it's a private member, it must have an underscore on the front.
|
||||
if ($isPublic === false && $memberName{0} !== '_') {
|
||||
$error = 'Private member variable "%s" must be prefixed with an underscore';
|
||||
$data = array($memberName);
|
||||
$phpcsFile->addError($error, $stackPtr, 'PrivateNoUnderscore', $data);
|
||||
return;
|
||||
}
|
||||
|
||||
// If it's not a private member, it must not have an underscore on the front.
|
||||
if ($isPublic === true && $scopeSpecified === true && $memberName{0} === '_') {
|
||||
$error = '%s member variable "%s" must not be prefixed with an underscore';
|
||||
$data = array(
|
||||
ucfirst($scope),
|
||||
$memberName,
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'PublicUnderscore', $data);
|
||||
return;
|
||||
}
|
||||
|
||||
}//end processMemberVar()
|
||||
|
||||
|
||||
/**
|
||||
* Processes normal variables.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where this token was found.
|
||||
* @param int $stackPtr The position where the token was found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processVariable(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
// We don't care about normal variables.
|
||||
return;
|
||||
|
||||
}//end processVariable()
|
||||
|
||||
|
||||
/**
|
||||
* Processes variables in double quoted strings.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where this token was found.
|
||||
* @param int $stackPtr The position where the token was found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processVariableInString(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
// We don't care about normal variables.
|
||||
return;
|
||||
|
||||
}//end processVariableInString()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,167 @@
|
||||
<?php
|
||||
/**
|
||||
* PEAR_Sniffs_WhiteSpace_ObjectOperatorIndentSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* PEAR_Sniffs_WhiteSpace_ObjectOperatorIndentSniff.
|
||||
*
|
||||
* Checks that object operators are indented 4 spaces if they are the first
|
||||
* thing on a line.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_WhiteSpace_ObjectOperatorIndentSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_OBJECT_OPERATOR);
|
||||
|
||||
}//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();
|
||||
|
||||
// Make sure this is the first object operator in a chain of them.
|
||||
$varToken = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
|
||||
if ($varToken === false || $tokens[$varToken]['code'] !== T_VARIABLE) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Make sure this is a chained call.
|
||||
$next = $phpcsFile->findNext(
|
||||
T_OBJECT_OPERATOR,
|
||||
($stackPtr + 1),
|
||||
null,
|
||||
false,
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
if ($next === false) {
|
||||
// Not a chained call.
|
||||
return;
|
||||
}
|
||||
|
||||
// Determine correct indent.
|
||||
for ($i = ($varToken - 1); $i >= 0; $i--) {
|
||||
if ($tokens[$i]['line'] !== $tokens[$varToken]['line']) {
|
||||
$i++;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
$requiredIndent = 0;
|
||||
if ($i >= 0 && $tokens[$i]['code'] === T_WHITESPACE) {
|
||||
$requiredIndent = strlen($tokens[$i]['content']);
|
||||
}
|
||||
|
||||
$requiredIndent += 4;
|
||||
|
||||
// Determine the scope of the original object operator.
|
||||
$origBrackets = null;
|
||||
if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
|
||||
$origBrackets = $tokens[$stackPtr]['nested_parenthesis'];
|
||||
}
|
||||
|
||||
$origConditions = null;
|
||||
if (isset($tokens[$stackPtr]['conditions']) === true) {
|
||||
$origConditions = $tokens[$stackPtr]['conditions'];
|
||||
}
|
||||
|
||||
// Check indentation of each object operator in the chain.
|
||||
// If the first object operator is on a different line than
|
||||
// the variable, make sure we check its indentation too.
|
||||
if ($tokens[$stackPtr]['line'] > $tokens[$varToken]['line']) {
|
||||
$next = $stackPtr;
|
||||
}
|
||||
|
||||
while ($next !== false) {
|
||||
// Make sure it is in the same scope, otherwise dont check indent.
|
||||
$brackets = null;
|
||||
if (isset($tokens[$next]['nested_parenthesis']) === true) {
|
||||
$brackets = $tokens[$next]['nested_parenthesis'];
|
||||
}
|
||||
|
||||
$conditions = null;
|
||||
if (isset($tokens[$next]['conditions']) === true) {
|
||||
$conditions = $tokens[$next]['conditions'];
|
||||
}
|
||||
|
||||
if ($origBrackets === $brackets && $origConditions === $conditions) {
|
||||
// Make sure it starts a line, otherwise dont check indent.
|
||||
$indent = $tokens[($next - 1)];
|
||||
if ($indent['code'] === T_WHITESPACE) {
|
||||
if ($indent['line'] === $tokens[$next]['line']) {
|
||||
$foundIndent = strlen($indent['content']);
|
||||
} else {
|
||||
$foundIndent = 0;
|
||||
}
|
||||
|
||||
if ($foundIndent !== $requiredIndent) {
|
||||
$error = 'Object operator not indented correctly; expected %s spaces but found %s';
|
||||
$data = array(
|
||||
$requiredIndent,
|
||||
$foundIndent,
|
||||
);
|
||||
$phpcsFile->addError($error, $next, 'Incorrect', $data);
|
||||
}
|
||||
}
|
||||
|
||||
// It cant be the last thing on the line either.
|
||||
$content = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true);
|
||||
if ($tokens[$content]['line'] !== $tokens[$next]['line']) {
|
||||
$error = 'Object operator must be at the start of the line, not the end';
|
||||
$phpcsFile->addError($error, $next, 'StartOfLine');
|
||||
}
|
||||
}//end if
|
||||
|
||||
$next = $phpcsFile->findNext(
|
||||
T_OBJECT_OPERATOR,
|
||||
($next + 1),
|
||||
null,
|
||||
false,
|
||||
null,
|
||||
true
|
||||
);
|
||||
}//end while
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,143 @@
|
||||
<?php
|
||||
/**
|
||||
* PEAR_Sniffs_Whitespace_ScopeClosingBraceSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* PEAR_Sniffs_Whitespace_ScopeClosingBraceSniff.
|
||||
*
|
||||
* Checks that the closing braces of scopes are aligned correctly.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_WhiteSpace_ScopeClosingBraceSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* 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']) {
|
||||
$error = 'Closing brace must be on a line by itself';
|
||||
$phpcsFile->addError($error, $scopeEnd, 'Line');
|
||||
return;
|
||||
}
|
||||
|
||||
// Check now that the closing brace is lined up correctly.
|
||||
$braceIndent = $tokens[$scopeEnd]['column'];
|
||||
$isBreakCloser = ($tokens[$scopeEnd]['code'] === T_BREAK);
|
||||
if (in_array($tokens[$stackPtr]['code'], array(T_CASE, T_DEFAULT)) === true
|
||||
&& $isBreakCloser === true
|
||||
) {
|
||||
// BREAK statements should be indented 4 spaces from the
|
||||
// CASE or DEFAULT statement.
|
||||
if ($braceIndent !== ($startColumn + 4)) {
|
||||
$error = 'Break statement indented incorrectly; expected %s spaces, found %s';
|
||||
$data = array(
|
||||
($startColumn + 3),
|
||||
($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);
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,48 @@
|
||||
<?php
|
||||
/**
|
||||
* PEAR_Sniffs_Whitespace_ScopeIndentSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
if (class_exists('Generic_Sniffs_WhiteSpace_ScopeIndentSniff', true) === false) {
|
||||
$error = 'Class Generic_Sniffs_WhiteSpace_ScopeIndentSniff not found';
|
||||
throw new PHP_CodeSniffer_Exception($error);
|
||||
}
|
||||
|
||||
/**
|
||||
* PEAR_Sniffs_Whitespace_ScopeIndentSniff.
|
||||
*
|
||||
* Checks that control structures are structured correctly, and their content
|
||||
* is indented correctly.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class PEAR_Sniffs_WhiteSpace_ScopeIndentSniff extends Generic_Sniffs_WhiteSpace_ScopeIndentSniff
|
||||
{
|
||||
|
||||
/**
|
||||
* Any scope openers that should not cause an indent.
|
||||
*
|
||||
* @var array(int)
|
||||
*/
|
||||
protected $nonIndentingScopes = array(T_SWITCH);
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
39
database/php/pear/PHP/CodeSniffer/Standards/PEAR/ruleset.xml
Normal file
39
database/php/pear/PHP/CodeSniffer/Standards/PEAR/ruleset.xml
Normal file
@@ -0,0 +1,39 @@
|
||||
<?xml version="1.0"?>
|
||||
<ruleset name="PEAR">
|
||||
<description>The PEAR coding standard.</description>
|
||||
|
||||
<!-- Include some additional sniffs from the Generic standard -->
|
||||
<rule ref="Generic.Functions.FunctionCallArgumentSpacing"/>
|
||||
<rule ref="Generic.NamingConventions.UpperCaseConstantName"/>
|
||||
<rule ref="Generic.PHP.LowerCaseConstant"/>
|
||||
<rule ref="Generic.PHP.DisallowShortOpenTag"/>
|
||||
<rule ref="Generic.WhiteSpace.DisallowTabIndent"/>
|
||||
|
||||
<!-- Lines can be 85 chars long, but never show errors -->
|
||||
<rule ref="Generic.Files.LineLength">
|
||||
<properties>
|
||||
<property name="lineLimit" value="85"/>
|
||||
<property name="absoluteLineLimit" value="0"/>
|
||||
</properties>
|
||||
</rule>
|
||||
|
||||
<!-- Use Unix newlines -->
|
||||
<rule ref="Generic.Files.LineEndings">
|
||||
<properties>
|
||||
<property name="eolChar" value="\n"/>
|
||||
</properties>
|
||||
</rule>
|
||||
|
||||
<!-- This messgae is not required as spaces are allowed for alignment -->
|
||||
<rule ref="Generic.Functions.FunctionCallArgumentSpacing.TooMuchSpaceAfterComma">
|
||||
<severity>0</severity>
|
||||
</rule>
|
||||
|
||||
<!-- Use warnings for inline control structures -->
|
||||
<rule ref="Generic.ControlStructures.InlineControlStructure">
|
||||
<properties>
|
||||
<property name="error" value="false"/>
|
||||
</properties>
|
||||
</rule>
|
||||
|
||||
</ruleset>
|
||||
@@ -0,0 +1,27 @@
|
||||
<?xml version="1.0"?>
|
||||
<ruleset name="PHP_CodeSniffer">
|
||||
<description>The coding standard for PHP_CodeSniffer itself.</description>
|
||||
<exclude-pattern>*/Tests/*</exclude-pattern>
|
||||
|
||||
<!-- Include the whole PEAR standard -->
|
||||
<rule ref="PEAR"/>
|
||||
|
||||
<!-- Include most of the Squiz standard -->
|
||||
<rule ref="Squiz">
|
||||
<exclude name="Squiz.Classes.ClassFileName"/>
|
||||
<exclude name="Squiz.Classes.ValidClassName"/>
|
||||
<exclude name="Squiz.Commenting.ClassComment"/>
|
||||
<exclude name="Squiz.Commenting.FileComment"/>
|
||||
<exclude name="Squiz.Commenting.FunctionComment"/>
|
||||
<exclude name="Squiz.Commenting.VariableComment"/>
|
||||
<exclude name="Squiz.ControlStructures.SwitchDeclaration"/>
|
||||
<exclude name="Squiz.Files.FileExtension"/>
|
||||
<exclude name="Squiz.NamingConventions.ConstantCase"/>
|
||||
</rule>
|
||||
|
||||
<!-- We allow variables to be used inside double quoted strings -->
|
||||
<rule ref="Squiz.Strings.DoubleQuoteUsage.ContainsVar">
|
||||
<severity>0</severity>
|
||||
</rule>
|
||||
|
||||
</ruleset>
|
||||
@@ -0,0 +1,117 @@
|
||||
<documentation title="Array Declarations">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
This standard covers all array declarations, regardless of the number and type of values contained within the array.
|
||||
]]>
|
||||
</standard>
|
||||
<standard>
|
||||
<![CDATA[
|
||||
The <em>array</em> keyword must be lowercase.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: array keyword lowercase">
|
||||
<![CDATA[
|
||||
$array = <em>a</em>rray('val1', 'val2');
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: first letter capitialised">
|
||||
<![CDATA[
|
||||
$array = <em>A</em>rray('val1', 'val2');
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
<standard>
|
||||
<![CDATA[
|
||||
The first array key must begin on the line after the <em>array</em> keyword.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: first key on second line">
|
||||
<![CDATA[
|
||||
$array = array(
|
||||
<em>'key1'</em> => 'value1',
|
||||
'key2' => 'value2',
|
||||
);
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: first key on same line">
|
||||
<![CDATA[
|
||||
$array = array(<em>'key1'</em> => 'value1',
|
||||
'key2' => 'value2',
|
||||
);
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
<standard>
|
||||
<![CDATA[
|
||||
All array keys must be indented to one space after the start of the <em>array</em> keyword. The closing parenthesis must be aligned with the start of the <em>array</em> keyword.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: aligned correctly">
|
||||
<![CDATA[
|
||||
$array = array(
|
||||
<em> </em>'key1' => 'value1',
|
||||
<em> </em>'key2' => 'value2',
|
||||
);
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: keys and parenthesis aligned incorrectly">
|
||||
<![CDATA[
|
||||
$array = array(
|
||||
<em>'</em>key1' => 'value1',
|
||||
<em>'</em>key2' => 'value2',
|
||||
);
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
<standard>
|
||||
<![CDATA[
|
||||
All double arrow symbols must be aligned to one space after the longest array key. Alignment must be achieved using spaces.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: keys and values aligned">
|
||||
<![CDATA[
|
||||
$array = array(
|
||||
'keyTen'<em> </em>=> 'ValueTen',
|
||||
'keyTwenty'<em> </em>=> 'ValueTwenty',
|
||||
);
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: alignment incorrect">
|
||||
<![CDATA[
|
||||
$array = array(
|
||||
'keyTen'<em> </em>=> 'ValueTen',
|
||||
'keyTwenty'<em> </em>=> 'ValueTwenty',
|
||||
);
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
<standard>
|
||||
<![CDATA[
|
||||
All array values must be followed by a comma, including the final value.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: comma after each value">
|
||||
<![CDATA[
|
||||
$array = array(
|
||||
'key1' => 'value1',
|
||||
'key2' => 'value2',
|
||||
'key3' => 'value3'<em>,</em>
|
||||
);
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: no comma after last value">
|
||||
<![CDATA[
|
||||
$array = array(
|
||||
'key1' => 'value1',
|
||||
'key2' => 'value2',
|
||||
'key3' => 'value3'<em> </em>
|
||||
);
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,97 @@
|
||||
<?php
|
||||
/**
|
||||
* Squiz_Sniffs_Arrays_ArrayBracketSpacingSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Squiz_Sniffs_Arrays_ArrayBracketSpacingSniff.
|
||||
*
|
||||
* Ensure that there are no spaces around square brackets.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Squiz_Sniffs_Arrays_ArrayBracketSpacingSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(
|
||||
T_OPEN_SQUARE_BRACKET,
|
||||
T_CLOSE_SQUARE_BRACKET,
|
||||
);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, when one of its tokens is encountered.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The current file being checked.
|
||||
* @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();
|
||||
|
||||
// No bracket can have space before them.
|
||||
$prevType = $tokens[($stackPtr - 1)]['code'];
|
||||
if (in_array($prevType, PHP_CodeSniffer_Tokens::$emptyTokens) === true) {
|
||||
$nonSpace = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 2), null, true);
|
||||
$expected = $tokens[$nonSpace]['content'].$tokens[$stackPtr]['content'];
|
||||
$found = $phpcsFile->getTokensAsString($nonSpace, ($stackPtr - $nonSpace)).$tokens[$stackPtr]['content'];
|
||||
$error = 'Space found before square bracket; expected "%s" but found "%s"';
|
||||
$data = array(
|
||||
$expected,
|
||||
$found,
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'SpaceBeforeBracket', $data);
|
||||
}
|
||||
|
||||
if ($tokens[$stackPtr]['type'] === 'T_OPEN_SQUARE_BRACKET') {
|
||||
// Open brackets can't have spaces on after them either.
|
||||
$nextType = $tokens[($stackPtr + 1)]['code'];
|
||||
if (in_array($nextType, PHP_CodeSniffer_Tokens::$emptyTokens) === true) {
|
||||
$nonSpace = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 2), null, true);
|
||||
$expected = $tokens[$stackPtr]['content'].$tokens[$nonSpace]['content'];
|
||||
$found = $phpcsFile->getTokensAsString($stackPtr, ($nonSpace - $stackPtr + 1));
|
||||
$error = 'Space found after square bracket; expected "%s" but found "%s"';
|
||||
$data = array(
|
||||
$expected,
|
||||
$found,
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'SpaceAfterBracket', $data);
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,513 @@
|
||||
<?php
|
||||
/**
|
||||
* A test to ensure that arrays conform to the array coding standard.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* A test to ensure that arrays conform to the array coding standard.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @author Marc McIntyre <mmcintyre@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Squiz_Sniffs_Arrays_ArrayDeclarationSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_ARRAY);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes this sniff, when one of its tokens is encountered.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The current file being checked.
|
||||
* @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();
|
||||
|
||||
// Array keyword should be lower case.
|
||||
if (strtolower($tokens[$stackPtr]['content']) !== $tokens[$stackPtr]['content']) {
|
||||
$error = 'Array keyword should be lower case; expected "array" but found "%s"';
|
||||
$data = array($tokens[$stackPtr]['content']);
|
||||
$phpcsFile->addError($error, $stackPtr, 'NotLowerCase', $data);
|
||||
}
|
||||
|
||||
$arrayStart = $tokens[$stackPtr]['parenthesis_opener'];
|
||||
$arrayEnd = $tokens[$arrayStart]['parenthesis_closer'];
|
||||
$keywordStart = $tokens[$stackPtr]['column'];
|
||||
|
||||
if ($arrayStart != ($stackPtr + 1)) {
|
||||
$error = 'There must be no space between the Array keyword and the opening parenthesis';
|
||||
$phpcsFile->addError($error, $stackPtr, 'SpaceAfterKeyword');
|
||||
}
|
||||
|
||||
// Check for empty arrays.
|
||||
$content = $phpcsFile->findNext(array(T_WHITESPACE), ($arrayStart + 1), ($arrayEnd + 1), true);
|
||||
if ($content === $arrayEnd) {
|
||||
// Empty array, but if the brackets aren't together, there's a problem.
|
||||
if (($arrayEnd - $arrayStart) !== 1) {
|
||||
$error = 'Empty array declaration must have no space between the parentheses';
|
||||
$phpcsFile->addError($error, $stackPtr, 'SpaceInEmptyArray');
|
||||
|
||||
// We can return here because there is nothing else to check. All code
|
||||
// below can assume that the array is not empty.
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
if ($tokens[$arrayStart]['line'] === $tokens[$arrayEnd]['line']) {
|
||||
// Single line array.
|
||||
// Check if there are multiple values. If so, then it has to be multiple lines
|
||||
// unless it is contained inside a function call or condition.
|
||||
$valueCount = 0;
|
||||
$commas = array();
|
||||
for ($i = ($arrayStart + 1); $i < $arrayEnd; $i++) {
|
||||
// Skip bracketed statements, like function calls.
|
||||
if ($tokens[$i]['code'] === T_OPEN_PARENTHESIS) {
|
||||
$i = $tokens[$i]['parenthesis_closer'];
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($tokens[$i]['code'] === T_COMMA) {
|
||||
$valueCount++;
|
||||
$commas[] = $i;
|
||||
}
|
||||
}
|
||||
|
||||
// Now check each of the double arrows (if any).
|
||||
$nextArrow = $arrayStart;
|
||||
while (($nextArrow = $phpcsFile->findNext(T_DOUBLE_ARROW, ($nextArrow + 1), $arrayEnd)) !== false) {
|
||||
if ($tokens[($nextArrow - 1)]['code'] !== T_WHITESPACE) {
|
||||
$content = $tokens[($nextArrow - 1)]['content'];
|
||||
$error = 'Expected 1 space between "%s" and double arrow; 0 found';
|
||||
$data = array($content);
|
||||
$phpcsFile->addError($error, $nextArrow, 'NoSpaceBeforeDoubleArrow', $data);
|
||||
} else {
|
||||
$spaceLength = strlen($tokens[($nextArrow - 1)]['content']);
|
||||
if ($spaceLength !== 1) {
|
||||
$content = $tokens[($nextArrow - 2)]['content'];
|
||||
$error = 'Expected 1 space between "%s" and double arrow; %s found';
|
||||
$data = array(
|
||||
$content,
|
||||
$spaceLength,
|
||||
);
|
||||
$phpcsFile->addError($error, $nextArrow, 'SpaceBeforeDoubleArrow', $data);
|
||||
}
|
||||
}
|
||||
|
||||
if ($tokens[($nextArrow + 1)]['code'] !== T_WHITESPACE) {
|
||||
$content = $tokens[($nextArrow + 1)]['content'];
|
||||
$error = 'Expected 1 space between double arrow and "%s"; 0 found';
|
||||
$data = array($content);
|
||||
$phpcsFile->addError($error, $nextArrow, 'NoSpaceAfterDoubleArrow', $data);
|
||||
} else {
|
||||
$spaceLength = strlen($tokens[($nextArrow + 1)]['content']);
|
||||
if ($spaceLength !== 1) {
|
||||
$content = $tokens[($nextArrow + 2)]['content'];
|
||||
$error = 'Expected 1 space between double arrow and "%s"; %s found';
|
||||
$data = array(
|
||||
$content,
|
||||
$spaceLength,
|
||||
);
|
||||
$phpcsFile->addError($error, $nextArrow, 'SpaceAfterDoubleArrow', $data);
|
||||
}
|
||||
}
|
||||
}//end while
|
||||
|
||||
if ($valueCount > 0) {
|
||||
$conditionCheck = $phpcsFile->findPrevious(array(T_OPEN_PARENTHESIS, T_SEMICOLON), ($stackPtr - 1), null, false);
|
||||
|
||||
if (($conditionCheck === false) || ($tokens[$conditionCheck]['line'] !== $tokens[$stackPtr]['line'])) {
|
||||
$error = 'Array with multiple values cannot be declared on a single line';
|
||||
$phpcsFile->addError($error, $stackPtr, 'SingleLineNotAllowed');
|
||||
return;
|
||||
}
|
||||
|
||||
// We have a multiple value array that is inside a condition or
|
||||
// function. Check its spacing is correct.
|
||||
foreach ($commas as $comma) {
|
||||
if ($tokens[($comma + 1)]['code'] !== T_WHITESPACE) {
|
||||
$content = $tokens[($comma + 1)]['content'];
|
||||
$error = 'Expected 1 space between comma and "%s"; 0 found';
|
||||
$data = array($content);
|
||||
$phpcsFile->addError($error, $comma, 'NoSpaceAfterComma', $data);
|
||||
} else {
|
||||
$spaceLength = strlen($tokens[($comma + 1)]['content']);
|
||||
if ($spaceLength !== 1) {
|
||||
$content = $tokens[($comma + 2)]['content'];
|
||||
$error = 'Expected 1 space between comma and "%s"; %s found';
|
||||
$data = array(
|
||||
$content,
|
||||
$spaceLength,
|
||||
);
|
||||
$phpcsFile->addError($error, $comma, 'SpaceAfterComma', $data);
|
||||
}
|
||||
}
|
||||
|
||||
if ($tokens[($comma - 1)]['code'] === T_WHITESPACE) {
|
||||
$content = $tokens[($comma - 2)]['content'];
|
||||
$spaceLength = strlen($tokens[($comma - 1)]['content']);
|
||||
$error = 'Expected 0 spaces between "%s" and comma; %s found';
|
||||
$data = array(
|
||||
$content,
|
||||
$spaceLength,
|
||||
);
|
||||
$phpcsFile->addError($error, $comma, 'SpaceBeforeComma', $data);
|
||||
}
|
||||
}//end foreach
|
||||
}//end if
|
||||
|
||||
return;
|
||||
}//end if
|
||||
|
||||
// Check the closing bracket is on a new line.
|
||||
$lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($arrayEnd - 1), $arrayStart, true);
|
||||
if ($tokens[$lastContent]['line'] !== ($tokens[$arrayEnd]['line'] - 1)) {
|
||||
$error = 'Closing parenthesis of array declaration must be on a new line';
|
||||
$phpcsFile->addError($error, $arrayEnd, 'CloseBraceNewLine');
|
||||
} else if ($tokens[$arrayEnd]['column'] !== $keywordStart) {
|
||||
// Check the closing bracket is lined up under the a in array.
|
||||
$expected = $keywordStart;
|
||||
$found = $tokens[$arrayEnd]['column'];
|
||||
$error = 'Closing parenthesis not aligned correctly; expected %s space(s) but found %s';
|
||||
$data = array(
|
||||
$expected,
|
||||
$found,
|
||||
);
|
||||
$phpcsFile->addError($error, $arrayEnd, 'CloseBraceNotAligned', $data);
|
||||
}
|
||||
|
||||
$nextToken = $stackPtr;
|
||||
$lastComma = $stackPtr;
|
||||
$keyUsed = false;
|
||||
$singleUsed = false;
|
||||
$lastToken = '';
|
||||
$indices = array();
|
||||
$maxLength = 0;
|
||||
|
||||
// Find all the double arrows that reside in this scope.
|
||||
while (($nextToken = $phpcsFile->findNext(array(T_DOUBLE_ARROW, T_COMMA, T_ARRAY), ($nextToken + 1), $arrayEnd)) !== false) {
|
||||
$currentEntry = array();
|
||||
|
||||
if ($tokens[$nextToken]['code'] === T_ARRAY) {
|
||||
// Let subsequent calls of this test handle nested arrays.
|
||||
$indices[] = array(
|
||||
'value' => $nextToken,
|
||||
);
|
||||
$nextToken = $tokens[$tokens[$nextToken]['parenthesis_opener']]['parenthesis_closer'];
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($tokens[$nextToken]['code'] === T_COMMA) {
|
||||
$stackPtrCount = 0;
|
||||
if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
|
||||
$stackPtrCount = count($tokens[$stackPtr]['nested_parenthesis']);
|
||||
}
|
||||
|
||||
if (count($tokens[$nextToken]['nested_parenthesis']) > ($stackPtrCount + 1)) {
|
||||
// This comma is inside more parenthesis than the ARRAY keyword,
|
||||
// then there it is actually a comma used to seperate arguments
|
||||
// in a function call.
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($keyUsed === true && $lastToken === T_COMMA) {
|
||||
$error = 'No key specified for array entry; first entry specifies key';
|
||||
$phpcsFile->addError($error, $nextToken, 'NoKeySpecified');
|
||||
return;
|
||||
}
|
||||
|
||||
if ($keyUsed === false) {
|
||||
if ($tokens[($nextToken - 1)]['code'] === T_WHITESPACE) {
|
||||
$content = $tokens[($nextToken - 2)]['content'];
|
||||
$spaceLength = strlen($tokens[($nextToken - 1)]['content']);
|
||||
$error = 'Expected 0 spaces between "%s" and comma; %s found';
|
||||
$data = array(
|
||||
$content,
|
||||
$spaceLength,
|
||||
);
|
||||
$phpcsFile->addError($error, $nextToken, 'SpaceBeforeComma', $data);
|
||||
}
|
||||
|
||||
// Find the value, which will be the first token on the line,
|
||||
// excluding the leading whitespace.
|
||||
$valueContent = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($nextToken - 1), null, true);
|
||||
while ($tokens[$valueContent]['line'] === $tokens[$nextToken]['line']) {
|
||||
if ($valueContent === $arrayStart) {
|
||||
// Value must have been on the same line as the array
|
||||
// parenthesis, so we have reached the start of the value.
|
||||
break;
|
||||
}
|
||||
|
||||
$valueContent--;
|
||||
}
|
||||
|
||||
$valueContent = $phpcsFile->findNext(T_WHITESPACE, ($valueContent + 1), $nextToken, true);
|
||||
$indices[] = array('value' => $valueContent);
|
||||
$singleUsed = true;
|
||||
}//end if
|
||||
|
||||
$lastToken = T_COMMA;
|
||||
continue;
|
||||
}//end if
|
||||
|
||||
if ($tokens[$nextToken]['code'] === T_DOUBLE_ARROW) {
|
||||
if ($singleUsed === true) {
|
||||
$error = 'Key specified for array entry; first entry has no key';
|
||||
$phpcsFile->addError($error, $nextToken, 'KeySpecified');
|
||||
return;
|
||||
}
|
||||
|
||||
$currentEntry['arrow'] = $nextToken;
|
||||
$keyUsed = true;
|
||||
|
||||
// Find the start of index that uses this double arrow.
|
||||
$indexEnd = $phpcsFile->findPrevious(T_WHITESPACE, ($nextToken - 1), $arrayStart, true);
|
||||
$indexStart = $phpcsFile->findPrevious(T_WHITESPACE, $indexEnd, $arrayStart);
|
||||
|
||||
if ($indexStart === false) {
|
||||
$index = $indexEnd;
|
||||
} else {
|
||||
$index = ($indexStart + 1);
|
||||
}
|
||||
|
||||
$currentEntry['index'] = $index;
|
||||
$currentEntry['index_content'] = $phpcsFile->getTokensAsString($index, ($indexEnd - $index + 1));
|
||||
|
||||
$indexLength = strlen($currentEntry['index_content']);
|
||||
if ($maxLength < $indexLength) {
|
||||
$maxLength = $indexLength;
|
||||
}
|
||||
|
||||
// Find the value of this index.
|
||||
$nextContent = $phpcsFile->findNext(array(T_WHITESPACE), ($nextToken + 1), $arrayEnd, true);
|
||||
$currentEntry['value'] = $nextContent;
|
||||
$indices[] = $currentEntry;
|
||||
$lastToken = T_DOUBLE_ARROW;
|
||||
}//end if
|
||||
}//end while
|
||||
|
||||
// Check for mutli-line arrays that should be single-line.
|
||||
$singleValue = false;
|
||||
|
||||
if (empty($indices) === true) {
|
||||
$singleValue = true;
|
||||
} else if (count($indices) === 1) {
|
||||
if ($lastToken === T_COMMA) {
|
||||
// There may be another array value without a comma.
|
||||
$exclude = PHP_CodeSniffer_Tokens::$emptyTokens;
|
||||
$exclude[] = T_COMMA;
|
||||
$nextContent = $phpcsFile->findNext($exclude, ($indices[0]['value'] + 1), $arrayEnd, true);
|
||||
if ($nextContent === false) {
|
||||
$singleValue = true;
|
||||
}
|
||||
}
|
||||
|
||||
if ($singleValue === false && isset($indices[0]['arrow']) === false) {
|
||||
// A single nested array as a value is fine.
|
||||
if ($tokens[$indices[0]['value']]['code'] !== T_ARRAY) {
|
||||
$singleValue === true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if ($singleValue === true) {
|
||||
// Array cannot be empty, so this is a multi-line array with
|
||||
// a single value. It should be defined on single line.
|
||||
$error = 'Multi-line array contains a single value; use single-line array instead';
|
||||
$phpcsFile->addError($error, $stackPtr, 'MulitLineNotAllowed');
|
||||
return;
|
||||
}
|
||||
|
||||
/*
|
||||
This section checks for arrays that don't specify keys.
|
||||
|
||||
Arrays such as:
|
||||
array(
|
||||
'aaa',
|
||||
'bbb',
|
||||
'd',
|
||||
);
|
||||
*/
|
||||
|
||||
if ($keyUsed === false && empty($indices) === false) {
|
||||
$count = count($indices);
|
||||
$lastIndex = $indices[($count - 1)]['value'];
|
||||
|
||||
$trailingContent = $phpcsFile->findPrevious(T_WHITESPACE, ($arrayEnd - 1), $lastIndex, true);
|
||||
if ($tokens[$trailingContent]['code'] !== T_COMMA) {
|
||||
$error = 'Comma required after last value in array declaration';
|
||||
$phpcsFile->addError($error, $trailingContent, 'NoCommaAfterLast');
|
||||
}
|
||||
|
||||
foreach ($indices as $value) {
|
||||
if (empty($value['value']) === true) {
|
||||
// Array was malformed and we couldn't figure out
|
||||
// the array value correctly, so we have to ignore it.
|
||||
// Other parts of this sniff will correct the error.
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($tokens[($value['value'] - 1)]['code'] === T_WHITESPACE) {
|
||||
// A whitespace token before this value means that the value
|
||||
// was indented and not flush with the opening parenthesis.
|
||||
if ($tokens[$value['value']]['column'] !== ($keywordStart + 1)) {
|
||||
$error = 'Array value not aligned correctly; expected %s spaces but found %s';
|
||||
$data = array(
|
||||
($keywordStart + 1),
|
||||
$tokens[$value['value']]['column'],
|
||||
);
|
||||
$phpcsFile->addError($error, $value['value'], 'ValueNotAligned', $data);
|
||||
}
|
||||
}
|
||||
}
|
||||
}//end if
|
||||
|
||||
/*
|
||||
Below the actual indentation of the array is checked.
|
||||
Errors will be thrown when a key is not aligned, when
|
||||
a double arrow is not aligned, and when a value is not
|
||||
aligned correctly.
|
||||
If an error is found in one of the above areas, then errors
|
||||
are not reported for the rest of the line to avoid reporting
|
||||
spaces and columns incorrectly. Often fixing the first
|
||||
problem will fix the other 2 anyway.
|
||||
|
||||
For example:
|
||||
|
||||
$a = array(
|
||||
'index' => '2',
|
||||
);
|
||||
|
||||
In this array, the double arrow is indented too far, but this
|
||||
will also cause an error in the value's alignment. If the arrow were
|
||||
to be moved back one space however, then both errors would be fixed.
|
||||
*/
|
||||
|
||||
$numValues = count($indices);
|
||||
|
||||
$indicesStart = ($keywordStart + 1);
|
||||
$arrowStart = ($indicesStart + $maxLength + 1);
|
||||
$valueStart = ($arrowStart + 3);
|
||||
foreach ($indices as $index) {
|
||||
if (isset($index['index']) === false) {
|
||||
// Array value only.
|
||||
if (($tokens[$index['value']]['line'] === $tokens[$stackPtr]['line']) && ($numValues > 1)) {
|
||||
$error = 'The first value in a multi-value array must be on a new line';
|
||||
$phpcsFile->addError($error, $stackPtr, 'FirstValueNoNewline');
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
if (($tokens[$index['index']]['line'] === $tokens[$stackPtr]['line'])) {
|
||||
$error = 'The first index in a multi-value array must be on a new line';
|
||||
$phpcsFile->addError($error, $stackPtr, 'FirstIndexNoNewline');
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($tokens[$index['index']]['column'] !== $indicesStart) {
|
||||
$error = 'Array key not aligned correctly; expected %s spaces but found %s';
|
||||
$data = array(
|
||||
($indicesStart - 1),
|
||||
($tokens[$index['index']]['column'] - 1),
|
||||
);
|
||||
$phpcsFile->addError($error, $index['index'], 'KeyNotAligned', $data);
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($tokens[$index['arrow']]['column'] !== $arrowStart) {
|
||||
$expected = ($arrowStart - (strlen($index['index_content']) + $tokens[$index['index']]['column']));
|
||||
$found = ($tokens[$index['arrow']]['column'] - (strlen($index['index_content']) + $tokens[$index['index']]['column']));
|
||||
|
||||
$error = 'Array double arrow not aligned correctly; expected %s space(s) but found %s';
|
||||
$data = array(
|
||||
$expected,
|
||||
$found,
|
||||
);
|
||||
$phpcsFile->addError($error, $index['arrow'], 'DoubleArrowNotAligned', $data);
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($tokens[$index['value']]['column'] !== $valueStart) {
|
||||
$expected = ($valueStart - (strlen($tokens[$index['arrow']]['content']) + $tokens[$index['arrow']]['column']));
|
||||
$found = ($tokens[$index['value']]['column'] - (strlen($tokens[$index['arrow']]['content']) + $tokens[$index['arrow']]['column']));
|
||||
|
||||
$error = 'Array value not aligned correctly; expected %s space(s) but found %s';
|
||||
$data = array(
|
||||
$expected,
|
||||
$found,
|
||||
);
|
||||
$phpcsFile->addError($error, $index['arrow'], 'ValueNotAligned', $data);
|
||||
}
|
||||
|
||||
// Check each line ends in a comma.
|
||||
if ($tokens[$index['value']]['code'] !== T_ARRAY) {
|
||||
$nextComma = false;
|
||||
for ($i = ($index['value'] + 1); $i < $arrayEnd; $i++) {
|
||||
// Skip bracketed statements, like function calls.
|
||||
if ($tokens[$i]['code'] === T_OPEN_PARENTHESIS) {
|
||||
$i = $tokens[$i]['parenthesis_closer'];
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($tokens[$i]['code'] === T_COMMA) {
|
||||
$nextComma = $i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (($nextComma === false) || ($tokens[$nextComma]['line'] !== $tokens[$index['value']]['line'])) {
|
||||
$error = 'Each line in an array declaration must end in a comma';
|
||||
$phpcsFile->addError($error, $index['value'], 'NoComma');
|
||||
}
|
||||
|
||||
// Check that there is no space before the comma.
|
||||
if ($nextComma !== false && $tokens[($nextComma - 1)]['code'] === T_WHITESPACE) {
|
||||
$content = $tokens[($nextComma - 2)]['content'];
|
||||
$spaceLength = strlen($tokens[($nextComma - 1)]['content']);
|
||||
$error = 'Expected 0 spaces between "%s" and comma; %s found';
|
||||
$data = array(
|
||||
$content,
|
||||
$spaceLength,
|
||||
);
|
||||
$phpcsFile->addError($error, $nextComma, 'SpaceBeforeComma', $data);
|
||||
}
|
||||
}
|
||||
}//end foreach
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,103 @@
|
||||
<?php
|
||||
/**
|
||||
* Squiz_Sniffs_CSS_ClassDefinitionClosingBraceSpaceSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Squiz_Sniffs_CSS_ClassDefinitionClosingBraceSpaceSniff.
|
||||
*
|
||||
* Ensure there is a single blank line after the closing brace of a class definition.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Squiz_Sniffs_CSS_ClassDefinitionClosingBraceSpaceSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array('CSS');
|
||||
|
||||
|
||||
/**
|
||||
* Returns the token types that this sniff is interested in.
|
||||
*
|
||||
* @return array(int)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_CLOSE_CURLY_BRACKET);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the tokens that this sniff is interested in.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
|
||||
* @param int $stackPtr The position in the stack where
|
||||
* the token was found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
|
||||
if ($next === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($tokens[$next]['code'] !== T_CLOSE_TAG) {
|
||||
$found = (($tokens[$next]['line'] - $tokens[$stackPtr]['line']) - 1);
|
||||
if ($found !== 1) {
|
||||
$error = 'Expected one blank line after closing brace of class definition; %s found';
|
||||
$data = array($found);
|
||||
$phpcsFile->addError($error, $stackPtr, 'SpacingAfterClose', $data);
|
||||
}
|
||||
}
|
||||
|
||||
// Ignore nested style definitions from here on. The spacing before the closing brace
|
||||
// (a single blank line) will be enforced by the above check, which ensures there is a
|
||||
// blank line after the last nested class.
|
||||
$found = $phpcsFile->findPrevious(
|
||||
T_CLOSE_CURLY_BRACKET,
|
||||
($stackPtr - 1),
|
||||
$tokens[$stackPtr]['bracket_opener']
|
||||
);
|
||||
if ($found !== false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
|
||||
if ($prev !== false && $tokens[$prev]['line'] !== ($tokens[$stackPtr]['line'] - 1)) {
|
||||
$num = ($tokens[$stackPtr]['line'] - $tokens[$prev]['line'] - 1);
|
||||
$error = 'Expected 0 blank lines before closing brace of class definition; %s found';
|
||||
$data = array($num);
|
||||
$phpcsFile->addError($error, $stackPtr, 'SpacingBeforeClose', $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,118 @@
|
||||
<?php
|
||||
/**
|
||||
* Squiz_Sniffs_CSS_ClassDefinitionNameSpacingSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Squiz_Sniffs_CSS_ClassDefinitionNameSpacingSniff.
|
||||
*
|
||||
* Ensure there are no blank lines between the names of classes/IDs.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Squiz_Sniffs_CSS_ClassDefinitionNameSpacingSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array('CSS');
|
||||
|
||||
|
||||
/**
|
||||
* Returns the token types that this sniff is interested in.
|
||||
*
|
||||
* @return array(int)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_OPEN_CURLY_BRACKET);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the tokens that this sniff is interested in.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
|
||||
* @param int $stackPtr The position in the stack where
|
||||
* the token was found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
// Do not check nested style definitions as, for example, in @media style rules.
|
||||
$nested = $phpcsFile->findNext(T_OPEN_CURLY_BRACKET, ($stackPtr + 1), $tokens[$stackPtr]['bracket_closer']);
|
||||
if ($nested !== false) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Find the first blank line before this openning brace, unless we get
|
||||
// to another style definition, comment or the start of the file.
|
||||
$endTokens = array(
|
||||
T_OPEN_CURLY_BRACKET,
|
||||
T_CLOSE_CURLY_BRACKET,
|
||||
T_COMMENT,
|
||||
T_DOC_COMMENT,
|
||||
T_OPEN_TAG,
|
||||
);
|
||||
|
||||
$foundContent = false;
|
||||
$currentLine = $tokens[$stackPtr]['line'];
|
||||
for ($i = ($stackPtr - 1); $i >= 0; $i--) {
|
||||
if (in_array($tokens[$i]['code'], $endTokens) === true) {
|
||||
break;
|
||||
}
|
||||
|
||||
if ($tokens[$i]['line'] === $currentLine) {
|
||||
if ($tokens[$i]['code'] !== T_WHITESPACE) {
|
||||
$foundContent = true;
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
// We changed lines.
|
||||
if ($foundContent === false) {
|
||||
// Before we throw an error, make sure we are not looking
|
||||
// at a gap before the style definition.
|
||||
$prev = $phpcsFile->findPrevious(T_WHITESPACE, $i, null, true);
|
||||
if ($prev !== false
|
||||
&& in_array($tokens[$prev]['code'], $endTokens) === false
|
||||
) {
|
||||
$error = 'Blank lines are not allowed between class names';
|
||||
$phpcsFile->addError($error, ($i + 1), 'BlankLinesFound');
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
$foundContent = false;
|
||||
$currentLine = $tokens[$i]['line'];
|
||||
}//end for
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,118 @@
|
||||
<?php
|
||||
/**
|
||||
* Squiz_Sniffs_CSS_ClassDefinitionOpeningBraceSpaceSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Squiz_Sniffs_CSS_ClassDefinitionOpeningBraceSpaceSniff.
|
||||
*
|
||||
* Ensure there is a single space before the opening brace in a class definition
|
||||
* and the content starts on the next line.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Squiz_Sniffs_CSS_ClassDefinitionOpeningBraceSpaceSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array('CSS');
|
||||
|
||||
|
||||
/**
|
||||
* Returns the token types that this sniff is interested in.
|
||||
*
|
||||
* @return array(int)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_OPEN_CURLY_BRACKET);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the tokens that this sniff is interested in.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
|
||||
* @param int $stackPtr The position in the stack where
|
||||
* the token was found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
if ($tokens[($stackPtr - 1)]['code'] !== T_WHITESPACE) {
|
||||
$error = 'Expected 1 space before opening brace of class definition; 0 found';
|
||||
$phpcsFile->addError($error, $stackPtr, 'NoneBefore');
|
||||
} else {
|
||||
$content = $tokens[($stackPtr - 1)]['content'];
|
||||
if ($content !== ' ') {
|
||||
$length = strlen($content);
|
||||
if ($length === 1) {
|
||||
$length = 'tab';
|
||||
}
|
||||
|
||||
$error = 'Expected 1 space before opening brace of class definition; %s found';
|
||||
$data = array($length);
|
||||
$phpcsFile->addError($error, $stackPtr, 'Before', $data);
|
||||
}
|
||||
}//end if
|
||||
|
||||
$next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true);
|
||||
if ($next === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Check for nested class definitions.
|
||||
$nested = false;
|
||||
$found = $phpcsFile->findNext(
|
||||
T_OPEN_CURLY_BRACKET,
|
||||
($stackPtr + 1),
|
||||
$tokens[$stackPtr]['bracket_closer']
|
||||
);
|
||||
if ($found !== false) {
|
||||
$nested = true;
|
||||
}
|
||||
|
||||
$foundLines = ($tokens[$next]['line'] - $tokens[$stackPtr]['line'] - 1);
|
||||
if ($nested === true) {
|
||||
if ($foundLines !== 1) {
|
||||
$error = 'Expected 1 blank line after opening brace of nesting class definition; %s found';
|
||||
$data = array($foundLines);
|
||||
$phpcsFile->addError($error, $stackPtr, 'AfterNesting', $data);
|
||||
}
|
||||
} else {
|
||||
if ($foundLines !== 0) {
|
||||
$error = 'Expected 0 blank lines after opening brace of class definition; %s found';
|
||||
$data = array($foundLines);
|
||||
$phpcsFile->addError($error, $stackPtr, 'After', $data);
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,96 @@
|
||||
<?php
|
||||
/**
|
||||
* Squiz_Sniffs_CSS_ColonSpacingSniff.
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
|
||||
/**
|
||||
* Squiz_Sniffs_CSS_ColonSpacingSniff.
|
||||
*
|
||||
* Ensure there is no space before a colon and one space after it.
|
||||
*
|
||||
* @category PHP
|
||||
* @package PHP_CodeSniffer
|
||||
* @author Greg Sherwood <gsherwood@squiz.net>
|
||||
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
|
||||
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
||||
* @version Release: 1.3.3
|
||||
* @link http://pear.php.net/package/PHP_CodeSniffer
|
||||
*/
|
||||
class Squiz_Sniffs_CSS_ColonSpacingSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
/**
|
||||
* A list of tokenizers this sniff supports.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $supportedTokenizers = array('CSS');
|
||||
|
||||
|
||||
/**
|
||||
* Returns the token types that this sniff is interested in.
|
||||
*
|
||||
* @return array(int)
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(T_COLON);
|
||||
|
||||
}//end register()
|
||||
|
||||
|
||||
/**
|
||||
* Processes the tokens that this sniff is interested in.
|
||||
*
|
||||
* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
|
||||
* @param int $stackPtr The position in the stack where
|
||||
* the token was found.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
|
||||
{
|
||||
$tokens = $phpcsFile->getTokens();
|
||||
|
||||
$prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
|
||||
if ($tokens[$prev]['code'] !== T_STYLE) {
|
||||
// The colon is not part of a style definition.
|
||||
return;
|
||||
}
|
||||
|
||||
if ($tokens[($stackPtr - 1)]['code'] === T_WHITESPACE) {
|
||||
$error = 'There must be no space before a colon in a style definition';
|
||||
$phpcsFile->addError($error, $stackPtr, 'Before');
|
||||
}
|
||||
|
||||
if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) {
|
||||
$error = 'Expected 1 space after colon in style definition; 0 found';
|
||||
$phpcsFile->addError($error, $stackPtr, 'NoneAfter');
|
||||
} else {
|
||||
$content = $tokens[($stackPtr + 1)]['content'];
|
||||
if (strpos($content, $phpcsFile->eolChar) === false) {
|
||||
$length = strlen($content);
|
||||
if ($length !== 1) {
|
||||
$error = 'Expected 1 space after colon in style definition; %s found';
|
||||
$data = array($length);
|
||||
$phpcsFile->addError($error, $stackPtr, 'After', $data);
|
||||
}
|
||||
} else {
|
||||
$error = 'Expected 1 space after colon in style definition; newline found';
|
||||
$phpcsFile->addError($error, $stackPtr, 'AfterNewline');
|
||||
}
|
||||
}//end if
|
||||
|
||||
}//end process()
|
||||
|
||||
}//end class
|
||||
?>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user