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

Copy
1<?php
2
3/**
4 * Demonstrates the usage of SplFixedArray::offsetSet and its relation to offsetUnset.
5 *
6 * SplFixedArray provides a fixed-size array functionality, meaning its size
7 * cannot be changed after creation.
8 * - offsetSet allows assigning a value to a specific index.
9 * - offsetUnset removes a value at a specific index, effectively setting it to null
10 *   while keeping the array's fixed size.
11 */
12function demonstrateSplFixedArrayOperations(): void
13{
14    echo "--- SplFixedArray::offsetSet and offsetUnset Demonstration ---" . PHP_EOL;
15
16    // 1. Create an SplFixedArray with a fixed size of 3 elements.
17    // The array can hold elements at indices 0, 1, and 2.
18    $fixedArray = new SplFixedArray(3);
19    echo "Initial SplFixedArray (size: " . $fixedArray->getSize() . "):" . PHP_EOL;
20    print_r($fixedArray);
21
22    // 2. Use offsetSet to assign values to specific indices.
23    // offsetSet(int $index, mixed $value) is the programmatic way to
24    // set a value at a given index. It behaves like $fixedArray[$index] = $value;.
25    $fixedArray->offsetSet(0, "Apple");
26    $fixedArray->offsetSet(1, "Banana");
27    $fixedArray->offsetSet(2, "Cherry");
28
29    echo PHP_EOL . "After setting values using offsetSet:" . PHP_EOL;
30    print_r($fixedArray);
31
32    // Attempting to set an index beyond the fixed size (e.g., index 3)
33    // would result in an OutOfRangeException.
34    // Uncomment the line below to see the error:
35    // $fixedArray->offsetSet(3, "Date");
36
37    // 3. Access elements to confirm values set by offsetSet.
38    echo "Value at index 0: " . $fixedArray->offsetGet(0) . PHP_EOL; // Access using offsetGet
39    echo "Value at index 1: " . $fixedArray[1] . PHP_EOL;             // Access using array syntax
40
41    // 4. Demonstrate offsetUnset.
42    // offsetUnset(int $index) removes the value at the specified index.
43    // For SplFixedArray, this means the element's value becomes null,
44    // but the array's size remains unchanged.
45    echo PHP_EOL . "Before calling offsetUnset(1):" . PHP_EOL;
46    print_r($fixedArray);
47
48    $fixedArray->offsetUnset(1);
49
50    echo "After calling offsetUnset(1):" . PHP_EOL;
51    print_r($fixedArray);
52
53    // After unsetting, accessing the index will return null.
54    echo "Value at index 1 after unset: " . var_export($fixedArray->offsetGet(1), true) . PHP_EOL;
55
56    echo PHP_EOL . "--- End of Demonstration ---" . PHP_EOL;
57}
58
59// Execute the demonstration function.
60demonstrateSplFixedArrayOperations();

PHP 8のSplFixedArray::offsetSetメソッドは、固定サイズの配列であるSplFixedArrayの特定のインデックスに値を設定するために使用されます。SplFixedArrayは、一度作成するとその要素数が変更できない特殊な配列です。

このoffsetSetメソッドは、int $indexで指定されたインデックス（要素番号）に、mixed $valueで指定された値を割り当てます。例えば、$fixedArray->offsetSet(0, "Apple");と記述すると、配列の0番目の要素に"Apple"という値が格納されます。これは$fixedArray[$index] = $value;という配列構文と同様の働きです。インデックスは配列のサイズ内のみ有効であり、範囲外に設定しようとするとOutOfRangeExceptionが発生しますのでご注意ください。このメソッドは値を返しません。

関連メソッドのoffsetUnsetは、指定されたインデックスの値を削除しますが、SplFixedArrayの場合、そのインデックスの値をnullに設定するだけで、配列のサイズは変わりません。offsetSetで値を設定し、offsetUnsetで値をクリアすることで、固定サイズというSplFixedArrayの特性を維持しながら要素を管理します。

