Skip to content

Overview

Types from Reflection

Reflection gives the docblock of a class or a method as a string, DocBlockParser turns it into tags with parsed types. The examples print the types with the pretty printer.

/**
* @template-covariant T of object
* @template TKey of array-key = int
*/
final class Repository
{
/**
* @param array $ids
* @phpstan-param list<positive-int> $ids
* @param bool $withDeleted
* @return list<User>
*/
public function findAll(array $ids, bool $withDeleted = false): array
{
// ...
}
}

@phpstan-param and @psalm-param are parsed into the same ParamTag as @param, the $name of the tag tells them apart. A tool usually prefers the prefixed one.

use TypeLang\PhpDoc\DocBlock\Tag\ParamTag\ParamTag;
use TypeLang\PhpDoc\DocBlock\Tag\ReturnTag\ReturnTag;
use TypeLang\PhpDoc\DocBlockParser;
use TypeLang\Printer\PrettyTypePrinter;
$parser = DocBlockParser::createDefault();
$printer = new PrettyTypePrinter();
$method = new \ReflectionMethod(Repository::class, 'findAll');
$block = $parser->parse((string) $method->getDocComment());
$params = [];
$return = null;
foreach ($block as $tag) {
if ($tag instanceof ParamTag) {
// "@param" does not override "@phpstan-param" or "@psalm-param"
if ($tag->name === 'param' && isset($params[$tag->variable])) {
continue;
}
$params[$tag->variable] = $tag->type;
}
if ($tag instanceof ReturnTag) {
$return = $tag->type;
}
}
echo $printer->print($params['ids']); // list<positive-int>
echo $printer->print($params['withDeleted']); // bool
echo $printer->print($return); // list<User>

@template, @template-covariant and @template-contravariant share the TypeParameterTag base: the $parameter name, the optional $bound and $default.

use TypeLang\PhpDoc\DocBlock\Tag\TemplateTag\TypeParameterTag;
$class = new \ReflectionClass(Repository::class);
$block = $parser->parse((string) $class->getDocComment());
foreach ($block as $tag) {
if (!$tag instanceof TypeParameterTag) {
continue;
}
echo $tag->name; // "template-covariant"
echo $tag->parameter; // "T"
echo $printer->print($tag->bound->type); // object
}

For TKey the loop gives template, TKey, the bound array-key and $tag->default->type printed as int.

The types hold class names as they are written in the docblock: User above is a short name. To get App\Entity\User, resolve the names against the namespace and the use statements of the file with the type resolver.