PHP Type Annotation for functions?

Question

In PHP it's common to type annotate variables like this:

  /**
   * @var boolean
   */
  protected $isLoaded;

But what about the return types in functions? Does PHP Type Annotation support the return type of a function?

If so, how can I annotate the return type of the function in class diagram

-getName(): String

?

I would expect something like:

  /**
   * @return String
   */
  private function getName() {}

But it's ignored.

ah thanks, I was looking on the wrong place: php-annotations.readthedocs.io/en/latest/… and couldn't find the answer. — StandardNerd
– StandardNerd, Commented Jul 9, 2017 at 15:26

colburton · Accepted Answer · 2017-07-09 15:17:22Z

1

That would just be:

/**
 * @return string
 */
private function getName(): string {}

The annotation is optional at this point.

answered Jul 9, 2017 at 15:17

colburton

4,7252 gold badges28 silver badges41 bronze badges

Sign up to request clarification or add additional context in comments.

1 Answer 1