Skip to content

Fix reflection-docblock deprecation warnings #64

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
BrianHenryIE wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Fix reflection-docblock deprecation warnings #64

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
72c9e81
Use `DocBlockFactory::createInstance()`
BrianHenryIE Jun 12, 2025
00f0c4b
Update more cases of `Utils::createDocBlockInstance()`
BrianHenryIE Jun 12, 2025
f3439a5
Add missing `use phpDocumentor\Reflection\DocBlockFactory`
BrianHenryIE Jun 12, 2025
8ce16ff
Use `DocFactoryProvider::getDocFactory()` instead
BrianHenryIE Jun 15, 2025
f19c206
Update imports
BrianHenryIE Jun 17, 2025
93c7fd3
Restore previous `::createDocBlockInstance()`
BrianHenryIE Jun 17, 2025
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
3 changes: 2 additions & 1 deletion src/voku/SimplePhpParser/Model/PHPClass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace voku\SimplePhpParser\Model;

use phpDocumentor\Reflection\DocBlockFactory;
use PhpParser\Comment\Doc;
use PhpParser\Node\Stmt\Class_;
use ReflectionClass;
Expand Down Expand Up @@ -385,7 +386,7 @@ private function readPhpDocProperties($doc): void
}

try {
$phpDoc = Utils::createDocBlockInstance()->create($docComment);
$phpDoc = DocBlockFactory::createInstance()->create($docComment);
Copy link

@gemini-code-assist gemini-code-assist bot Jun 12, 2025

Choose a reason for hiding this comment

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

high

Consider using DocFactoryProvider::getDocFactory() instead to leverage the cached factory instance for better performance.

            $phpDoc = DocFactoryProvider::getDocFactory()->create($docComment);


$parsedPropertyTags = $phpDoc->getTagsByName('property')
+ $phpDoc->getTagsByName('property-read')
Expand Down
4 changes: 2 additions & 2 deletions src/voku/SimplePhpParser/Model/PHPFunction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public function readObjectFromPhpNode($node, $dummy = null): self
$docComment = $node->getDocComment();
if ($docComment) {
try {
$phpDoc = Utils::createDocBlockInstance()->create($docComment->getText());
$phpDoc = DocBlockFactory::createInstance()->create($docComment->getText());
Copy link

@gemini-code-assist gemini-code-assist bot Jun 12, 2025

Choose a reason for hiding this comment

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

high

Use DocFactoryProvider::getDocFactory() to utilize the cached factory instance, improving performance.

                $phpDoc = DocFactoryProvider::getDocFactory()->create($docComment->getText());

$this->summary = $phpDoc->getSummary();
$this->description = (string) $phpDoc->getDescription();
} catch (\Exception $e) {
Expand Down Expand Up @@ -229,7 +229,7 @@ protected function readPhpDoc($doc): void
}

try {
$phpDoc = Utils::createDocBlockInstance()->create($docComment);
$phpDoc = DocBlockFactory::createInstance()->create($docComment);

$parsedReturnTag = $phpDoc->getTagsByName('return');

Expand Down
2 changes: 1 addition & 1 deletion src/voku/SimplePhpParser/Model/PHPMethod.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public function readObjectFromPhpNode($node, $classStr = null): PHPFunction
$docComment = $node->getDocComment();
if ($docComment) {
try {
$phpDoc = Utils::createDocBlockInstance()->create($docComment->getText());
$phpDoc = DocBlockFactory::createInstance()->create($docComment->getText());
$this->summary = $phpDoc->getSummary();
$this->description = (string) $phpDoc->getDescription();
} catch (\Exception $e) {
Expand Down
2 changes: 1 addition & 1 deletion src/voku/SimplePhpParser/Model/PHPParameter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ private function readPhpDoc($doc, string $parameterName): void
}

try {
$phpDoc = Utils::createDocBlockInstance()->create($docComment);
$phpDoc = DocBlockFactory::createInstance()->create($docComment);

$parsedParamTags = $phpDoc->getTagsByName('param');

Expand Down
2 changes: 1 addition & 1 deletion src/voku/SimplePhpParser/Model/PHPProperty.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ private function readPhpDoc($doc): void
}

try {
$phpDoc = Utils::createDocBlockInstance()->create($docComment);
$phpDoc = DocBlockFactory::createInstance()->create($docComment);

$parsedParamTags = $phpDoc->getTagsByName('var');

Expand Down
2 changes: 1 addition & 1 deletion src/voku/SimplePhpParser/Model/PHPTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ private function readPhpDocProperties($doc): void
}

try {
$phpDoc = Utils::createDocBlockInstance()->create($docComment);
$phpDoc = DocBlockFactory::createInstance()->create($docComment);

$parsedPropertyTags = $phpDoc->getTagsByName('property')
+ $phpDoc->getTagsByName('property-read')
Expand Down