Copy
1<?php
2
3/**
4 * SplFixedArray の offsetSet メソッドと offsetGet メソッドの基本的な使用方法を示す関数。
5 *
6 * SplFixedArray は、事前にサイズが固定された配列を提供するPHPの標準拡張クラスです。
7 * offsetSet は指定したインデックスに値を設定し、offsetGet は指定したインデックスの値を取得します。
8 * これらのメソッドは、通常の配列アクセス（$array[$index] = $value; や $value = $array[$index];）の
9 * 背後で呼び出される ArrayAccess インターフェースの一部でもあります。
10 */
11function demonstrateSplFixedArrayOffsetOperations(): void
12{
13    // サイズが3のSplFixedArrayインスタンスを初期化します。
14    // 配列のサイズは固定され、この例では0から2までのインデックスを使用できます。
15    $fixedArray = new SplFixedArray(3);
16
17    echo "--- SplFixedArray 初期化時の内容 (デフォルトは null) ---\n";
18    // 初期状態を表示。要素はデフォルトで null が設定されています。
19    foreach ($fixedArray as $index => $value) {
20        echo "インデックス {$index}: " . var_export($value, true) . "\n";
21    }
22    echo "\n";
23
24    // offsetSet メソッドを使用して値を設定します。
25    // 第1引数はインデックス、第2引数は設定する値です。
26    echo "--- offsetSet を使用して値を設定 ---\n";
27    $fixedArray->offsetSet(0, "PHP");
28    $fixedArray->offsetSet(1, 8);
29    // SplFixedArray は ArrayAccess インターフェースを実装しているため、
30    // 配列のように角括弧 [] を使って値を設定することもできます。
31    // これは内部的には offsetSet メソッドを呼び出します。
32    $fixedArray[2] = true;
33
34    echo "値を設定後の SplFixedArray の内容:\n";
35    foreach ($fixedArray as $index => $value) {
36        echo "インデックス {$index}: " . var_export($value, true) . "\n";
37    }
38    echo "\n";
39
40    // offsetGet メソッドを使用して値を取得します。
41    // 引数として取得したいインデックスを指定します。
42    echo "--- offsetGet を使用して値を取得 ---\n";
43    $valueAtIndex0 = $fixedArray->offsetGet(0);
44    echo "インデックス 0 の値: " . var_export($valueAtIndex0, true) . "\n";
45
46    $valueAtIndex1 = $fixedArray->offsetGet(1);
47    echo "インデックス 1 の値: " . var_export($valueAtIndex1, true) . "\n";
48
49    // offsetGet と同様に、配列のように角括弧 [] を使って値を取得することもできます。
50    // これは内部的には offsetGet メソッドを呼び出します。
51    $valueAtIndex2 = $fixedArray[2];
52    echo "インデックス 2 の値: " . var_export($valueAtIndex2, true) . "\n";
53    echo "\n";
54
55    // 補足: SplFixedArray の固定サイズを超えてアクセスしようとすると、
56    // RuntimeException がスローされます。
57    // 例: $fixedArray->offsetSet(3, "OutOfBoundsValue"); // この行はエラーになります
58}
59
60// サンプル関数を実行します。
61demonstrateSplFixedArrayOffsetOperations();

PHPのSplFixedArrayは、事前に要素数が固定された配列を提供する標準拡張クラスです。このクラスは、一度サイズを決定するとそのサイズを超える要素の追加はできませんが、特定の条件下で通常の配列よりも効率的に動作する利点があります。

offsetSetメソッドは、SplFixedArrayインスタンスの指定されたインデックスに値を設定するために使われます。第1引数$indexには、値を設定したい配列のインデックスを整数で指定します。第2引数$valueには、そのインデックスに格納したい任意の型の値を渡します。このメソッドは、値を設定する操作のみを行い、特に戻り値はありません。

関連するoffsetGetメソッドは、指定したインデックスの値を安全に取得する際に使用します。引数$indexに取得したいインデックスを整数で指定すると、その位置に格納されている値が返されます。

SplFixedArrayはArrayAccessインターフェースを実装しているため、$fixedArray[0] = "値";のように通常の配列と同じ角括弧[]シンタックスを使って値の設定や取得が可能です。これらの操作は、内部的にoffsetSetやoffsetGetメソッドを呼び出しています。

提供されたサンプルコードでは、サイズ3のSplFixedArrayを作成し、offsetSetメソッドや角括弧[]を使って各インデックスに値を設定しています。その後、offsetGetメソッドや角括弧[]を用いて設定された値を取得し、表示することでこれらのメソッドの基本的な使い方を示しています。SplFixedArrayは固定サイズのため、存在しないインデックスにアクセスしようとするとエラーが発生することに注意が必要です。