How do I annotate variables in an included PHP file?

Question

In my controller I have code like this:

public function showStudent($id)
{
    $student = new Student();
    $student->loadFromId($id);

    /* call the view */
    include '/path/to/student/view.php';
}

In the view.php file I want my code editor (netbeans, of course) to know $student is an instance of the Student class so it can suggest and check methods and properties etc. Can I help the editor to know this with an annotation, like

<?php
/**
* @magic Student $student
*/
?>
<html>
....
<p>Good day, <?= $student->name; ?></p>
</html>

adlawson · Accepted Answer · 2012-11-08 09:31:58Z

1

/* @var $student Student */
$student->name;

Netbeans, of course? You should look at Sublime Text.

answered Nov 8, 2012 at 9:31

adlawson

6,4291 gold badge37 silver badges46 bronze badges

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

3 Comments

Jannie Theunissen Over a year ago

Sorry, doesn't work for me. According to the ApiGen docs @var takes two arguments: datatype and description and should precede the variable declaration. I don't want to redeclare the variable

Jannie Theunissen Over a year ago

No dice. Maybe it's Sublime specific?

Jannie Theunissen Over a year ago

Your answer should work on a healthy netbeans install: netbeans.org/bugzilla/show_bug.cgi?id=222012 Thanks for putting me on the right track.

Collectives™ on Stack Overflow

How do I annotate variables in an included PHP file?

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