From 64440b20516f645f06b02ef67d9d0414c2b92803 Mon Sep 17 00:00:00 2001 From: jrfnl Date: Thu, 4 Jan 2024 19:28:49 +0100 Subject: [PATCH] Hard deprecate all sniffs which will be removed in PHPCS 4.0 The new messages themselves are not covered by automated tests, but the principle of this is tested via the tests for the `DeprecatedSniff` feature (PR 281). Fixes 188 --- .../Generic/Sniffs/Debug/CSSLintSniff.php | 39 ++++++++++++++++++- .../Sniffs/Debug/ClosureLinterSniff.php | 39 ++++++++++++++++++- .../Generic/Sniffs/Debug/ESLintSniff.php | 39 ++++++++++++++++++- .../Generic/Sniffs/Debug/JSHintSniff.php | 39 ++++++++++++++++++- .../Formatting/NoSpaceAfterCastSniff.php | 39 ++++++++++++++++++- .../Sniffs/CSS/BrowserSpecificStylesSniff.php | 39 ++++++++++++++++++- .../Channels/DisallowSelfActionsSniff.php | 39 ++++++++++++++++++- .../Sniffs/Channels/IncludeOwnSystemSniff.php | 39 ++++++++++++++++++- .../Sniffs/Channels/IncludeSystemSniff.php | 39 ++++++++++++++++++- .../Sniffs/Channels/UnusedSystemSniff.php | 39 ++++++++++++++++++- .../Commenting/FunctionCommentSniff.php | 39 ++++++++++++++++++- .../MySource/Sniffs/Debug/DebugCodeSniff.php | 39 ++++++++++++++++++- .../Sniffs/Debug/FirebugConsoleSniff.php | 39 ++++++++++++++++++- .../Sniffs/Objects/AssignThisSniff.php | 39 ++++++++++++++++++- .../Objects/CreateWidgetTypeCallbackSniff.php | 39 ++++++++++++++++++- .../Sniffs/Objects/DisallowNewWidgetSniff.php | 39 ++++++++++++++++++- .../Sniffs/PHP/AjaxNullComparisonSniff.php | 39 ++++++++++++++++++- .../Sniffs/PHP/EvalObjectFactorySniff.php | 39 ++++++++++++++++++- .../Sniffs/PHP/GetRequestDataSniff.php | 39 ++++++++++++++++++- .../Sniffs/PHP/ReturnFunctionValueSniff.php | 39 ++++++++++++++++++- .../Sniffs/Strings/JoinStringsSniff.php | 39 ++++++++++++++++++- .../ClassDefinitionClosingBraceSpaceSniff.php | 39 ++++++++++++++++++- .../CSS/ClassDefinitionNameSpacingSniff.php | 39 ++++++++++++++++++- .../ClassDefinitionOpeningBraceSpaceSniff.php | 39 ++++++++++++++++++- .../Squiz/Sniffs/CSS/ColonSpacingSniff.php | 39 ++++++++++++++++++- .../Sniffs/CSS/ColourDefinitionSniff.php | 39 ++++++++++++++++++- .../DisallowMultipleStyleDefinitionsSniff.php | 39 ++++++++++++++++++- .../CSS/DuplicateClassDefinitionSniff.php | 39 ++++++++++++++++++- .../CSS/DuplicateStyleDefinitionSniff.php | 39 ++++++++++++++++++- .../Sniffs/CSS/EmptyClassDefinitionSniff.php | 39 ++++++++++++++++++- .../Sniffs/CSS/EmptyStyleDefinitionSniff.php | 39 ++++++++++++++++++- .../Squiz/Sniffs/CSS/ForbiddenStylesSniff.php | 39 ++++++++++++++++++- .../Squiz/Sniffs/CSS/IndentationSniff.php | 39 ++++++++++++++++++- .../CSS/LowercaseStyleDefinitionSniff.php | 39 ++++++++++++++++++- .../Squiz/Sniffs/CSS/MissingColonSniff.php | 39 ++++++++++++++++++- .../Squiz/Sniffs/CSS/NamedColoursSniff.php | 39 ++++++++++++++++++- .../Squiz/Sniffs/CSS/OpacitySniff.php | 39 ++++++++++++++++++- .../Sniffs/CSS/SemicolonSpacingSniff.php | 39 ++++++++++++++++++- .../Squiz/Sniffs/CSS/ShorthandSizeSniff.php | 39 ++++++++++++++++++- .../Sniffs/Classes/DuplicatePropertySniff.php | 39 ++++++++++++++++++- .../Squiz/Sniffs/Debug/JSLintSniff.php | 39 ++++++++++++++++++- .../Sniffs/Debug/JavaScriptLintSniff.php | 39 ++++++++++++++++++- .../DisallowObjectStringIndexSniff.php | 39 ++++++++++++++++++- .../Sniffs/Objects/ObjectMemberCommaSniff.php | 39 ++++++++++++++++++- .../LanguageConstructSpacingSniff.php | 39 ++++++++++++++++++- .../WhiteSpace/PropertyLabelSpacingSniff.php | 39 ++++++++++++++++++- .../Zend/Sniffs/Debug/CodeAnalyzerSniff.php | 39 ++++++++++++++++++- 47 files changed, 1786 insertions(+), 47 deletions(-) diff --git a/src/Standards/Generic/Sniffs/Debug/CSSLintSniff.php b/src/Standards/Generic/Sniffs/Debug/CSSLintSniff.php index 6df4c1ffb2..db0660d191 100644 --- a/src/Standards/Generic/Sniffs/Debug/CSSLintSniff.php +++ b/src/Standards/Generic/Sniffs/Debug/CSSLintSniff.php @@ -13,10 +13,11 @@ use PHP_CodeSniffer\Config; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Common; -class CSSLintSniff implements Sniff +class CSSLintSniff implements Sniff, DeprecatedSniff { /** @@ -95,4 +96,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Generic/Sniffs/Debug/ClosureLinterSniff.php b/src/Standards/Generic/Sniffs/Debug/ClosureLinterSniff.php index 637bf41ead..8d365f2876 100644 --- a/src/Standards/Generic/Sniffs/Debug/ClosureLinterSniff.php +++ b/src/Standards/Generic/Sniffs/Debug/ClosureLinterSniff.php @@ -13,10 +13,11 @@ use PHP_CodeSniffer\Config; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Common; -class ClosureLinterSniff implements Sniff +class ClosureLinterSniff implements Sniff, DeprecatedSniff { /** @@ -116,4 +117,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning JavaScript files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Generic/Sniffs/Debug/ESLintSniff.php b/src/Standards/Generic/Sniffs/Debug/ESLintSniff.php index 1c6b0e3f31..469d636414 100644 --- a/src/Standards/Generic/Sniffs/Debug/ESLintSniff.php +++ b/src/Standards/Generic/Sniffs/Debug/ESLintSniff.php @@ -13,10 +13,11 @@ use PHP_CodeSniffer\Config; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Common; -class ESLintSniff implements Sniff +class ESLintSniff implements Sniff, DeprecatedSniff { /** @@ -112,4 +113,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning JavaScript files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Generic/Sniffs/Debug/JSHintSniff.php b/src/Standards/Generic/Sniffs/Debug/JSHintSniff.php index ae8264ebba..66bc04e3fb 100644 --- a/src/Standards/Generic/Sniffs/Debug/JSHintSniff.php +++ b/src/Standards/Generic/Sniffs/Debug/JSHintSniff.php @@ -14,10 +14,11 @@ use PHP_CodeSniffer\Config; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Common; -class JSHintSniff implements Sniff +class JSHintSniff implements Sniff, DeprecatedSniff { /** @@ -94,4 +95,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning JavaScript files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Generic/Sniffs/Formatting/NoSpaceAfterCastSniff.php b/src/Standards/Generic/Sniffs/Formatting/NoSpaceAfterCastSniff.php index f7644df031..008d27662d 100644 --- a/src/Standards/Generic/Sniffs/Formatting/NoSpaceAfterCastSniff.php +++ b/src/Standards/Generic/Sniffs/Formatting/NoSpaceAfterCastSniff.php @@ -13,10 +13,11 @@ namespace PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Tokens; -class NoSpaceAfterCastSniff implements Sniff +class NoSpaceAfterCastSniff implements Sniff, DeprecatedSniff { @@ -58,4 +59,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.4.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Use the Generic.Formatting.SpaceAfterCast sniff with the $spacing property set to 0 instead.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/CSS/BrowserSpecificStylesSniff.php b/src/Standards/MySource/Sniffs/CSS/BrowserSpecificStylesSniff.php index 904769e120..a9d9ae5679 100644 --- a/src/Standards/MySource/Sniffs/CSS/BrowserSpecificStylesSniff.php +++ b/src/Standards/MySource/Sniffs/CSS/BrowserSpecificStylesSniff.php @@ -11,10 +11,11 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\CSS; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; -class BrowserSpecificStylesSniff implements Sniff +class BrowserSpecificStylesSniff implements Sniff, DeprecatedSniff { /** @@ -86,4 +87,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/Channels/DisallowSelfActionsSniff.php b/src/Standards/MySource/Sniffs/Channels/DisallowSelfActionsSniff.php index 91004a84d0..6f199bf3f0 100644 --- a/src/Standards/MySource/Sniffs/Channels/DisallowSelfActionsSniff.php +++ b/src/Standards/MySource/Sniffs/Channels/DisallowSelfActionsSniff.php @@ -11,11 +11,12 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\Channels; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Util\Tokens; -class DisallowSelfActionsSniff implements Sniff +class DisallowSelfActionsSniff implements Sniff, DeprecatedSniff { @@ -124,4 +125,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/Channels/IncludeOwnSystemSniff.php b/src/Standards/MySource/Sniffs/Channels/IncludeOwnSystemSniff.php index 83bb5ff319..68e498b687 100644 --- a/src/Standards/MySource/Sniffs/Channels/IncludeOwnSystemSniff.php +++ b/src/Standards/MySource/Sniffs/Channels/IncludeOwnSystemSniff.php @@ -11,10 +11,11 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\Channels; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; -class IncludeOwnSystemSniff implements Sniff +class IncludeOwnSystemSniff implements Sniff, DeprecatedSniff { @@ -97,4 +98,40 @@ protected function getIncludedClassFromToken( }//end getIncludedClassFromToken() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/Channels/IncludeSystemSniff.php b/src/Standards/MySource/Sniffs/Channels/IncludeSystemSniff.php index 063dab4a86..3161514605 100644 --- a/src/Standards/MySource/Sniffs/Channels/IncludeSystemSniff.php +++ b/src/Standards/MySource/Sniffs/Channels/IncludeSystemSniff.php @@ -12,10 +12,11 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\Channels; use PHP_CodeSniffer\Sniffs\AbstractScopeSniff; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Util\Tokens; -class IncludeSystemSniff extends AbstractScopeSniff +class IncludeSystemSniff extends AbstractScopeSniff implements DeprecatedSniff { /** @@ -313,4 +314,40 @@ protected function getIncludedClassFromToken(File $phpcsFile, array $tokens, $st }//end getIncludedClassFromToken() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/Channels/UnusedSystemSniff.php b/src/Standards/MySource/Sniffs/Channels/UnusedSystemSniff.php index 0f20f70b9e..f322792453 100644 --- a/src/Standards/MySource/Sniffs/Channels/UnusedSystemSniff.php +++ b/src/Standards/MySource/Sniffs/Channels/UnusedSystemSniff.php @@ -11,10 +11,11 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\Channels; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; -class UnusedSystemSniff implements Sniff +class UnusedSystemSniff implements Sniff, DeprecatedSniff { @@ -140,4 +141,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/Commenting/FunctionCommentSniff.php b/src/Standards/MySource/Sniffs/Commenting/FunctionCommentSniff.php index da00c903f6..22d4135b0c 100644 --- a/src/Standards/MySource/Sniffs/Commenting/FunctionCommentSniff.php +++ b/src/Standards/MySource/Sniffs/Commenting/FunctionCommentSniff.php @@ -13,11 +13,12 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\Commenting; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\FunctionCommentSniff as SquizFunctionCommentSniff; use PHP_CodeSniffer\Util\Tokens; use PHP_CodeSniffer\Files\File; -class FunctionCommentSniff extends SquizFunctionCommentSniff +class FunctionCommentSniff extends SquizFunctionCommentSniff implements DeprecatedSniff { @@ -83,4 +84,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/Debug/DebugCodeSniff.php b/src/Standards/MySource/Sniffs/Debug/DebugCodeSniff.php index d40e064e8b..634bdf924d 100644 --- a/src/Standards/MySource/Sniffs/Debug/DebugCodeSniff.php +++ b/src/Standards/MySource/Sniffs/Debug/DebugCodeSniff.php @@ -11,10 +11,11 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\Debug; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; -class DebugCodeSniff implements Sniff +class DebugCodeSniff implements Sniff, DeprecatedSniff { @@ -54,4 +55,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/Debug/FirebugConsoleSniff.php b/src/Standards/MySource/Sniffs/Debug/FirebugConsoleSniff.php index 1f56a0e280..d9c7823141 100644 --- a/src/Standards/MySource/Sniffs/Debug/FirebugConsoleSniff.php +++ b/src/Standards/MySource/Sniffs/Debug/FirebugConsoleSniff.php @@ -11,10 +11,11 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\Debug; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; -class FirebugConsoleSniff implements Sniff +class FirebugConsoleSniff implements Sniff, DeprecatedSniff { /** @@ -63,4 +64,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/Objects/AssignThisSniff.php b/src/Standards/MySource/Sniffs/Objects/AssignThisSniff.php index 97732872c7..abfe65cbe8 100644 --- a/src/Standards/MySource/Sniffs/Objects/AssignThisSniff.php +++ b/src/Standards/MySource/Sniffs/Objects/AssignThisSniff.php @@ -11,10 +11,11 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\Objects; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; -class AssignThisSniff implements Sniff +class AssignThisSniff implements Sniff, DeprecatedSniff { /** @@ -80,4 +81,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/Objects/CreateWidgetTypeCallbackSniff.php b/src/Standards/MySource/Sniffs/Objects/CreateWidgetTypeCallbackSniff.php index 5d8dc99687..eef7c49a2e 100644 --- a/src/Standards/MySource/Sniffs/Objects/CreateWidgetTypeCallbackSniff.php +++ b/src/Standards/MySource/Sniffs/Objects/CreateWidgetTypeCallbackSniff.php @@ -11,11 +11,12 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\Objects; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Util\Tokens; -class CreateWidgetTypeCallbackSniff implements Sniff +class CreateWidgetTypeCallbackSniff implements Sniff, DeprecatedSniff { /** @@ -217,4 +218,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/Objects/DisallowNewWidgetSniff.php b/src/Standards/MySource/Sniffs/Objects/DisallowNewWidgetSniff.php index 693a03714c..505da09859 100644 --- a/src/Standards/MySource/Sniffs/Objects/DisallowNewWidgetSniff.php +++ b/src/Standards/MySource/Sniffs/Objects/DisallowNewWidgetSniff.php @@ -11,10 +11,11 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\Objects; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; -class DisallowNewWidgetSniff implements Sniff +class DisallowNewWidgetSniff implements Sniff, DeprecatedSniff { @@ -58,4 +59,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/PHP/AjaxNullComparisonSniff.php b/src/Standards/MySource/Sniffs/PHP/AjaxNullComparisonSniff.php index 06c2512717..d18982762a 100644 --- a/src/Standards/MySource/Sniffs/PHP/AjaxNullComparisonSniff.php +++ b/src/Standards/MySource/Sniffs/PHP/AjaxNullComparisonSniff.php @@ -14,10 +14,11 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\PHP; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; -class AjaxNullComparisonSniff implements Sniff +class AjaxNullComparisonSniff implements Sniff, DeprecatedSniff { @@ -102,4 +103,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/PHP/EvalObjectFactorySniff.php b/src/Standards/MySource/Sniffs/PHP/EvalObjectFactorySniff.php index 6684691f3c..1a88beda63 100644 --- a/src/Standards/MySource/Sniffs/PHP/EvalObjectFactorySniff.php +++ b/src/Standards/MySource/Sniffs/PHP/EvalObjectFactorySniff.php @@ -11,11 +11,12 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\PHP; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Util\Tokens; -class EvalObjectFactorySniff implements Sniff +class EvalObjectFactorySniff implements Sniff, DeprecatedSniff { @@ -113,4 +114,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/PHP/GetRequestDataSniff.php b/src/Standards/MySource/Sniffs/PHP/GetRequestDataSniff.php index a076779685..fa8374fef7 100644 --- a/src/Standards/MySource/Sniffs/PHP/GetRequestDataSniff.php +++ b/src/Standards/MySource/Sniffs/PHP/GetRequestDataSniff.php @@ -11,10 +11,11 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\PHP; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; -class GetRequestDataSniff implements Sniff +class GetRequestDataSniff implements Sniff, DeprecatedSniff { @@ -105,4 +106,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/PHP/ReturnFunctionValueSniff.php b/src/Standards/MySource/Sniffs/PHP/ReturnFunctionValueSniff.php index 697e91dc7e..fe7c3d4342 100644 --- a/src/Standards/MySource/Sniffs/PHP/ReturnFunctionValueSniff.php +++ b/src/Standards/MySource/Sniffs/PHP/ReturnFunctionValueSniff.php @@ -11,10 +11,11 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\PHP; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; -class ReturnFunctionValueSniff implements Sniff +class ReturnFunctionValueSniff implements Sniff, DeprecatedSniff { @@ -62,4 +63,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/MySource/Sniffs/Strings/JoinStringsSniff.php b/src/Standards/MySource/Sniffs/Strings/JoinStringsSniff.php index ee527b41be..bfa0149090 100644 --- a/src/Standards/MySource/Sniffs/Strings/JoinStringsSniff.php +++ b/src/Standards/MySource/Sniffs/Strings/JoinStringsSniff.php @@ -11,11 +11,12 @@ namespace PHP_CodeSniffer\Standards\MySource\Sniffs\Strings; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Util\Tokens; -class JoinStringsSniff implements Sniff +class JoinStringsSniff implements Sniff, DeprecatedSniff { /** @@ -75,4 +76,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'The MySource standard will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/ClassDefinitionClosingBraceSpaceSniff.php b/src/Standards/Squiz/Sniffs/CSS/ClassDefinitionClosingBraceSpaceSniff.php index 384a8f2b86..608b23a2b8 100644 --- a/src/Standards/Squiz/Sniffs/CSS/ClassDefinitionClosingBraceSpaceSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/ClassDefinitionClosingBraceSpaceSniff.php @@ -12,10 +12,11 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Tokens; -class ClassDefinitionClosingBraceSpaceSniff implements Sniff +class ClassDefinitionClosingBraceSpaceSniff implements Sniff, DeprecatedSniff { /** @@ -133,4 +134,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/ClassDefinitionNameSpacingSniff.php b/src/Standards/Squiz/Sniffs/CSS/ClassDefinitionNameSpacingSniff.php index 796bbbaa1a..c8bef79a51 100644 --- a/src/Standards/Squiz/Sniffs/CSS/ClassDefinitionNameSpacingSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/ClassDefinitionNameSpacingSniff.php @@ -12,10 +12,11 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Tokens; -class ClassDefinitionNameSpacingSniff implements Sniff +class ClassDefinitionNameSpacingSniff implements Sniff, DeprecatedSniff { /** @@ -110,4 +111,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/ClassDefinitionOpeningBraceSpaceSniff.php b/src/Standards/Squiz/Sniffs/CSS/ClassDefinitionOpeningBraceSpaceSniff.php index 7750fa1de5..92e3750a2a 100644 --- a/src/Standards/Squiz/Sniffs/CSS/ClassDefinitionOpeningBraceSpaceSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/ClassDefinitionOpeningBraceSpaceSniff.php @@ -12,10 +12,11 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Tokens; -class ClassDefinitionOpeningBraceSpaceSniff implements Sniff +class ClassDefinitionOpeningBraceSpaceSniff implements Sniff, DeprecatedSniff { /** @@ -175,4 +176,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/ColonSpacingSniff.php b/src/Standards/Squiz/Sniffs/CSS/ColonSpacingSniff.php index 6459e035c5..21e49b1a2e 100644 --- a/src/Standards/Squiz/Sniffs/CSS/ColonSpacingSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/ColonSpacingSniff.php @@ -12,10 +12,11 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Tokens; -class ColonSpacingSniff implements Sniff +class ColonSpacingSniff implements Sniff, DeprecatedSniff { /** @@ -106,4 +107,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/ColourDefinitionSniff.php b/src/Standards/Squiz/Sniffs/CSS/ColourDefinitionSniff.php index 5114a0cb03..ff89dd8d78 100644 --- a/src/Standards/Squiz/Sniffs/CSS/ColourDefinitionSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/ColourDefinitionSniff.php @@ -12,9 +12,10 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; -class ColourDefinitionSniff implements Sniff +class ColourDefinitionSniff implements Sniff, DeprecatedSniff { /** @@ -87,4 +88,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/DisallowMultipleStyleDefinitionsSniff.php b/src/Standards/Squiz/Sniffs/CSS/DisallowMultipleStyleDefinitionsSniff.php index 72448a30b3..f8db90924e 100644 --- a/src/Standards/Squiz/Sniffs/CSS/DisallowMultipleStyleDefinitionsSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/DisallowMultipleStyleDefinitionsSniff.php @@ -12,9 +12,10 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; -class DisallowMultipleStyleDefinitionsSniff implements Sniff +class DisallowMultipleStyleDefinitionsSniff implements Sniff, DeprecatedSniff { /** @@ -70,4 +71,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/DuplicateClassDefinitionSniff.php b/src/Standards/Squiz/Sniffs/CSS/DuplicateClassDefinitionSniff.php index 82a974c8a0..f6b2459059 100644 --- a/src/Standards/Squiz/Sniffs/CSS/DuplicateClassDefinitionSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/DuplicateClassDefinitionSniff.php @@ -12,10 +12,11 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Tokens; -class DuplicateClassDefinitionSniff implements Sniff +class DuplicateClassDefinitionSniff implements Sniff, DeprecatedSniff { /** @@ -115,4 +116,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/DuplicateStyleDefinitionSniff.php b/src/Standards/Squiz/Sniffs/CSS/DuplicateStyleDefinitionSniff.php index e9221470ea..4426ad112d 100644 --- a/src/Standards/Squiz/Sniffs/CSS/DuplicateStyleDefinitionSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/DuplicateStyleDefinitionSniff.php @@ -12,9 +12,10 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; -class DuplicateStyleDefinitionSniff implements Sniff +class DuplicateStyleDefinitionSniff implements Sniff, DeprecatedSniff { /** @@ -87,4 +88,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/EmptyClassDefinitionSniff.php b/src/Standards/Squiz/Sniffs/CSS/EmptyClassDefinitionSniff.php index b7671d3e44..eb8b92edef 100644 --- a/src/Standards/Squiz/Sniffs/CSS/EmptyClassDefinitionSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/EmptyClassDefinitionSniff.php @@ -12,10 +12,11 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Tokens; -class EmptyClassDefinitionSniff implements Sniff +class EmptyClassDefinitionSniff implements Sniff, DeprecatedSniff { /** @@ -60,4 +61,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/EmptyStyleDefinitionSniff.php b/src/Standards/Squiz/Sniffs/CSS/EmptyStyleDefinitionSniff.php index cc3007f2e4..5a549372a8 100644 --- a/src/Standards/Squiz/Sniffs/CSS/EmptyStyleDefinitionSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/EmptyStyleDefinitionSniff.php @@ -12,10 +12,11 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Tokens; -class EmptyStyleDefinitionSniff implements Sniff +class EmptyStyleDefinitionSniff implements Sniff, DeprecatedSniff { /** @@ -63,4 +64,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/ForbiddenStylesSniff.php b/src/Standards/Squiz/Sniffs/CSS/ForbiddenStylesSniff.php index 982f469705..a28f02f83c 100644 --- a/src/Standards/Squiz/Sniffs/CSS/ForbiddenStylesSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/ForbiddenStylesSniff.php @@ -12,9 +12,10 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; -class ForbiddenStylesSniff implements Sniff +class ForbiddenStylesSniff implements Sniff, DeprecatedSniff { /** @@ -176,4 +177,40 @@ protected function addError($phpcsFile, $stackPtr, $style, $pattern=null) }//end addError() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/IndentationSniff.php b/src/Standards/Squiz/Sniffs/CSS/IndentationSniff.php index 56406ccb38..3b0336b8c9 100644 --- a/src/Standards/Squiz/Sniffs/CSS/IndentationSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/IndentationSniff.php @@ -12,10 +12,11 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Tokens; -class IndentationSniff implements Sniff +class IndentationSniff implements Sniff, DeprecatedSniff { /** @@ -149,4 +150,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/LowercaseStyleDefinitionSniff.php b/src/Standards/Squiz/Sniffs/CSS/LowercaseStyleDefinitionSniff.php index c8393c51c3..8246cf5aa6 100644 --- a/src/Standards/Squiz/Sniffs/CSS/LowercaseStyleDefinitionSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/LowercaseStyleDefinitionSniff.php @@ -12,9 +12,10 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; -class LowercaseStyleDefinitionSniff implements Sniff +class LowercaseStyleDefinitionSniff implements Sniff, DeprecatedSniff { /** @@ -96,4 +97,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/MissingColonSniff.php b/src/Standards/Squiz/Sniffs/CSS/MissingColonSniff.php index 83f2a6c822..d86debe052 100644 --- a/src/Standards/Squiz/Sniffs/CSS/MissingColonSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/MissingColonSniff.php @@ -12,9 +12,10 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; -class MissingColonSniff implements Sniff +class MissingColonSniff implements Sniff, DeprecatedSniff { /** @@ -90,4 +91,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/NamedColoursSniff.php b/src/Standards/Squiz/Sniffs/CSS/NamedColoursSniff.php index 586b4730a5..fea0a15517 100644 --- a/src/Standards/Squiz/Sniffs/CSS/NamedColoursSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/NamedColoursSniff.php @@ -12,9 +12,10 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; -class NamedColoursSniff implements Sniff +class NamedColoursSniff implements Sniff, DeprecatedSniff { /** @@ -92,4 +93,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/OpacitySniff.php b/src/Standards/Squiz/Sniffs/CSS/OpacitySniff.php index 0c1c553a56..e9dfe7c3e5 100644 --- a/src/Standards/Squiz/Sniffs/CSS/OpacitySniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/OpacitySniff.php @@ -12,10 +12,11 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Tokens; -class OpacitySniff implements Sniff +class OpacitySniff implements Sniff, DeprecatedSniff { /** @@ -100,4 +101,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/SemicolonSpacingSniff.php b/src/Standards/Squiz/Sniffs/CSS/SemicolonSpacingSniff.php index 9030468b8d..7c205d8186 100644 --- a/src/Standards/Squiz/Sniffs/CSS/SemicolonSpacingSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/SemicolonSpacingSniff.php @@ -12,10 +12,11 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Tokens; -class SemicolonSpacingSniff implements Sniff +class SemicolonSpacingSniff implements Sniff, DeprecatedSniff { /** @@ -102,4 +103,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/CSS/ShorthandSizeSniff.php b/src/Standards/Squiz/Sniffs/CSS/ShorthandSizeSniff.php index 76e7330c71..252a06d199 100644 --- a/src/Standards/Squiz/Sniffs/CSS/ShorthandSizeSniff.php +++ b/src/Standards/Squiz/Sniffs/CSS/ShorthandSizeSniff.php @@ -12,9 +12,10 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; -class ShorthandSizeSniff implements Sniff +class ShorthandSizeSniff implements Sniff, DeprecatedSniff { /** @@ -180,4 +181,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning CSS files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/Classes/DuplicatePropertySniff.php b/src/Standards/Squiz/Sniffs/Classes/DuplicatePropertySniff.php index 12d8a24561..225a29659a 100644 --- a/src/Standards/Squiz/Sniffs/Classes/DuplicatePropertySniff.php +++ b/src/Standards/Squiz/Sniffs/Classes/DuplicatePropertySniff.php @@ -12,9 +12,10 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\Classes; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; -class DuplicatePropertySniff implements Sniff +class DuplicatePropertySniff implements Sniff, DeprecatedSniff { /** @@ -81,4 +82,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning JavaScript files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/Debug/JSLintSniff.php b/src/Standards/Squiz/Sniffs/Debug/JSLintSniff.php index 652391f112..9d4d79bee0 100644 --- a/src/Standards/Squiz/Sniffs/Debug/JSLintSniff.php +++ b/src/Standards/Squiz/Sniffs/Debug/JSLintSniff.php @@ -13,10 +13,11 @@ use PHP_CodeSniffer\Config; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Common; -class JSLintSniff implements Sniff +class JSLintSniff implements Sniff, DeprecatedSniff { /** @@ -85,4 +86,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning JavaScript files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/Debug/JavaScriptLintSniff.php b/src/Standards/Squiz/Sniffs/Debug/JavaScriptLintSniff.php index 031b2e39a3..a1fe215e28 100644 --- a/src/Standards/Squiz/Sniffs/Debug/JavaScriptLintSniff.php +++ b/src/Standards/Squiz/Sniffs/Debug/JavaScriptLintSniff.php @@ -14,10 +14,11 @@ use PHP_CodeSniffer\Config; use PHP_CodeSniffer\Exceptions\RuntimeException; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Common; -class JavaScriptLintSniff implements Sniff +class JavaScriptLintSniff implements Sniff, DeprecatedSniff { /** @@ -88,4 +89,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning JavaScript files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/Objects/DisallowObjectStringIndexSniff.php b/src/Standards/Squiz/Sniffs/Objects/DisallowObjectStringIndexSniff.php index b619924e8c..a956a7c4c8 100644 --- a/src/Standards/Squiz/Sniffs/Objects/DisallowObjectStringIndexSniff.php +++ b/src/Standards/Squiz/Sniffs/Objects/DisallowObjectStringIndexSniff.php @@ -12,9 +12,10 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\Objects; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; -class DisallowObjectStringIndexSniff implements Sniff +class DisallowObjectStringIndexSniff implements Sniff, DeprecatedSniff { /** @@ -84,4 +85,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning JavaScript files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/Objects/ObjectMemberCommaSniff.php b/src/Standards/Squiz/Sniffs/Objects/ObjectMemberCommaSniff.php index dbbc1b842a..b7fc84dfd5 100644 --- a/src/Standards/Squiz/Sniffs/Objects/ObjectMemberCommaSniff.php +++ b/src/Standards/Squiz/Sniffs/Objects/ObjectMemberCommaSniff.php @@ -12,10 +12,11 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\Objects; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Tokens; -class ObjectMemberCommaSniff implements Sniff +class ObjectMemberCommaSniff implements Sniff, DeprecatedSniff { /** @@ -63,4 +64,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning JavaScript files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php b/src/Standards/Squiz/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php index c4faf158b2..7890dd5fd6 100644 --- a/src/Standards/Squiz/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php +++ b/src/Standards/Squiz/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php @@ -12,10 +12,11 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util; -class LanguageConstructSpacingSniff implements Sniff +class LanguageConstructSpacingSniff implements Sniff, DeprecatedSniff { @@ -88,4 +89,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.3.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Use the Generic.WhiteSpace.LanguageConstructSpacing sniff instead.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Squiz/Sniffs/WhiteSpace/PropertyLabelSpacingSniff.php b/src/Standards/Squiz/Sniffs/WhiteSpace/PropertyLabelSpacingSniff.php index ec8218fef1..7e5bf9c204 100644 --- a/src/Standards/Squiz/Sniffs/WhiteSpace/PropertyLabelSpacingSniff.php +++ b/src/Standards/Squiz/Sniffs/WhiteSpace/PropertyLabelSpacingSniff.php @@ -12,9 +12,10 @@ namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; -class PropertyLabelSpacingSniff implements Sniff +class PropertyLabelSpacingSniff implements Sniff, DeprecatedSniff { /** @@ -78,4 +79,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return 'Support for scanning JavaScript files will be removed completely in v4.0.0.'; + + }//end getDeprecationMessage() + + }//end class diff --git a/src/Standards/Zend/Sniffs/Debug/CodeAnalyzerSniff.php b/src/Standards/Zend/Sniffs/Debug/CodeAnalyzerSniff.php index 454f665a71..3db606addb 100644 --- a/src/Standards/Zend/Sniffs/Debug/CodeAnalyzerSniff.php +++ b/src/Standards/Zend/Sniffs/Debug/CodeAnalyzerSniff.php @@ -12,13 +12,14 @@ namespace PHP_CodeSniffer\Standards\Zend\Sniffs\Debug; +use PHP_CodeSniffer\Sniffs\DeprecatedSniff; use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Config; use PHP_CodeSniffer\Exceptions\RuntimeException; use PHP_CodeSniffer\Util\Common; -class CodeAnalyzerSniff implements Sniff +class CodeAnalyzerSniff implements Sniff, DeprecatedSniff { @@ -97,4 +98,40 @@ public function process(File $phpcsFile, $stackPtr) }//end process() + /** + * Provide the version number in which the sniff was deprecated. + * + * @return string + */ + public function getDeprecationVersion() + { + return 'v3.9.0'; + + }//end getDeprecationVersion() + + + /** + * Provide the version number in which the sniff will be removed. + * + * @return string + */ + public function getRemovalVersion() + { + return 'v4.0.0'; + + }//end getRemovalVersion() + + + /** + * Provide a custom message to display with the deprecation. + * + * @return string + */ + public function getDeprecationMessage() + { + return ''; + + }//end getDeprecationMessage() + + }//end class