PHP doc: état que vous renvoie le résultat d'un autre appel de fonction

Question

Avec une fonction comme ceci:

function cancel($thing_id) 
{ 
    $this->Thing->id = $thing_id; 
    return $this->Thing->cancel(); 
} 

Comment formater le @return pour refléter le fait que je retourne le résultat d'un autre appel de fonction?

Answer 1

Il n'est pas possible de lier le type de retour à un type de retour de fonctions différent. Il n'est pas mentionné en tant que type dans phpDocumentor: Defining a 'Type', et le plus proche serait le type callable.

La meilleure chose que vous pouvez faire est probablement la suivante:

/** 
* As a example I have assumed that $this->Thing->cancel() returns either true or false 
* 
* @see Thing::cancel 
* @return bool Returns the result of Thing::cancel 
*/ 

Comme vous pouvez le voir, je précise le type de retour de $this->Thing->cancel() et expliquer où le type de retour est originaire. Pour faciliter la recherche de la méthode, j'ai ajouté l'étiquette @see, en pointant sur la méthode