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

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList::offsetUnset の使用例を示す関数です。
5 * このメソッドは、リスト内の指定されたインデックスにある要素を削除します。
6 *
7 * @return void
8 */
9function demonstrateOffsetUnset(): void
10{
11    echo "SplDoublyLinkedList::offsetUnset の使用例\n";
12    echo "-------------------------------------\n\n";
13
14    // SplDoublyLinkedList の新しいインスタンスを作成します。
15    // SplDoublyLinkedList は、要素を両端から効率的に追加・削除できるリストです。
16    $list = new SplDoublyLinkedList();
17
18    // リストにいくつかの要素を追加します。
19    // push() メソッドはリストの末尾に要素を追加します。
20    $list->push('Apple');  // インデックス 0
21    $list->push('Banana'); // インデックス 1
22    $list->push('Cherry'); // インデックス 2
23    $list->push('Date');   // インデックス 3
24
25    echo "--- 初期状態のリスト ---\n";
26    // リストの要素とインデックスを表示します。
27    foreach ($list as $key => $value) {
28        echo "  Index {$key}: {$value}\n";
29    }
30    echo "現在のリストの要素数: " . $list->count() . "\n\n";
31
32    // 削除したい要素のインデックスを指定します。
33    $indexToRemove = 1; // 'Banana' を削除します。
34
35    echo "--- インデックス {$indexToRemove} の要素を削除 ---\n";
36    try {
37        // offsetUnset() メソッドを呼び出して、指定されたインデックスの要素を削除します。
38        // 指定されたインデックスが存在しない場合、OutOfBoundsException がスローされます。
39        $list->offsetUnset($indexToRemove);
40        echo "インデックス {$indexToRemove} の要素を削除しました。\n\n";
41    } catch (OutOfBoundsException $e) {
42        echo "エラー: 指定されたインデックス {$indexToRemove} はリストの範囲外です。\n";
43        echo "詳細: " . $e->getMessage() . "\n\n";
44    }
45
46    echo "--- 削除後のリスト ---\n";
47    // 削除後のリストの要素とインデックスを再度表示します。
48    // 削除された要素が消え、後続の要素のインデックスが再配置されていることを確認できます。
49    foreach ($list as $key => $value) {
50        echo "  Index {$key}: {$value}\n";
51    }
52    echo "現在のリストの要素数: " . $list->count() . "\n\n";
53
54    // 存在しないインデックスを削除しようとした場合の例
55    $invalidIndex = 10;
56    echo "--- 存在しないインデックス {$invalidIndex} の要素を削除しようとする ---\n";
57    try {
58        $list->offsetUnset($invalidIndex);
59        // ここには到達しません。
60        echo "インデックス {$invalidIndex} の要素を削除しました。\n\n";
61    } catch (OutOfBoundsException $e) {
62        echo "エラー: 指定されたインデックス {$invalidIndex} はリストの範囲外です。\n";
63        echo "詳細: " . $e->getMessage() . "\n\n";
64    }
65
66    echo "--- 最終状態のリスト ---\n";
67    foreach ($list as $key => $value) {
68        echo "  Index {$key}: {$value}\n";
69    }
70    echo "現在のリストの要素数: " . $list->count() . "\n\n";
71}
72
73// 上記の関数を実行して、SplDoublyLinkedList::offsetUnset の動作を確認します。
74demonstrateOffsetUnset();

PHP 8で提供されるSplDoublyLinkedListクラスのoffsetUnsetメソッドは、リスト内の指定されたインデックスにある要素を削除するために使用されます。引数mixed $offsetには、削除したい要素のインデックス（位置）を整数で渡します。このメソッドは要素を削除するだけで、特に戻り値を返しません。

サンプルコードでは、まずSplDoublyLinkedListの新しいインスタンスを作成し、「Apple」「Banana」「Cherry」「Date」といった複数の要素をリストの末尾に追加しています。初期状態のリストを確認した後、$list->offsetUnset(1)と呼び出すことで、インデックス1に位置する「Banana」がリストから削除されます。削除後には、後続の要素のインデックスが自動的に再配置され、リストの要素数が減少していることが確認できます。

