samedi 5 juillet 2014

PHPDoc pour le retour d'une méthode qui retourne $this

Lorsque vous écrivez la PHPDoc d'une méthode, vous pouvez indiquer quel sera le type du retour de cette méthode, via @return.

Si votre méthode retourne l'objet qui contient cette méthode (par exemple return $this pour les appels chaînés), vous pouvez écrire @return Foo.

Mais vous pouvez aussi écrire @return $this, ce qui permettra à votre éditeur de créer une auto-complétion complète dans le cas ou votre classe serait héritée par une autre.
class Foo { /** * @return $this */ public function myMethod() { } } class Bar extends Foo { public function myBarMethod() { } } $var = new Bar(); $var-> // ici, vous avez l'auto-complétion avec myMethod et myBarMethod !)

Aucun commentaire:

Publier un commentaire