FunctionVariantWithPhpDocs.php

<?php declare(strict_types = 1);

namespace PHPStan\Reflection;

use PHPStan\Type\Generic\TemplateTypeMap;
use PHPStan\Type\Type;
use PHPStan\Type\TypeUtils;

/** @api */
class FunctionVariantWithPhpDocs extends FunctionVariant implements ParametersAcceptorWithPhpDocs
{

	/**
	 * @api
	 * @param array<int, ParameterReflectionWithPhpDocs> $parameters
	 */
	public function __construct(
		TemplateTypeMap $templateTypeMap,
		?TemplateTypeMap $resolvedTemplateTypeMap,
		array $parameters,
		bool $isVariadic,
		Type $returnType,
		private Type $phpDocReturnType,
		private Type $nativeReturnType,
	)
	{
		parent::__construct(
			$templateTypeMap,
			$resolvedTemplateTypeMap,
			$parameters,
			$isVariadic,
			$returnType,
		);
	}

	/**
	 * @return array<int, ParameterReflectionWithPhpDocs>
	 */
	public function getParameters(): array
	{
		/** @var ParameterReflectionWithPhpDocs[] $parameters */
		$parameters = parent::getParameters();

		return $parameters;
	}

	public function getPhpDocReturnType(): Type
	{
		return $this->phpDocReturnType;
	}

	public function getNativeReturnType(): Type
	{
		return $this->nativeReturnType;
	}

	/**
	 * @return static
	 */
	public function flattenConditionalsInReturnType(): SingleParametersAcceptor
	{
		/** @var static $result */
		$result = new self(
			$this->getTemplateTypeMap(),
			$this->getResolvedTemplateTypeMap(),
			$this->getParameters(),
			$this->isVariadic(),
			TypeUtils::flattenConditionals($this->getReturnType()),
			TypeUtils::flattenConditionals($this->phpDocReturnType),
			$this->nativeReturnType,
		);

		return $result;
	}

}