重要な点として、指定したインデックスがリストの有効な範囲外である場合、OutOfBoundsExceptionという例外がスローされます。サンプルコードでは、try-catchブロックを用いてこの例外を捕捉し、エラーメッセージを表示することで、不正なインデックス指定によるプログラムの異常終了を防ぐ安全な処理が示されています。これにより、リスト内の特定の要素を柔軟かつ安全に削除することが可能になります。

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList の offsetUnset メソッドの動作をデモンストレーションします。
5 * このメソッドは、ArrayAccess インターフェース経由で unset() 関数を使用することで呼び出されます。
6 * キーワード「php offset エラー」に関連して、存在しないオフセットを削除しようとしても
7 * PHPの実行時エラーや警告が発生しない点に注目します。
8 */
9function demonstrateSplDoublyLinkedListOffsetUnset(): void
10{
11    echo "--- SplDoublyLinkedList::offsetUnset のデモンストレーション ---" . PHP_EOL;
12
13    // 1. SplDoublyLinkedList を初期化し、いくつかの要素を追加します。
14    $list = new SplDoublyLinkedList();
15    $list->push('Apple');
16    $list->push('Banana');
17    $list->push('Cherry');
18    $list->push('Date');
19
20    echo "\n[1] 初期リストの状態:" . PHP_EOL;
21    echo "  リストのサイズ: " . $list->count() . PHP_EOL;
22    foreach ($list as $offset => $value) {
23        echo "  - オフセット {$offset}: {$value}" . PHP_EOL;
24    }
25
26    // 2. 存在するオフセットの要素を削除します。
27    // unset($list[$offset]) 構文を使用すると、内部的に offsetUnset メソッドが呼び出されます。
28    $offsetToRemove = 1; // 'Banana'
29    echo "\n[2] オフセット {$offsetToRemove} の要素を削除 (unset(\$list[{$offsetToRemove}])):" . PHP_EOL;
30    unset($list[$offsetToRemove]);
31
32    echo "  削除後のリストの状態:" . PHP_EOL;
33    echo "  リストのサイズ: " . $list->count() . PHP_EOL;
34    foreach ($list as $offset => $value) {
35        echo "  - オフセット {$offset}: {$value}" . PHP_EOL;
36    }
37    // 注: 要素が削除されると、残りの要素のインデックスは自動的に再割り当てされ、連番が維持されます。
38    // 例: 'Apple' (0), 'Cherry' (1), 'Date' (2) となります。
39
40    // 3. 存在しないオフセットの要素を削除しようとします。
41    // SplDoublyLinkedList::offsetUnset は、存在しないオフセットに対して呼び出されても
42    // PHPのエラー（Fatal error, Warning, Noticeなど）を発生させません。
43    $nonExistentOffset = 100;
44    echo "\n[3] 存在しないオフセット {$nonExistentOffset} の要素を削除しようと試みる (unset(\$list[{$nonExistentOffset}])):" . PHP_EOL;
45    unset($list[$nonExistentOffset]);
46
47    echo "  操作後のリストの状態 (変更なし):" . PHP_EOL;
48    echo "  リストのサイズ: " . $list->count() . PHP_EOL;
49    foreach ($list as $offset => $value) {
50        echo "  - オフセット {$offset}: {$value}" . PHP_EOL;
51    }
52    echo "  => 存在しないオフセットを削除しようとしても、エラーは発生せず、リストも変更されませんでした。" . PHP_EOL;
53}
54
55// デモンストレーション関数を実行します。
56demonstrateSplDoublyLinkedListOffsetUnset();

PHPのSplDoublyLinkedListクラスに属するoffsetUnsetメソッドは、両方向リストから指定された位置（オフセット）の要素を削除するために使用されます。このメソッドは直接呼び出すのではなく、unset($list[$offset])という配列のような構文を通じて間接的に利用されます。引数$offsetには削除したい要素のインデックスを指定し、どのような型の値でも指定できます。戻り値は特にありません。

サンプルコードでは、まずSplDoublyLinkedListを初期化し、いくつかの要素を追加します。次に、存在するオフセット1の要素をunset()で削除すると、リストから「Banana」が取り除かれ、残りの要素のインデックスが自動的に詰められて再割り当てされる様子を示しています。

特に重要な点として、このメソッドは存在しないオフセットを指定して削除しようとしても、PHPの実行時エラーや警告（Warning、Noticeなど）を発生させません。リストの状態は変更されず、処理は静かに完了します。これは、キーワード「php offset エラー」で検索されるような状況で、エラーが発生しないという挙動を知っておくことが、システム開発において安全なコードを書く上で役立ちます。