13

How do I setup code completion to work on Zend Studio (or any Eclipse based IDE) when working with a class that has private or protected member variables WITHOUT resorting to a bunch of Getter's OR setting the member vars as public.

For example:

class Dog {

    protected $bark = 'woof!';

    public function __get($key) {
        if (isset($this->$key)) {
            return $this->$key;
        }
    }

}

$Dog = new Dog();
echo $Dog->bark; // <-- I want the IDE to "know" that bark is a property of Dog.
jlee
  • 492
  • 5
  • 15

1 Answers1

26

Code Completion for Magic Methods can be achieved by using the @property and @method annotation in the DocBlock of the class (not in the Method Docs).

/**
 * @property string bark
 */
class Dog {
    /* ... */
}

$Dog = new Dog();
echo $Dog-> // will autocomplete now

Note that there is no correlation between the actual code and the annotation. Zend Studio will show whatever you set for @property, regardless of this property existing. It will also not check if there actually is a magic method available.

Code Completion in Zend Studio with @property annotation

Gordon
  • 312,688
  • 75
  • 539
  • 559
  • 1
    @Matthieu it should work with Eclipse, too. But dont nail me on that. – Gordon Jun 01 '11 at 11:01
  • Yup, it works in Eclipse PDT. I knew this was possible but was looking everywhere for it. The @method annotation on the class an amazing solution for fancy abstract/inherited methods. – Dustin Graham Apr 16 '13 at 05:22