Dois-je utiliser @return le soi, ou de la classe en cours?

J'ai une méthode qui renvoie l'état de l'objet, comment ce document?

/**
 * set something
 *
 * @return this
 */
public function setSomething(){
            //...
    return $this;
}

Ou dois-je faire @return self ou @return Current_Class_Name?

InformationsquelleAutor lucaswxp | 2011-08-04
  1. 29

    @return Current_Class_Name sera certainement le travail et c'est ce que je préfère.

    @return self peut fonctionner avec certains programmes.

    @return this est mauvais parce que ce n'est pas un typename.

    • "de retour Current_Class_Name" qui fonctionne le mieux en ce moment, comme il l'a IDE d'auto-complétion pour réussir. Il y a de demandes de fonctionnalités pour phpDocumentor [1] et Eclipse PDT [2] à reconnaître "return $this". [1] -- pear.php.net/bugs/bug.php?id=16223 [2] -- bugs.eclipse.org/bugs/show_bug.cgi?id=276082
    • PhpStorm prend en charge @return self
    • Que faire si je veux le retour de la sous-classe, mais pas la classe de base où je vous écris de la méthode?
    InformationsquelleAutor RiaD
  2. 36

    Il y a un PHP Normes de la Recommandation (PSR) actuellement dans le projet de (PSR-5) qui se propose de @return $this est utilisé pour indiquer que la même instance est retournée.

    $cela, l'élément de ce type s'applique est exactement la même instance de la classe en cours dans le contexte donné. Comme tel, ce type est une version plus stricte de la statique comme, en plus, le retour de l'instance ne doit pas seulement être de la même classe, mais aussi la même instance.

    Ce type est souvent utilisé comme valeur de retour pour les méthodes de mise en œuvre de l'Interface Fluide motif de conception.

    Cette notation est utilisée actuellement par le populaire IDEs tels que PhpStorm et Netbeans.

    • Votre réponse est trompeur car il semble que ce RP recommande $this. Je ne pense pas que cela est vrai. Il a simplement permet, comme Current_Class_Name et self.
    • Notez également qu'il est @return $this pas @return this comme à la question posée.
    • J'utilise le PHP Tempête $et cela bouleverse, alors que l'auto et \Classe n'
    • Veuillez noter que le PSR-5 est abandonné.
    • pas plus, par exemple, voir ce PR github.com/php-fig/fig-standards/pull/1104 et de discussion groups.google.com/forum/#!topic/php-fig/W1VyAtoqGQ8
    • Je confirme, le PSR-5 n'est plus abandonné, il est en projet maintenant. Merci beaucoup pour ce point.

    InformationsquelleAutor g .
  3. 7
    /**
 * set something
 *
 * @return self
 */
public function setSomething(){
            //...
    return $this;
}

    Vous pouvez utiliser le bouton "auto" type @param ou @return..

    PHPDoc recommande de " moi " pour se référer à soi-même dans l'objet.

    Source: http://www.phpdoc.org/docs/latest/references/phpdoc/types.html

    • Cela fonctionne avec des sous-classes mal. Si le sous-classe ne veut pas le remplacer, les interprètes ne savent pas qu'un objet avec la même sous-classe doit être retourné.
    • statique semble être soutenue par PHPStorm.
    InformationsquelleAutor MURATSPLAT
  4. 5

    Cette question est assez vieux, mais je veux juste partager à tout le monde!

    AU MOINS pour ceux qui utilise NetBeans 8.1.. cette notation fait code d'auto-complétion pour bien travailler à l'IDE:

    /**
 * Method that returns $this instance (using late state binding)
 * @return static
 */
 public function iWillReturnMyself ( ) {
     return $this;
 }

    Je dis AU MOINS pour NetBeans8.1 les utilisateurs, mais peuvent travailler sur des versions plus anciennes et/ou d'autres IDEs trop =]

    • pour netbeans 8.2 travaille trop
    • Ce (omi, la meilleure option) ne fonctionne malheureusement pas dans PHPStorm. "Champ name pas trouvé en statique".
    • PHPStorm prend en charge statique ici sur ma version (2018.2)
    InformationsquelleAutor Diego Calero