From 89af4a2e371d5e907458ca28d00c9b56e9e27c0e Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Tue, 11 Apr 2017 08:39:32 +0200 Subject: [PATCH] TASK: Configure phpmd * Make phpmd pass. * Comment supressions with a reason. --- phpmd.xml | 20 +++++++++++++------ src/CodeSniffer/Tokenizers/TypoScript.php | 2 ++ .../AbstractClassnameChecker.php | 6 ++++++ .../Sniffs/LegacyClassnames/Mapping.php | 3 +++ .../MissingNamespaceSniff.php | 2 ++ .../Sniffs/LegacyClassnames/UseSniff.php | 2 ++ .../Sniffs/Removed/AbstractGenericUsage.php | 5 +++-- 7 files changed, 32 insertions(+), 8 deletions(-) diff --git a/phpmd.xml b/phpmd.xml index 829b5eb..67d345c 100644 --- a/phpmd.xml +++ b/phpmd.xml @@ -10,10 +10,18 @@ My custom rule set that checks my code... - - - - - - + + + + + + + + + + + + + + diff --git a/src/CodeSniffer/Tokenizers/TypoScript.php b/src/CodeSniffer/Tokenizers/TypoScript.php index 8130faf..26136f6 100644 --- a/src/CodeSniffer/Tokenizers/TypoScript.php +++ b/src/CodeSniffer/Tokenizers/TypoScript.php @@ -65,6 +65,8 @@ class PHP_CodeSniffer_Tokenizers_TYPOSCRIPT * @param string $eolChar The EOL character to use for splitting strings. * * @return void + * + * @SuppressWarnings(PHPMD.UnusedFormalParameter) We need to match the signature. */ public function processAdditional(&$tokens, $eolChar) { diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/AbstractClassnameChecker.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/AbstractClassnameChecker.php index 19719e9..76c3cfe 100644 --- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/AbstractClassnameChecker.php +++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/AbstractClassnameChecker.php @@ -82,6 +82,8 @@ abstract class AbstractClassnameChecker implements PhpCsSniff * the token was found. * * @return void + * + * @SuppressWarnings(PHPMD.ElseExpression) This is for performance reason. */ public function process(PhpCsFile $phpcsFile, $stackPtr) { @@ -217,6 +219,8 @@ abstract class AbstractClassnameChecker implements PhpCsSniff * @param int $classnamePosition * @param string $classname * @param bool $forceEmptyPrefix Defines whether '\\' prefix should be checked or always be left out. + * + * @SuppressWarnings(PHPMD.BooleanArgumentFlag) */ protected function replaceLegacyClassname( PhpCsFile $phpcsFile, @@ -243,6 +247,8 @@ abstract class AbstractClassnameChecker implements PhpCsSniff * @param string $originalClassname * @param PhpCsFile $phpcsFile * @return string + * + * @SuppressWarnings(PHPMD.UnusedFormalParameter) We need to match the signature. */ protected function getTokenForReplacement($newClassname, $originalClassname, PhpCsFile $phpcsFile) { diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/Mapping.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/Mapping.php index 201263a..685dec6 100644 --- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/Mapping.php +++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/Mapping.php @@ -48,6 +48,9 @@ final class Mapping private function __clone() { } + /** + * @SuppressWarnings(PHPMD.UnusedPrivateMethod) We just want to implement singleton pattern. + */ private function __wakeup() { } diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/MissingNamespaceSniff.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/MissingNamespaceSniff.php index e8d0feb..8e97c45 100644 --- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/MissingNamespaceSniff.php +++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/MissingNamespaceSniff.php @@ -95,6 +95,8 @@ class Typo3Update_Sniffs_LegacyClassnames_MissingNamespaceSniff extends Abstract * @param int $classnamePosition * @param string $classname * @param bool $forceEmptyPrefix Defines whether '\\' prefix should be checked or always be left out. + * + * @SuppressWarnings(PHPMD.BooleanArgumentFlag) */ protected function replaceLegacyClassname( PhpCsFile $phpcsFile, diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/UseSniff.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/UseSniff.php index f1129ba..bed18bc 100644 --- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/UseSniff.php +++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/UseSniff.php @@ -46,6 +46,8 @@ class Typo3Update_Sniffs_LegacyClassnames_UseSniff extends AbstractClassnameChec * @param int $classnamePosition * @param string $classname * @param bool $forceEmptyPrefix Defines whether '\\' prefix should be checked or always be left out. + * + * @SuppressWarnings(PHPMD.BooleanArgumentFlag) */ protected function replaceLegacyClassname( PhpCsFile $phpcsFile, diff --git a/src/Standards/Typo3Update/Sniffs/Removed/AbstractGenericUsage.php b/src/Standards/Typo3Update/Sniffs/Removed/AbstractGenericUsage.php index 766db34..13697f0 100644 --- a/src/Standards/Typo3Update/Sniffs/Removed/AbstractGenericUsage.php +++ b/src/Standards/Typo3Update/Sniffs/Removed/AbstractGenericUsage.php @@ -29,8 +29,9 @@ use Typo3Update\Sniffs\Options; /** * Contains common functionality for removed code like constants or functions. * - * Removed parts are configured using YAML-Files, for examples see src/Standards/Typo3Update/Configuration/Removed/Constants/7.0.yaml - * Also check out the configuration options in Readme.rst. + * Removed parts are configured using YAML-Files, for examples see + * src/Standards/Typo3Update/Configuration/Removed/Constants/7.0.yaml Also + * check out the configuration options in Readme.rst. */ abstract class AbstractGenericUsage implements PhpCsSniff {