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

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList の offsetSet および offsetUnset メソッドの使用例を示します。
5 *
6 * SplDoublyLinkedList は、両端キュー（deque）としても利用できるリスト構造です。
7 * offsetSet は、特定のインデックスに値を設定（追加または更新）するために使用されます。
8 * offsetUnset は、特定のインデックスの要素を削除するために使用されます。
9 */
10
11// SplDoublyLinkedList の新しいインスタンスを作成します。
12$list = new SplDoublyLinkedList();
13
14// リストに初期データをいくつか追加します。
15$list->push('Apple');    // インデックス0に 'Apple'
16$list->push('Banana');   // インデックス1に 'Banana'
17$list->push('Cherry');   // インデックス2に 'Cherry'
18
19echo "--- 初期状態 ---" . PHP_EOL;
20foreach ($list as $index => $value) {
21    echo "[$index] => $value" . PHP_EOL;
22}
23echo "現在の要素数: " . $list->count() . PHP_EOL . PHP_EOL;
24
25// --- offsetSet の使用例 ---
26
27// 既存のインデックスの値を更新します。
28// インデックス1の 'Banana' を 'Blueberry' に変更します。
29$list->offsetSet(1, 'Blueberry');
30echo "--- offsetSet(1, 'Blueberry') 後 (既存要素の更新) ---" . PHP_EOL;
31foreach ($list as $index => $value) {
32    echo "[$index] => $value" . PHP_EOL;
33}
34echo "現在の要素数: " . $list->count() . PHP_EOL . PHP_EOL;
35
36// 存在しないインデックスに値を設定します。
37// SplDoublyLinkedList では、これはリストの末尾への追加として扱われます。
38// 現在の要素数は3なので、インデックス3に 'Date' を追加します。
39$list->offsetSet(3, 'Date');
40echo "--- offsetSet(3, 'Date') 後 (新規要素の追加) ---" . PHP_EOL;
41foreach ($list as $index => $value) {
42    echo "[$index] => $value" . PHP_EOL;
43}
44echo "現在の要素数: " . $list->count() . PHP_EOL . PHP_EOL;
45
46// --- キーワード 'offsetUnset' の関連使用例 ---
47
48// offsetUnset を使用して、特定のインデックスの要素を削除します。
49// インデックス2の 'Cherry' を削除します。
50$list->offsetUnset(2);
51echo "--- offsetUnset(2) 後 (要素の削除) ---" . PHP_EOL;
52foreach ($list as $index => $value) {
53    echo "[$index] => $value" . PHP_EOL;
54}
55echo "現在の要素数: " . $list->count() . PHP_EOL . PHP_EOL;
56
57// 削除されたインデックスの後の要素は、自動的にインデックスが詰められます。
58// 例えば、インデックス3だった 'Date' はインデックス2になります。
59echo "--- 削除後の要素とインデックスの確認 ---" . PHP_EOL;
60// getIteratorMode を設定することで、順方向のイテレーションと常に有効なインデックスを取得できます。
61$list->setIteratorMode(SplDoublyLinkedList::IT_MODE_FIFO | SplDoublyLinkedList::IT_MODE_KEEP_INDEX);
62foreach ($list as $index => $value) {
63    echo "[$index] => $value" . PHP_EOL;
64}
65echo "最終要素数: " . $list->count() . PHP_EOL;
66
67?>

PHPのSplDoublyLinkedListは、両端キューとしても利用できるリスト構造を提供するクラスです。このクラスのoffsetSetメソッドは、リスト内の特定のインデックスに値を設定するために使用されます。引数$indexには値を設定したい位置を、$valueには設定するデータを指定します。

offsetSetは、すでにデータが存在するインデックスを指定した場合、その位置の既存の値を新しい$valueで更新します。一方、現在のリストに存在しないインデックス（例えば、現在の要素数を超えるインデックス）を指定して値を設定すると、その値はリストの末尾に新しい要素として追加されます。このメソッドは戻り値がありません。

