【PHP8.x】is_iterable関数の使い方

Copy
1<?php
2
3/**
4 * iterableかどうかをチェックする例
5 */
6function checkIterable(mixed $value): void
7{
8    if (is_iterable($value)) {
9        echo "The value is iterable.\n";
10    } else {
11        echo "The value is not iterable.\n";
12    }
13}
14
15// 配列のチェック
16$array = [1, 2, 3];
17echo "Checking an array:\n";
18checkIterable($array);
19
20// Traversableオブジェクトのチェック
21$traversable = new ArrayIterator([4, 5, 6]);
22echo "\nChecking a Traversable object:\n";
23checkIterable($traversable);
24
25// 文字列のチェック
26$string = "hello";
27echo "\nChecking a string:\n";
28checkIterable($string);
29
30// 整数のチェック
31$integer = 123;
32echo "\nChecking an integer:\n";
33checkIterable($integer);

PHP 8におけるis_iterable関数は、与えられた変数がiterableかどうかを判定する関数です。iterableとは、foreachループで反復処理できるデータ構造（配列やTraversableインターフェースを実装したオブジェクトなど）のことです。

is_iterable関数は、引数として任意の型の変数 $value を受け取ります。この $value がiterableであれば true を、そうでなければ false を返します。

サンプルコードでは、checkIterableという関数を定義し、様々な型の変数をis_iterable関数に渡して、その結果を表示しています。

配列（$array）はiterableなので、is_iterable($array)はtrueを返し、「The value is iterable.」と出力されます。同様に、ArrayIteratorオブジェクト（$traversable）もiterableなので、is_iterable($traversable)はtrueを返し、同じメッセージが出力されます。

一方、文字列（$string）や整数（$integer）はiterableではないので、is_iterable($string)とis_iterable($integer)はそれぞれfalseを返し、「The value is not iterable.」と出力されます。

この関数を使用することで、foreachループを実行する前に、変数がiterableかどうかを事前に確認し、エラーを回避することができます。例えば、ユーザーからの入力に基づいて処理を行う場合、入力が配列であるかを確認する際に役立ちます。

Copy
1<?php
2
3/**
4 * is_iterable 関数の使用例
5 */
6
7$array = [1, 2, 3];
8$object = new ArrayObject($array);
9$integer = 123;
10
11// 配列は iterable です
12if (is_iterable($array)) {
13    echo "配列は iterable です\n";
14} else {
15    echo "配列は iterable ではありません\n";
16}
17
18// ArrayObject は iterable です
19if (is_iterable($object)) {
20    echo "ArrayObject は iterable です\n";
21} else {
22    echo "ArrayObject は iterable ではありません\n";
23}
24
25// 整数は iterable ではありません
26if (is_iterable($integer)) {
27    echo "整数は iterable です\n";
28} else {
29    echo "整数は iterable ではありません\n";
30}
31
32?>

is_iterable() 関数は、PHP 8 で導入された、変数が iterable であるかどうかを判定する関数です。iterable とは、foreach ループで反復処理できるデータ構造のことです。具体的には、配列（array）や Traversable インターフェースを実装したオブジェクトなどが該当します。

この関数は、引数 $value に判定したい変数を渡します。引数の型は mixed 型なので、どんな型の変数でも渡すことができます。

戻り値は、bool 型です。引数 $value が iterable であれば true、そうでなければ false を返します。

サンプルコードでは、配列、ArrayObject、整数という３つの異なる型の変数を is_iterable() 関数に渡し、結果を表示しています。配列は iterable なので true、ArrayObject も iterable なので true、整数は iterable ではないので false が返されることが確認できます。

システムエンジニアを目指す上で、is_iterable() 関数は、変数の型をチェックし、安全に foreach ループを使用するために非常に役立ちます。予期せぬエラーを回避し、より堅牢なコードを作成するために、この関数の使い方を理解しておくことをお勧めします。