Support "Implementation of..." for legacy Drupal 6 sites [#2220833]

Unfortunately, we have a major Drupal 6 site and not enough time to upgrade to Drupal 7.

How would you recommend that we deal with "Implementation of..."?

Simply ignore the warning-level message (it's only a warning afterall)
Create a new rule and disable the old one through configuration (duplicate the ruleset.xml file perhaps)
Implement an option in the package that specifies which version of Drupal is being scanned (could be useful for other things)

I'd also say that we're not really strict about forcing people to use "Implementation of..." in Drupal 6 as people sometimes (probably most often) just use "Implements...". However, I'd rather not warn people about the use of "Implementation of..." when it's perfectly valid in Drupal 6. This is why I hesitated and wanted to ask your opinion.

Comment	File	Size	Author
#5	coder-phpcs-implementation-of-2220833.patch	3.84 KB	psynaptic

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

psynaptic CreditAttribution: psynaptic commented 19 March 2014 at 04:10

Issue summary:

View changes

Comment #2

klausi

he/him||they/them

German

🇦🇹 Vienna

CreditAttribution: klausi commented 22 March 2014 at 12:40

You could just "hack" the ruleset.xml like this to disable the hook sniff:

<rule ref="Drupal.Commenting.HookComment">
  <severity>0</severity>
</rule>

Maybe that could also be specified as command line parameter to phpcs.

Comment #3

psynaptic CreditAttribution: psynaptic commented 25 March 2014 at 05:05

Thinking more on this, the problem with that seems to be that we won't get the useful warnings about erroneous hook implementation documentation. We don't care so much if people use "Implements..." vs "Implementation of..." but we do require one or the other to be present and in the correct format.

Comment #4

psynaptic CreditAttribution: psynaptic commented 9 April 2014 at 17:34

Do sniffs have access to the ruleset config? Perhaps I could add an option to allow both versions.

Comment #5

psynaptic CreditAttribution: psynaptic commented 9 April 2014 at 21:14

Status:

Active

» Needs review

File	Size
coder-phpcs-implementation-of-2220833.patch	3.84 KB

I've added an option which can be used in ruleset.xml as follows:

 <rule ref="Drupal.Commenting.HookComment">
  <properties>
   <property name="strict" value="false"/>
  </properties>
 </rule>

By default the existing behavior is maintained but there is now the option to allow "Implements" and "Implementation of" to pass without generating a warning.