CKTIS / PHP
Generator::getReturn — lire la valeur de retour d’un générateur
Récupérez le résultat final d’un générateur après sa fin normale. La valeur de `return` est distincte des éléments produits par `yield`.
Version : PHP 8.3
Syntaxe
public function Generator::getReturn(): mixedGenerator::getReturn est une méthode d’instance publique de la classe intégrée \Generator, disponible depuis PHP 7.0. Elle ne nécessite aucune extension facultative. Appelez-la sans argument avec $generator->getReturn(). L’appel à une fonction génératrice fournit un objet \Generator ; le type de retour mixed dans la signature présentée pour PHP 8.3 décrit la valeur finale du générateur, pas le type de cet objet.
yield fournit un élément à l’itération et suspend l’exécution. return termine le générateur, sans ajouter sa valeur aux éléments parcourus par foreach. Une fois la boucle menée à son terme, lisez le résultat sur le même objet. Recevoir le dernier élément ne suffit pas : un break peut laisser le générateur suspendu sur un yield, et l’appel de la méthode dans cet état lève une \Exception.
Si le générateur se termine normalement sans renvoyer de valeur, la méthode renvoie null. Si une exception non interceptée met fin au générateur, aucun résultat n’est disponible et un appel ultérieur à getReturn() lève une \Exception. Lors d’une délégation à un autre générateur, yield from transmet ses éléments et a pour valeur son résultat final. Le générateur externe peut renvoyer ce résultat comme le sien avec return yield from $inner;.
Exemples
<?php
function readings(): \Generator
{
$total = 0;
foreach ([4, 7] as $reading) {
$total += $reading;
yield $reading;
}
return $total;
}
$generator = readings();
foreach ($generator as $reading) {
echo 'item: ', $reading, "\n";
}
echo 'total: ', $generator->getReturn(), "\n";
Résultat
item: 4 item: 7 total: 11
`foreach` affiche les relevés `4` et `7`. Ce n’est qu’après la boucle que `getReturn()` donne le total `11`, qui ne fait pas partie des éléments parcourus.
Leçons associées
- PHP · Leçon 59 · Avancé · Version : 2