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

Copy
1<?php
2
3// SplDoublyLinkedList は、PHP の標準ライブラリ (SPL) で提供される、
4// 双方向連結リストを実装するクラスです。
5// このサンプルコードは、SplDoublyLinkedList の 'count' メソッドが
6// どのように動作するか、特にリストに 'null' 値が含まれる場合にどうなるかを示します。
7
8// 1. 空のリストを作成し、その要素数をカウントします。
9$emptyList = new SplDoublyLinkedList();
10echo "空のリストの要素数: " . $emptyList->count() . "\n"; // 期待される出力: 0
11
12// 2. さまざまな要素（文字列、数値、真偽値、および 'null' 値）を持つリストを作成します。
13$listWithVariousElements = new SplDoublyLinkedList();
14
15// リストに要素を追加します。
16$listWithVariousElements->push('Hello');       // 文字列
17$listWithVariousElements->push(123);           // 整数
18$listWithVariousElements->push(null);          // null 値
19$listWithVariousElements->push(true);          // 真偽値
20$listWithVariousElements->push(null);          // 別の null 値
21
22echo "\n--- 要素を含むリストの操作 ---\n";
23
24// 要素を追加した後のリストの要素数をカウントします。
25// SplDoublyLinkedList の count メソッドは、null 値も1つの有効な要素として数えます。
26echo "要素追加後のリストの要素数: " . $listWithVariousElements->count() . "\n"; // 期待される出力: 5
27
28// リスト内の各要素とその型を表示し、null が要素として扱われていることを確認します。
29echo "リスト内の要素:\n";
30foreach ($listWithVariousElements as $index => $value) {
31    // var_export を使用して null を 'NULL' と表示させ、分かりやすくします。
32    echo "  要素[" . $index . "]: " . var_export($value, true) . " (型: " . gettype($value) . ")\n";
33}
34
35// 3. リストから要素を削除した場合のカウントを確認します。
36$listWithVariousElements->pop(); // リストの末尾の要素 (2つ目の 'null') を削除します。
37echo "\n--- 要素削除後のリストの操作 ---\n";
38echo "要素削除後のリストの要素数: " . $listWithVariousElements->count() . "\n"; // 期待される出力: 4
39
40// 結論:
41// SplDoublyLinkedList の 'count' メソッドは、リスト内に存在する 'null' 値も
42// 他のデータ型と同様に1つの有効な要素としてカウントします。
43// これは、PHP の組み込み関数である 'count()' が 'null' を渡された場合に 0 を返す挙動とは異なります。
44
45?>

PHP 8で提供されるSplDoublyLinkedListクラスは、双方向連結リストというデータ構造を実装しており、要素を効率的に追加・削除できる特徴があります。このクラスのcountメソッドは、リストに現在いくつの要素が含まれているかを知りたいときに使用します。このメソッドは引数を取りません。リストの要素数を整数型（int）で正確に返します。

特に注目すべきは、SplDoublyLinkedList::countメソッドが、リスト内にnull値が存在する場合でも、それを他のデータ型（文字列や数値など）と同じように1つの有効な要素として数える点です。例えば、'apple', 100, null, trueといった要素がリストに含まれている場合、countメソッドは「4」を返します。これは、PHPの組み込み関数であるcount()が、直接nullを渡された場合に0を返す挙動とは異なりますので、混同しないよう注意が必要です。

サンプルコードでは、空のリストが0を返すことから始まり、null値を含む複数の要素を追加したリストが正確な要素数（例えば5）を返すことを示しています。さらに、リストから要素を削除すると、その変更が即座にcountメソッドの戻り値に反映されることも確認できます。これにより、SplDoublyLinkedList::countメソッドは、リスト内のあらゆるデータを有効な要素として扱い、その合計数を常に正確に提供することが理解できます。

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList の count() メソッドの使用例を示します。
5 * このメソッドはリスト内の要素の数を返します。
6 */
7
8// SplDoublyLinkedList クラスの新しいインスタンスを作成します。
9// このクラスは両方向から要素の追加・削除が可能な連結リストを実装しています。
10$list = new SplDoublyLinkedList();
11
12// リストに要素を追加します。
13// push() メソッドはリストの末尾に要素を追加します。
14$list->push('apple');
15$list->push('banana');
16
17// unshift() メソッドはリストの先頭に要素を追加します。
18$list->unshift('orange');
19
20// SplDoublyLinkedList::count() メソッドを使用して、リスト内の現在の要素数を取得します。
21// このメソッドは引数を受け取らず、リスト内の要素の総数を整数 (int) で返します。
22$itemCount = $list->count();
23
24// 取得した要素数を出力します。
25echo "現在のリスト内の要素数: " . $itemCount . "\n";
26
27// さらに要素を追加してから、もう一度要素数を数えてみます。
28$list->push('grape');
29$list->push('melon');
30
31$itemCountAfterAddition = $list->count();
32echo "要素追加後のリスト内の要素数: " . $itemCountAfterAddition . "\n";
33
34?>

PHPのSplDoublyLinkedList::count()メソッドは、特定のデータ構造である「連結リスト」に含まれる要素の総数を取得するために使用されます。このメソッドについて、サンプルコードを交えて説明します。

まず、SplDoublyLinkedListは、要素を前からも後ろからも効率的に追加・削除できる「両方向連結リスト」をPHPで扱うためのクラスです。サンプルコードでは、このSplDoublyLinkedListの新しいインスタンスを作成し、push()メソッド（リストの末尾に追加）やunshift()メソッド（リストの先頭に追加）を使っていくつかの要素を追加しています。

SplDoublyLinkedList::count()メソッドは、現在のリスト内にいくつの要素があるかを数え、その数を返します。このメソッドは引数を受け取りません。戻り値は常に**整数（int型）**で、リスト内の要素の総数を正確に示します。

サンプルコードでは、要素をいくつか追加した後に$itemCount = $list->count();としてメソッドを呼び出し、その時点での要素数「3」を取得しています。さらに追加で要素（'grape', 'melon'）を投入した後、もう一度count()メソッドを呼び出すと、更新された要素数「5」が取得できることを確認できます。これにより、リストの内容が変化するたびに正確な要素数を把握できることがわかります。このメソッドは、リストのサイズ管理や繰り返し処理の範囲決定など、様々な場面で役立ちます。