From 72c9e814e48cbcfebe43ba0dc4b7d1fba5349b8b Mon Sep 17 00:00:00 2001 From: Brian Henry Date: Wed, 11 Jun 2025 19:29:48 -0700 Subject: [PATCH 1/6] Use `DocBlockFactory::createInstance()` --- src/voku/SimplePhpParser/Model/PHPClass.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/voku/SimplePhpParser/Model/PHPClass.php b/src/voku/SimplePhpParser/Model/PHPClass.php index 9246244..d98d879 100644 --- a/src/voku/SimplePhpParser/Model/PHPClass.php +++ b/src/voku/SimplePhpParser/Model/PHPClass.php @@ -4,6 +4,7 @@ namespace voku\SimplePhpParser\Model; +use phpDocumentor\Reflection\DocBlockFactory; use PhpParser\Comment\Doc; use PhpParser\Node\Stmt\Class_; use ReflectionClass; @@ -385,7 +386,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') From 00f0c4b67c876217350a62500ce0f58c26c834d6 Mon Sep 17 00:00:00 2001 From: Brian Henry Date: Wed, 11 Jun 2025 19:32:59 -0700 Subject: [PATCH 2/6] Update more cases of `Utils::createDocBlockInstance()` --- src/voku/SimplePhpParser/Model/PHPFunction.php | 4 ++-- src/voku/SimplePhpParser/Model/PHPMethod.php | 2 +- src/voku/SimplePhpParser/Model/PHPParameter.php | 2 +- src/voku/SimplePhpParser/Model/PHPProperty.php | 2 +- src/voku/SimplePhpParser/Model/PHPTrait.php | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/voku/SimplePhpParser/Model/PHPFunction.php b/src/voku/SimplePhpParser/Model/PHPFunction.php index d907c3c..956fa6a 100644 --- a/src/voku/SimplePhpParser/Model/PHPFunction.php +++ b/src/voku/SimplePhpParser/Model/PHPFunction.php @@ -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()); $this->summary = $phpDoc->getSummary(); $this->description = (string) $phpDoc->getDescription(); } catch (\Exception $e) { @@ -229,7 +229,7 @@ protected function readPhpDoc($doc): void } try { - $phpDoc = Utils::createDocBlockInstance()->create($docComment); + $phpDoc = DocBlockFactory::createInstance()->create($docComment); $parsedReturnTag = $phpDoc->getTagsByName('return'); diff --git a/src/voku/SimplePhpParser/Model/PHPMethod.php b/src/voku/SimplePhpParser/Model/PHPMethod.php index 182c05d..bc41f73 100644 --- a/src/voku/SimplePhpParser/Model/PHPMethod.php +++ b/src/voku/SimplePhpParser/Model/PHPMethod.php @@ -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) { diff --git a/src/voku/SimplePhpParser/Model/PHPParameter.php b/src/voku/SimplePhpParser/Model/PHPParameter.php index 2175cdf..2de8442 100644 --- a/src/voku/SimplePhpParser/Model/PHPParameter.php +++ b/src/voku/SimplePhpParser/Model/PHPParameter.php @@ -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'); diff --git a/src/voku/SimplePhpParser/Model/PHPProperty.php b/src/voku/SimplePhpParser/Model/PHPProperty.php index 5f90f20..a9cabb2 100644 --- a/src/voku/SimplePhpParser/Model/PHPProperty.php +++ b/src/voku/SimplePhpParser/Model/PHPProperty.php @@ -229,7 +229,7 @@ private function readPhpDoc($doc): void } try { - $phpDoc = Utils::createDocBlockInstance()->create($docComment); + $phpDoc = DocBlockFactory::createInstance()->create($docComment); $parsedParamTags = $phpDoc->getTagsByName('var'); diff --git a/src/voku/SimplePhpParser/Model/PHPTrait.php b/src/voku/SimplePhpParser/Model/PHPTrait.php index 7335437..424db5a 100644 --- a/src/voku/SimplePhpParser/Model/PHPTrait.php +++ b/src/voku/SimplePhpParser/Model/PHPTrait.php @@ -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') From f3439a56f350c6cb33a73a88072183fa0e864db3 Mon Sep 17 00:00:00 2001 From: Brian Henry Date: Wed, 11 Jun 2025 22:47:10 -0700 Subject: [PATCH 3/6] Add missing `use phpDocumentor\Reflection\DocBlockFactory` --- src/voku/SimplePhpParser/Model/PHPFunction.php | 1 + src/voku/SimplePhpParser/Model/PHPMethod.php | 1 + src/voku/SimplePhpParser/Model/PHPParameter.php | 1 + src/voku/SimplePhpParser/Model/PHPProperty.php | 1 + src/voku/SimplePhpParser/Model/PHPTrait.php | 1 + 5 files changed, 5 insertions(+) diff --git a/src/voku/SimplePhpParser/Model/PHPFunction.php b/src/voku/SimplePhpParser/Model/PHPFunction.php index 956fa6a..4cc67f6 100644 --- a/src/voku/SimplePhpParser/Model/PHPFunction.php +++ b/src/voku/SimplePhpParser/Model/PHPFunction.php @@ -6,6 +6,7 @@ use phpDocumentor\Reflection\DocBlock\Tags\Generic; use phpDocumentor\Reflection\DocBlock\Tags\Return_; +use phpDocumentor\Reflection\DocBlockFactory; use PhpParser\Comment\Doc; use PhpParser\Node\Stmt\Function_; use ReflectionFunction; diff --git a/src/voku/SimplePhpParser/Model/PHPMethod.php b/src/voku/SimplePhpParser/Model/PHPMethod.php index bc41f73..323041e 100644 --- a/src/voku/SimplePhpParser/Model/PHPMethod.php +++ b/src/voku/SimplePhpParser/Model/PHPMethod.php @@ -4,6 +4,7 @@ namespace voku\SimplePhpParser\Model; +use phpDocumentor\Reflection\DocBlockFactory; use voku\SimplePhpParser\Parsers\Helper\DocFactoryProvider; use voku\SimplePhpParser\Parsers\Helper\Utils; diff --git a/src/voku/SimplePhpParser/Model/PHPParameter.php b/src/voku/SimplePhpParser/Model/PHPParameter.php index 2de8442..ea5f748 100644 --- a/src/voku/SimplePhpParser/Model/PHPParameter.php +++ b/src/voku/SimplePhpParser/Model/PHPParameter.php @@ -4,6 +4,7 @@ namespace voku\SimplePhpParser\Model; +use phpDocumentor\Reflection\DocBlockFactory; use PhpParser\Comment\Doc; use PhpParser\Node\FunctionLike; use PhpParser\Node\Param; diff --git a/src/voku/SimplePhpParser/Model/PHPProperty.php b/src/voku/SimplePhpParser/Model/PHPProperty.php index a9cabb2..29198fe 100644 --- a/src/voku/SimplePhpParser/Model/PHPProperty.php +++ b/src/voku/SimplePhpParser/Model/PHPProperty.php @@ -4,6 +4,7 @@ namespace voku\SimplePhpParser\Model; +use phpDocumentor\Reflection\DocBlockFactory; use PhpParser\Comment\Doc; use PhpParser\Node\Stmt\Property; use ReflectionProperty; diff --git a/src/voku/SimplePhpParser/Model/PHPTrait.php b/src/voku/SimplePhpParser/Model/PHPTrait.php index 424db5a..d6f3882 100644 --- a/src/voku/SimplePhpParser/Model/PHPTrait.php +++ b/src/voku/SimplePhpParser/Model/PHPTrait.php @@ -4,6 +4,7 @@ namespace voku\SimplePhpParser\Model; +use phpDocumentor\Reflection\DocBlockFactory; use PhpParser\Comment\Doc; use PhpParser\Node\Stmt\Trait_; use ReflectionClass; From 8ce16ff7cf9ad1c0d5b496ae5158b333eb082d56 Mon Sep 17 00:00:00 2001 From: Brian Henry Date: Sun, 15 Jun 2025 14:59:15 -0700 Subject: [PATCH 4/6] Use `DocFactoryProvider::getDocFactory()` instead --- src/voku/SimplePhpParser/Model/PHPClass.php | 3 ++- src/voku/SimplePhpParser/Model/PHPFunction.php | 4 ++-- src/voku/SimplePhpParser/Model/PHPMethod.php | 2 +- src/voku/SimplePhpParser/Model/PHPParameter.php | 2 +- src/voku/SimplePhpParser/Model/PHPProperty.php | 2 +- src/voku/SimplePhpParser/Model/PHPTrait.php | 2 +- 6 files changed, 8 insertions(+), 7 deletions(-) diff --git a/src/voku/SimplePhpParser/Model/PHPClass.php b/src/voku/SimplePhpParser/Model/PHPClass.php index d98d879..69dc70e 100644 --- a/src/voku/SimplePhpParser/Model/PHPClass.php +++ b/src/voku/SimplePhpParser/Model/PHPClass.php @@ -8,6 +8,7 @@ use PhpParser\Comment\Doc; use PhpParser\Node\Stmt\Class_; use ReflectionClass; +use voku\SimplePhpParser\Parsers\Helper\DocFactoryProvider; use voku\SimplePhpParser\Parsers\Helper\Utils; class PHPClass extends BasePHPClass @@ -386,7 +387,7 @@ private function readPhpDocProperties($doc): void } try { - $phpDoc = DocBlockFactory::createInstance()->create($docComment); + $phpDoc = DocFactoryProvider::getDocFactory()->create($docComment); $parsedPropertyTags = $phpDoc->getTagsByName('property') + $phpDoc->getTagsByName('property-read') diff --git a/src/voku/SimplePhpParser/Model/PHPFunction.php b/src/voku/SimplePhpParser/Model/PHPFunction.php index 4cc67f6..88dc141 100644 --- a/src/voku/SimplePhpParser/Model/PHPFunction.php +++ b/src/voku/SimplePhpParser/Model/PHPFunction.php @@ -77,7 +77,7 @@ public function readObjectFromPhpNode($node, $dummy = null): self $docComment = $node->getDocComment(); if ($docComment) { try { - $phpDoc = DocBlockFactory::createInstance()->create($docComment->getText()); + $phpDoc = DocFactoryProvider::getDocFactory()->create($docComment->getText()); $this->summary = $phpDoc->getSummary(); $this->description = (string) $phpDoc->getDescription(); } catch (\Exception $e) { @@ -230,7 +230,7 @@ protected function readPhpDoc($doc): void } try { - $phpDoc = DocBlockFactory::createInstance()->create($docComment); + $phpDoc = DocFactoryProvider::getDocFactory()->create($docComment); $parsedReturnTag = $phpDoc->getTagsByName('return'); diff --git a/src/voku/SimplePhpParser/Model/PHPMethod.php b/src/voku/SimplePhpParser/Model/PHPMethod.php index 323041e..de20d2c 100644 --- a/src/voku/SimplePhpParser/Model/PHPMethod.php +++ b/src/voku/SimplePhpParser/Model/PHPMethod.php @@ -45,7 +45,7 @@ public function readObjectFromPhpNode($node, $classStr = null): PHPFunction $docComment = $node->getDocComment(); if ($docComment) { try { - $phpDoc = DocBlockFactory::createInstance()->create($docComment->getText()); + $phpDoc = DocFactoryProvider::getDocFactory()->create($docComment->getText()); $this->summary = $phpDoc->getSummary(); $this->description = (string) $phpDoc->getDescription(); } catch (\Exception $e) { diff --git a/src/voku/SimplePhpParser/Model/PHPParameter.php b/src/voku/SimplePhpParser/Model/PHPParameter.php index ea5f748..33073e5 100644 --- a/src/voku/SimplePhpParser/Model/PHPParameter.php +++ b/src/voku/SimplePhpParser/Model/PHPParameter.php @@ -221,7 +221,7 @@ private function readPhpDoc($doc, string $parameterName): void } try { - $phpDoc = DocBlockFactory::createInstance()->create($docComment); + $phpDoc = DocFactoryProvider::getDocFactory()->create($docComment); $parsedParamTags = $phpDoc->getTagsByName('param'); diff --git a/src/voku/SimplePhpParser/Model/PHPProperty.php b/src/voku/SimplePhpParser/Model/PHPProperty.php index 29198fe..7177b76 100644 --- a/src/voku/SimplePhpParser/Model/PHPProperty.php +++ b/src/voku/SimplePhpParser/Model/PHPProperty.php @@ -230,7 +230,7 @@ private function readPhpDoc($doc): void } try { - $phpDoc = DocBlockFactory::createInstance()->create($docComment); + $phpDoc = DocFactoryProvider::getDocFactory()->create($docComment); $parsedParamTags = $phpDoc->getTagsByName('var'); diff --git a/src/voku/SimplePhpParser/Model/PHPTrait.php b/src/voku/SimplePhpParser/Model/PHPTrait.php index d6f3882..158e756 100644 --- a/src/voku/SimplePhpParser/Model/PHPTrait.php +++ b/src/voku/SimplePhpParser/Model/PHPTrait.php @@ -293,7 +293,7 @@ private function readPhpDocProperties($doc): void } try { - $phpDoc = DocBlockFactory::createInstance()->create($docComment); + $phpDoc = DocFactoryProvider::getDocFactory()->create($docComment); $parsedPropertyTags = $phpDoc->getTagsByName('property') + $phpDoc->getTagsByName('property-read') From f19c206d8c47c54c0c71189965f96e658c5bb156 Mon Sep 17 00:00:00 2001 From: Brian Henry Date: Mon, 16 Jun 2025 20:17:20 -0700 Subject: [PATCH 5/6] Update imports --- src/voku/SimplePhpParser/Model/PHPClass.php | 1 - src/voku/SimplePhpParser/Model/PHPFunction.php | 1 - src/voku/SimplePhpParser/Model/PHPMethod.php | 1 - src/voku/SimplePhpParser/Model/PHPProperty.php | 2 +- src/voku/SimplePhpParser/Model/PHPTrait.php | 2 +- 5 files changed, 2 insertions(+), 5 deletions(-) diff --git a/src/voku/SimplePhpParser/Model/PHPClass.php b/src/voku/SimplePhpParser/Model/PHPClass.php index 69dc70e..b81d530 100644 --- a/src/voku/SimplePhpParser/Model/PHPClass.php +++ b/src/voku/SimplePhpParser/Model/PHPClass.php @@ -4,7 +4,6 @@ namespace voku\SimplePhpParser\Model; -use phpDocumentor\Reflection\DocBlockFactory; use PhpParser\Comment\Doc; use PhpParser\Node\Stmt\Class_; use ReflectionClass; diff --git a/src/voku/SimplePhpParser/Model/PHPFunction.php b/src/voku/SimplePhpParser/Model/PHPFunction.php index 88dc141..b58a555 100644 --- a/src/voku/SimplePhpParser/Model/PHPFunction.php +++ b/src/voku/SimplePhpParser/Model/PHPFunction.php @@ -6,7 +6,6 @@ use phpDocumentor\Reflection\DocBlock\Tags\Generic; use phpDocumentor\Reflection\DocBlock\Tags\Return_; -use phpDocumentor\Reflection\DocBlockFactory; use PhpParser\Comment\Doc; use PhpParser\Node\Stmt\Function_; use ReflectionFunction; diff --git a/src/voku/SimplePhpParser/Model/PHPMethod.php b/src/voku/SimplePhpParser/Model/PHPMethod.php index de20d2c..0411ae8 100644 --- a/src/voku/SimplePhpParser/Model/PHPMethod.php +++ b/src/voku/SimplePhpParser/Model/PHPMethod.php @@ -4,7 +4,6 @@ namespace voku\SimplePhpParser\Model; -use phpDocumentor\Reflection\DocBlockFactory; use voku\SimplePhpParser\Parsers\Helper\DocFactoryProvider; use voku\SimplePhpParser\Parsers\Helper\Utils; diff --git a/src/voku/SimplePhpParser/Model/PHPProperty.php b/src/voku/SimplePhpParser/Model/PHPProperty.php index 7177b76..c651e27 100644 --- a/src/voku/SimplePhpParser/Model/PHPProperty.php +++ b/src/voku/SimplePhpParser/Model/PHPProperty.php @@ -4,10 +4,10 @@ namespace voku\SimplePhpParser\Model; -use phpDocumentor\Reflection\DocBlockFactory; use PhpParser\Comment\Doc; use PhpParser\Node\Stmt\Property; use ReflectionProperty; +use voku\SimplePhpParser\Parsers\Helper\DocFactoryProvider; use voku\SimplePhpParser\Parsers\Helper\Utils; class PHPProperty extends BasePHPElement diff --git a/src/voku/SimplePhpParser/Model/PHPTrait.php b/src/voku/SimplePhpParser/Model/PHPTrait.php index 158e756..c4ba4c8 100644 --- a/src/voku/SimplePhpParser/Model/PHPTrait.php +++ b/src/voku/SimplePhpParser/Model/PHPTrait.php @@ -4,10 +4,10 @@ namespace voku\SimplePhpParser\Model; -use phpDocumentor\Reflection\DocBlockFactory; use PhpParser\Comment\Doc; use PhpParser\Node\Stmt\Trait_; use ReflectionClass; +use voku\SimplePhpParser\Parsers\Helper\DocFactoryProvider; use voku\SimplePhpParser\Parsers\Helper\Utils; final class PHPTrait extends BasePHPClass From 93c7fd37deaaac869587417e4e3f3eee16ca4e16 Mon Sep 17 00:00:00 2001 From: Brian Henry Date: Mon, 16 Jun 2025 20:28:47 -0700 Subject: [PATCH 6/6] Restore previous `::createDocBlockInstance()` --- src/voku/SimplePhpParser/Model/PHPParameter.php | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/voku/SimplePhpParser/Model/PHPParameter.php b/src/voku/SimplePhpParser/Model/PHPParameter.php index 33073e5..9324492 100644 --- a/src/voku/SimplePhpParser/Model/PHPParameter.php +++ b/src/voku/SimplePhpParser/Model/PHPParameter.php @@ -4,7 +4,6 @@ namespace voku\SimplePhpParser\Model; -use phpDocumentor\Reflection\DocBlockFactory; use PhpParser\Comment\Doc; use PhpParser\Node\FunctionLike; use PhpParser\Node\Param; @@ -221,8 +220,7 @@ private function readPhpDoc($doc, string $parameterName): void } try { - $phpDoc = DocFactoryProvider::getDocFactory()->create($docComment); - + $phpDoc = Utils::createDocBlockInstance()->create($docComment); $parsedParamTags = $phpDoc->getTagsByName('param'); if (!empty($parsedParamTags)) {