Initial Commit
This commit is contained in:
Riley Schneider
@@ -0,0 +1,253 @@
|
||||
<?php
|
||||
/**
|
||||
* Squiz_Sniffs_Functions_FunctionDeclarationArgumentSpacingSniff.
|
||||
*
|
||||
* 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_Functions_FunctionDeclarationArgumentSpacingSniff.
|
||||
*
|
||||
* Checks that arguments in function declarations 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 Squiz_Sniffs_Functions_FunctionDeclarationArgumentSpacingSniff 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();
|
||||
|
||||
$functionName = $phpcsFile->findNext(array(T_STRING), $stackPtr);
|
||||
$openBracket = $tokens[$stackPtr]['parenthesis_opener'];
|
||||
$closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
|
||||
|
||||
$multiLine = ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']);
|
||||
|
||||
$nextParam = $openBracket;
|
||||
$params = array();
|
||||
while (($nextParam = $phpcsFile->findNext(T_VARIABLE, ($nextParam + 1), $closeBracket)) !== false) {
|
||||
|
||||
$nextToken = $phpcsFile->findNext(T_WHITESPACE, ($nextParam + 1), ($closeBracket + 1), true);
|
||||
if ($nextToken === false) {
|
||||
break;
|
||||
}
|
||||
|
||||
$nextCode = $tokens[$nextToken]['code'];
|
||||
|
||||
if ($nextCode === T_EQUAL) {
|
||||
// Check parameter default spacing.
|
||||
if (($nextToken - $nextParam) > 1) {
|
||||
$error = 'Expected 0 spaces between argument "%s" and equals sign; %s found';
|
||||
$data = array(
|
||||
$tokens[$nextParam]['content'],
|
||||
strlen($tokens[($nextParam + 1)]['content']),
|
||||
);
|
||||
$phpcsFile->addError($error, $nextToken, 'SpaceBeforeEquals', $data);
|
||||
}
|
||||
|
||||
if ($tokens[($nextToken + 1)]['code'] === T_WHITESPACE) {
|
||||
$error = 'Expected 0 spaces between default value and equals sign for argument "%s"; %s found';
|
||||
$data = array(
|
||||
$tokens[$nextParam]['content'],
|
||||
strlen($tokens[($nextToken + 1)]['content']),
|
||||
);
|
||||
$phpcsFile->addError($error, $nextToken, 'SpaceAfterDefault', $data);
|
||||
}
|
||||
}
|
||||
|
||||
// Find and check the comma (if there is one).
|
||||
$nextComma = $phpcsFile->findNext(T_COMMA, ($nextParam + 1), $closeBracket);
|
||||
if ($nextComma !== false) {
|
||||
// Comma found.
|
||||
if ($tokens[($nextComma - 1)]['code'] === T_WHITESPACE) {
|
||||
$error = 'Expected 0 spaces between argument "%s" and comma; %s found';
|
||||
$data = array(
|
||||
$tokens[$nextParam]['content'],
|
||||
strlen($tokens[($nextComma - 1)]['content']),
|
||||
);
|
||||
$phpcsFile->addError($error, $nextToken, 'SpaceBeforeComma', $data);
|
||||
}
|
||||
}
|
||||
|
||||
// Take references into account when expecting the
|
||||
// location of whitespace.
|
||||
if ($phpcsFile->isReference(($nextParam - 1)) === true) {
|
||||
$whitespace = $tokens[($nextParam - 2)];
|
||||
} else {
|
||||
$whitespace = $tokens[($nextParam - 1)];
|
||||
}
|
||||
|
||||
if (empty($params) === false) {
|
||||
// This is not the first argument in the function declaration.
|
||||
$arg = $tokens[$nextParam]['content'];
|
||||
|
||||
if ($whitespace['code'] === T_WHITESPACE) {
|
||||
$gap = strlen($whitespace['content']);
|
||||
|
||||
// Before we throw an error, make sure there is no type hint.
|
||||
$comma = $phpcsFile->findPrevious(T_COMMA, ($nextParam - 1));
|
||||
$nextToken = $phpcsFile->findNext(T_WHITESPACE, ($comma + 1), null, true);
|
||||
if ($phpcsFile->isReference($nextToken) === true) {
|
||||
$nextToken++;
|
||||
}
|
||||
|
||||
if ($nextToken !== $nextParam) {
|
||||
// There was a type hint, so check the spacing between
|
||||
// the hint and the variable as well.
|
||||
$hint = $tokens[$nextToken]['content'];
|
||||
|
||||
if ($gap !== 1) {
|
||||
$error = 'Expected 1 space between type hint and argument "%s"; %s found';
|
||||
$data = array(
|
||||
$arg,
|
||||
$gap,
|
||||
);
|
||||
$phpcsFile->addError($error, $nextToken, 'SpacingAfterHint', $data);
|
||||
}
|
||||
|
||||
if ($multiLine === false) {
|
||||
if ($tokens[($comma + 1)]['code'] !== T_WHITESPACE) {
|
||||
$error = 'Expected 1 space between comma and type hint "%s"; 0 found';
|
||||
$data = array($hint);
|
||||
$phpcsFile->addError($error, $nextToken, 'NoSapceBeforeHint', $data);
|
||||
} else {
|
||||
$gap = strlen($tokens[($comma + 1)]['content']);
|
||||
if ($gap !== 1) {
|
||||
$error = 'Expected 1 space between comma and type hint "%s"; %s found';
|
||||
$data = array(
|
||||
$hint,
|
||||
$gap,
|
||||
);
|
||||
$phpcsFile->addError($error, $nextToken, 'SpacingBeforeHint', $data);
|
||||
}
|
||||
}
|
||||
}
|
||||
} else if ($multiLine === false && $gap !== 1) {
|
||||
$error = 'Expected 1 space between comma and argument "%s"; %s found';
|
||||
$data = array(
|
||||
$arg,
|
||||
$gap,
|
||||
);
|
||||
$phpcsFile->addError($error, $nextToken, 'SpacingBeforeArg', $data);
|
||||
}//end if
|
||||
} else {
|
||||
$error = 'Expected 1 space between comma and argument "%s"; 0 found';
|
||||
$data = array($arg);
|
||||
$phpcsFile->addError($error, $nextToken, 'NoSpaceBeforeArg', $data);
|
||||
}//end if
|
||||
} else {
|
||||
// First argument in function declaration.
|
||||
if ($whitespace['code'] === T_WHITESPACE) {
|
||||
$gap = strlen($whitespace['content']);
|
||||
$arg = $tokens[$nextParam]['content'];
|
||||
|
||||
// Before we throw an error, make sure there is no type hint.
|
||||
$bracket = $phpcsFile->findPrevious(T_OPEN_PARENTHESIS, ($nextParam - 1));
|
||||
$nextToken = $phpcsFile->findNext(T_WHITESPACE, ($bracket + 1), null, true);
|
||||
if ($phpcsFile->isReference($nextToken) === true) {
|
||||
$nextToken++;
|
||||
}
|
||||
|
||||
if ($nextToken !== $nextParam) {
|
||||
// There was a type hint, so check the spacing between
|
||||
// the hint and the variable as well.
|
||||
$hint = $tokens[$nextToken]['content'];
|
||||
|
||||
if ($gap !== 1) {
|
||||
$error = 'Expected 1 space between type hint and argument "%s"; %s found';
|
||||
$data = array(
|
||||
$arg,
|
||||
$gap,
|
||||
);
|
||||
$phpcsFile->addError($error, $nextToken, 'SpacingAfterHint', $data);
|
||||
}
|
||||
|
||||
if ($multiLine === false
|
||||
&& $tokens[($bracket + 1)]['code'] === T_WHITESPACE
|
||||
) {
|
||||
$error = 'Expected 0 spaces between opening bracket and type hint "%s"; %s found';
|
||||
$data = array(
|
||||
$hint,
|
||||
strlen($tokens[($bracket + 1)]['content']),
|
||||
);
|
||||
$phpcsFile->addError($error, $nextToken, 'SpacingAfterOpenHint', $data);
|
||||
}
|
||||
} else if ($multiLine === false) {
|
||||
$error = 'Expected 0 spaces between opening bracket and argument "%s"; %s found';
|
||||
$data = array(
|
||||
$arg,
|
||||
$gap,
|
||||
);
|
||||
$phpcsFile->addError($error, $nextToken, 'SpacingAfterOpen', $data);
|
||||
}
|
||||
}//end if
|
||||
}//end if
|
||||
|
||||
$params[] = $nextParam;
|
||||
|
||||
}//end while
|
||||
|
||||
if (empty($params) === true) {
|
||||
// There are no parameters for this function.
|
||||
if (($closeBracket - $openBracket) !== 1) {
|
||||
$error = 'Expected 0 spaces between brackets of function declaration; %s found';
|
||||
$data = array(strlen($tokens[($closeBracket - 1)]['content']));
|
||||
$phpcsFile->addError($error, $stackPtr, 'SpacingBetween', $data);
|
||||
}
|
||||
} else if ($multiLine === false
|
||||
&& $tokens[($closeBracket - 1)]['code'] === T_WHITESPACE
|
||||
) {
|
||||
$lastParam = array_pop($params);
|
||||
$error = 'Expected 0 spaces between argument "%s" and closing bracket; %s found';
|
||||
$data = array(
|
||||
$tokens[$lastParam]['content'],
|
||||
strlen($tokens[($closeBracket - 1)]['content']),
|
||||
);
|
||||
$phpcsFile->addError($error, $closeBracket, 'SpacingBeforeClose', $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,55 @@
|
||||
<?php
|
||||
/**
|
||||
* Squiz_Sniffs_Functions_FunctionDeclarationSniff.
|
||||
*
|
||||
* 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');
|
||||
}
|
||||
|
||||
/**
|
||||
* Squiz_Sniffs_Functions_FunctionDeclarationSniff.
|
||||
*
|
||||
* Checks the function declaration 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 Squiz_Sniffs_Functions_FunctionDeclarationSniff extends PHP_CodeSniffer_Standards_AbstractPatternSniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of patterns to check are correct.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function getPatterns()
|
||||
{
|
||||
return array(
|
||||
'function abc(...);',
|
||||
'abstract function abc(...);',
|
||||
);
|
||||
|
||||
}//end getPatterns()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,81 @@
|
||||
<?php
|
||||
/**
|
||||
* Squiz_Sniffs_Functions_FunctionDuplicateArgumentSpacingSniff.
|
||||
*
|
||||
* 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_Functions_FunctionDuplicateArgumentSpacingSniff.
|
||||
*
|
||||
* Checks that duplicate arguments are not used in function declarations.
|
||||
*
|
||||
* @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_Functions_FunctionDuplicateArgumentSniff 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();
|
||||
|
||||
$openBracket = $tokens[$stackPtr]['parenthesis_opener'];
|
||||
$closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
|
||||
|
||||
$foundVariables = array();
|
||||
for ($i = ($openBracket + 1); $i < $closeBracket; $i++) {
|
||||
if ($tokens[$i]['code'] === T_VARIABLE) {
|
||||
$variable = $tokens[$i]['content'];
|
||||
if (in_array($variable, $foundVariables) === true) {
|
||||
$error = 'Variable "%s" appears more than once in function declaration';
|
||||
$data = array($variable);
|
||||
$phpcsFile->addError($error, $i, 'Found', $data);
|
||||
} else {
|
||||
$foundVariables[] = $variable;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,78 @@
|
||||
<?php
|
||||
/**
|
||||
* Squiz_Sniffs_Functions_GlobalFunctionSniff.
|
||||
*
|
||||
* 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_Functions_GlobalFunctionSniff.
|
||||
*
|
||||
* Tests for functions outside of classes.
|
||||
*
|
||||
* @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_Functions_GlobalFunctionSniff 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();
|
||||
|
||||
if (empty($tokens[$stackPtr]['conditions']) === true) {
|
||||
$functionName = $phpcsFile->getDeclarationName($stackPtr);
|
||||
if ($functionName === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Special exception for __autoload as it needs to be global.
|
||||
if ($functionName !== '__autoload') {
|
||||
$error = 'Consider putting global function "%s" in a static class';
|
||||
$data = array($functionName);
|
||||
$phpcsFile->addWarning($error, $stackPtr, 'Found', $data);
|
||||
}
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,81 @@
|
||||
<?php
|
||||
/**
|
||||
* Squiz_Sniffs_Functions_LowercaseFunctionKeywordsSniff.
|
||||
*
|
||||
* 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_Functions_LowercaseFunctionKeywordsSniff.
|
||||
*
|
||||
* Ensures all class keywords are lowercase.
|
||||
*
|
||||
* @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_Functions_LowercaseFunctionKeywordsSniff implements PHP_CodeSniffer_Sniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of tokens this test wants to listen for.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
return array(
|
||||
T_FUNCTION,
|
||||
T_PUBLIC,
|
||||
T_PRIVATE,
|
||||
T_PROTECTED,
|
||||
T_STATIC,
|
||||
);
|
||||
|
||||
}//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();
|
||||
|
||||
$content = $tokens[$stackPtr]['content'];
|
||||
if ($content !== strtolower($content)) {
|
||||
$error = '%s keyword must be lowercase; expected "%s" but found "%s"';
|
||||
$data = array(
|
||||
strtoupper($content),
|
||||
strtolower($content),
|
||||
$content,
|
||||
);
|
||||
$phpcsFile->addError($error, $stackPtr, 'FoundUppercase', $data);
|
||||
}
|
||||
|
||||
}//end process()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,94 @@
|
||||
<?php
|
||||
/**
|
||||
* Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff.
|
||||
*
|
||||
* 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('PEAR_Sniffs_Functions_FunctionDeclarationSniff', true) === false) {
|
||||
$error = 'Class PEAR_Sniffs_Functions_FunctionDeclarationSniff not found';
|
||||
throw new PHP_CodeSniffer_Exception($error);
|
||||
}
|
||||
|
||||
/**
|
||||
* Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff.
|
||||
*
|
||||
* 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 Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff extends PEAR_Sniffs_Functions_FunctionDeclarationSniff
|
||||
{
|
||||
|
||||
|
||||
/**
|
||||
* 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 do everything the parent sniff does, and a bit more.
|
||||
parent::processMultiLineDeclaration($phpcsFile, $stackPtr, $tokens);
|
||||
|
||||
$openBracket = $tokens[$stackPtr]['parenthesis_opener'];
|
||||
$closeBracket = $tokens[$stackPtr]['parenthesis_closer'];
|
||||
|
||||
// The open bracket should be the last thing on the line.
|
||||
$next = $phpcsFile->findNext(T_WHITESPACE, ($openBracket + 1), null, true);
|
||||
if ($tokens[$next]['line'] !== ($tokens[$openBracket]['line'] + 1)) {
|
||||
$error = 'The first parameter of a multi-line function declaration must be on the line after the opening bracket';
|
||||
$phpcsFile->addError($error, $next, 'FirstParamSpacing');
|
||||
}
|
||||
|
||||
// Each line between the brackets should contain a single parameter.
|
||||
$lastCommaLine = null;
|
||||
for ($i = ($openBracket + 1); $i < $closeBracket; $i++) {
|
||||
// Skip brackets, like arrays, as they can contain commas.
|
||||
if (isset($tokens[$i]['parenthesis_opener']) === true) {
|
||||
$i = $tokens[$i]['parenthesis_closer'];
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($tokens[$i]['code'] === T_COMMA) {
|
||||
if ($lastCommaLine !== null && $lastCommaLine === $tokens[$i]['line']) {
|
||||
$error = 'Multi-line function declarations must define one parameter per line';
|
||||
$phpcsFile->addError($error, $i, 'OneParamPerLine');
|
||||
} else {
|
||||
// Comma must be the last thing on the line.
|
||||
$next = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), null, true);
|
||||
if ($tokens[$next]['line'] !== ($tokens[$i]['line'] + 1)) {
|
||||
$error = 'Commas in multi-line function declarations must be the last content on a line';
|
||||
$phpcsFile->addError($error, $next, 'ContentAfterComma');
|
||||
}
|
||||
}
|
||||
|
||||
$lastCommaLine = $tokens[$i]['line'];
|
||||
}
|
||||
}
|
||||
|
||||
}//end processMultiLineDeclaration()
|
||||
|
||||
|
||||
}//end class
|
||||
|
||||
?>
|
||||
Reference in New Issue
Block a user