Skip to content

Add support for phpdocumentor/reflection-docblock v6 #660

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.

Sign up for GitHub

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

Open
mspirkov wants to merge 8 commits into
base: master
Choose a base branch
from
+7 −3
Open

Add support for phpdocumentor/reflection-docblock v6 #660

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0a37c84
Add support for `phpdocumentor/reflection-docblock` v6
mspirkov Jan 18, 2026
a74605e
Fix PHPStan errors
mspirkov Jan 19, 2026
dbdb392
Remove unused imports
mspirkov Jan 19, 2026
ccb849d
Fix errors in `ClassTagRetriever`
mspirkov Jan 19, 2026
c816336
Fix PHPStan errors after new PHPStan release
mspirkov Jan 20, 2026
b895bf6
Ignore PHPStan errors
mspirkov Jan 20, 2026
83bd6c2
Revert some changes in `ClassTagRetriever`
mspirkov Jan 20, 2026
4ae6d31
Merge branch 'master' into add-support-for-reflection-docblock-v6
mspirkov Feb 9, 2026
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
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

"require": {
"php": "8.2.* || 8.3.* || 8.4.* || 8.5.*",
"phpdocumentor/reflection-docblock": "^5.2",
"phpdocumentor/reflection-docblock": "^5.2 || ^6.0",
"sebastian/comparator": "^3.0 || ^4.0 || ^5.0 || ^6.0 || ^7.0",
"doctrine/instantiator": "^1.2 || ^2.0",
"sebastian/recursion-context": "^3.0 || ^4.0 || ^5.0 || ^6.0 || ^7.0",
Expand Down
1 change: 0 additions & 1 deletion spec/Prophecy/Doubler/Generator/ClassCodeGeneratorSpec.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

namespace spec\Prophecy\Doubler\Generator;

use phpDocumentor\Reflection\DocBlock\Tags\Method;
use PhpSpec\ObjectBehavior;
use Prophecy\Argument;
use Prophecy\Doubler\Generator\Node\ArgumentNode;
Expand Down
1 change: 0 additions & 1 deletion spec/Prophecy/Prophecy/ObjectProphecySpec.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

namespace spec\Prophecy\Prophecy;

use phpDocumentor\Reflection\DocBlock\Tags\Method;
use PhpSpec\ObjectBehavior;
use Prophecy\Argument;
use Prophecy\Argument\ArgumentsWildcard;
Expand Down
2 changes: 1 addition & 1 deletion src/Prophecy/Doubler/ClassPatch/MagicCallPatch.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public function apply(ClassNode $node)
$argumentNode = new ArgumentNode($argument->getName());
$methodNode->addArgument($argumentNode);
}
} else {
} elseif (method_exists($tag, 'getArguments')) {
// Reflection Docblock < 5.4.0.
foreach ($tag->getArguments() as $argument) {
$argumentNode = new ArgumentNode($argument['name']);
Expand Down
6 changes: 6 additions & 0 deletions src/Prophecy/PhpDocumentor/ClassTagRetriever.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

use phpDocumentor\Reflection\DocBlock\Tags\Method;
use phpDocumentor\Reflection\DocBlockFactory;
use phpDocumentor\Reflection\Exception\CannotCreateTag;
use phpDocumentor\Reflection\Types\ContextFactory;

/**
Expand Down Expand Up @@ -50,6 +51,11 @@ public function getTagList(\ReflectionClass $reflectionClass)
return $methods;
} catch (\InvalidArgumentException $e) {
return array();
} catch (CannotCreateTag $e) {
// In version 6.0, all deprecated methods have been removed from "ReflectionDocblock".
// Now, exceptions are thrown when trying to create a tag with a type and in other
// situations that previously did not throw exceptions.
Copy link
Member

@stof stof Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks suspicious to me. AFAICT, we should not be trying to create tags directly (and if we currently do, we should instead fix the root cause). In which case does this exception happen in a way that should be caught to ignore all tags ?

Copy link
Author

@mspirkov mspirkov Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's hard to say, because I don't use this package and I don't fully understand what's going on inside it. I'll take a closer look.

Copy link
Member

@stof stof Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what was the behavior without adding this catch statement ?

Copy link
Author

@mspirkov mspirkov Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tests fail due to exceptions: https://github.com/phpspec/prophecy/actions/runs/21114065815/job/60726462701

Copy link
Member

@stof stof Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that the static create method of the Method tag is not meant to be called anymore (the proper tag factory should be used instead), the actual root cause should be investigated (inspecting the stack trace to see where it is called). It might be an issue in the way we use the library (which then must be fixed) or an upstream bug. But silently ignoring all tags when a CannotCreateTag exception happen while this exception only happens when reaching an unsupported code path does not make sense (and would probably break support for magic methods)

Copy link
Author

@mspirkov mspirkov Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will fix the problem in ReflectionDocblock and come back here.

Copy link
Member

@stof stof Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

next step would be debugging which tag is attempted to be created in the StandardTagFactory (and potentially also debugging what is the doc comment from which the phpdoc is parsed).

I suspect this is an upstream issue.

Copy link
Author

@mspirkov mspirkov Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

phpDocumentor/ReflectionDocBlock#438

Copy link
Author

@mspirkov mspirkov Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that all we need to do is restart CI after ReflectionDocBlock release.

Copy link
Author

@mspirkov mspirkov Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/phpDocumentor/ReflectionDocBlock/releases/tag/6.0.1

return array();
}
}
}
1 change: 1 addition & 0 deletions src/Prophecy/Util/ExportUtil.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ public static function toArray($value)
// above (fast) mechanism nor with reflection in Zend.
// Format the output similarly to print_r() in this case
if ($value instanceof \SplObjectStorage) {
/** @var \SplObjectStorage<object, mixed> $value */
foreach ($value as $key => $val) {
// Use the same identifier that would be printed alongside the object's representation elsewhere.
$array[spl_object_id($val)] = array(
Expand Down
Loading