Skip to content

Fix PHP Fatal error when docblock is invalid #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Magento2/Sniffs/Annotation/MethodArgumentsSniff.php
Original file line number Diff line number Diff line change
Expand Up @@ -609,8 +609,6 @@ public function process(File $phpcsFile, $stackPtr)
* @param File $phpcsFile
* @param array $paramPointers
*
* @SuppressWarnings(PHPMD.UnusedLocalVariable)
*
* @see https://devdocs.magento.com/guides/v2.4/coding-standards/docblock-standard-general.html#format-consistency
*/
private function validateFormattingConsistency(
Expand All @@ -626,7 +624,9 @@ private function validateFormattingConsistency(
if (isset($paramPointers[$ptr])) {
$paramContent = $tokens[$paramPointers[$ptr] + 2]['content'];
$paramDefinition = $paramDefinitions[$ptr];
$argumentPositions[] = strpos($paramContent, $paramDefinition['paramName']);
if (isset($paramDefinition['paramName'])) {
$argumentPositions[] = strpos($paramContent, $paramDefinition['paramName']);
}
$commentPositions[] = $paramDefinition['comment']
? strrpos($paramContent, $paramDefinition['comment']) : null;
}
Expand Down
11 changes: 11 additions & 0 deletions Magento2/Tests/Annotation/MethodArgumentsUnitTest.inc
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,14 @@ public function setExtensionAs(\Magento\Catalog\Api\Data\CategoryExtensionInterf
{
return $this->_setExtensionAttributes($extensionAttributes);
}

/**
* Short description of method
*
* @param int
* @return int
*/
public function invalidDocBlockShouldNotCauseFatalErrorInSniff(int $number): int
{
return $number;
}
5 changes: 3 additions & 2 deletions Magento2/Tests/Annotation/MethodArgumentsUnitTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,11 @@ public function getErrorList()
{
return [
12 => 1,
21 => 1
21 => 1,
32 => 1,
];
}

/**
* @inheritdoc
*/
Expand Down