From 45d7de293c1963406665411a7430a34d1fe64860 Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Thu, 16 Mar 2017 15:18:10 +0100 Subject: [PATCH 1/3] BUGFIX: Fix wrong phpdocs of sniff classes --- .../Typo3Update/Sniffs/LegacyClassnames/InstanceofSniff.php | 2 +- .../LegacyClassnames/InstantiationWithMakeInstanceSniff.php | 2 +- .../Sniffs/LegacyClassnames/InstantiationWithNewSniff.php | 2 +- .../LegacyClassnames/InstantiationWithObjectManagerSniff.php | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstanceofSniff.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstanceofSniff.php index 05cf416..518e3e6 100644 --- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstanceofSniff.php +++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstanceofSniff.php @@ -20,7 +20,7 @@ */ /** - * Detect and migrate extend and implement of old legacy classnames. + * Detect and instanceof checks of old legacy classnames. */ class Typo3Update_Sniffs_LegacyClassnames_InstanceofSniff implements PHP_CodeSniffer_Sniff { diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstantiationWithMakeInstanceSniff.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstantiationWithMakeInstanceSniff.php index 94bb175..989668a 100644 --- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstantiationWithMakeInstanceSniff.php +++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstantiationWithMakeInstanceSniff.php @@ -22,7 +22,7 @@ use PHP_CodeSniffer_Tokens as Tokens; /** - * Detect and migrate static calls to old legacy classnames. + * Detect and migrate instantiations of old legacy classnames using "makeInstance". */ class Typo3Update_Sniffs_LegacyClassnames_InstantiationWithMakeInstanceSniff implements PHP_CodeSniffer_Sniff { diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstantiationWithNewSniff.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstantiationWithNewSniff.php index d98dc79..e96d117 100644 --- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstantiationWithNewSniff.php +++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstantiationWithNewSniff.php @@ -20,7 +20,7 @@ */ /** - * Detect and migrate static calls to old legacy classnames. + * Detect and migrate old legacy classnames instantiations using phps "new". */ class Typo3Update_Sniffs_LegacyClassnames_InstantiationWithNewSniff implements PHP_CodeSniffer_Sniff { diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstantiationWithObjectManagerSniff.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstantiationWithObjectManagerSniff.php index c16b47d..dec134f 100644 --- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstantiationWithObjectManagerSniff.php +++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstantiationWithObjectManagerSniff.php @@ -22,7 +22,7 @@ use PHP_CodeSniffer_Tokens as Tokens; /** - * Detect and migrate static calls to old legacy classnames. + * Detect and migrate old legacy classname instantiations using objectmanager create and get. */ class Typo3Update_Sniffs_LegacyClassnames_InstantiationWithObjectManagerSniff implements PHP_CodeSniffer_Sniff { From fc070f3bf6c0703afc5177a3e532827f88ce70a3 Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Thu, 16 Mar 2017 16:24:47 +0100 Subject: [PATCH 2/3] FEATURE: Make PHPDoc tags configurable * Make them configurable in Sniff. * Extend readme with new configuration option. * Provide example in ruleset.xml Resolves: #25, #24, #23 --- Readme.rst | 13 +++++++++++++ .../Sniffs/LegacyClassnames/DocCommentSniff.php | 2 +- src/Standards/Typo3Update/ruleset.xml | 5 +++++ 3 files changed, 19 insertions(+), 1 deletion(-) diff --git a/Readme.rst b/Readme.rst index 4aba35d..71be644 100644 --- a/Readme.rst +++ b/Readme.rst @@ -119,3 +119,16 @@ the provided one. + +Typo3Update.LegacyClassnames.DocComment: ``allowedTags`` + Configures which tags are checked for legacy class names. + + Example: + +.. code:: xml + + + + + + diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/DocCommentSniff.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/DocCommentSniff.php index 1f18228..7ab8eca 100644 --- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/DocCommentSniff.php +++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/DocCommentSniff.php @@ -32,7 +32,7 @@ class Typo3Update_Sniffs_LegacyClassnames_DocCommentSniff implements PHP_CodeSni * The configured tags will be processed. * @var array */ - protected $allowedTags = ['@param', '@return', '@var']; + public $allowedTags = ['@param', '@return', '@var']; /** * Original token content for reuse accross methods. diff --git a/src/Standards/Typo3Update/ruleset.xml b/src/Standards/Typo3Update/ruleset.xml index b067e1d..c8e6a69 100644 --- a/src/Standards/Typo3Update/ruleset.xml +++ b/src/Standards/Typo3Update/ruleset.xml @@ -7,4 +7,9 @@ + + + + + From 9364b8d61ef8cd6c9a3b4136c81b571fad78a301 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20H=C3=BCrtgen?= Date: Thu, 16 Mar 2017 16:45:56 +0100 Subject: [PATCH 3/3] BUGFIX: Fix missing word in phpdocs of sniff classes --- .../Typo3Update/Sniffs/LegacyClassnames/InstanceofSniff.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstanceofSniff.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstanceofSniff.php index 518e3e6..4140602 100644 --- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstanceofSniff.php +++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/InstanceofSniff.php @@ -20,7 +20,7 @@ */ /** - * Detect and instanceof checks of old legacy classnames. + * Detect and migrate instanceof checks of old legacy classnames. */ class Typo3Update_Sniffs_LegacyClassnames_InstanceofSniff implements PHP_CodeSniffer_Sniff {