How to resolve FQCN of a PhpDoc which uses alias?

[nikophil]

Hello,

in a custom rule, I'm reading phpdoc from a property like this:

$tokens = new TokenIterator($this->phpDocLexer->tokenize($docComment->getText()));
$phpDocNodes = $this->phpDocParser->parse($tokens);

but my phpdoc uses some aliases:

use Some\Namespace as SomeNamespaceAlias;

class Dummy
{
    /** @var list<SomeNamespaceAlias\SomeClass> */
    public array $someClasses = [];
}

Then my docnode looks like this:

^ PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode^ {#23587
  +type: PHPStan\PhpDocParser\Ast\Type\GenericTypeNode^ {#23355
    +type: PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode^ {#23590
      +name: "list"
      -attributes: []
    }
    +genericTypes: array:1 [
      0 => PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode^ {#23589
        +name: "SomeNamespaceAlias\SomeClass"
        -attributes: []
      }
    ]
    +variances: array:1 [
      0 => "invariant"
    ]
    -attributes: []
  }
}

how can I resolve the FQCN?

I also tried to use the following

$this->fileTypeMapper->getResolvedPhpDoc(fileName: null, className: $class, traitName: null, functionName: null, docComment: $docComment->getText());

but it seems the full type is not resolved either...

bonus question: is there some documentation which I can refer to for this kind of "complex" case?

thanks for your answer! 🙏

[ondrejmirtes]

I'm happy to help you, I just need more context and information.

What are you trying to achieve with your custom rule?

[nikophil]

Hi,

thanks for your answer.

I want to enforce cohesion between the phpdoc and a custom doctrine type, which helps us to store value objects as json in the database:

use Fully\Qualified\Class\Name as SomeNamespaceAlias;

#[ORM\Entity]
class SomeEntity
{
    /** @var list<SomeNamespaceAlias\SomeClass> */ // <--- I want this...
    #[ORM\Column('list<Fully\Qualified\Class\Name\SomeClass>')] // <--- ...to be coherent with this
    public array $someClasses = [];
}

[ondrejmirtes]

You can read that from PropertyReflection:

• https://phpstan.org/developing-extensions/reflection
• https://apiref.phpstan.org/1.11.x/PHPStan.Reflection.PropertyReflection.html#_getReadableType

You don't need to parse PHPDocs manually at all.

[nikophil]

exactly what I need, thank you! 🙏