Add return tag factory

This commit is contained in:
Jaapio
2022-10-28 16:47:01 +02:00
parent b12a33921b
commit 1dd491c8ec
12 changed files with 113 additions and 2 deletions
@@ -0,0 +1,44 @@
<?php
declare(strict_types=1);
namespace phpDocumentor\Reflection\DocBlock\Tags\Factory;
use phpDocumentor\Reflection\DocBlock\DescriptionFactory;
use phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Tags\Return_;
use phpDocumentor\Reflection\Types\Context;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
use Webmozart\Assert\Assert;
/**
* @internal This class is not part of the BC promise of this library.
*/
final class ReturnFactory implements PHPStanFactory
{
private TypeFactory $typeFactory;
private DescriptionFactory $descriptionFactory;
public function __construct(TypeFactory $typeFactory, DescriptionFactory $descriptionFactory)
{
$this->typeFactory = $typeFactory;
$this->descriptionFactory = $descriptionFactory;
}
public function create(PhpDocTagNode $node, ?Context $context): Tag
{
$tagValue = $node->value;
Assert::isInstanceOf($tagValue, ReturnTagValueNode::class);
return new Return_(
$this->typeFactory->createType($tagValue->type, $context),
$this->descriptionFactory->create($tagValue->description, $context)
);
}
public function supports(PhpDocTagNode $node, ?Context $context): bool
{
return $node->value instanceof ReturnTagValueNode;
}
}
@@ -36,6 +36,7 @@ use PHPStan\PhpDocParser\Ast\Type\ThisTypeNode;
use PHPStan\PhpDocParser\Ast\Type\TypeNode;
use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
use function array_filter;
use function array_map;
use function array_reverse;
use function get_class;
@@ -78,6 +79,7 @@ final class TypeFactory
case ConstTypeNode::class:
return null;
case GenericTypeNode::class:
return $this->createFromGeneric($type, $context);
+3
View File
@@ -31,9 +31,12 @@ use function preg_match;
use function sort;
use function strpos;
use function substr;
use function trigger_error;
use function trim;
use function var_export;
use const E_USER_DEPRECATED;
/**
* Reflection class for an {@}method in a Docblock.
*/
+2
View File
@@ -26,7 +26,9 @@ use function array_unshift;
use function implode;
use function strpos;
use function substr;
use function trigger_error;
use const E_USER_DEPRECATED;
use const PREG_SPLIT_DELIM_CAPTURE;
/**
+2
View File
@@ -26,7 +26,9 @@ use function array_unshift;
use function implode;
use function strpos;
use function substr;
use function trigger_error;
use const E_USER_DEPRECATED;
use const PREG_SPLIT_DELIM_CAPTURE;
/**
+2
View File
@@ -26,7 +26,9 @@ use function array_unshift;
use function implode;
use function strpos;
use function substr;
use function trigger_error;
use const E_USER_DEPRECATED;
use const PREG_SPLIT_DELIM_CAPTURE;
/**
+2
View File
@@ -26,7 +26,9 @@ use function array_unshift;
use function implode;
use function strpos;
use function substr;
use function trigger_error;
use const E_USER_DEPRECATED;
use const PREG_SPLIT_DELIM_CAPTURE;
/**
+4
View File
@@ -20,6 +20,10 @@ use phpDocumentor\Reflection\TypeResolver;
use phpDocumentor\Reflection\Types\Context as TypeContext;
use Webmozart\Assert\Assert;
use function trigger_error;
use const E_USER_DEPRECATED;
/**
* Reflection class for a {@}return tag in a Docblock.
*/
+2
View File
@@ -26,7 +26,9 @@ use function array_unshift;
use function implode;
use function strpos;
use function substr;
use function trigger_error;
use const E_USER_DEPRECATED;
use const PREG_SPLIT_DELIM_CAPTURE;
/**