From b5e8538e8f749f234bfd5c6c75909fc0c256634a Mon Sep 17 00:00:00 2001 From: Dakwamine Date: Mon, 1 May 2017 11:26:31 +0200 Subject: [PATCH] Issue #2863898 by Dakwamine: Updated to PHP_CodeSniffer version 3.0.0 --- .../Sniffs/Array/DisallowLongArraySyntaxSniff.php | 43 ---- .../Drupal/Sniffs/{Array => Arrays}/ArraySniff.php | 28 ++- .../Sniffs/Arrays/DisallowLongArraySyntaxSniff.php | 49 +++++ .../Sniffs/CSS/ClassDefinitionNameSpacingSniff.php | 24 +- .../Drupal/Sniffs/CSS/ColourDefinitionSniff.php | 19 +- .../Sniffs/Classes/ClassCreateInstanceSniff.php | 20 +- .../Sniffs/Classes/ClassDeclarationSniff.php | 26 ++- .../Classes/FullyQualifiedNamespaceSniff.php | 21 +- .../Drupal/Sniffs/Classes/InterfaceNameSniff.php | 17 +- .../Sniffs/Classes/PropertyDeclarationSniff.php | 33 +-- .../Sniffs/Classes/UnusedUseStatementSniff.php | 22 +- .../Sniffs/Classes/UseLeadingBackslashSniff.php | 20 +- .../Drupal/Sniffs/Commenting/ClassCommentSniff.php | 20 +- .../Sniffs/Commenting/DataTypeNamespaceSniff.php | 20 +- .../Sniffs/Commenting/DocCommentAlignmentSniff.php | 25 ++- .../Drupal/Sniffs/Commenting/DocCommentSniff.php | 20 +- .../Sniffs/Commenting/DocCommentStarSniff.php | 17 +- .../Drupal/Sniffs/Commenting/FileCommentSniff.php | 15 +- .../Sniffs/Commenting/FunctionCommentSniff.php | 72 +++--- .../Drupal/Sniffs/Commenting/HookCommentSniff.php | 20 +- .../Sniffs/Commenting/InlineCommentSniff.php | 45 ++-- .../Commenting/PostStatementCommentSniff.php | 22 +- .../Sniffs/Commenting/VariableCommentSniff.php | 38 ++-- .../ControlStructures/ControlSignatureSniff.php | 25 ++- .../Sniffs/ControlStructures/ElseIfSniff.php | 17 +- .../InlineControlStructureSniff.php | 20 +- .../Drupal/Sniffs/Files/EndFileNewlineSniff.php | 17 +- .../Drupal/Sniffs/Files/FileEncodingSniff.php | 19 +- .../Drupal/Sniffs/Files/LineLengthSniff.php | 26 ++- .../Drupal/Sniffs/Files/TxtFileLineLengthSniff.php | 26 +-- .../Sniffs/Formatting/MultiLineAssignmentSniff.php | 30 +-- .../Formatting/MultipleStatementAlignmentSniff.php | 28 ++- .../Sniffs/Formatting/SpaceInlineIfSniff.php | 17 +- .../Sniffs/Formatting/SpaceUnaryOperatorSniff.php | 22 +- .../Sniffs/Functions/DiscouragedFunctionsSniff.php | 8 +- .../Sniffs/Functions/FunctionDeclarationSniff.php | 17 +- .../Drupal/Sniffs/InfoFiles/AutoAddedKeysSniff.php | 20 +- .../Drupal/Sniffs/InfoFiles/ClassFilesSniff.php | 25 ++- .../Sniffs/InfoFiles/DuplicateEntrySniff.php | 17 +- .../Drupal/Sniffs/InfoFiles/RequiredSniff.php | 22 +- .../Sniffs/Methods/MethodDeclarationSniff.php | 15 +- .../NamingConventions/ValidClassNameSniff.php | 19 +- .../NamingConventions/ValidFunctionNameSniff.php | 39 ++-- .../Sniffs/NamingConventions/ValidGlobalSniff.php | 20 +- .../NamingConventions/ValidVariableNameSniff.php | 33 +-- .../Drupal/Sniffs/Scope/MethodScopeSniff.php | 43 +++- .../Drupal/Sniffs/Semantics/ConstantNameSniff.php | 25 ++- .../Drupal/Sniffs/Semantics/EmptyInstallSniff.php | 24 +- .../Drupal/Sniffs/Semantics/FunctionAliasSniff.php | 25 ++- .../Drupal/Sniffs/Semantics/FunctionCall.php | 42 ++-- .../Drupal/Sniffs/Semantics/FunctionDefinition.php | 32 +-- .../Drupal/Sniffs/Semantics/FunctionTSniff.php | 30 ++- .../Sniffs/Semantics/FunctionWatchdogSniff.php | 25 ++- .../Drupal/Sniffs/Semantics/InstallHooksSniff.php | 21 +- .../Sniffs/Semantics/LStringTranslatableSniff.php | 25 ++- .../Drupal/Sniffs/Semantics/PregSecuritySniff.php | 25 ++- .../Drupal/Sniffs/Semantics/RemoteAddressSniff.php | 17 +- .../Drupal/Sniffs/Semantics/TInHookMenuSniff.php | 24 +- .../Drupal/Sniffs/Semantics/TInHookSchemaSniff.php | 24 +- .../Strings/UnnecessaryStringConcatSniff.php | 44 ++-- .../Sniffs/WhiteSpace/CloseBracketSpacingSniff.php | 23 +- .../Drupal/Sniffs/WhiteSpace/CommaSniff.php | 19 +- .../Drupal/Sniffs/WhiteSpace/EmptyLinesSniff.php | 19 +- .../Drupal/Sniffs/WhiteSpace/NamespaceSniff.php | 17 +- .../WhiteSpace/ObjectOperatorIndentSniff.php | 30 ++- .../WhiteSpace/ObjectOperatorSpacingSniff.php | 25 ++- .../Sniffs/WhiteSpace/OpenBracketSpacingSniff.php | 20 +- .../Sniffs/WhiteSpace/OpenTagNewlineSniff.php | 22 +- .../Sniffs/WhiteSpace/OperatorSpacingSniff.php | 34 +-- .../Sniffs/WhiteSpace/ScopeClosingBraceSniff.php | 22 +- .../Drupal/Sniffs/WhiteSpace/ScopeIndentSniff.php | 43 ++-- .../Test/{Array => Arrays}/ArrayUnitTest.inc | 0 .../Test/{Array => Arrays}/ArrayUnitTest.inc.fixed | 0 .../Test/{Array => Arrays}/ArrayUnitTest.php | 6 +- .../DisallowLongArraySyntaxUnitTest.php | 6 +- .../DisallowLongArraySyntaxUnitTest.1.inc | 0 .../disallow_long_array_d7.info | 0 .../DisallowLongArraySyntaxUnitTest.2.inc | 0 .../DisallowLongArraySyntaxUnitTest.2.inc.fixed | 0 .../disallow_long_array_d8.info.yml | 0 .../Test/Classes/ClassCreateInstanceUnitTest.php | 6 +- .../Test/Classes/ClassDeclarationUnitTest.php | 6 +- .../Classes/FullyQualifiedNamespaceUnitTest.php | 6 +- .../Test/Classes/PropertyDeclarationUnitTest.php | 6 +- .../Test/Classes/UnusedUseStatementUnitTest.php | 6 +- .../Test/Classes/UseLeadingBackslashUnitTest.php | 6 +- coder_sniffer/Drupal/Test/CoderSniffUnitTest.php | 18 +- .../Test/Commenting/ClassCommentUnitTest.php | 6 +- .../Test/Commenting/DataTypeNamespaceUnitTest.php | 6 +- .../Commenting/DocCommentAlignmentUnitTest.php | 6 +- .../Test/Commenting/DocCommentStarUnitTest.php | 6 +- .../Drupal/Test/Commenting/DocCommentUnitTest.php | 6 +- .../Drupal/Test/Commenting/FileCommentUnitTest.php | 6 +- .../Test/Commenting/FunctionCommentUnitTest.php | 6 +- .../Test/Commenting/InlineCommentUnitTest.php | 6 +- .../Commenting/PostStatementCommentUnitTest.php | 6 +- .../Test/Commenting/VariableCommentUnitTest.php | 6 +- .../ControlStructures/ControlSignatureUnitTest.php | 8 +- .../Test/ControlStructures/ElseIfUnitTest.php | 6 +- .../Drupal/Test/Files/EndFileNewlineUnitTest.php | 6 +- .../Drupal/Test/Files/FileEncodingUnitTest.php | 6 +- .../Drupal/Test/Files/LineLengthUnitTest.php | 6 +- .../Test/Files/TxtFileLineLengthUnitTest.php | 6 +- .../MultipleStatementAlignmentUnitTest.php | 6 +- .../Test/Formatting/SpaceUnaryOperatorUnitTest.php | 6 +- .../Test/InfoFiles/AutoAddedKeysUnitTest.php | 6 +- .../Drupal/Test/InfoFiles/ClassFilesUnitTest.php | 6 +- .../Test/InfoFiles/DuplicateEntryUnitTest.php | 6 +- .../ValidFunctionNameUnitTest.php | 6 +- .../ValidVariableNameUnitTest.php | 6 +- .../Drupal/Test/Scope/MethodScopeUnitTest.php | 6 +- .../Drupal/Test/Semantics/ConstantNameUnitTest.php | 6 +- .../Drupal/Test/Semantics/FunctionTUnitTest.php | 6 +- .../Test/Semantics/FunctionWatchdogUnitTest.php | 6 +- .../WhiteSpace/CloseBracketSpacingUnitTest.php | 6 +- .../Drupal/Test/WhiteSpace/CommaUnitTest.php | 6 +- .../Drupal/Test/WhiteSpace/NamespaceUnitTest.php | 6 +- .../WhiteSpace/ObjectOperatorIndentUnitTest.php | 6 +- .../WhiteSpace/ObjectOperatorSpacingUnitTest.php | 6 +- .../Test/WhiteSpace/OpenBracketSpacingUnitTest.php | 6 +- .../Test/WhiteSpace/OpenTagNewlineUnitTest.php | 6 +- .../Drupal/Test/WhiteSpace/ScopeIndentUnitTest.php | 6 +- coder_sniffer/Drupal/Test/bad/BadUnitTest.php | 6 +- coder_sniffer/Drupal/Test/good/GoodUnitTest.php | 6 +- coder_sniffer/DrupalPractice/Project.php | 38 ++-- .../Sniffs/CodeAnalysis/VariableAnalysisSniff.php | 241 +++++++++++---------- .../Sniffs/Commenting/AuthorTagSniff.php | 17 +- .../Sniffs/Commenting/CommentEmptyLineSniff.php | 17 +- .../Sniffs/Commenting/ExpectedExceptionSniff.php | 19 +- .../Sniffs/Constants/GlobalConstantSniff.php | 20 +- .../Sniffs/Constants/GlobalDefineSniff.php | 28 ++- .../Sniffs/FunctionCalls/CheckPlainSniff.php | 25 ++- .../Sniffs/FunctionCalls/CurlSslVerifierSniff.php | 25 ++- .../Sniffs/FunctionCalls/DbQuerySniff.php | 28 ++- .../Sniffs/FunctionCalls/DbSelectBracesSniff.php | 25 ++- .../FunctionCalls/DefaultValueSanitizeSniff.php | 30 ++- .../Sniffs/FunctionCalls/FormErrorTSniff.php | 25 ++- .../Sniffs/FunctionCalls/LCheckPlainSniff.php | 25 ++- .../Sniffs/FunctionCalls/MessageTSniff.php | 25 ++- .../Sniffs/FunctionCalls/TCheckPlainSniff.php | 25 ++- .../Sniffs/FunctionCalls/ThemeSniff.php | 19 +- .../FunctionCalls/VariableSetSanitizeSniff.php | 25 ++- .../FunctionDefinitions/AccessHookMenuSniff.php | 28 ++- .../FunctionDefinitions/FormAlterDocSniff.php | 24 +- .../FunctionDefinitions/HookInitCssSniff.php | 27 ++- .../Sniffs/FunctionDefinitions/InstallTSniff.php | 27 ++- .../Sniffs/General/AccessAdminPagesSniff.php | 21 +- .../Sniffs/General/ClassNameSniff.php | 20 +- .../Sniffs/General/DescriptionTSniff.php | 19 +- .../Sniffs/General/FormStateInputSniff.php | 17 +- .../Sniffs/General/LanguageNoneSniff.php | 17 +- .../Sniffs/General/OptionsTSniff.php | 17 +- .../Sniffs/General/VariableNameSniff.php | 33 +-- .../Sniffs/InfoFiles/NamespacedDependencySniff.php | 17 +- .../Sniffs/Objects/GlobalClassSniff.php | 22 +- .../Sniffs/Objects/GlobalDrupalSniff.php | 20 +- .../Sniffs/Objects/GlobalFunctionSniff.php | 24 +- .../Sniffs/Objects/UnusedPrivateMethodSniff.php | 28 ++- .../Sniffs/Yaml/RoutingAccessSniff.php | 17 +- .../Test/CodeAnalysis/VariableAnalysisUnitTest.php | 6 +- .../Test/Commenting/AuthorTagUnitTest.php | 6 +- .../Test/Commenting/CommentEmptyLineUnitTest.php | 6 +- .../Test/Commenting/ExpectedExceptionUnitTest.php | 6 +- .../Test/Constants/GlobalConstantUnitTest.php | 6 +- .../Test/Constants/GlobalDefineUnitTest.php | 6 +- .../Test/FunctionCalls/CheckPlainUnitTest.php | 6 +- .../Test/FunctionCalls/CurlSslVerifierUnitTest.php | 6 +- .../Test/FunctionCalls/DbQueryUnitTest.php | 6 +- .../Test/FunctionCalls/DbSelectBracesUnitTest.php | 6 +- .../FunctionCalls/DefaultValueSanitizeUnitTest.php | 6 +- .../Test/FunctionCalls/TCheckPlainUnitTest.php | 6 +- .../FunctionCalls/VariableSetSanitizeUnitTest.php | 6 +- .../FunctionDefinitions/AccessHookMenuUnitTest.php | 6 +- .../FunctionDefinitions/FormAlterDocUnitTest.php | 6 +- .../FunctionDefinitions/HookInitCssUnitTest.php | 6 +- .../FunctionDefinitions/InstallTSniffUnitTest.php | 6 +- .../Test/General/OptionsTUnitTest.php | 6 +- .../Test/General/VariableNameUnitTest.php | 6 +- .../InfoFiles/NamespacedDependencyUnitTest.php | 6 +- .../Test/Objects/GlobalClassUnitTest.php | 6 +- .../Test/Objects/GlobalDrupalUnitTest.php | 6 +- .../Test/Objects/GlobalFunctionUnitTest.php | 6 +- .../Test/Objects/UnusedPrivateMethodUnitTest.php | 6 +- .../Test/ProjectDetection/ProjectUnitTest.php | 10 +- .../Test/Yaml/RoutingAccessUnitTest.php | 6 +- .../DrupalPractice/Test/good/GoodUnitTest.php | 6 +- composer.json | 2 +- 187 files changed, 2098 insertions(+), 1213 deletions(-) delete mode 100644 coder_sniffer/Drupal/Sniffs/Array/DisallowLongArraySyntaxSniff.php rename coder_sniffer/Drupal/Sniffs/{Array => Arrays}/ArraySniff.php (92%) create mode 100644 coder_sniffer/Drupal/Sniffs/Arrays/DisallowLongArraySyntaxSniff.php rename coder_sniffer/Drupal/Test/{Array => Arrays}/ArrayUnitTest.inc (100%) rename coder_sniffer/Drupal/Test/{Array => Arrays}/ArrayUnitTest.inc.fixed (100%) rename coder_sniffer/Drupal/Test/{Array => Arrays}/ArrayUnitTest.php (90%) rename coder_sniffer/Drupal/Test/{Array => Arrays}/DisallowLongArraySyntaxUnitTest.php (90%) rename coder_sniffer/Drupal/Test/{Array => Arrays}/disallow_long_array_d7/DisallowLongArraySyntaxUnitTest.1.inc (100%) rename coder_sniffer/Drupal/Test/{Array => Arrays}/disallow_long_array_d7/disallow_long_array_d7.info (100%) rename coder_sniffer/Drupal/Test/{Array => Arrays}/disallow_long_array_d8/DisallowLongArraySyntaxUnitTest.2.inc (100%) rename coder_sniffer/Drupal/Test/{Array => Arrays}/disallow_long_array_d8/DisallowLongArraySyntaxUnitTest.2.inc.fixed (100%) rename coder_sniffer/Drupal/Test/{Array => Arrays}/disallow_long_array_d8/disallow_long_array_d8.info.yml (100%) diff --git a/coder_sniffer/Drupal/Sniffs/Array/DisallowLongArraySyntaxSniff.php b/coder_sniffer/Drupal/Sniffs/Array/DisallowLongArraySyntaxSniff.php deleted file mode 100644 index fe72b44..0000000 --- a/coder_sniffer/Drupal/Sniffs/Array/DisallowLongArraySyntaxSniff.php +++ /dev/null @@ -1,43 +0,0 @@ -numTokens + 1); - } - - return parent::process($phpcsFile, $stackPtr); - - }//end process() - - -}//end class diff --git a/coder_sniffer/Drupal/Sniffs/Array/ArraySniff.php b/coder_sniffer/Drupal/Sniffs/Arrays/ArraySniff.php similarity index 92% rename from coder_sniffer/Drupal/Sniffs/Array/ArraySniff.php rename to coder_sniffer/Drupal/Sniffs/Arrays/ArraySniff.php index f9fcd43..e1edb9f 100644 --- a/coder_sniffer/Drupal/Sniffs/Array/ArraySniff.php +++ b/coder_sniffer/Drupal/Sniffs/Arrays/ArraySniff.php @@ -1,14 +1,20 @@ getTokens(); @@ -65,7 +71,7 @@ class Drupal_Sniffs_Array_ArraySniff implements PHP_CodeSniffer_Sniff } $lastItem = $phpcsFile->findPrevious( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($tokens[$stackPtr][$parenthesis_closer] - 1), $stackPtr, true @@ -83,7 +89,7 @@ class Drupal_Sniffs_Array_ArraySniff implements PHP_CodeSniffer_Sniff if ($tokens[$lastItem]['code'] !== T_COMMA && $isInlineArray === false && $tokens[($lastItem + 1)]['code'] !== T_CLOSE_PARENTHESIS && $tokens[($lastItem + 1)]['code'] !== T_CLOSE_SHORT_ARRAY - && isset(PHP_CodeSniffer_Tokens::$heredocTokens[$tokens[$lastItem]['code']]) === false + && isset(Tokens::$heredocTokens[$tokens[$lastItem]['code']]) === false ) { $data = array($tokens[$lastItem]['content']); $fix = $phpcsFile->addFixableWarning('A comma should follow the last multiline array item. Found: %s', $lastItem, 'CommaLastItem', $data); @@ -146,7 +152,7 @@ class Drupal_Sniffs_Array_ArraySniff implements PHP_CodeSniffer_Sniff $current_line = $tokens[$newLineStart]['line']; while ($current_line >= $tokens[$newLineStart]['line']) { $newLineStart = $phpcsFile->findNext( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($newLineStart + 1), ($tokens[$stackPtr][$parenthesis_closer] + 1), true @@ -215,7 +221,7 @@ class Drupal_Sniffs_Array_ArraySniff implements PHP_CodeSniffer_Sniff $isMultiLineString = $tokens[($newLineStart - 1)]['code'] === T_CONSTANT_ENCAPSED_STRING && substr($tokens[($newLineStart - 1)]['content'], -1) === $phpcsFile->eolChar; // Skip NOWDOC or HEREDOC lines. - $nowDoc = isset(PHP_CodeSniffer_Tokens::$heredocTokens[$tokens[$newLineStart]['code']]); + $nowDoc = isset(Tokens::$heredocTokens[$tokens[$newLineStart]['code']]); if ($innerNesting === false && $isMultiLineString === false && $nowDoc === false) { $error = 'Array indentation error, expected %s spaces but found %s'; $data = array( diff --git a/coder_sniffer/Drupal/Sniffs/Arrays/DisallowLongArraySyntaxSniff.php b/coder_sniffer/Drupal/Sniffs/Arrays/DisallowLongArraySyntaxSniff.php new file mode 100644 index 0000000..701c2d3 --- /dev/null +++ b/coder_sniffer/Drupal/Sniffs/Arrays/DisallowLongArraySyntaxSniff.php @@ -0,0 +1,49 @@ +numTokens + 1); + } + + return parent::process($phpcsFile, $stackPtr); + + }//end process() + + +}//end class diff --git a/coder_sniffer/Drupal/Sniffs/CSS/ClassDefinitionNameSpacingSniff.php b/coder_sniffer/Drupal/Sniffs/CSS/ClassDefinitionNameSpacingSniff.php index 4184ac6..a3780c2 100644 --- a/coder_sniffer/Drupal/Sniffs/CSS/ClassDefinitionNameSpacingSniff.php +++ b/coder_sniffer/Drupal/Sniffs/CSS/ClassDefinitionNameSpacingSniff.php @@ -1,22 +1,28 @@ getTokens(); @@ -65,7 +71,7 @@ class Drupal_Sniffs_CSS_ClassDefinitionNameSpacingSniff implements PHP_CodeSniff T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_OPEN_TAG => T_OPEN_TAG, ); - $endTokens += PHP_CodeSniffer_Tokens::$commentTokens; + $endTokens += Tokens::$commentTokens; $foundContent = false; $currentLine = $tokens[$stackPtr]['line']; diff --git a/coder_sniffer/Drupal/Sniffs/CSS/ColourDefinitionSniff.php b/coder_sniffer/Drupal/Sniffs/CSS/ColourDefinitionSniff.php index e80021a..be8f888 100644 --- a/coder_sniffer/Drupal/Sniffs/CSS/ColourDefinitionSniff.php +++ b/coder_sniffer/Drupal/Sniffs/CSS/ColourDefinitionSniff.php @@ -1,14 +1,19 @@ getTokens(); $colour = $tokens[$stackPtr]['content']; diff --git a/coder_sniffer/Drupal/Sniffs/Classes/ClassCreateInstanceSniff.php b/coder_sniffer/Drupal/Sniffs/Classes/ClassCreateInstanceSniff.php index 9476c7d..bb08722 100644 --- a/coder_sniffer/Drupal/Sniffs/Classes/ClassCreateInstanceSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Classes/ClassCreateInstanceSniff.php @@ -7,6 +7,12 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace Drupal\Sniffs\Classes; + +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\Sniff; +use PHP_CodeSniffer\Util\Tokens; + /** * Class create instance Test. * @@ -16,7 +22,7 @@ * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ -class Drupal_Sniffs_Classes_ClassCreateInstanceSniff implements PHP_CodeSniffer_Sniff +class ClassCreateInstanceSniff implements Sniff { @@ -35,13 +41,13 @@ class Drupal_Sniffs_Classes_ClassCreateInstanceSniff implements PHP_CodeSniffer_ /** * 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. + * @param \PHP_CodeSniffer\Files\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) + public function process(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -56,7 +62,7 @@ class Drupal_Sniffs_Classes_ClassCreateInstanceSniff implements PHP_CodeSniffer_ $nextParenthesis = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($stackPtr + 1), $commaOrColon); if ($nextParenthesis === false) { $error = 'Calling class constructors must always include parentheses'; - $constructor = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true, null, true); + $constructor = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true, null, true); // We can invoke the fixer if we know this is a static constructor // function call or constructor calls with namespaces, example // "new \DOMDocument;" or constructor with class names in variables @@ -70,7 +76,7 @@ class Drupal_Sniffs_Classes_ClassCreateInstanceSniff implements PHP_CodeSniffer_ $nextConstructorPart = $constructor; while (true) { $nextConstructorPart = $phpcsFile->findNext( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($nextConstructorPart + 1), null, true, diff --git a/coder_sniffer/Drupal/Sniffs/Classes/ClassDeclarationSniff.php b/coder_sniffer/Drupal/Sniffs/Classes/ClassDeclarationSniff.php index d4c49c2..ea63234 100644 --- a/coder_sniffer/Drupal/Sniffs/Classes/ClassDeclarationSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Classes/ClassDeclarationSniff.php @@ -7,6 +7,12 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace Drupal\Sniffs\Classes; + +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\ClassDeclarationSniff as PSR2ClassDeclarationSniff; +use PHP_CodeSniffer\Util\Tokens; + /** * Class Declaration Test. * @@ -16,7 +22,7 @@ * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ -class Drupal_Sniffs_Classes_ClassDeclarationSniff extends PSR2_Sniffs_Classes_ClassDeclarationSniff +class ClassDeclarationSniff extends PSR2ClassDeclarationSniff { @@ -39,13 +45,13 @@ class Drupal_Sniffs_Classes_ClassDeclarationSniff extends PSR2_Sniffs_Classes_Cl /** * 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. + * @param \PHP_CodeSniffer\Files\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) + public function process(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $errorData = array(strtolower($tokens[$stackPtr]['content'])); @@ -122,13 +128,13 @@ class Drupal_Sniffs_Classes_ClassDeclarationSniff extends PSR2_Sniffs_Classes_Cl /** * Processes the closing section of a class declaration. * - * @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 \PHP_CodeSniffer\Files\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 processClose(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + public function processClose(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -143,7 +149,7 @@ class Drupal_Sniffs_Classes_ClassDeclarationSniff extends PSR2_Sniffs_Classes_Cl if ($prevContent !== $tokens[$stackPtr]['scope_opener'] && $tokens[$prevContent]['line'] !== ($tokens[$closeBrace]['line'] - 2) // If the class only contains a comment no extra line is needed. - && isset(PHP_CodeSniffer_Tokens::$commentTokens[$tokens[$prevContent]['code']]) === false + && isset(Tokens::$commentTokens[$tokens[$prevContent]['code']]) === false ) { $error = 'The closing brace for the %s must have an empty line before it'; $data = array($tokens[$stackPtr]['content']); diff --git a/coder_sniffer/Drupal/Sniffs/Classes/FullyQualifiedNamespaceSniff.php b/coder_sniffer/Drupal/Sniffs/Classes/FullyQualifiedNamespaceSniff.php index ed60885..46f71ab 100644 --- a/coder_sniffer/Drupal/Sniffs/Classes/FullyQualifiedNamespaceSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Classes/FullyQualifiedNamespaceSniff.php @@ -1,12 +1,17 @@ numTokens + 1 to skip * the rest of the file. */ - public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + public function process(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/Classes/InterfaceNameSniff.php b/coder_sniffer/Drupal/Sniffs/Classes/InterfaceNameSniff.php index 2852da2..156ea06 100644 --- a/coder_sniffer/Drupal/Sniffs/Classes/InterfaceNameSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Classes/InterfaceNameSniff.php @@ -1,12 +1,17 @@ getTokens(); $namePtr = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); diff --git a/coder_sniffer/Drupal/Sniffs/Classes/PropertyDeclarationSniff.php b/coder_sniffer/Drupal/Sniffs/Classes/PropertyDeclarationSniff.php index b672329..ffd231d 100644 --- a/coder_sniffer/Drupal/Sniffs/Classes/PropertyDeclarationSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Classes/PropertyDeclarationSniff.php @@ -7,27 +7,34 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace Drupal\Sniffs\Classes; + +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\AbstractVariableSniff; +use PHP_CodeSniffer\Util\Tokens; + /** - * Laregely copied from PSR2_Sniffs_Classes_PropertyDeclarationSniff to have a fixer + * Laregely copied from + * \PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\PropertyDeclarationSniff to have a fixer * for the var keyword. * * @category PHP * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ -class Drupal_Sniffs_Classes_PropertyDeclarationSniff extends PHP_CodeSniffer_Standards_AbstractVariableSniff +class PropertyDeclarationSniff extends AbstractVariableSniff { /** * Processes the function tokens within the class. * - * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. - * @param int $stackPtr The position where the token was found. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found. + * @param int $stackPtr The position where the token was found. * * @return void */ - protected function processMemberVar(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + protected function processMemberVar(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -40,7 +47,7 @@ class Drupal_Sniffs_Classes_PropertyDeclarationSniff extends PHP_CodeSniffer_Sta // Detect multiple properties defined at the same time. Throw an error // for this, but also only process the first property in the list so we don't // repeat errors. - $find = PHP_CodeSniffer_Tokens::$scopeModifiers; + $find = Tokens::$scopeModifiers; $find = array_merge($find, array(T_VARIABLE, T_VAR, T_SEMICOLON)); $prev = $phpcsFile->findPrevious($find, ($stackPtr - 1)); if ($tokens[$prev]['code'] === T_VARIABLE) { @@ -61,7 +68,7 @@ class Drupal_Sniffs_Classes_PropertyDeclarationSniff extends PHP_CodeSniffer_Sta $phpcsFile->addError($error, $stackPtr, 'Multiple'); } - $modifier = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$scopeModifiers, $stackPtr); + $modifier = $phpcsFile->findPrevious(Tokens::$scopeModifiers, $stackPtr); if (($modifier === false) || ($tokens[$modifier]['line'] !== $tokens[$stackPtr]['line'])) { $error = 'Visibility must be declared on property "%s"'; $data = array($tokens[$stackPtr]['content']); @@ -74,12 +81,12 @@ class Drupal_Sniffs_Classes_PropertyDeclarationSniff extends PHP_CodeSniffer_Sta /** * 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. + * @param \PHP_CodeSniffer\Files\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) + protected function processVariable(File $phpcsFile, $stackPtr) { /* We don't care about normal variables. @@ -91,12 +98,12 @@ class Drupal_Sniffs_Classes_PropertyDeclarationSniff extends PHP_CodeSniffer_Sta /** * 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. + * @param \PHP_CodeSniffer\Files\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) + protected function processVariableInString(File $phpcsFile, $stackPtr) { /* We don't care about normal variables. diff --git a/coder_sniffer/Drupal/Sniffs/Classes/UnusedUseStatementSniff.php b/coder_sniffer/Drupal/Sniffs/Classes/UnusedUseStatementSniff.php index 4825e22..d506a59 100644 --- a/coder_sniffer/Drupal/Sniffs/Classes/UnusedUseStatementSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Classes/UnusedUseStatementSniff.php @@ -1,12 +1,18 @@ getTokens(); @@ -55,7 +61,7 @@ class Drupal_Sniffs_Classes_UnusedUseStatementSniff implements PHP_CodeSniffer_S } $classPtr = $phpcsFile->findPrevious( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($semiColon - 1), null, true @@ -117,7 +123,7 @@ class Drupal_Sniffs_Classes_UnusedUseStatementSniff implements PHP_CodeSniffer_S } $beforeUsage = $phpcsFile->findPrevious( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($classUsed - 1), null, true diff --git a/coder_sniffer/Drupal/Sniffs/Classes/UseLeadingBackslashSniff.php b/coder_sniffer/Drupal/Sniffs/Classes/UseLeadingBackslashSniff.php index bad21c0..9bc894a 100644 --- a/coder_sniffer/Drupal/Sniffs/Classes/UseLeadingBackslashSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Classes/UseLeadingBackslashSniff.php @@ -1,12 +1,18 @@ getTokens(); @@ -49,7 +55,7 @@ class Drupal_Sniffs_Classes_UseLeadingBackslashSniff implements PHP_CodeSniffer_ } $startPtr = $phpcsFile->findNext( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($stackPtr + 1), null, true diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/ClassCommentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/ClassCommentSniff.php index 6cf5048..68bacb1 100644 --- a/coder_sniffer/Drupal/Sniffs/Commenting/ClassCommentSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Commenting/ClassCommentSniff.php @@ -7,9 +7,15 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace Drupal\Sniffs\Commenting; + +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\Sniff; +use PHP_CodeSniffer\Util\Tokens; + /** * Checks that comment doc blocks exist on classes, interfaces and traits. Largely - * copied from Squiz_Sniffs_Commenting_ClassCommentSniff. + * copied from PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\ClassCommentSniff. * * @category PHP * @package PHP_CodeSniffer @@ -19,7 +25,7 @@ * @version Release: @package_version@ * @link http://pear.php.net/package/PHP_CodeSniffer */ -class Drupal_Sniffs_Commenting_ClassCommentSniff implements PHP_CodeSniffer_Sniff +class ClassCommentSniff implements Sniff { @@ -42,16 +48,16 @@ class Drupal_Sniffs_Commenting_ClassCommentSniff implements PHP_CodeSniffer_Snif /** * 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. + * @param \PHP_CodeSniffer\Files\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) + public function process(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); - $find = PHP_CodeSniffer_Tokens::$methodPrefixes; + $find = Tokens::$methodPrefixes; $find[] = T_WHITESPACE; $name = $tokens[$stackPtr]['content']; diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/DataTypeNamespaceSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/DataTypeNamespaceSniff.php index 6638a51..6778d5c 100644 --- a/coder_sniffer/Drupal/Sniffs/Commenting/DataTypeNamespaceSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Commenting/DataTypeNamespaceSniff.php @@ -1,12 +1,18 @@ getTokens(); @@ -55,7 +61,7 @@ class Drupal_Sniffs_Commenting_DataTypeNamespaceSniff implements PHP_CodeSniffer } $classPtr = $phpcsFile->findPrevious( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($semiColon - 1), null, true diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentAlignmentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentAlignmentSniff.php index 4703dbe..167b2de 100644 --- a/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentAlignmentSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentAlignmentSniff.php @@ -1,14 +1,21 @@ getTokens(); // We are only interested in function/class/interface doc block comments. - $ignore = PHP_CodeSniffer_Tokens::$emptyTokens; + $ignore = Tokens::$emptyTokens; if ($phpcsFile->tokenizerType === 'JS') { $ignore[] = T_EQUAL; $ignore[] = T_STRING; @@ -71,7 +78,7 @@ class Drupal_Sniffs_Commenting_DocCommentAlignmentSniff implements PHP_CodeSniff if (isset($ignore[$tokens[$nextToken]['code']]) === false) { // Could be a file comment. - $prevToken = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); + $prevToken = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($tokens[$prevToken]['code'] !== T_OPEN_TAG) { return; } diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentSniff.php index 10fbe8f..ecc948a 100644 --- a/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentSniff.php @@ -7,17 +7,23 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace Drupal\Sniffs\Commenting; + +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\Sniff; + /** * Ensures doc blocks follow basic formatting. * - * Largely copied from Generic_Sniffs_Commenting_DocCommentSniff, but Drupal @file - * comments are different. + * Largely copied from + * \PHP_CodeSniffer\Standards\Generic\Sniffs\Commenting\DocCommentSniff, + * but Drupal @file comments are different. * * @category PHP * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ -class Drupal_Sniffs_Commenting_DocCommentSniff implements PHP_CodeSniffer_Sniff +class DocCommentSniff implements Sniff { /** @@ -46,13 +52,13 @@ class Drupal_Sniffs_Commenting_DocCommentSniff implements PHP_CodeSniffer_Sniff /** * 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. + * @param \PHP_CodeSniffer\Files\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) + public function process(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $commentEnd = $phpcsFile->findNext(T_DOC_COMMENT_CLOSE_TAG, ($stackPtr + 1)); diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentStarSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentStarSniff.php index f4a87ae..f791081 100644 --- a/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentStarSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Commenting/DocCommentStarSniff.php @@ -1,12 +1,17 @@ getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/FileCommentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/FileCommentSniff.php index 55746bc..2fe5e94 100644 --- a/coder_sniffer/Drupal/Sniffs/Commenting/FileCommentSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Commenting/FileCommentSniff.php @@ -7,6 +7,11 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace Drupal\Sniffs\Commenting; + +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\Sniff; + /** * Parses and verifies the doc comments for files. * @@ -21,7 +26,7 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ -class Drupal_Sniffs_Commenting_FileCommentSniff implements PHP_CodeSniffer_Sniff +class FileCommentSniff implements Sniff { @@ -51,13 +56,13 @@ class Drupal_Sniffs_Commenting_FileCommentSniff implements PHP_CodeSniffer_Sniff /** * 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. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. + * @param int $stackPtr The position of the current token + * in the stack passed in $tokens. * * @return int */ - public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + public function process(File $phpcsFile, $stackPtr) { $this->currentFile = $phpcsFile; diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php index ed9e14c..8da751a 100644 --- a/coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php @@ -7,15 +7,21 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace Drupal\Sniffs\Commenting; + +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\Sniff; +use PHP_CodeSniffer\Util\Tokens; + /** * Parses and verifies the doc comments for functions. Largely copied from - * Squiz_Sniffs_Commenting_FunctionCommentSniff. + * PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\FunctionCommentSniff. * * @category PHP * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ -class Drupal_Sniffs_Commenting_FunctionCommentSniff implements PHP_CodeSniffer_Sniff +class FunctionCommentSniff implements Sniff { /** @@ -72,20 +78,20 @@ class Drupal_Sniffs_Commenting_FunctionCommentSniff implements PHP_CodeSniffer_S /** * 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. + * @param \PHP_CodeSniffer\Files\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) + public function process(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); - $find = PHP_CodeSniffer_Tokens::$methodPrefixes; + $find = Tokens::$methodPrefixes; $find[] = T_WHITESPACE; $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true); - $beforeCommentEnd = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($commentEnd - 1), null, true); + $beforeCommentEnd = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($commentEnd - 1), null, true); if (($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG && $tokens[$commentEnd]['code'] !== T_COMMENT) || ($beforeCommentEnd !== false @@ -162,14 +168,14 @@ class Drupal_Sniffs_Commenting_FunctionCommentSniff implements PHP_CodeSniffer_S /** * Process the return comment of this function comment. * - * @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 $commentStart The position in the stack where the comment started. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. + * @param int $stackPtr The position of the current token + * in the stack passed in $tokens. + * @param int $commentStart The position in the stack where the comment started. * * @return void */ - protected function processReturn(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) + protected function processReturn(File $phpcsFile, $stackPtr, $commentStart) { $tokens = $phpcsFile->getTokens(); @@ -365,14 +371,14 @@ class Drupal_Sniffs_Commenting_FunctionCommentSniff implements PHP_CodeSniffer_S /** * Process any throw tags that this function comment has. * - * @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 $commentStart The position in the stack where the comment started. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. + * @param int $stackPtr The position of the current token + * in the stack passed in $tokens. + * @param int $commentStart The position in the stack where the comment started. * * @return void */ - protected function processThrows(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) + protected function processThrows(File $phpcsFile, $stackPtr, $commentStart) { $tokens = $phpcsFile->getTokens(); @@ -445,14 +451,14 @@ class Drupal_Sniffs_Commenting_FunctionCommentSniff implements PHP_CodeSniffer_S /** * Process the function parameter comments. * - * @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 $commentStart The position in the stack where the comment started. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. + * @param int $stackPtr The position of the current token + * in the stack passed in $tokens. + * @param int $commentStart The position in the stack where the comment started. * * @return void */ - protected function processParams(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) + protected function processParams(File $phpcsFile, $stackPtr, $commentStart) { $tokens = $phpcsFile->getTokens(); @@ -872,14 +878,14 @@ class Drupal_Sniffs_Commenting_FunctionCommentSniff implements PHP_CodeSniffer_S /** * Process the function "see" comments. * - * @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 $commentStart The position in the stack where the comment started. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. + * @param int $stackPtr The position of the current token + * in the stack passed in $tokens. + * @param int $commentStart The position in the stack where the comment started. * * @return void */ - protected function processSees(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) + protected function processSees(File $phpcsFile, $stackPtr, $commentStart) { $tokens = $phpcsFile->getTokens(); foreach ($tokens[$commentStart]['comment_tags'] as $tag) { @@ -941,11 +947,11 @@ class Drupal_Sniffs_Commenting_FunctionCommentSniff implements PHP_CodeSniffer_S * @param string $typeHint The type hint used. * @param string $suggestedTypeHint The fully qualified type to * check against. - * @param PHP_CodeSniffer_File $phpcsFile The file being checked. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being checked. * * @return boolean */ - protected function isAliasedType($typeHint, $suggestedTypeHint, PHP_CodeSniffer_File $phpcsFile) + protected function isAliasedType($typeHint, $suggestedTypeHint, File $phpcsFile) { $tokens = $phpcsFile->getTokens(); @@ -964,7 +970,7 @@ class Drupal_Sniffs_Commenting_FunctionCommentSniff implements PHP_CodeSniffer_S // Now comes the original class name, possibly with namespace // backslashes. - $originalClass = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($usePtr + 1), null, true); + $originalClass = $phpcsFile->findNext(Tokens::$emptyTokens, ($usePtr + 1), null, true); if ($originalClass === false || ($tokens[$originalClass]['code'] !== T_STRING && $tokens[$originalClass]['code'] !== T_NS_SEPARATOR) ) { @@ -982,13 +988,13 @@ class Drupal_Sniffs_Commenting_FunctionCommentSniff implements PHP_CodeSniffer_S } // Now comes the "as" keyword signaling an alias name for the class. - $asPtr = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($originalClass + 1), null, true); + $asPtr = $phpcsFile->findNext(Tokens::$emptyTokens, ($originalClass + 1), null, true); if ($asPtr === false || $tokens[$asPtr]['code'] !== T_AS) { continue; } // Now comes the name the class is aliased to. - $aliasPtr = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($asPtr + 1), null, true); + $aliasPtr = $phpcsFile->findNext(Tokens::$emptyTokens, ($asPtr + 1), null, true); if ($aliasPtr === false || $tokens[$aliasPtr]['code'] !== T_STRING || $tokens[$aliasPtr]['content'] !== $typeHint ) { diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/HookCommentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/HookCommentSniff.php index f2fa4f0..84f95ff 100644 --- a/coder_sniffer/Drupal/Sniffs/Commenting/HookCommentSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Commenting/HookCommentSniff.php @@ -7,6 +7,12 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace Drupal\Sniffs\Commenting; + +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\Sniff; +use PHP_CodeSniffer\Util\Tokens; + /** * Ensures hook comments on function are correct. * @@ -14,7 +20,7 @@ * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ -class Drupal_Sniffs_Commenting_HookCommentSniff implements PHP_CodeSniffer_Sniff +class HookCommentSniff implements Sniff { @@ -33,16 +39,16 @@ class Drupal_Sniffs_Commenting_HookCommentSniff implements PHP_CodeSniffer_Sniff /** * 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. + * @param \PHP_CodeSniffer\Files\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) + public function process(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); - $find = PHP_CodeSniffer_Tokens::$methodPrefixes; + $find = Tokens::$methodPrefixes; $find[] = T_WHITESPACE; $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true); @@ -89,7 +95,7 @@ class Drupal_Sniffs_Commenting_HookCommentSniff implements PHP_CodeSniffer_Sniff if (strstr($matches[0], 'Implements ') === false || strstr($matches[0], 'Implements of') !== false || preg_match('/ (drush_)?hook_[a-zA-Z0-9_]+\(\)( for .+)?\.$/', $matches[0]) !== 1 ) { - $phpcsFile->addWarning('Format should be "* Implements hook_foo().", "* Implements hook_foo_BAR_ID_bar() for xyz_bar().",, "* Implements hook_foo_BAR_ID_bar() for xyz-bar.html.twig.", "* Implements hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.", or "* Implements hook_foo_BAR_ID_bar() for block templates."', $short); + $phpcsFile->addWarning('Format should be "* Implements hook_foo().", "* Implements hook_foo_BAR_ID_bar() for xyz_bar().",, "* Implements hook_foo_BAR_ID_bar() for xyz-bar.html.twig.", "* Implements hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.", or "* Implements hook_foo_BAR_ID_bar() for block templates."', $short, 'HookCommentFormat'); } else { // Check that a hook implementation does not duplicate @param and // @return documentation. diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/InlineCommentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/InlineCommentSniff.php index 32da8dd..cbdfc70 100644 --- a/coder_sniffer/Drupal/Sniffs/Commenting/InlineCommentSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Commenting/InlineCommentSniff.php @@ -1,24 +1,31 @@ getTokens(); @@ -65,7 +72,7 @@ class Drupal_Sniffs_Commenting_InlineCommentSniff implements PHP_CodeSniffer_Sni // not allowed. if ($tokens[$stackPtr]['code'] === T_DOC_COMMENT_OPEN_TAG) { $nextToken = $phpcsFile->findNext( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($stackPtr + 1), null, true @@ -99,7 +106,7 @@ class Drupal_Sniffs_Commenting_InlineCommentSniff implements PHP_CodeSniffer_Sni if ($phpcsFile->tokenizerType === 'JS') { // We allow block comments if a function or object // is being assigned to a variable. - $ignore = PHP_CodeSniffer_Tokens::$emptyTokens; + $ignore = Tokens::$emptyTokens; $ignore[] = T_EQUAL; $ignore[] = T_STRING; $ignore[] = T_OBJECT_OPERATOR; @@ -114,7 +121,7 @@ class Drupal_Sniffs_Commenting_InlineCommentSniff implements PHP_CodeSniffer_Sni } $prevToken = $phpcsFile->findPrevious( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($stackPtr - 1), null, true @@ -322,14 +329,14 @@ class Drupal_Sniffs_Commenting_InlineCommentSniff implements PHP_CodeSniffer_Sni /** * Determines if a comment line is part of an @code/@endcode example. * - * @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 \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. + * @param int $stackPtr The position of the current token + * in the stack passed in $tokens. * * @return boolean Returns true if the comment line is within a @code block, * false otherwise. */ - protected function isInCodeExample(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + protected function isInCodeExample(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $prevComment = $stackPtr; @@ -358,13 +365,13 @@ class Drupal_Sniffs_Commenting_InlineCommentSniff implements PHP_CodeSniffer_Sni /** * Checks the indentation level of the comment contents. * - * @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 \PHP_CodeSniffer\Files\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 processIndentation(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + protected function processIndentation(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $comment = rtrim($tokens[$stackPtr]['content']); diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/PostStatementCommentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/PostStatementCommentSniff.php index ae38ded..57b2091 100644 --- a/coder_sniffer/Drupal/Sniffs/Commenting/PostStatementCommentSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Commenting/PostStatementCommentSniff.php @@ -1,21 +1,27 @@ getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/VariableCommentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/VariableCommentSniff.php index db3feeb..9649f5b 100644 --- a/coder_sniffer/Drupal/Sniffs/Commenting/VariableCommentSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Commenting/VariableCommentSniff.php @@ -7,29 +7,37 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace Drupal\Sniffs\Commenting; + +use Drupal\Sniffs\Commenting\FunctionCommentSniff; +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\AbstractVariableSniff; +use PHP_CodeSniffer\Util\Tokens; + /** * Parses and verifies class property doc comments. * - * Laregely copied from Squiz_Sniffs_Commenting_VariableCommentSniff. + * Laregely copied from + * \PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\VariableCommentSniff. * * @category PHP * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ -class Drupal_Sniffs_Commenting_VariableCommentSniff extends PHP_CodeSniffer_Standards_AbstractVariableSniff +class VariableCommentSniff extends AbstractVariableSniff { /** * Called to process class member vars. * - * @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 \PHP_CodeSniffer\Files\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 processMemberVar(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + public function processMemberVar(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $commentToken = array( @@ -120,7 +128,7 @@ class Drupal_Sniffs_Commenting_VariableCommentSniff extends PHP_CodeSniffer_Stan // There may be multiple types separated by pipes. $suggestedTypes = array(); foreach (explode('|', $varType) as $type) { - $suggestedTypes[] = Drupal_Sniffs_Commenting_FunctionCommentSniff::suggestType($type); + $suggestedTypes[] = FunctionCommentSniff::suggestType($type); } $suggestedType = implode('|', $suggestedTypes); @@ -157,13 +165,13 @@ class Drupal_Sniffs_Commenting_VariableCommentSniff extends PHP_CodeSniffer_Stan * * Not required for this sniff. * - * @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. + * @param \PHP_CodeSniffer\Files\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 */ - protected function processVariable(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + protected function processVariable(File $phpcsFile, $stackPtr) { }//end processVariable() @@ -174,13 +182,13 @@ class Drupal_Sniffs_Commenting_VariableCommentSniff extends PHP_CodeSniffer_Stan * * Not required for this sniff. * - * @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. + * @param \PHP_CodeSniffer\Files\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 */ - protected function processVariableInString(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + protected function processVariableInString(File $phpcsFile, $stackPtr) { }//end processVariableInString() diff --git a/coder_sniffer/Drupal/Sniffs/ControlStructures/ControlSignatureSniff.php b/coder_sniffer/Drupal/Sniffs/ControlStructures/ControlSignatureSniff.php index 43f35eb..ab74cdb 100644 --- a/coder_sniffer/Drupal/Sniffs/ControlStructures/ControlSignatureSniff.php +++ b/coder_sniffer/Drupal/Sniffs/ControlStructures/ControlSignatureSniff.php @@ -7,17 +7,24 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace Drupal\Sniffs\ControlStructures; + +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\Sniff; +use PHP_CodeSniffer\Util\Tokens; + /** * Verifies that control statements conform to their coding standards. * - * Largely copied from Squiz_Sniffs_ControlStructures_ControlSignatureSniff and - * adapted for Drupal's else on new lines. + * Largely copied from + * \PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures\ControlSignatureSniff + * and adapted for Drupal's else on new lines. * * @category PHP * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ -class Drupal_Sniffs_ControlStructures_ControlSignatureSniff implements PHP_CodeSniffer_Sniff +class ControlSignatureSniff implements Sniff { /** @@ -57,13 +64,13 @@ class Drupal_Sniffs_ControlStructures_ControlSignatureSniff implements PHP_CodeS /** * 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. + * @param \PHP_CodeSniffer\Files\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) + public function process(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -155,7 +162,7 @@ class Drupal_Sniffs_ControlStructures_ControlSignatureSniff implements PHP_CodeS // Skip all empty tokens on the same line as the opener. if ($tokens[$next]['line'] === $tokens[$opener]['line'] - && (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === true + && (isset(Tokens::$emptyTokens[$code]) === true || $code === T_CLOSE_TAG) ) { continue; @@ -248,7 +255,7 @@ class Drupal_Sniffs_ControlStructures_ControlSignatureSniff implements PHP_CodeS || $tokens[$stackPtr]['code'] === T_ELSEIF || $tokens[$stackPtr]['code'] === T_CATCH ) { - $closer = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); + $closer = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($closer === false || $tokens[$closer]['code'] !== T_CLOSE_CURLY_BRACKET) { return; } diff --git a/coder_sniffer/Drupal/Sniffs/ControlStructures/ElseIfSniff.php b/coder_sniffer/Drupal/Sniffs/ControlStructures/ElseIfSniff.php index 734453d..aabc016 100644 --- a/coder_sniffer/Drupal/Sniffs/ControlStructures/ElseIfSniff.php +++ b/coder_sniffer/Drupal/Sniffs/ControlStructures/ElseIfSniff.php @@ -7,6 +7,11 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace Drupal\Sniffs\ControlStructures; + +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\Sniff; + /** * Checks that "elseif" is used instead of "else if". * @@ -14,7 +19,7 @@ * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ -class Drupal_Sniffs_ControlStructures_ElseIfSniff implements PHP_CodeSniffer_Sniff +class ElseIfSniff implements Sniff { @@ -33,13 +38,13 @@ class Drupal_Sniffs_ControlStructures_ElseIfSniff implements PHP_CodeSniffer_Sni /** * 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. + * @param \PHP_CodeSniffer\Files\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) + public function process(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -54,7 +59,7 @@ class Drupal_Sniffs_ControlStructures_ElseIfSniff implements PHP_CodeSniffer_Sni ); if ($tokens[$nextNonWhiteSpace]['code'] === T_IF) { - $fix = $phpcsFile->addFixableError('Use "elseif" in place of "else if"', $nextNonWhiteSpace); + $fix = $phpcsFile->addFixableError('Use "elseif" in place of "else if"', $nextNonWhiteSpace, 'ElseIfDeclaration'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->replaceToken($stackPtr, 'elseif'); diff --git a/coder_sniffer/Drupal/Sniffs/ControlStructures/InlineControlStructureSniff.php b/coder_sniffer/Drupal/Sniffs/ControlStructures/InlineControlStructureSniff.php index c2dd39a..ef1fb70 100644 --- a/coder_sniffer/Drupal/Sniffs/ControlStructures/InlineControlStructureSniff.php +++ b/coder_sniffer/Drupal/Sniffs/ControlStructures/InlineControlStructureSniff.php @@ -1,14 +1,19 @@ getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/Files/EndFileNewlineSniff.php b/coder_sniffer/Drupal/Sniffs/Files/EndFileNewlineSniff.php index 4f7d7b8..d829cda 100644 --- a/coder_sniffer/Drupal/Sniffs/Files/EndFileNewlineSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Files/EndFileNewlineSniff.php @@ -1,12 +1,17 @@ getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/Files/FileEncodingSniff.php b/coder_sniffer/Drupal/Sniffs/Files/FileEncodingSniff.php index a071f1c..26a08da 100644 --- a/coder_sniffer/Drupal/Sniffs/Files/FileEncodingSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Files/FileEncodingSniff.php @@ -1,6 +1,6 @@ findFirstOnLine(T_DOC_COMMENT_TAG, ($stackPtr - 1)); if ($doc_comment_tag !== false) { // Allow doc comment tags such as long @param tags to exceed the 80 @@ -105,12 +111,12 @@ class Drupal_Sniffs_Files_LineLengthSniff extends Generic_Sniffs_Files_LineLengt /** * Returns the length of a defined line. * - * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. - * @param int $currentLine The current line. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. + * @param int $currentLine The current line. * * @return int */ - public function getLineLength(PHP_CodeSniffer_File $phpcsFile, $currentLine) + public function getLineLength(File $phpcsFile, $currentLine) { $tokens = $phpcsFile->getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/Files/TxtFileLineLengthSniff.php b/coder_sniffer/Drupal/Sniffs/Files/TxtFileLineLengthSniff.php index 4ba76dd..9128f4d 100644 --- a/coder_sniffer/Drupal/Sniffs/Files/TxtFileLineLengthSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Files/TxtFileLineLengthSniff.php @@ -1,14 +1,19 @@ getFilename(), -3)); if ($fileExtension === 'txt' || $fileExtension === '.md') { @@ -51,12 +56,7 @@ class Drupal_Sniffs_Files_TxtFileLineLengthSniff implements PHP_CodeSniffer_Snif $content = rtrim($tokens[$stackPtr]['content']); $lineLength = mb_strlen($content, 'UTF-8'); // Lines without spaces are allowed to be longer (for example long URLs). - // Markdown is allowed to be longer for lines - // - without spaces. - // - starting with #. - // - containing URLs (https://). - // - starting with | (tables). - if ($lineLength > 80 && preg_match('/^([^ ]+$|#|.*https?:\/\/|\|)/', $content) === 0) { + if ($lineLength > 80 && preg_match('/[^ ]+ [^ ]+/', $content) === 1) { $data = array( 80, $lineLength, diff --git a/coder_sniffer/Drupal/Sniffs/Formatting/MultiLineAssignmentSniff.php b/coder_sniffer/Drupal/Sniffs/Formatting/MultiLineAssignmentSniff.php index c7a5206..4b5c1c9 100644 --- a/coder_sniffer/Drupal/Sniffs/Formatting/MultiLineAssignmentSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Formatting/MultiLineAssignmentSniff.php @@ -1,17 +1,19 @@ - * @copyright 2006 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 + * @category PHP + * @package PHP_CodeSniffer + * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace Drupal\Sniffs\Formatting; + +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\Sniff; + /** - * Drupal_Sniffs_Formatting_MultiLineAssignmentSniff. + * \Drupal\Sniffs\Formatting\MultiLineAssignmentSniff. * * If an assignment goes over two lines, ensure the equal sign is indented. * @@ -23,7 +25,7 @@ * @version Release: 1.2.0RC3 * @link http://pear.php.net/package/PHP_CodeSniffer */ -class Drupal_Sniffs_Formatting_MultiLineAssignmentSniff implements PHP_CodeSniffer_Sniff +class MultiLineAssignmentSniff implements Sniff { @@ -42,13 +44,13 @@ class Drupal_Sniffs_Formatting_MultiLineAssignmentSniff implements PHP_CodeSniff /** * 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. + * @param \PHP_CodeSniffer\Files\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) + public function process(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -91,7 +93,7 @@ class Drupal_Sniffs_Formatting_MultiLineAssignmentSniff implements PHP_CodeSniff $foundIndent = strlen($tokens[$prev]['content']); if ($foundIndent !== $expectedIndent) { $error = "Multi-line assignment not indented correctly; expected $expectedIndent spaces but found $foundIndent"; - $phpcsFile->addError($error, $stackPtr); + $phpcsFile->addError($error, $stackPtr, 'MultiLineAssignmentIndent'); } }//end process() diff --git a/coder_sniffer/Drupal/Sniffs/Formatting/MultipleStatementAlignmentSniff.php b/coder_sniffer/Drupal/Sniffs/Formatting/MultipleStatementAlignmentSniff.php index bc029f2..38071a4 100644 --- a/coder_sniffer/Drupal/Sniffs/Formatting/MultipleStatementAlignmentSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Formatting/MultipleStatementAlignmentSniff.php @@ -1,22 +1,28 @@ getTokens(); @@ -49,13 +55,13 @@ class Drupal_Sniffs_Formatting_MultipleStatementAlignmentSniff extends Generic_S $lastCode = $stackPtr; $lastSemi = null; - $find = PHP_CodeSniffer_Tokens::$assignmentTokens; + $find = Tokens::$assignmentTokens; unset($find[T_DOUBLE_ARROW]); for ($assign = $stackPtr; $assign < $phpcsFile->numTokens; $assign++) { if (isset($find[$tokens[$assign]['code']]) === false) { // A blank line indicates that the assignment block has ended. - if (isset(PHP_CodeSniffer_tokens::$emptyTokens[$tokens[$assign]['code']]) === false) { + if (isset(Tokens::$emptyTokens[$tokens[$assign]['code']]) === false) { if (($tokens[$assign]['line'] - $tokens[$lastCode]['line']) > 1) { break; } @@ -101,7 +107,7 @@ class Drupal_Sniffs_Formatting_MultipleStatementAlignmentSniff extends Generic_S }//end if $var = $phpcsFile->findPrevious( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($assign - 1), null, true diff --git a/coder_sniffer/Drupal/Sniffs/Formatting/SpaceInlineIfSniff.php b/coder_sniffer/Drupal/Sniffs/Formatting/SpaceInlineIfSniff.php index 138f5b1..8634c59 100644 --- a/coder_sniffer/Drupal/Sniffs/Formatting/SpaceInlineIfSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Formatting/SpaceInlineIfSniff.php @@ -1,12 +1,17 @@ getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/Formatting/SpaceUnaryOperatorSniff.php b/coder_sniffer/Drupal/Sniffs/Formatting/SpaceUnaryOperatorSniff.php index 91bca8c..6fb7e18 100644 --- a/coder_sniffer/Drupal/Sniffs/Formatting/SpaceUnaryOperatorSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Formatting/SpaceUnaryOperatorSniff.php @@ -1,14 +1,20 @@ getTokens(); // Check decrement / increment. if ($tokens[$stackPtr]['code'] === T_DEC || $tokens[$stackPtr]['code'] === T_INC) { - $previous = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); + $previous = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true); $modifyLeft = in_array( $tokens[$previous]['code'], array( diff --git a/coder_sniffer/Drupal/Sniffs/Functions/DiscouragedFunctionsSniff.php b/coder_sniffer/Drupal/Sniffs/Functions/DiscouragedFunctionsSniff.php index e82c67d..d23f809 100644 --- a/coder_sniffer/Drupal/Sniffs/Functions/DiscouragedFunctionsSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Functions/DiscouragedFunctionsSniff.php @@ -1,12 +1,16 @@ getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/InfoFiles/AutoAddedKeysSniff.php b/coder_sniffer/Drupal/Sniffs/InfoFiles/AutoAddedKeysSniff.php index ee72d42..98e474e 100644 --- a/coder_sniffer/Drupal/Sniffs/InfoFiles/AutoAddedKeysSniff.php +++ b/coder_sniffer/Drupal/Sniffs/InfoFiles/AutoAddedKeysSniff.php @@ -1,12 +1,18 @@ getFilename()) === 1) { // Drupal 7 style info file. $contents = file_get_contents($phpcsFile->getFilename()); - $info = Drupal_Sniffs_InfoFiles_ClassFilesSniff::drupalParseInfoFormat($contents); + $info = ClassFilesSniff::drupalParseInfoFormat($contents); } else if (preg_match('/\.info\.yml$/', $phpcsFile->getFilename()) === 1) { // Drupal 8 style info.yml file. $contents = file_get_contents($phpcsFile->getFilename()); diff --git a/coder_sniffer/Drupal/Sniffs/InfoFiles/ClassFilesSniff.php b/coder_sniffer/Drupal/Sniffs/InfoFiles/ClassFilesSniff.php index 733e13f..681e198 100644 --- a/coder_sniffer/Drupal/Sniffs/InfoFiles/ClassFilesSniff.php +++ b/coder_sniffer/Drupal/Sniffs/InfoFiles/ClassFilesSniff.php @@ -1,12 +1,17 @@ getFilename(), -4)); @@ -87,14 +92,14 @@ class Drupal_Sniffs_InfoFiles_ClassFilesSniff implements PHP_CodeSniffer_Sniff /** * Helper function that returns the position of the key in the info file. * - * @param string $key Key name to search for. - * @param string $value Corresponding value to search for. - * @param PHP_CodeSniffer_File $infoFile Info file to search in. + * @param string $key Key name to search for. + * @param string $value Corresponding value to search for. + * @param \PHP_CodeSniffer\Files\File $infoFile Info file to search in. * * @return int|false Returns the stack position if the file name is found, false * otherwise. */ - public static function getPtr($key, $value, PHP_CodeSniffer_File $infoFile) + public static function getPtr($key, $value, File $infoFile) { foreach ($infoFile->getTokens() as $ptr => $tokenInfo) { if (preg_match('@^[\s]*'.preg_quote($key).'[\s]*=[\s]*["\']?'.preg_quote($value).'["\']?@', $tokenInfo['content']) === 1) { diff --git a/coder_sniffer/Drupal/Sniffs/InfoFiles/DuplicateEntrySniff.php b/coder_sniffer/Drupal/Sniffs/InfoFiles/DuplicateEntrySniff.php index 974c408..a6d5285 100644 --- a/coder_sniffer/Drupal/Sniffs/InfoFiles/DuplicateEntrySniff.php +++ b/coder_sniffer/Drupal/Sniffs/InfoFiles/DuplicateEntrySniff.php @@ -1,12 +1,17 @@ getFilename(), -4)); diff --git a/coder_sniffer/Drupal/Sniffs/InfoFiles/RequiredSniff.php b/coder_sniffer/Drupal/Sniffs/InfoFiles/RequiredSniff.php index 941c197..67a03c5 100644 --- a/coder_sniffer/Drupal/Sniffs/InfoFiles/RequiredSniff.php +++ b/coder_sniffer/Drupal/Sniffs/InfoFiles/RequiredSniff.php @@ -1,12 +1,18 @@ getFilename(), -4)); @@ -49,7 +55,7 @@ class Drupal_Sniffs_InfoFiles_RequiredSniff implements PHP_CodeSniffer_Sniff } $contents = file_get_contents($phpcsFile->getFilename()); - $info = Drupal_Sniffs_InfoFiles_ClassFilesSniff::drupalParseInfoFormat($contents); + $info = ClassFilesSniff::drupalParseInfoFormat($contents); if (isset($info['name']) === false) { $error = '"name" property is missing in the info file'; $phpcsFile->addError($error, $stackPtr, 'Name'); @@ -67,7 +73,7 @@ class Drupal_Sniffs_InfoFiles_RequiredSniff implements PHP_CodeSniffer_Sniff && $info['php'] <= '5.2' ) { $error = 'Drupal 7 core already requires PHP 5.2'; - $ptr = Drupal_Sniffs_InfoFiles_ClassFilesSniff::getPtr('php', $info['php'], $phpcsFile); + $ptr = ClassFilesSniff::getPtr('php', $info['php'], $phpcsFile); $phpcsFile->addError($error, $ptr, 'D7PHPVersion'); } diff --git a/coder_sniffer/Drupal/Sniffs/Methods/MethodDeclarationSniff.php b/coder_sniffer/Drupal/Sniffs/Methods/MethodDeclarationSniff.php index 63661a0..d36b32d 100644 --- a/coder_sniffer/Drupal/Sniffs/Methods/MethodDeclarationSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Methods/MethodDeclarationSniff.php @@ -1,22 +1,29 @@ getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidFunctionNameSniff.php b/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidFunctionNameSniff.php index b0b0f4a..5f6b1ab 100644 --- a/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidFunctionNameSniff.php +++ b/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidFunctionNameSniff.php @@ -1,38 +1,45 @@ getDeclarationName($stackPtr); if ($methodName === null) { @@ -57,7 +64,7 @@ class Drupal_Sniffs_NamingConventions_ValidFunctionNameSniff extends Generic_Sni } $methodProps = $phpcsFile->getMethodProperties($stackPtr); - if (PHP_CodeSniffer::isCamelCaps($methodName, false, true, $this->strict) === false) { + if (Common::isCamelCaps($methodName, false, true, $this->strict) === false) { if ($methodProps['scope_specified'] === true) { $error = '%s method name "%s" is not in lowerCamel format'; $data = array( @@ -82,13 +89,13 @@ class Drupal_Sniffs_NamingConventions_ValidFunctionNameSniff extends Generic_Sni /** * 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. + * @param \PHP_CodeSniffer\Files\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) + protected function processTokenOutsideScope(File $phpcsFile, $stackPtr) { $functionName = $phpcsFile->getDeclarationName($stackPtr); if ($functionName === null) { diff --git a/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidGlobalSniff.php b/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidGlobalSniff.php index 1422c48..9166675 100644 --- a/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidGlobalSniff.php +++ b/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidGlobalSniff.php @@ -1,12 +1,18 @@ getTokens(); $varToken = $stackPtr; // Find variable names until we hit a semicolon. - $ignore = PHP_CodeSniffer_Tokens::$emptyTokens; + $ignore = Tokens::$emptyTokens; $ignore[] = T_SEMICOLON; while (($varToken = $phpcsFile->findNext($ignore, ($varToken + 1), null, true, null, true)) !== false) { if ($tokens[$varToken]['code'] === T_VARIABLE diff --git a/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidVariableNameSniff.php b/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidVariableNameSniff.php index d092ea8..4f8cf0a 100644 --- a/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidVariableNameSniff.php +++ b/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidVariableNameSniff.php @@ -1,14 +1,19 @@ getTokens(); @@ -71,12 +74,12 @@ class Drupal_Sniffs_NamingConventions_ValidVariableNameSniff /** * 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. + * @param \PHP_CodeSniffer\Files\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) + protected function processVariable(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -115,12 +118,12 @@ class Drupal_Sniffs_NamingConventions_ValidVariableNameSniff /** * 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. + * @param \PHP_CodeSniffer\Files\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) + protected function processVariableInString(File $phpcsFile, $stackPtr) { // We don't care about variables in strings. return; diff --git a/coder_sniffer/Drupal/Sniffs/Scope/MethodScopeSniff.php b/coder_sniffer/Drupal/Sniffs/Scope/MethodScopeSniff.php index 6831beb..a953581 100644 --- a/coder_sniffer/Drupal/Sniffs/Scope/MethodScopeSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Scope/MethodScopeSniff.php @@ -7,22 +7,30 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace Drupal\Sniffs\Scope; + +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\AbstractScopeSniff; +use PHP_CodeSniffer\Util\Tokens; + /** * Verifies that class/interface/trait methods have scope modifiers. * - * Laregely copied from Squiz_Sniffs_Scope_MethodScopeSniff to work on traits - * and have a fixer. + * Laregely copied from + * \PHP_CodeSniffer\Standards\Squiz\Sniffs\Scope\MethodScopeSniff to work on + * traits and have a fixer. * * @category PHP * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ -class Drupal_Sniffs_Scope_MethodScopeSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff +class MethodScopeSniff extends AbstractScopeSniff { /** - * Constructs a Squiz_Sniffs_Scope_MethodScopeSniff. + * Constructs a + * \PHP_CodeSniffer\Standards\Squiz\Sniffs\Scope\MethodScopeSniff. */ public function __construct() { @@ -34,13 +42,13 @@ class Drupal_Sniffs_Scope_MethodScopeSniff extends PHP_CodeSniffer_Standards_Abs /** * Processes the function tokens within the class. * - * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. - * @param int $stackPtr The position where the token was found. - * @param int $currScope The current scope opener token. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found. + * @param int $stackPtr The position where the token was found. + * @param int $currScope The current scope opener token. * * @return void */ - protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope) + protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope) { $tokens = $phpcsFile->getTokens(); @@ -59,7 +67,7 @@ class Drupal_Sniffs_Scope_MethodScopeSniff extends PHP_CodeSniffer_Standards_Abs for ($i = ($stackPtr - 1); $i > 0; $i--) { if ($tokens[$i]['line'] < $tokens[$stackPtr]['line']) { break; - } else if (isset(PHP_CodeSniffer_Tokens::$scopeModifiers[$tokens[$i]['code']]) === true) { + } else if (isset(Tokens::$scopeModifiers[$tokens[$i]['code']]) === true) { $modifier = $i; break; } @@ -80,4 +88,21 @@ class Drupal_Sniffs_Scope_MethodScopeSniff extends PHP_CodeSniffer_Standards_Abs }//end processTokenWithinScope() + /** + * Processes a token that is found outside the scope that this test is + * listening to. + * + * @param \PHP_CodeSniffer\Files\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(File $phpcsFile, $stackPtr) + { + // Nothing to do. + + }//end processTokenOutsideScope() + + }//end class diff --git a/coder_sniffer/Drupal/Sniffs/Semantics/ConstantNameSniff.php b/coder_sniffer/Drupal/Sniffs/Semantics/ConstantNameSniff.php index d9903f5..9fb999d 100644 --- a/coder_sniffer/Drupal/Sniffs/Semantics/ConstantNameSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Semantics/ConstantNameSniff.php @@ -1,12 +1,17 @@ getFilename(), -7)); // Only check in *.install files. @@ -44,7 +50,7 @@ class Drupal_Sniffs_Semantics_EmptyInstallSniff extends Drupal_Sniffs_Semantics_ ) { // Check if there is a function body. $bodyPtr = $phpcsFile->findNext( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($tokens[$functionPtr]['scope_opener'] + 1), $tokens[$functionPtr]['scope_closer'], true diff --git a/coder_sniffer/Drupal/Sniffs/Semantics/FunctionAliasSniff.php b/coder_sniffer/Drupal/Sniffs/Semantics/FunctionAliasSniff.php index 39a2a87..ee7e12a 100644 --- a/coder_sniffer/Drupal/Sniffs/Semantics/FunctionAliasSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Semantics/FunctionAliasSniff.php @@ -1,12 +1,17 @@ getTokens(); $functionName = $tokens[$stackPtr]['content']; @@ -96,7 +102,7 @@ abstract class Drupal_Sniffs_Semantics_FunctionCall implements PHP_CodeSniffer_S } // Find the next non-empty token. - $openBracket = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true); + $openBracket = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true); $this->phpcsFile = $phpcsFile; $this->functionCall = $stackPtr; @@ -112,17 +118,17 @@ abstract class Drupal_Sniffs_Semantics_FunctionCall implements PHP_CodeSniffer_S /** * Checks if this is a function call. * - * @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 \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. + * @param int $stackPtr The position of the current token + * in the stack passed in $tokens. * * @return bool */ - protected function isFunctionCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + protected function isFunctionCall(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Find the next non-empty token. - $openBracket = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true); + $openBracket = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true); if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) { // Not a function call. @@ -135,7 +141,7 @@ abstract class Drupal_Sniffs_Semantics_FunctionCall implements PHP_CodeSniffer_S } // Find the previous non-empty token. - $search = PHP_CodeSniffer_Tokens::$emptyTokens; + $search = Tokens::$emptyTokens; $search[] = T_BITWISE_AND; $previous = $phpcsFile->findPrevious($search, ($stackPtr - 1), null, true); if ($tokens[$previous]['code'] === T_FUNCTION) { @@ -175,14 +181,14 @@ abstract class Drupal_Sniffs_Semantics_FunctionCall implements PHP_CodeSniffer_S $tokens = $this->phpcsFile->getTokens(); // Start token of the first argument. - $start = $this->phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($this->openBracket + 1), null, true); + $start = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($this->openBracket + 1), null, true); if ($start === $this->closeBracket) { // Function call has no arguments, so return false. return false; } // End token of the last argument. - $end = $this->phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($this->closeBracket - 1), null, true); + $end = $this->phpcsFile->findPrevious(Tokens::$emptyTokens, ($this->closeBracket - 1), null, true); $lastArgEnd = $end; $nextSeperator = $this->openBracket; $counter = 1; @@ -196,7 +202,7 @@ abstract class Drupal_Sniffs_Semantics_FunctionCall implements PHP_CodeSniffer_S } // Update the end token of the current argument. - $end = $this->phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($nextSeperator - 1), null, true); + $end = $this->phpcsFile->findPrevious(Tokens::$emptyTokens, ($nextSeperator - 1), null, true); // Save the calculated findings for the current argument. $this->arguments[$counter] = array( 'start' => $start, @@ -207,7 +213,7 @@ abstract class Drupal_Sniffs_Semantics_FunctionCall implements PHP_CodeSniffer_S } $counter++; - $start = $this->phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($nextSeperator + 1), null, true); + $start = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($nextSeperator + 1), null, true); $end = $lastArgEnd; }//end while diff --git a/coder_sniffer/Drupal/Sniffs/Semantics/FunctionDefinition.php b/coder_sniffer/Drupal/Sniffs/Semantics/FunctionDefinition.php index 02ab303..7d047ac 100644 --- a/coder_sniffer/Drupal/Sniffs/Semantics/FunctionDefinition.php +++ b/coder_sniffer/Drupal/Sniffs/Semantics/FunctionDefinition.php @@ -1,12 +1,18 @@ getTokens(); // Check if this is a function definition. $functionPtr = $phpcsFile->findPrevious( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($stackPtr - 1), null, true @@ -59,15 +65,15 @@ abstract class Drupal_Sniffs_Semantics_FunctionDefinition implements PHP_CodeSni /** * Process this function definition. * - * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. - * @param int $stackPtr The position of the function name in the stack. - * name in the stack. - * @param int $functionPtr The position of the function keyword in the stack. - * keyword in the stack. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. + * @param int $stackPtr The position of the function name in the stack. + * name in the stack. + * @param int $functionPtr The position of the function keyword in the stack. + * keyword in the stack. * * @return void */ - public abstract function processFunction(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $functionPtr); + public abstract function processFunction(File $phpcsFile, $stackPtr, $functionPtr); }//end class diff --git a/coder_sniffer/Drupal/Sniffs/Semantics/FunctionTSniff.php b/coder_sniffer/Drupal/Sniffs/Semantics/FunctionTSniff.php index e538585..cbf3f7f 100644 --- a/coder_sniffer/Drupal/Sniffs/Semantics/FunctionTSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Semantics/FunctionTSniff.php @@ -1,12 +1,18 @@ findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($closeBracket + 1), null, true, null, true); + $concatAfter = $phpcsFile->findNext(Tokens::$emptyTokens, ($closeBracket + 1), null, true, null, true); if ($concatAfter !== false && $tokens[$concatAfter]['code'] === T_STRING_CONCAT) { - $stringAfter = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($concatAfter + 1), null, true, null, true); + $stringAfter = $phpcsFile->findNext(Tokens::$emptyTokens, ($concatAfter + 1), null, true, null, true); if ($stringAfter !== false && $tokens[$stringAfter]['code'] === T_CONSTANT_ENCAPSED_STRING && $this->checkConcatString($tokens[$stringAfter]['content']) === false diff --git a/coder_sniffer/Drupal/Sniffs/Semantics/FunctionWatchdogSniff.php b/coder_sniffer/Drupal/Sniffs/Semantics/FunctionWatchdogSniff.php index 7117bdb..05b952c 100644 --- a/coder_sniffer/Drupal/Sniffs/Semantics/FunctionWatchdogSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Semantics/FunctionWatchdogSniff.php @@ -1,12 +1,17 @@ getFilename(), -6)); // Only check in *.module files. diff --git a/coder_sniffer/Drupal/Sniffs/Semantics/LStringTranslatableSniff.php b/coder_sniffer/Drupal/Sniffs/Semantics/LStringTranslatableSniff.php index 6b48994..a8edcef 100644 --- a/coder_sniffer/Drupal/Sniffs/Semantics/LStringTranslatableSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Semantics/LStringTranslatableSniff.php @@ -1,12 +1,17 @@ getTokensAsString($stackPtr, 4); if ($string === '$_SERVER["REMOTE_ADDR"]' || $string === '$_SERVER[\'REMOTE_ADDR\']') { diff --git a/coder_sniffer/Drupal/Sniffs/Semantics/TInHookMenuSniff.php b/coder_sniffer/Drupal/Sniffs/Semantics/TInHookMenuSniff.php index bb25f37..08cfc80 100644 --- a/coder_sniffer/Drupal/Sniffs/Semantics/TInHookMenuSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Semantics/TInHookMenuSniff.php @@ -1,12 +1,18 @@ getFilename(), -6)); // Only check in *.module files. @@ -52,7 +58,7 @@ class Drupal_Sniffs_Semantics_TInHookMenuSniff extends Drupal_Sniffs_Semantics_F while ($string !== false) { if ($tokens[$string]['content'] === 't') { $opener = $phpcsFile->findNext( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($string + 1), null, true diff --git a/coder_sniffer/Drupal/Sniffs/Semantics/TInHookSchemaSniff.php b/coder_sniffer/Drupal/Sniffs/Semantics/TInHookSchemaSniff.php index e10ce0a..490df8e 100644 --- a/coder_sniffer/Drupal/Sniffs/Semantics/TInHookSchemaSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Semantics/TInHookSchemaSniff.php @@ -1,12 +1,18 @@ getFilename(), -7)); // Only check in *.install files. @@ -52,7 +58,7 @@ class Drupal_Sniffs_Semantics_TInHookSchemaSniff extends Drupal_Sniffs_Semantics while ($string !== false) { if ($tokens[$string]['content'] === 't') { $opener = $phpcsFile->findNext( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($string + 1), null, true diff --git a/coder_sniffer/Drupal/Sniffs/Strings/UnnecessaryStringConcatSniff.php b/coder_sniffer/Drupal/Sniffs/Strings/UnnecessaryStringConcatSniff.php index 69d12a8..d814f86 100644 --- a/coder_sniffer/Drupal/Sniffs/Strings/UnnecessaryStringConcatSniff.php +++ b/coder_sniffer/Drupal/Sniffs/Strings/UnnecessaryStringConcatSniff.php @@ -1,44 +1,40 @@ - * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600) - * @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence - * @version CVS: $Id: UnnecessaryStringConcatSniff.php 304603 2010-10-22 03:07:04Z squiz $ - * @link http://pear.php.net/package/PHP_CodeSniffer + * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600) + * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence */ +namespace Drupal\Sniffs\Strings; + +use Drupal\Sniffs\Files\LineLengthSniff; +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Standards\Generic\Sniffs\Strings\UnnecessaryStringConcatSniff as GenericUnnecessaryStringConcatSniff; +use PHP_CodeSniffer\Util\Tokens; + /** - * Generic_Sniffs_Strings_UnnecessaryStringConcatSniff. - * - * Checks that two strings are not concatenated together; suggests - * using one string instead. + * Checks that two strings are not concatenated together; suggests using one string instead. * - * @category PHP - * @package PHP_CodeSniffer * @author Greg Sherwood - * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600) - * @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence - * @version Release: 1.3.1 - * @link http://pear.php.net/package/PHP_CodeSniffer + * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600) + * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence */ -class Drupal_Sniffs_Strings_UnnecessaryStringConcatSniff extends Generic_Sniffs_Strings_UnnecessaryStringConcatSniff +class UnnecessaryStringConcatSniff extends GenericUnnecessaryStringConcatSniff { /** * 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. + * @param \PHP_CodeSniffer\Files\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) + public function process(File $phpcsFile, $stackPtr) { // Work out which type of file this is for. $tokens = $phpcsFile->getTokens(); @@ -58,7 +54,7 @@ class Drupal_Sniffs_Strings_UnnecessaryStringConcatSniff extends Generic_Sniffs_ return; } - $stringTokens = PHP_CodeSniffer_Tokens::$stringTokens; + $stringTokens = Tokens::$stringTokens; if (in_array($tokens[$prev]['code'], $stringTokens) === true && in_array($tokens[$next]['code'], $stringTokens) === true ) { @@ -77,7 +73,7 @@ class Drupal_Sniffs_Strings_UnnecessaryStringConcatSniff extends Generic_Sniffs_ // Before we throw an error check if the string is longer than // the line length limit. - $lineLengthLimitSniff = new Drupal_Sniffs_Files_LineLengthSniff; + $lineLengthLimitSniff = new LineLengthSniff; $lineLenght = $lineLengthLimitSniff->getLineLength($phpcsFile, $tokens[$prev]['line']); $stringLength = ($lineLenght + strlen($tokens[$next]['content']) - 4); diff --git a/coder_sniffer/Drupal/Sniffs/WhiteSpace/CloseBracketSpacingSniff.php b/coder_sniffer/Drupal/Sniffs/WhiteSpace/CloseBracketSpacingSniff.php index 84753b3..720ba3c 100644 --- a/coder_sniffer/Drupal/Sniffs/WhiteSpace/CloseBracketSpacingSniff.php +++ b/coder_sniffer/Drupal/Sniffs/WhiteSpace/CloseBracketSpacingSniff.php @@ -1,21 +1,28 @@ getTokens(); @@ -68,7 +75,7 @@ class Drupal_Sniffs_WhiteSpace_CloseBracketSpacingSniff implements PHP_CodeSniff if (isset($tokens[($stackPtr - 1)]) === true && $tokens[($stackPtr - 1)]['code'] === T_WHITESPACE ) { - $before = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); + $before = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($before !== false && $tokens[$stackPtr]['line'] === $tokens[$before]['line']) { $error = 'There should be no white space before a closing "%s"'; $fix = $phpcsFile->addFixableError( diff --git a/coder_sniffer/Drupal/Sniffs/WhiteSpace/CommaSniff.php b/coder_sniffer/Drupal/Sniffs/WhiteSpace/CommaSniff.php index 87c069f..69f1fba 100644 --- a/coder_sniffer/Drupal/Sniffs/WhiteSpace/CommaSniff.php +++ b/coder_sniffer/Drupal/Sniffs/WhiteSpace/CommaSniff.php @@ -1,14 +1,19 @@ getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/WhiteSpace/EmptyLinesSniff.php b/coder_sniffer/Drupal/Sniffs/WhiteSpace/EmptyLinesSniff.php index ae8fabf..0d09618 100644 --- a/coder_sniffer/Drupal/Sniffs/WhiteSpace/EmptyLinesSniff.php +++ b/coder_sniffer/Drupal/Sniffs/WhiteSpace/EmptyLinesSniff.php @@ -1,14 +1,19 @@ getTokens(); if ($tokens[$stackPtr]['content'] === $phpcsFile->eolChar diff --git a/coder_sniffer/Drupal/Sniffs/WhiteSpace/NamespaceSniff.php b/coder_sniffer/Drupal/Sniffs/WhiteSpace/NamespaceSniff.php index 3da0e5a..ddee524 100644 --- a/coder_sniffer/Drupal/Sniffs/WhiteSpace/NamespaceSniff.php +++ b/coder_sniffer/Drupal/Sniffs/WhiteSpace/NamespaceSniff.php @@ -1,12 +1,17 @@ getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/WhiteSpace/ObjectOperatorIndentSniff.php b/coder_sniffer/Drupal/Sniffs/WhiteSpace/ObjectOperatorIndentSniff.php index 50f20b9..ab72a1c 100644 --- a/coder_sniffer/Drupal/Sniffs/WhiteSpace/ObjectOperatorIndentSniff.php +++ b/coder_sniffer/Drupal/Sniffs/WhiteSpace/ObjectOperatorIndentSniff.php @@ -1,6 +1,6 @@ getTokens(); @@ -59,7 +65,7 @@ class Drupal_Sniffs_WhiteSpace_ObjectOperatorIndentSniff implements PHP_CodeSnif return; } - $previousLine = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 2), null, true, null, true); + $previousLine = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 2), null, true, null, true); if ($previousLine === false) { return; @@ -127,13 +133,13 @@ class Drupal_Sniffs_WhiteSpace_ObjectOperatorIndentSniff implements PHP_CodeSnif /** * Returns the first non whitespace token on the line. * - * @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. + * @param \PHP_CodeSniffer\Files\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 int */ - protected function findStartOfline(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + protected function findStartOfline(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/WhiteSpace/ObjectOperatorSpacingSniff.php b/coder_sniffer/Drupal/Sniffs/WhiteSpace/ObjectOperatorSpacingSniff.php index 3d42e2f..ba787fd 100644 --- a/coder_sniffer/Drupal/Sniffs/WhiteSpace/ObjectOperatorSpacingSniff.php +++ b/coder_sniffer/Drupal/Sniffs/WhiteSpace/ObjectOperatorSpacingSniff.php @@ -1,23 +1,30 @@ getTokens(); if ($tokens[($stackPtr - 1)]['code'] !== T_WHITESPACE) { @@ -68,7 +75,7 @@ class Drupal_Sniffs_WhiteSpace_ObjectOperatorSpacingSniff implements PHP_CodeSni $phpcsFile->recordMetric($stackPtr, 'Spacing before object operator', $before); $phpcsFile->recordMetric($stackPtr, 'Spacing after object operator', $after); - $prevToken = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); + $prevToken = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true); // Line breaks are allowed before an object operator. if ($before !== 0 && $tokens[$stackPtr]['line'] === $tokens[$prevToken]['line']) { $error = 'Space found before object operator'; diff --git a/coder_sniffer/Drupal/Sniffs/WhiteSpace/OpenBracketSpacingSniff.php b/coder_sniffer/Drupal/Sniffs/WhiteSpace/OpenBracketSpacingSniff.php index 07c5b6e..6c35ecf 100644 --- a/coder_sniffer/Drupal/Sniffs/WhiteSpace/OpenBracketSpacingSniff.php +++ b/coder_sniffer/Drupal/Sniffs/WhiteSpace/OpenBracketSpacingSniff.php @@ -1,21 +1,27 @@ getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/WhiteSpace/OpenTagNewlineSniff.php b/coder_sniffer/Drupal/Sniffs/WhiteSpace/OpenTagNewlineSniff.php index 6dfd7ec..c4f4e7c 100644 --- a/coder_sniffer/Drupal/Sniffs/WhiteSpace/OpenTagNewlineSniff.php +++ b/coder_sniffer/Drupal/Sniffs/WhiteSpace/OpenTagNewlineSniff.php @@ -1,13 +1,17 @@ getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/WhiteSpace/OperatorSpacingSniff.php b/coder_sniffer/Drupal/Sniffs/WhiteSpace/OperatorSpacingSniff.php index e705541..92b8518 100644 --- a/coder_sniffer/Drupal/Sniffs/WhiteSpace/OperatorSpacingSniff.php +++ b/coder_sniffer/Drupal/Sniffs/WhiteSpace/OperatorSpacingSniff.php @@ -1,12 +1,18 @@ getTokens(); @@ -184,22 +190,22 @@ class Drupal_Sniffs_WhiteSpace_OperatorSpacingSniff implements PHP_CodeSniffer_S return; } - if (isset(PHP_CodeSniffer_Tokens::$operators[$tokens[$prev]['code']]) === true) { + if (isset(Tokens::$operators[$tokens[$prev]['code']]) === true) { // Just trying to operate on a negative value; eg. ($var * -1). return; } - if (isset(PHP_CodeSniffer_Tokens::$comparisonTokens[$tokens[$prev]['code']]) === true) { + if (isset(Tokens::$comparisonTokens[$tokens[$prev]['code']]) === true) { // Just trying to compare a negative value; eg. ($var === -1). return; } - if (isset(PHP_CodeSniffer_Tokens::$booleanOperators[$tokens[$prev]['code']]) === true) { + if (isset(Tokens::$booleanOperators[$tokens[$prev]['code']]) === true) { // Just trying to compare a negative value; eg. ($var || -1 === $b). return; } - if (isset(PHP_CodeSniffer_Tokens::$assignmentTokens[$tokens[$prev]['code']]) === true) { + if (isset(Tokens::$assignmentTokens[$tokens[$prev]['code']]) === true) { // Just trying to assign a negative value; eg. ($var = -1). return; } @@ -234,7 +240,7 @@ class Drupal_Sniffs_WhiteSpace_OperatorSpacingSniff implements PHP_CodeSniffer_S } $phpcsFile->recordMetric($stackPtr, 'Space before operator', 0); - } else if (isset(PHP_CodeSniffer_Tokens::$assignmentTokens[$tokens[$stackPtr]['code']]) === false) { + } else if (isset(Tokens::$assignmentTokens[$tokens[$stackPtr]['code']]) === false) { // Don't throw an error for assignments, because other standards allow // multiple spaces there to align multiple assignments. if ($tokens[($stackPtr - 2)]['line'] !== $tokens[$stackPtr]['line']) { diff --git a/coder_sniffer/Drupal/Sniffs/WhiteSpace/ScopeClosingBraceSniff.php b/coder_sniffer/Drupal/Sniffs/WhiteSpace/ScopeClosingBraceSniff.php index ab5d014..a06da0e 100644 --- a/coder_sniffer/Drupal/Sniffs/WhiteSpace/ScopeClosingBraceSniff.php +++ b/coder_sniffer/Drupal/Sniffs/WhiteSpace/ScopeClosingBraceSniff.php @@ -1,14 +1,20 @@ getTokens(); diff --git a/coder_sniffer/Drupal/Sniffs/WhiteSpace/ScopeIndentSniff.php b/coder_sniffer/Drupal/Sniffs/WhiteSpace/ScopeIndentSniff.php index 2fff41d..7c414eb 100644 --- a/coder_sniffer/Drupal/Sniffs/WhiteSpace/ScopeIndentSniff.php +++ b/coder_sniffer/Drupal/Sniffs/WhiteSpace/ScopeIndentSniff.php @@ -1,15 +1,24 @@ _debug = (bool) $debug; } if ($this->_tabWidth === null) { - $cliValues = $phpcsFile->phpcs->cli->getCommandLineValues(); - if (isset($cliValues['tabWidth']) === false || $cliValues['tabWidth'] === 0) { + $config = $phpcsFile->config; + if (isset($config->tabWidth) === false || $config->tabWidth === 0) { // We have no idea how wide tabs are, so assume 4 spaces for fixing. // It shouldn't really matter because indent checks elsewhere in the // standard should fix things up. $this->_tabWidth = 4; } else { - $this->_tabWidth = $cliValues['tabWidth']; + $this->_tabWidth = $config->tabWidth; } } @@ -718,7 +727,7 @@ class Drupal_Sniffs_WhiteSpace_ScopeIndentSniff implements PHP_CodeSniffer_Sniff }//end if if ($checkToken !== null - && isset(PHP_CodeSniffer_Tokens::$scopeOpeners[$tokens[$checkToken]['code']]) === true + && isset(Tokens::$scopeOpeners[$tokens[$checkToken]['code']]) === true && in_array($tokens[$checkToken]['code'], $this->nonIndentingScopes) === false && isset($tokens[$checkToken]['scope_opener']) === true ) { @@ -768,7 +777,7 @@ class Drupal_Sniffs_WhiteSpace_ScopeIndentSniff implements PHP_CodeSniffer_Sniff // Method prefix indentation has to be exact or else if will break // the rest of the function declaration, and potentially future ones. if ($checkToken !== null - && isset(PHP_CodeSniffer_Tokens::$methodPrefixes[$tokens[$checkToken]['code']]) === true + && isset(Tokens::$methodPrefixes[$tokens[$checkToken]['code']]) === true && $tokens[($checkToken + 1)]['code'] !== T_DOUBLE_COLON ) { $exact = true; @@ -820,7 +829,7 @@ class Drupal_Sniffs_WhiteSpace_ScopeIndentSniff implements PHP_CodeSniffer_Sniff ) { if ($tokenIndent > $checkIndent) { // Ignore multi line statements. - $before = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($checkToken - 1), null, true); + $before = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($checkToken - 1), null, true); if ($before !== false && in_array( $tokens[$before]['code'], array( @@ -1065,7 +1074,7 @@ class Drupal_Sniffs_WhiteSpace_ScopeIndentSniff implements PHP_CodeSniffer_Sniff } $condition = $tokens[$tokens[$i]['scope_condition']]['code']; - if (isset(PHP_CodeSniffer_Tokens::$scopeOpeners[$condition]) === true + if (isset(Tokens::$scopeOpeners[$condition]) === true && in_array($condition, $this->nonIndentingScopes) === false ) { if ($this->_debug === true) { @@ -1186,7 +1195,7 @@ class Drupal_Sniffs_WhiteSpace_ScopeIndentSniff implements PHP_CodeSniffer_Sniff echo "\t* using parenthesis *".PHP_EOL; } - $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($parens - 1), null, true); + $prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($parens - 1), null, true); $object = 0; $condition = 0; } else if ($object > 0 && $object >= $condition) { diff --git a/coder_sniffer/Drupal/Test/Array/ArrayUnitTest.inc b/coder_sniffer/Drupal/Test/Arrays/ArrayUnitTest.inc similarity index 100% rename from coder_sniffer/Drupal/Test/Array/ArrayUnitTest.inc rename to coder_sniffer/Drupal/Test/Arrays/ArrayUnitTest.inc diff --git a/coder_sniffer/Drupal/Test/Array/ArrayUnitTest.inc.fixed b/coder_sniffer/Drupal/Test/Arrays/ArrayUnitTest.inc.fixed similarity index 100% rename from coder_sniffer/Drupal/Test/Array/ArrayUnitTest.inc.fixed rename to coder_sniffer/Drupal/Test/Arrays/ArrayUnitTest.inc.fixed diff --git a/coder_sniffer/Drupal/Test/Array/ArrayUnitTest.php b/coder_sniffer/Drupal/Test/Arrays/ArrayUnitTest.php similarity index 90% rename from coder_sniffer/Drupal/Test/Array/ArrayUnitTest.php rename to coder_sniffer/Drupal/Test/Arrays/ArrayUnitTest.php index 15ef908..72142a4 100644 --- a/coder_sniffer/Drupal/Test/Array/ArrayUnitTest.php +++ b/coder_sniffer/Drupal/Test/Arrays/ArrayUnitTest.php @@ -1,6 +1,10 @@ getFilename(); @@ -182,11 +188,11 @@ abstract class CoderSniffUnitTest extends PHPUnit_Framework_TestCase $expectedWarnings = $this->getWarningList(basename($testFile)); if (is_array($expectedErrors) === false) { - throw new PHP_CodeSniffer_Exception('getErrorList() must return an array'); + throw new RuntimeException('getErrorList() must return an array'); } if (is_array($expectedWarnings) === false) { - throw new PHP_CodeSniffer_Exception('getWarningList() must return an array'); + throw new RuntimeException('getWarningList() must return an array'); } /* diff --git a/coder_sniffer/Drupal/Test/Commenting/ClassCommentUnitTest.php b/coder_sniffer/Drupal/Test/Commenting/ClassCommentUnitTest.php index b096084..0a9e75a 100644 --- a/coder_sniffer/Drupal/Test/Commenting/ClassCommentUnitTest.php +++ b/coder_sniffer/Drupal/Test/Commenting/ClassCommentUnitTest.php @@ -1,6 +1,10 @@ getFilename()] = $infoFile; return $infoFile; @@ -106,12 +110,12 @@ class DrupalPractice_Project /** * Determines the *.services.yml file in a module. * - * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. * * @return string|false The Services YML file name or false if it could not * be derived. */ - public static function getServicesYmlFile(PHP_CodeSniffer_File $phpcsFile) + public static function getServicesYmlFile(File $phpcsFile) { // Cache the services file per file as this might get called often. static $cache; @@ -138,7 +142,7 @@ class DrupalPractice_Project } // Sort the YML file names and take the shortest info file. - usort($ymlFiles, array('DrupalPractice_Project', 'compareLength')); + usort($ymlFiles, array(__NAMESPACE__.'\Project', 'compareLength')); $ymlFile = $ymlFiles[0]; $cache[$phpcsFile->getFilename()] = $ymlFile; return $ymlFile; @@ -149,13 +153,13 @@ class DrupalPractice_Project /** * Return true if the given class is a Drupal service registered in *.services.yml. * - * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. - * @param int $classPtr The position of the class declaration - * in the token stack. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. + * @param int $classPtr The position of the class declaration + * in the token stack. * * @return bool */ - public static function isServiceClass(PHP_CodeSniffer_File $phpcsFile, $classPtr) + public static function isServiceClass(File $phpcsFile, $classPtr) { // Cache the information per file as this might get called often. static $cache; @@ -228,12 +232,12 @@ class DrupalPractice_Project /** * Determines the Drupal core version a file might be associated with. * - * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned. * * @return string|false The core version string or false if it could not * be derived. */ - public static function getCoreVersion(PHP_CodeSniffer_File $phpcsFile) + public static function getCoreVersion(File $phpcsFile) { $infoFile = static::getInfoFile($phpcsFile); if ($infoFile === false) { @@ -244,7 +248,7 @@ class DrupalPractice_Project // Drupal 6 and 7 use the .info file extension. if ($pathParts['extension'] === 'info') { - $info_settings = Drupal_Sniffs_InfoFiles_ClassFilesSniff::drupalParseInfoFormat(file_get_contents($infoFile)); + $info_settings = ClassFilesSniff::drupalParseInfoFormat(file_get_contents($infoFile)); if (isset($info_settings['core']) === true) { return $info_settings['core']; } diff --git a/coder_sniffer/DrupalPractice/Sniffs/CodeAnalysis/VariableAnalysisSniff.php b/coder_sniffer/DrupalPractice/Sniffs/CodeAnalysis/VariableAnalysisSniff.php index 980021e..0ed2cd2 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/CodeAnalysis/VariableAnalysisSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/CodeAnalysis/VariableAnalysisSniff.php @@ -10,6 +10,11 @@ * @link http://pear.php.net/package/PHP_CodeSniffer */ +namespace DrupalPractice\Sniffs\CodeAnalysis; + +use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\Sniff; + /** * Holds details of a scope. * @@ -103,7 +108,7 @@ class VariableInfo * @copyright 2011 Sam Graham * @link http://pear.php.net/package/PHP_CodeSniffer */ -class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_CodeSniffer_Sniff +class VariableAnalysisSniff implements Sniff { /** * The current phpcsFile being checked. @@ -606,13 +611,13 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * 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. + * @param \PHP_CodeSniffer\Files\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) + public function process(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $token = $tokens[$stackPtr]; @@ -897,14 +902,14 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Marks a variable as read and throws a PHPCS warning if it is undefined. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param string $varName - * @param int $stackPtr - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param string $varName + * @param int $stackPtr + * @param string $currScope * * @return bool */ - function markVariableReadAndWarnIfUndefined(PHP_CodeSniffer_File $phpcsFile, $varName, $stackPtr, $currScope) + function markVariableReadAndWarnIfUndefined(File $phpcsFile, $varName, $stackPtr, $currScope) { $this->markVariableRead($varName, $stackPtr, $currScope); @@ -926,12 +931,12 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Returns the function declaration pointer. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr * * @return int|false */ - function findFunctionPrototype(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + function findFunctionPrototype(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -969,12 +974,12 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Find the scope the given pointer is in. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr * * @return int|false */ - function findVariableScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + function findVariableScope(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $token = $tokens[$stackPtr]; @@ -1010,12 +1015,12 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Checks if the next token is an assignment. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr * * @return bool */ - function isNextThingAnAssign(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + function isNextThingAnAssign(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -1041,12 +1046,12 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Find the end of the assignment. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr * * @return int */ - function findWhereAssignExecuted(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + function findWhereAssignExecuted(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -1085,12 +1090,12 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Find the parenthesis if the pointer is in some. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr * * @return int|false */ - function findContainingBrackets(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + function findContainingBrackets(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -1107,12 +1112,12 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Checks if the given pointer is in a function call. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr * * @return int|false */ - function findFunctionCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + function findFunctionCall(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -1139,12 +1144,12 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Get the arguments of a function call. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr * * @return array|false */ - function findFunctionCallArguments(PHP_CodeSniffer_File $phpcsFile, $stackPtr) + function findFunctionCallArguments(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -1199,15 +1204,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Checks the function prototype. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr - * @param string $varName - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr + * @param string $varName + * @param string $currScope * * @return bool */ protected function checkForFunctionPrototype( - PHP_CodeSniffer_File $phpcsFile, + File $phpcsFile, $stackPtr, $varName, $currScope @@ -1320,15 +1325,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Checks if we are in a catch() block. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr - * @param string $varName - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr + * @param string $varName + * @param string $currScope * * @return bool */ protected function checkForCatchBlock( - PHP_CodeSniffer_File $phpcsFile, + File $phpcsFile, $stackPtr, $varName, $currScope @@ -1375,15 +1380,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Checks if $this is used within a class. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr - * @param string $varName - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr + * @param string $varName + * @param string $currScope * * @return bool */ protected function checkForThisWithinClass( - PHP_CodeSniffer_File $phpcsFile, + File $phpcsFile, $stackPtr, $varName, $currScope @@ -1410,15 +1415,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Checks if the variable is a PHP super global. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr - * @param string $varName - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr + * @param string $varName + * @param string $currScope * * @return bool */ protected function checkForSuperGlobal( - PHP_CodeSniffer_File $phpcsFile, + File $phpcsFile, $stackPtr, $varName, $currScope @@ -1455,15 +1460,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Checks if the variable is a static class member. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr - * @param string $varName - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr + * @param string $varName + * @param string $currScope * * @return bool */ protected function checkForStaticMember( - PHP_CodeSniffer_File $phpcsFile, + File $phpcsFile, $stackPtr, $varName, $currScope @@ -1535,15 +1540,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Checks if the variable is being assigned to. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr - * @param string $varName - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr + * @param string $varName + * @param string $currScope * * @return bool */ protected function checkForAssignment( - PHP_CodeSniffer_File $phpcsFile, + File $phpcsFile, $stackPtr, $varName, $currScope @@ -1578,15 +1583,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Check if this is a list language construct assignment. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr - * @param string $varName - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr + * @param string $varName + * @param string $currScope * * @return bool */ protected function checkForListAssignment( - PHP_CodeSniffer_File $phpcsFile, + File $phpcsFile, $stackPtr, $varName, $currScope @@ -1620,15 +1625,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Check if this variable is declared globally. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr - * @param string $varName - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr + * @param string $varName + * @param string $currScope * * @return bool */ protected function checkForGlobalDeclaration( - PHP_CodeSniffer_File $phpcsFile, + File $phpcsFile, $stackPtr, $varName, $currScope @@ -1667,15 +1672,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Check is this is a static variable declaration. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr - * @param string $varName - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr + * @param string $varName + * @param string $currScope * * @return bool */ protected function checkForStaticDeclaration( - PHP_CodeSniffer_File $phpcsFile, + File $phpcsFile, $stackPtr, $varName, $currScope @@ -1759,15 +1764,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Check if this is a foreach loop variable. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr - * @param string $varName - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr + * @param string $varName + * @param string $currScope * * @return bool */ protected function checkForForeachLoopVar( - PHP_CodeSniffer_File $phpcsFile, + File $phpcsFile, $stackPtr, $varName, $currScope @@ -1809,15 +1814,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Check if this is a "&" function call. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr - * @param string $varName - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr + * @param string $varName + * @param string $currScope * * @return bool */ protected function checkForPassByReferenceFunctionCall( - PHP_CodeSniffer_File $phpcsFile, + File $phpcsFile, $stackPtr, $varName, $currScope @@ -1890,15 +1895,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Check if the variable is an object property. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr - * @param string $varName - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr + * @param string $varName + * @param string $currScope * * @return bool */ protected function checkForSymbolicObjectProperty( - PHP_CodeSniffer_File $phpcsFile, + File $phpcsFile, $stackPtr, $varName, $currScope @@ -1929,14 +1934,14 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * 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. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where this + * token was found. + * @param int $stackPtr The position where the token was found. * * @return void */ protected function processMemberVar( - PHP_CodeSniffer_File $phpcsFile, + File $phpcsFile, $stackPtr ) { // TODO: don't care for now. @@ -1949,14 +1954,14 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * 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. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer 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, + File $phpcsFile, $stackPtr ) { $tokens = $phpcsFile->getTokens(); @@ -2065,15 +2070,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co * Note that there may be more than one variable in the string, which will * result only in one call for the string. * - * @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. + * @param \PHP_CodeSniffer\Files\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 */ protected function processVariableInString( - PHP_CodeSniffer_File + File $phpcsFile, $stackPtr ) { @@ -2106,15 +2111,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Check variables in a compact() call. * - * @param PHP_CodeSniffer_File $phpcsFile - * @param int $stackPtr - * @param array $arguments - * @param string $currScope + * @param \PHP_CodeSniffer\Files\File $phpcsFile + * @param int $stackPtr + * @param array $arguments + * @param string $currScope * * @return void */ protected function processCompactArguments( - PHP_CodeSniffer_File + File $phpcsFile, $stackPtr, $arguments, @@ -2182,15 +2187,15 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co /** * Called to process variables named in a call to compact(). * - * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this - * token was found. - * @param int $stackPtr The position where the call to compact() - * was found. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where this + * token was found. + * @param int $stackPtr The position where the call to compact() + * was found. * * @return void */ protected function processCompact( - PHP_CodeSniffer_File + File $phpcsFile, $stackPtr ) { @@ -2212,14 +2217,14 @@ class DrupalPractice_Sniffs_CodeAnalysis_VariableAnalysisSniff implements PHP_Co * Note that although triggered by the closing curly brace of the scope, $stackPtr is * the scope conditional, not the closing curly brace. * - * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this - * token was found. - * @param int $stackPtr The position of the scope conditional. + * @param \PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where this + * token was found. + * @param int $stackPtr The position of the scope conditional. * * @return void */ protected function processScopeClose( - PHP_CodeSniffer_File + File $phpcsFile, $stackPtr ) { diff --git a/coder_sniffer/DrupalPractice/Sniffs/Commenting/AuthorTagSniff.php b/coder_sniffer/DrupalPractice/Sniffs/Commenting/AuthorTagSniff.php index f9c7dc1..df78d6d 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/Commenting/AuthorTagSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/Commenting/AuthorTagSniff.php @@ -1,12 +1,17 @@ getTokens(); diff --git a/coder_sniffer/DrupalPractice/Sniffs/Commenting/CommentEmptyLineSniff.php b/coder_sniffer/DrupalPractice/Sniffs/Commenting/CommentEmptyLineSniff.php index 1ffd149..0cb4e96 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/Commenting/CommentEmptyLineSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/Commenting/CommentEmptyLineSniff.php @@ -1,13 +1,18 @@ getTokens(); diff --git a/coder_sniffer/DrupalPractice/Sniffs/Commenting/ExpectedExceptionSniff.php b/coder_sniffer/DrupalPractice/Sniffs/Commenting/ExpectedExceptionSniff.php index abf6f3a..834fed4 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/Commenting/ExpectedExceptionSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/Commenting/ExpectedExceptionSniff.php @@ -1,12 +1,17 @@ getTokens(); @@ -50,7 +55,7 @@ class DrupalPractice_Sniffs_Commenting_ExpectedExceptionSniff implements PHP_Cod || $content === '@expectedExceptionMessage' || $content === '@expectedExceptionMessageRegExp' ) { - $warning = '%s tags should not be used, use $this->setExpectedException() or $this->expectException() instead'; + $warning = '%s tags should not be used, use $§this->setExpectedException() or $this->expectException() instead'; $phpcsFile->addWarning($warning, $stackPtr, 'TagFound', [$content]); } diff --git a/coder_sniffer/DrupalPractice/Sniffs/Constants/GlobalConstantSniff.php b/coder_sniffer/DrupalPractice/Sniffs/Constants/GlobalConstantSniff.php index b0284dc..9e40e49 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/Constants/GlobalConstantSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/Constants/GlobalConstantSniff.php @@ -1,12 +1,18 @@ getTokens(); @@ -48,7 +54,7 @@ class DrupalPractice_Sniffs_Constants_GlobalConstantSniff implements PHP_CodeSni return; } - $coreVersion = DrupalPractice_Project::getCoreVersion($phpcsFile); + $coreVersion = Project::getCoreVersion($phpcsFile); if ($coreVersion !== '8.x') { return; } diff --git a/coder_sniffer/DrupalPractice/Sniffs/Constants/GlobalDefineSniff.php b/coder_sniffer/DrupalPractice/Sniffs/Constants/GlobalDefineSniff.php index ef7cf7e..afe82eb 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/Constants/GlobalDefineSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/Constants/GlobalDefineSniff.php @@ -1,12 +1,18 @@ check_plain(...) is // wrong because the Form API already sanitizes #default_value. - $arrow = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); + $arrow = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($arrow === false || $tokens[$arrow]['code'] !== T_DOUBLE_ARROW) { return; } - $arrayKey = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($arrow - 1), null, true); + $arrayKey = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($arrow - 1), null, true); if ($arrayKey === false || $tokens[$arrayKey]['code'] !== T_CONSTANT_ENCAPSED_STRING || substr($tokens[$arrayKey]['content'], 1, -1) !== '#default_value' diff --git a/coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/FormErrorTSniff.php b/coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/FormErrorTSniff.php index 5ad2830..566c4e8 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/FormErrorTSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/FormErrorTSniff.php @@ -1,12 +1,17 @@ getTokens(); $functionName = $tokens[$stackPtr]['content']; diff --git a/coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/VariableSetSanitizeSniff.php b/coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/VariableSetSanitizeSniff.php index e172314..be10842 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/VariableSetSanitizeSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/VariableSetSanitizeSniff.php @@ -1,12 +1,17 @@ getFilename(), -6)); // Only check in *.module files. @@ -52,7 +58,7 @@ class DrupalPractice_Sniffs_FunctionDefinitions_AccessHookMenuSniff extends Drup while ($string !== false) { if (substr($tokens[$string]['content'], 1, -1) === 'access callback') { $array_operator = $phpcsFile->findNext( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($string + 1), null, true @@ -61,7 +67,7 @@ class DrupalPractice_Sniffs_FunctionDefinitions_AccessHookMenuSniff extends Drup && $tokens[$array_operator]['code'] === T_DOUBLE_ARROW ) { $callback = $phpcsFile->findNext( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($array_operator + 1), null, true @@ -75,7 +81,7 @@ class DrupalPractice_Sniffs_FunctionDefinitions_AccessHookMenuSniff extends Drup $tokens[$functionPtr]['scope_opener'], true ); - if ($commentBefore !== false && in_array($tokens[$commentBefore]['code'], PHP_CodeSniffer_Tokens::$commentTokens) === false) { + if ($commentBefore !== false && in_array($tokens[$commentBefore]['code'], Tokens::$commentTokens) === false) { $warning = 'Open page callback found, please add a comment before the line why there is no access restriction'; $phpcsFile->addWarning($warning, $callback, 'OpenCallback'); } diff --git a/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/FormAlterDocSniff.php b/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/FormAlterDocSniff.php index 7e51885..1aff0f2 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/FormAlterDocSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/FormAlterDocSniff.php @@ -1,12 +1,18 @@ getTokens(); $docCommentEnd = $phpcsFile->findPrevious(T_WHITESPACE, ($functionPtr - 1), null, true); @@ -55,7 +61,7 @@ class DrupalPractice_Sniffs_FunctionDefinitions_FormAlterDocSniff extends Drupal return; } - $projectName = DrupalPractice_Project::getName($phpcsFile); + $projectName = Project::getName($phpcsFile); if ($projectName === false) { return; } diff --git a/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/HookInitCssSniff.php b/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/HookInitCssSniff.php index f983713..4527a94 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/HookInitCssSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/HookInitCssSniff.php @@ -1,12 +1,19 @@ getFilename(), -6)); // Only check in *.module files. @@ -38,7 +45,7 @@ class DrupalPractice_Sniffs_FunctionDefinitions_HookInitCssSniff extends Drupal_ } // This check only applies to Drupal 7, not Drupal 6. - if (DrupalPractice_Project::getCoreVersion($phpcsFile) !== '7.x') { + if (Project::getCoreVersion($phpcsFile) !== '7.x') { return; } @@ -57,7 +64,7 @@ class DrupalPractice_Sniffs_FunctionDefinitions_HookInitCssSniff extends Drupal_ while ($string !== false) { if ($tokens[$string]['content'] === 'drupal_add_css' || $tokens[$string]['content'] === 'drupal_add_js') { $opener = $phpcsFile->findNext( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($string + 1), null, true diff --git a/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/InstallTSniff.php b/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/InstallTSniff.php index 94bcaf6..886091c 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/InstallTSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/InstallTSniff.php @@ -1,12 +1,19 @@ getFilename(), -7)); // Only check in *.install files. @@ -46,7 +53,7 @@ class DrupalPractice_Sniffs_FunctionDefinitions_InstallTSniff extends Drupal_Sni } // This check only applies to Drupal 7, not Drupal 8. - if (DrupalPractice_Project::getCoreVersion($phpcsFile) !== '7.x') { + if (Project::getCoreVersion($phpcsFile) !== '7.x') { return; } @@ -59,7 +66,7 @@ class DrupalPractice_Sniffs_FunctionDefinitions_InstallTSniff extends Drupal_Sni while ($string !== false) { if ($tokens[$string]['content'] === 't' || $tokens[$string]['content'] === 'st') { $opener = $phpcsFile->findNext( - PHP_CodeSniffer_Tokens::$emptyTokens, + Tokens::$emptyTokens, ($string + 1), null, true diff --git a/coder_sniffer/DrupalPractice/Sniffs/General/AccessAdminPagesSniff.php b/coder_sniffer/DrupalPractice/Sniffs/General/AccessAdminPagesSniff.php index d279304..c9305e7 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/General/AccessAdminPagesSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/General/AccessAdminPagesSniff.php @@ -1,12 +1,17 @@ getFilename(), -6)); // Only check in *.module files. diff --git a/coder_sniffer/DrupalPractice/Sniffs/General/ClassNameSniff.php b/coder_sniffer/DrupalPractice/Sniffs/General/ClassNameSniff.php index b2ea155..cf899d0 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/General/ClassNameSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/General/ClassNameSniff.php @@ -1,12 +1,18 @@ getTokens(); @@ -64,7 +69,7 @@ class DrupalPractice_Sniffs_General_DescriptionTSniff implements PHP_CodeSniffer if (strlen($content) > 5) { $warning = '#description values usually have to run through t() for translation'; - $phpcsFile->addWarning($warning, $stringToken); + $phpcsFile->addWarning($warning, $stringToken, 'DescriptionT'); } }//end process() diff --git a/coder_sniffer/DrupalPractice/Sniffs/General/FormStateInputSniff.php b/coder_sniffer/DrupalPractice/Sniffs/General/FormStateInputSniff.php index 97648a6..a6c299c 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/General/FormStateInputSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/General/FormStateInputSniff.php @@ -1,12 +1,17 @@ getTokensAsString($stackPtr, 4) === '$form_state[\'input\']' || $phpcsFile->getTokensAsString($stackPtr, 4) === '$form_state["input"]' diff --git a/coder_sniffer/DrupalPractice/Sniffs/General/LanguageNoneSniff.php b/coder_sniffer/DrupalPractice/Sniffs/General/LanguageNoneSniff.php index bb10afa..e744661 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/General/LanguageNoneSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/General/LanguageNoneSniff.php @@ -1,12 +1,17 @@ getTokensAsString($stackPtr, 3); if ($sequence === "['und']" || $sequence === '["und"]') { diff --git a/coder_sniffer/DrupalPractice/Sniffs/General/OptionsTSniff.php b/coder_sniffer/DrupalPractice/Sniffs/General/OptionsTSniff.php index fced8fc..e9a078b 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/General/OptionsTSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/General/OptionsTSniff.php @@ -1,12 +1,17 @@ getTokens(); diff --git a/coder_sniffer/DrupalPractice/Sniffs/General/VariableNameSniff.php b/coder_sniffer/DrupalPractice/Sniffs/General/VariableNameSniff.php index 16285d8..857e574 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/General/VariableNameSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/General/VariableNameSniff.php @@ -1,12 +1,19 @@ variable_get(...) // indicates a variable that the module owns. - $arrow = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); + $arrow = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($arrow === false || $tokens[$arrow]['code'] !== T_DOUBLE_ARROW) { return; } - $arrayKey = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($arrow - 1), null, true); + $arrayKey = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($arrow - 1), null, true); if ($arrayKey === false || $tokens[$arrayKey]['code'] !== T_CONSTANT_ENCAPSED_STRING || substr($tokens[$arrayKey]['content'], 1, -1) !== '#default_value' @@ -73,7 +80,7 @@ class DrupalPractice_Sniffs_General_VariableNameSniff extends Drupal_Sniffs_Sema return; } - $moduleName = DrupalPractice_Project::getName($phpcsFile); + $moduleName = Project::getName($phpcsFile); if ($moduleName === false) { return; } diff --git a/coder_sniffer/DrupalPractice/Sniffs/InfoFiles/NamespacedDependencySniff.php b/coder_sniffer/DrupalPractice/Sniffs/InfoFiles/NamespacedDependencySniff.php index 27c827a..d571017 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/InfoFiles/NamespacedDependencySniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/InfoFiles/NamespacedDependencySniff.php @@ -1,13 +1,18 @@ getTokens(); diff --git a/coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalClassSniff.php b/coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalClassSniff.php index 8e62fcc..e93542a 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalClassSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalClassSniff.php @@ -1,12 +1,18 @@ getTokens(); @@ -85,8 +91,8 @@ class DrupalPractice_Sniffs_Objects_GlobalClassSniff implements PHP_CodeSniffer_ $extendsName = $phpcsFile->findExtendedClassName($classPtr); if (($extendsName === false - || in_array($extendsName, DrupalPractice_Sniffs_Objects_GlobalDrupalSniff::$baseClasses) === false) - && DrupalPractice_Project::isServiceClass($phpcsFile, $classPtr) === false + || in_array($extendsName, GlobalDrupalSniff::$baseClasses) === false) + && Project::isServiceClass($phpcsFile, $classPtr) === false ) { return; } diff --git a/coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalDrupalSniff.php b/coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalDrupalSniff.php index 1bf4faf..ee2eda4 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalDrupalSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalDrupalSniff.php @@ -1,12 +1,18 @@ getTokens(); @@ -89,7 +95,7 @@ class DrupalPractice_Sniffs_Objects_GlobalDrupalSniff implements PHP_CodeSniffer $extendsName = $phpcsFile->findExtendedClassName($classPtr); if (($extendsName === false || in_array($extendsName, static::$baseClasses) === false) - && DrupalPractice_Project::isServiceClass($phpcsFile, $classPtr) === false + && Project::isServiceClass($phpcsFile, $classPtr) === false ) { return; } diff --git a/coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalFunctionSniff.php b/coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalFunctionSniff.php index 29d7f79..13e1423 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalFunctionSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/Objects/GlobalFunctionSniff.php @@ -1,12 +1,19 @@ 'the "entity_type.manager" service', 'format_date' => 'the "date.formatter" service', 'node_load' => 'the "entity_type.manager" service', - 'node_load_multiple' => 'the "entity_type.manager" service', 'node_type_load' => 'the "entity_type.manager" service', 't' => '$this->t()', 'taxonomy_term_load' => 'the "entity_type.manager" service', @@ -54,13 +60,13 @@ class DrupalPractice_Sniffs_Objects_GlobalFunctionSniff implements PHP_CodeSniff /** * 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. + * @param \PHP_CodeSniffer\Files\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) + public function process(File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); @@ -94,8 +100,8 @@ class DrupalPractice_Sniffs_Objects_GlobalFunctionSniff implements PHP_CodeSniff $extendsName = $phpcsFile->findExtendedClassName($classPtr); if (($extendsName === false - || in_array($extendsName, DrupalPractice_Sniffs_Objects_GlobalDrupalSniff::$baseClasses) === false) - && DrupalPractice_Project::isServiceClass($phpcsFile, $classPtr) === false + || in_array($extendsName, GlobalDrupalSniff::$baseClasses) === false) + && Project::isServiceClass($phpcsFile, $classPtr) === false ) { return; } diff --git a/coder_sniffer/DrupalPractice/Sniffs/Objects/UnusedPrivateMethodSniff.php b/coder_sniffer/DrupalPractice/Sniffs/Objects/UnusedPrivateMethodSniff.php index 7a55f7e..e22c6c9 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/Objects/UnusedPrivateMethodSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/Objects/UnusedPrivateMethodSniff.php @@ -1,12 +1,18 @@ getMethodProperties($stackPtr); @@ -60,18 +66,18 @@ class DrupalPractice_Sniffs_Objects_UnusedPrivateMethodSniff extends PHP_CodeSni continue; } - $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($current + 1), null, true); + $next = $phpcsFile->findNext(Tokens::$emptyTokens, ($current + 1), null, true); if ($next === false) { continue; } if ($tokens[$next]['code'] === T_OBJECT_OPERATOR) { - $call = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true); + $call = $phpcsFile->findNext(Tokens::$emptyTokens, ($next + 1), null, true); if ($call === false || $tokens[$call]['content'] !== $methodName) { continue; } - $parenthesis = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($call + 1), null, true); + $parenthesis = $phpcsFile->findNext(Tokens::$emptyTokens, ($call + 1), null, true); if ($parenthesis === false || $tokens[$parenthesis]['code'] !== T_OPEN_PARENTHESIS) { continue; } @@ -80,7 +86,7 @@ class DrupalPractice_Sniffs_Objects_UnusedPrivateMethodSniff extends PHP_CodeSni // can stop. return; } else if ($tokens[$next]['code'] === T_COMMA) { - $call = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true); + $call = $phpcsFile->findNext(Tokens::$emptyTokens, ($next + 1), null, true); if ($call === false || substr($tokens[$call]['content'], 1, -1) !== $methodName) { continue; } diff --git a/coder_sniffer/DrupalPractice/Sniffs/Yaml/RoutingAccessSniff.php b/coder_sniffer/DrupalPractice/Sniffs/Yaml/RoutingAccessSniff.php index 7834966..7ca3619 100644 --- a/coder_sniffer/DrupalPractice/Sniffs/Yaml/RoutingAccessSniff.php +++ b/coder_sniffer/DrupalPractice/Sniffs/Yaml/RoutingAccessSniff.php @@ -1,13 +1,18 @@ getTokens(); diff --git a/coder_sniffer/DrupalPractice/Test/CodeAnalysis/VariableAnalysisUnitTest.php b/coder_sniffer/DrupalPractice/Test/CodeAnalysis/VariableAnalysisUnitTest.php index 59b6732..fcb8334 100644 --- a/coder_sniffer/DrupalPractice/Test/CodeAnalysis/VariableAnalysisUnitTest.php +++ b/coder_sniffer/DrupalPractice/Test/CodeAnalysis/VariableAnalysisUnitTest.php @@ -1,12 +1,16 @@ will($this->returnValue(dirname(__FILE__) . '/modules/drupal6/test.php')); - $this->assertEquals(DrupalPractice_Project::getInfoFile($this->phpcsFile), dirname(__FILE__) . '/modules/drupal6/testmodule.info'); + $this->assertEquals(Project::getInfoFile($this->phpcsFile), dirname(__FILE__) . '/modules/drupal6/testmodule.info'); } /** @@ -47,7 +51,7 @@ class ProjectUnitTest extends PHPUnit_Framework_TestCase // The file does not exist, but doesn't matter for this test. ->will($this->returnValue(dirname(__FILE__) . '/modules/drupal6/nested/test.php')); - $this->assertEquals(DrupalPractice_Project::getInfoFile($this->phpcsFile), dirname(__FILE__) . '/modules/drupal6/testmodule.info'); + $this->assertEquals(Project::getInfoFile($this->phpcsFile), dirname(__FILE__) . '/modules/drupal6/testmodule.info'); } /** @@ -62,7 +66,7 @@ class ProjectUnitTest extends PHPUnit_Framework_TestCase // The file does not exist, but doesn't matter for this test. ->will($this->returnValue($filename)); - $this->assertEquals(DrupalPractice_Project::getCoreVersion($this->phpcsFile), $core_version); + $this->assertEquals(Project::getCoreVersion($this->phpcsFile), $core_version); } /** diff --git a/coder_sniffer/DrupalPractice/Test/Yaml/RoutingAccessUnitTest.php b/coder_sniffer/DrupalPractice/Test/Yaml/RoutingAccessUnitTest.php index 4651bda..9c1036a 100644 --- a/coder_sniffer/DrupalPractice/Test/Yaml/RoutingAccessUnitTest.php +++ b/coder_sniffer/DrupalPractice/Test/Yaml/RoutingAccessUnitTest.php @@ -1,6 +1,10 @@ =5.4.0", "ext-mbstring": "*", - "squizlabs/php_codesniffer": ">=2.8.1 <3.0", + "squizlabs/php_codesniffer": "~3.0.0RC4", "symfony/yaml": ">=2.0.0" }, "require-dev": { -- 2.11.0.windows.3