PHPDoc for property of object

Question

Is is possible (for type hinting purposes) to indicate the class of an object's property? The final product of the code works as expected, but, type hinting does not. For example, the following shows what I am trying to accomplish but that does not work:

    /* @var $this->view \app\components\View */
    $this->view->title = 'Title here';

All I have ever seen were references to @var $this or similar, but never a property of the $this object. If this is possible, what am I missing?

Panda · Accepted Answer · 2017-09-16 16:14:13Z

4

Yes - you must apply the PHPDoc annotation where you declare the property in the class:

class Foo
{
    /* @var \app\components\View $view*/
    public $view;

    public function __construct()
    {
          $this->view->title = 'Title here';
    }
}

edited Sep 16, 2017 at 16:14

Panda

6,8846 gold badges46 silver badges61 bronze badges

answered Sep 29, 2016 at 17:27

HPierce

7,4597 gold badges37 silver badges49 bronze badges

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

3 Comments

justinvoelker Over a year ago

Is there a way to annotate it in the class without declaring it? Such as when class Foo extends class Bar which is where the property is declared? I would have to go back through a few classes to find the original declaration of the view property (through vendor code, that is).

HPierce Over a year ago

I'm not aware of any ways to do that. I think I'd just opt to redeclare the property in the super class if your IDE was giving you fits.

justinvoelker Over a year ago

Since the super class is outside of my control that won't be easy/viable. What is working, though, is redeclaring the property in my class then inside where it is used I set it equal to the parent implementation of the value. So, my class starts off with it empty but by the time it is used it is back to what it should be. Thanks for the help!

Collectives™ on Stack Overflow

PHPDoc for property of object

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related