Un iterable est un pseudo-type introduit en PHP 7.1. Il accepte n'importe quel tableau ou objet implémentant l'interface Traversable. Ces deux types d'itérables peuvent utiliser foreach et peuvent être appelés avec yield from depuis un générateur.
Les Itérables peuvent être utilisés comme type d'argument pour indiquer qu'une fonction a besoin d'un ensemble de valeurs, mais se moque de la structure de l'ensemble puisqu'il va être utilisé avec foreach. Si une valeur passée en argument n'est pas un tableau ou une instance de Traversable, une exception TypeError sera lancée.
Exemple #1 Exemple de type d'argument itérable
<?php
function foo(iterable $iterable) {
foreach ($iterable as $value) {
// ...
}
}
?>
Les paramètres déclarés comme itérables peuvent utiliser NULL ou un tableau
comme valeur par défaut.
Exemple #2 Exemple de valeur par défaut d'un argument itérable
<?php
function foo(iterable $iterable = []) {
// ...
}
?>
Les itérables peuvent aussi être utilisés comme déclaration du type de retour pour indiquer qu'une fonction renverra une valeur itérable. Si la valeur renvoyée n'est pas un tableau ou une instance de Traversable, une exception TypeError sera lancée.
Exemple #3 Exemple de type de retour itérable.
<?php
function bar(): iterable {
return [1, 2, 3];
}
?>
Les fonctions déclarant un type de retour itérable peuvent aussi être des générateurs.
Exemple #4 Exemple de type de retour itérable d'un générateur
<?php
function gen(): iterable {
yield 1;
yield 2;
yield 3;
}
?>
Les classes qui étendent ou implémentent des méthodes utilisant des paramètres de type tableau ou Traversable peuvent les élargir à un type iterable. Et les classes qui étendent ou implémentent des méthodes utilisant une valeur de retour de type iterable peuvent la réduire à un type tableau or Traversable.
Exemple #5 Exemple de variation de type itérable
<?php
interface Example {
public function method(array $array): iterable;
}
class ExampleImplementation implements Example {
public function method(iterable $iterable): array {
// L'argument est élargit et le type de retour est reduit.
}
}
?>