ReturnFactory.php
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

ReturnFactory.php
View Options

	<?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\TypeResolver;
	use phpDocumentor\Reflection\Types\Context;
	use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
	use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
	use Webmozart\Assert\Assert;

	use function is_string;

	/**
	* @internal This class is not part of the BC promise of this library.
	*/
	final class ReturnFactory implements PHPStanFactory
	{
	private DescriptionFactory $descriptionFactory;
	private TypeResolver $typeResolver;

	public function __construct(TypeResolver $typeResolver, DescriptionFactory $descriptionFactory)
	{
	$this->descriptionFactory = $descriptionFactory;
	$this->typeResolver = $typeResolver;
	}

	public function create(PhpDocTagNode $node, Context $context): Tag
	{
	$tagValue = $node->value;
	Assert::isInstanceOf($tagValue, ReturnTagValueNode::class);

	$description = $tagValue->getAttribute('description');
	if (is_string($description) === false) {
	$description = $tagValue->description;
	}

	return new Return_(
	$this->typeResolver->createType($tagValue->type, $context),
	$this->descriptionFactory->create($description, $context)
	);
	}

	public function supports(PhpDocTagNode $node, Context $context): bool
	{
	return $node->value instanceof ReturnTagValueNode;
	}
	}