Coding-standard: TypeHintDeclarationSniff does not consider array of arrays

[marcospassos]

The inspection reports the absence of type hint in the return and parameter of a method if the type is an array of arrays (array[]).

/**
 * @param array[] $arrays
 *
 * @return array[]
 */
public function getAdditionTests(array $arrays) : array
{
    return [
        '1 + 2 = 3' => [
            'augend' => 1,
            'addend' => 2,
            'result' => 3,
        ],
    ];
}

The above snippet produces the following non-applicable warning:

@param annotation of getAdditionTests() does not specify type hint for items of its traversable parameter $arrays.
@return annotation of getAdditionTests() does not have @return annotation for its traversable return value.

[kukulich]

You should use mixed[][] or something like this.

[lookyman]

You should use mixed[][] or something like this.

Why?

[marcospassos]

@kukulich you could be more open to bug reports, as we spend time reporting an issue not only because it affects us, but also to help make the library more robust. This is the second issue you closed providing no feedback about the problem reported. _Closing an issue does not fix it._

The annotation @param array[] is a perfect valid PHPDoc annotation, that implies an array of arrays of mixed values. Why should I replace such a simple notation for something much less clear like mixed[][]? What is invalid in my complaint?

[kukulich]

@lookyman @marcospassos

The reported error is about specifying type of the items of the array. array is not valid type because it doesn't say anything about the type. It is just useless.

[marcospassos]

But I'm doing exactly it: array is the type of the items. What is wrong with having an array of tuples, for instance?

/** @param array[] $arrays */
function foo() : array {
    return [[1, 2], [3, 4]];
}

Besides this, if mixed[][] is valid, it implies thatarray[] should work as well, as it means an array of arrays containing mixed values.

[kukulich]

No, array is not valid in this sniff, deal with it :)

[lookyman]

@kukulich I will deal with it (have been doing that since I started using this cs), but I still don't understand your reasoning.

[github-actions[bot]]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.