When returning a Collection, you can annotate the @return type like:
/**
* @return Article[]
*/
#[GraphQLite\Field]
public function getArticles(): Collection;
However, this doesn't tell many static analyzers that the return type is a Collection. Maybe some smarter analyzers will check the actual return type, if typed, and use both combined. I'm unsure about that. But, there is value in using the Generics syntax for those that don't.
/**
* @return Collection<Article>
*/
#[GraphQLite\Field]
public function getArticles(): Collection;
This syntax is quickly becoming somewhat of a standard at this point. It's supported by Psalm, Phan, PHPStan and I'm sure others. It was implemented by PHPStorm.
Many of you are probably familiar with this syntax and probably use it. For compatibility reasons, we should support both of these syntaxes when evaluating an @return annotation for the sake of generating GraphQL Types. Currently, an error is thrown as it tries to create a Type definition out of Collection
When returning a Collection, you can annotate the
@returntype like:However, this doesn't tell many static analyzers that the return type is a Collection. Maybe some smarter analyzers will check the actual return type, if typed, and use both combined. I'm unsure about that. But, there is value in using the Generics syntax for those that don't.
This syntax is quickly becoming somewhat of a standard at this point. It's supported by Psalm, Phan, PHPStan and I'm sure others. It was implemented by PHPStorm.
Many of you are probably familiar with this syntax and probably use it. For compatibility reasons, we should support both of these syntaxes when evaluating an
@returnannotation for the sake of generating GraphQL Types. Currently, an error is thrown as it tries to create a Type definition out ofCollection