FunctionComment.SpacingAfterParamType not working with intersection types

[icanhazstring]

Hi there,

the given sniff Squiz.Commenting.FunctionComment.SpacingAfterParamType does not work well with intersection type annotations.

Used Version: 3.5.4

It might be related to an older, already fixed issue:
#2530

Given the following code

/**
 * @param ContainerInterface&ServiceManager $container
 * @param array<string, string> $options
 */
public function __invoke(ContainerInterface $container, array $options = []) : Fubar

Expected:
no problem

Actual:

FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 XX | ERROR | [x] Expected 4 spaces after parameter type; 0 found
      (Squiz.Commenting.FunctionComment.SpacingAfterParamType)

Using phpcbf to fix the issue resulted in this line:

* @param ContainerInterface    &ServiceManager $container
* @param array<string, string> $options

[VincentLanglet]

@icanhazstring It's related to #2806

It was fixed for the PEAR standard but not the Squizz one.

Do you want to create the PR ?

I recommend

• To create a constant or protected method in the src/Standards/PEAR/Sniffs/Commenting/FunctionCommentSniff.php
• To use this constant/method in the src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php (which is extending the PEAR one)

This way this won't happen again if we update the regex of the PEAR Sniff.

[rodrigoprimo]

I just tested, and I can confirm that PHPCSStandards/PHP_CodeSniffer#944 fixed this problem.

As stated in the issue description, before PHPCSStandards/PHP_CodeSniffer#944, phpcbf would fix the code sample provided here to:

/**
 * @param ContainerInterface    &ServiceManager $container
 * @param array<string, string> $options
 */
public function __invoke(ContainerInterface $container, array $options = []) : Fubar

Now it fixes it to:

/**
 * @param ContainerInterface&ServiceManager $container
 * @param array<string, string>             $options
 */
public function __invoke(ContainerInterface $container, array $options = []) : Fubar

Expected:
no problem

phpcs still flags the problem, and I believe this is the correct behavior, contrary to what was said in the issue description:

$ bin/phpcs --standard=Squiz --sniffs=Squiz.Commenting.FunctionComment test.php -s                 

FILE: test.php
-------------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------------------------------------------------------------------------------------------------------------------------------------------------
 4 | ERROR | [x] Expected 4 spaces after parameter type; 0 found (Squiz.Commenting.FunctionComment.SpacingAfterParamType)
-------------------------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------------------------------------------------

I suggest closing this issue.