【PHP8.x】SplFixedArray::offsetUnset()メソッドの使い方

Copy
1<?php
2
3/**
4 * SplFixedArray::offsetUnset メソッドの使用例を示します。
5 *
6 * SplFixedArray は固定サイズの配列であり、offsetUnset は指定されたインデックスの要素を
7 * 未設定の状態にします。配列のサイズ自体は変更されません。
8 */
9function demonstrateSplFixedArrayOffsetUnset(): void
10{
11    echo "--- SplFixedArray::offsetSet および offsetUnset のデモンストレーション ---\n\n";
12
13    // 1. サイズ3の SplFixedArray を作成します。
14    $fixedArray = new SplFixedArray(3);
15    echo "初期状態の SplFixedArray:\n";
16    print_r($fixedArray);
17
18    // 2. offsetSet メソッドまたは配列アクセスで要素を設定します。
19    $fixedArray->offsetSet(0, "Apple"); // offsetSet を明示的に使用
20    $fixedArray[1] = "Banana";          // 配列アクセス形式も内部的に offsetSet を使用
21    $fixedArray->offsetSet(2, "Cherry");
22
23    echo "要素設定後の SplFixedArray:\n";
24    print_r($fixedArray);
25    echo "現在のサイズ: " . $fixedArray->getSize() . "\n\n";
26
27    // 3. インデックス1の要素を offsetUnset メソッドで解除します。
28    $indexToUnset = 1;
29    echo "インデックス {$indexToUnset} の要素を offsetUnset で解除します...\n";
30    $fixedArray->offsetUnset($indexToUnset);
31
32    echo "解除後の SplFixedArray:\n";
33    print_r($fixedArray);
34    echo "現在のサイズ: " . $fixedArray->getSize() . " (サイズは変わりません)\n\n";
35
36    // 4. 解除されたインデックスの状態を確認します。
37    echo "解除されたインデックス {$indexToUnset} の値:\n";
38    var_dump($fixedArray[$indexToUnset]); // null が返されます
39    echo "isset(fixedArray[{$indexToUnset}]):\n";
40    var_dump(isset($fixedArray[$indexToUnset])); // false が返されます
41
42    echo "\n--- デモンストレーション終了 ---\n";
43}
44
45// 関数を実行してデモンストレーションを開始します。
46demonstrateSplFixedArrayOffsetUnset();
47

PHPのSplFixedArrayは、あらかじめサイズを固定して使用する特殊な配列です。このSplFixedArrayクラスのoffsetUnsetメソッドは、指定されたインデックスの要素を「未設定」の状態にするために使われます。引数として解除したい要素のインデックス（整数値）を指定しますが、このメソッド自体は戻り値を返しません。

サンプルコードでは、まずサイズ3のSplFixedArrayを初期化し、offsetSetメソッドや通常の配列アクセス（例: $fixedArray[1] = "Banana";）を用いて各要素に値を設定しています。これらの方法はいずれも、指定したインデックスに値を格納する際に使われます。

その後、offsetUnsetメソッドを呼び出し、インデックス1の要素を未設定にしています。ここで特に重要なのは、要素を未設定にしてもSplFixedArrayの全体的なサイズは変わらないという点です。配列の構造自体は保持され、指定されたインデックスの場所だけが空の状態になります。

未設定になった要素にアクセスすると、その値はnullとして扱われます。また、その要素が設定されているかを判定するisset関数を使用するとfalseが返されることから、実際に要素が「ない」状態になっていることが確認できます。このように、offsetUnsetは固定長配列のサイズを変更せずに、特定の要素を未設定にする機能を提供します。

Copy
1<?php
2
3/**
4 * SplFixedArray::offsetUnset の使用例と、範囲外オフセットによるエラーのハンドリングを示します。
5 *
6 * SplFixedArray は固定サイズの配列であり、通常の PHP 配列とは異なり、
7 * 存在しないオフセットに対して offsetUnset を呼び出すと OutOfRangeException をスローします。
8 * この挙動が「php offset エラー」というキーワードに関連する点です。
9 */
10function demonstrateSplFixedArrayOffsetUnsetErrors(): void
11{
12    // サイズ 3 の SplFixedArray を作成し、初期値を設定
13    $fixedArray = new SplFixedArray(3);
14    $fixedArray[0] = 'First';
15    $fixedArray[1] = 'Second';
16    $fixedArray[2] = 'Third';
17
18    echo "初期の SplFixedArray: [" . implode(', ', $fixedArray->toArray()) . "]\n";
19    echo "配列の現在のサイズ: " . $fixedArray->getSize() . "\n\n";
20
21    // 1. 存在するオフセットの要素を削除 (offsetUnset)
22    // 指定されたインデックスの要素を null に設定します。配列のサイズは変わりません。
23    echo "--- 存在するオフセット 1 の要素を削除 (offsetUnset(1)) ---\n";
24    $fixedArray->offsetUnset(1);
25    echo "削除後 SplFixedArray: [" . implode(', ', $fixedArray->toArray()) . "]\n";
26    echo "配列のサイズは変わりません: " . $fixedArray->getSize() . "\n\n";
27
28    // 2. 存在しないオフセットの要素を削除しようとした場合のエラーハンドリング
29    // SplFixedArray は厳密な範囲チェックを行うため、範囲外のインデックスを指定すると
30    // OutOfRangeException がスローされます。
31    echo "--- 存在しないオフセット 5 の要素を削除 (offsetUnset(5)) でエラー発生 ---\n";
32    try {
33        $fixedArray->offsetUnset(5); // 存在しないインデックス (0-2 の範囲外)
34    } catch (OutOfRangeException $e) {
35        echo "エラーをキャッチしました: " . $e->getMessage() . "\n";
36        echo "SplFixedArray::offsetUnset は、指定されたインデックスが範囲外の場合、"
37             . "OutOfRangeException をスローします。これが 'php offset エラー' の典型的な例です。\n";
38    }
39
40    echo "\n--- デモンストレーション終了 ---\n";
41}
42
43// 関数を実行してデモンストレーションを開始
44demonstrateSplFixedArrayOffsetUnsetErrors();
45

このサンプルコードは、PHPのSplFixedArrayクラスが提供するoffsetUnsetメソッドの使い方と、それに伴う「php offset エラー」のハンドリング方法を示しています。SplFixedArrayは、通常のPHP配列とは異なり、一度サイズが決められると要素の数を変更できない固定サイズの配列です。

offsetUnsetメソッドは、引数として渡されたint $indexに該当する要素の値をnullに設定します。この操作によって配列の総サイズが変化することはありません。また、このメソッドは特定の戻り値を返しません。

コードの最初の部分では、存在するインデックス（例として1）に対してoffsetUnsetを呼び出し、指定された要素がnullになる様子を確認できます。

特に重要なのは、SplFixedArrayがインデックスの範囲に対して非常に厳格である点です。サンプルコードの後半では、配列の実際のサイズを超える範囲外のインデックス（例として5）を指定してoffsetUnsetを呼び出すと、OutOfRangeExceptionというエラーがスローされることを示しています。これは、SplFixedArrayで発生する「php offset エラー」の典型例です。try-catchブロックを使うことで、このようなエラーを捕捉し、プログラムの予期せぬ停止を防ぐエラーハンドリングの重要性も理解できます。SplFixedArrayを利用する際は、常にインデックスの有効範囲に注意して操作を行う必要があります。