サンプルコードでは、まずpushで初期データを追加し、その後offsetSetを使ってインデックス1の要素を更新したり、存在しないインデックス3に新しい要素を追加したりしています。

また、関連キーワードであるoffsetUnsetメソッドも重要です。これは、指定したインデックスの要素をリストから削除するために使用されます。要素が削除されると、その後ろの要素は自動的にインデックスが詰められ、リストの整合性が保たれます。サンプルコードでは、offsetUnset(2)によってインデックス2の要素を削除し、その後インデックスがどのように変化するかを示しています。

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList の offsetSet メソッドの使用例を示します。
5 * offsetSet は、指定されたインデックスの要素を新しい値に置き換えます。
6 */
7function demonstrateSplDoublyLinkedListOffsetSet(): void
8{
9    // SplDoublyLinkedList のインスタンスを作成します。
10    $list = new SplDoublyLinkedList();
11
12    // いくつかの要素をリストに追加します。
13    $list->push('Apple');   // インデックス 0
14    $list->push('Banana');  // インデックス 1
15    $list->push('Cherry');  // インデックス 2
16
17    echo "--- 初期状態のリスト ---" . PHP_EOL;
18    // リストの内容を表示して初期状態を確認します。
19    for ($i = 0; $i < $list->count(); $i++) {
20        echo "インデックス {$i}: " . $list->offsetGet($i) . PHP_EOL;
21    }
22    echo PHP_EOL;
23
24    // offsetSet を使用して、インデックス 1 の要素を 'Grape' に変更します。
25    // 元の値 'Banana' が 'Grape' に置き換えられます。
26    $list->offsetSet(1, 'Grape');
27
28    echo "--- offsetSet 後 (インデックス 1 を変更) ---" . PHP_EOL;
29    // 変更が適用されたことを確認するために、再度リストの内容を表示します。
30    for ($i = 0; $i < $list->count(); $i++) {
31        echo "インデックス {$i}: " . $list->offsetGet($i) . PHP_EOL;
32    }
33    echo PHP_EOL;
34
35    // offsetSet を使用して、インデックス 0 の要素を 'Orange' に変更します。
36    $list->offsetSet(0, 'Orange');
37
38    echo "--- offsetSet 後 (インデックス 0 を変更) ---" . PHP_EOL;
39    // 変更が適用されたことを確認します。
40    for ($i = 0; $i < $list->count(); $i++) {
41        echo "インデックス {$i}: " . $list->offsetGet($i) . PHP_EOL;
42    }
43    echo PHP_EOL;
44}
45
46// 関数を実行します。
47demonstrateSplDoublyLinkedListOffsetSet();

PHP 8のSplDoublyLinkedList::offsetSetメソッドは、SplDoublyLinkedListクラスに属し、リスト内の指定されたインデックスにある要素を新しい値に置き換える際に使用されます。このメソッドは、既存のリストの特定の位置にあるデータを更新する機能を提供します。

引数としては、更新したい要素の位置を示す$indexと、その位置に設定したい新しい値を示す$valueの二つを受け取ります。$indexはリストの先頭を0とする整数で、$valueには文字列、数値など、あらゆるデータ型を指定できます。メソッドを実行すると、指定された$indexに存在する要素は$valueによって上書きされ、リストの内容が変更されます。このメソッド自体は何も値を返しません。

提供されたサンプルコードでは、まず「Apple」「Banana」「Cherry」といった要素が追加されたSplDoublyLinkedListを作成し、初期状態を表示しています。その後、$list->offsetSet(1, 'Grape');を実行することで、インデックス1に元々あった「Banana」を「Grape」に置き換えています。さらに、インデックス0の要素を「Orange」に変更する例も示されており、offsetGetメソッドを用いて変更後のリストの状態を確認することで、offsetSetが正しく要素を更新していることが理解できます。