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

Copy
1<?php
2
3/**
4 * SplQueue::count メソッドの使用例と、null値の扱いを示します。
5 * SplQueue は、PHPの標準ライブラリ（SPL）が提供するキュー（先入れ先出し）データ構造です。
6 * count() メソッドは、キュー内の要素の数を返します。
7 * null値もキューの有効な要素としてカウントされます。
8 */
9
10// SplQueue クラスの新しいインスタンスを作成します。
11$queue = new SplQueue();
12
13echo "初期状態のキューの要素数: " . $queue->count() . "\n"; // 出力: 0
14
15// キューにいくつかの要素を追加します。
16$queue->enqueue("First item");
17$queue->enqueue(123);
18echo "2つの要素を追加した後のキューの要素数: " . $queue->count() . "\n"; // 出力: 2
19
20// キーワード「null」に関連付けて、キューにnull値を追加します。
21// null値も他のデータ型と同様にキューの要素として扱われ、count()で数えられます。
22$queue->enqueue(null);
23echo "null値を追加した後のキューの要素数: " . $queue->count() . "\n"; // 出力: 3
24
25// キューから要素を取り出します（先入れ先出しなので、最初に追加した要素から取り出されます）。
26$item1 = $queue->dequeue(); // "First item" が取り出される
27echo "1つの要素を取り出した後のキューの要素数: " . $queue->count() . "\n"; // 出力: 2
28echo "取り出された要素1: " . var_export($item1, true) . "\n";
29
30$item2 = $queue->dequeue(); // 123 が取り出される
31echo "さらに1つの要素を取り出した後のキューの要素数: " . $queue->count() . "\n"; // 出力: 1
32echo "取り出された要素2: " . var_export($item2, true) . "\n";
33
34// null値が取り出されることを確認します。
35$item3 = $queue->dequeue(); // null が取り出される
36echo "null値を取り出した後のキューの要素数: " . $queue->count() . "\n"; // 出力: 0
37echo "取り出された要素3: " . var_export($item3, true) . "\n";
38
39?>

PHP 8のSplQueueクラスは、プログラム内でデータを先入れ先出し（FIFO）の順序で管理する「キュー」データ構造を提供します。このSplQueue::countメソッドは、現在キュー内に格納されている要素の総数を整数値（int）として返します。このメソッドは引数を一切必要としません。

サンプルコードでは、SplQueueの新しいインスタンスを作成した初期状態からcount()メソッドを使用し、要素数が0であることを示しています。その後、enqueue()メソッドで文字列や数値といった要素をキューに追加していくと、count()の値が適切に増加していく様子が確認できます。特に、null値もキューの有効な要素として認識され、count()によって他のデータ型と同様に正確に数えられる点が重要です。null値を追加した後も、要素数は正しく増えています。さらに、dequeue()メソッドでキューから要素を順番に取り出すたびに、count()の値が減少し、キュー内の残りの要素数を正確に反映していることがわかります。このように、SplQueue::countは、キューの現在のサイズを簡潔に取得するための便利なメソッドです。

Copy
1<?php
2
3/**
4 * SplQueue クラスは、キュー（待ち行列）データ構造を実装します。
5 * このサンプルコードでは、SplQueue::count() メソッドを使用して、
6 * キュー内の要素数を取得する方法を示します。
7 */
8
9// SplQueue オブジェクトを新しく作成します。
10$queue = new SplQueue();
11
12// 初期状態のキューの要素数を確認します。
13// count() メソッドは現在の要素数を整数で返します。
14echo "初期状態のキューの要素数: " . $queue->count() . "\n"; // 出力: 0
15
16// キューに要素を追加します (enqueue)。
17$queue->enqueue("タスク A");
18$queue->enqueue("タスク B");
19$queue->enqueue("タスク C");
20
21// 要素を追加した後のキューの要素数を確認します。
22echo "3つの要素を追加後のキューの要素数: " . $queue->count() . "\n"; // 出力: 3
23
24// キューから要素を取り出します (dequeue)。
25// キューはFIFO (First-In, First-Out) の原則に従います。
26$firstItem = $queue->dequeue();
27echo "取り出した要素: " . $firstItem . "\n"; // 出力: タスク A
28
29// 1つの要素を取り出した後のキューの要素数を確認します。
30echo "1つの要素を取り出し後のキューの要素数: " . $queue->count() . "\n"; // 出力: 2
31
32// 残りの要素をすべて取り出します。
33$queue->dequeue();
34$queue->dequeue();
35
36// すべての要素を取り出した後のキューの要素数を確認します。
37echo "すべての要素を取り出し後のキューの要素数: " . $queue->count() . "\n"; // 出力: 0
38
39?>

PHPのSplQueueクラスは、データが先に入れたものから先に取り出される「キュー（待ち行列）」というデータ構造を実装するものです。このSplQueueクラスに属するcount()メソッドは、現在キューの中にいくつの要素が格納されているかを調べたいときに使用します。

count()メソッドは引数を一切必要とせず、キュー内の現在の要素数を整数（int）として返します。例えば、新しくSplQueueオブジェクトを作成した直後では、まだ何も要素がないためcount()は0を返します。

サンプルコードでは、最初に空のキューの要素数をcount()で確認し、0が出力されることを示しています。次に、enqueue()メソッドを使って「タスク A」「タスク B」「タスク C」という3つの要素をキューに追加すると、count()は3を返します。その後、dequeue()メソッドでキューの先頭から1つの要素（この場合は「タスク A」）を取り出すと、キューはFirst-In, First-Out (FIFO) の原則に従い、残りの要素数が2になります。そのため、再度count()を実行すると2が返されます。最終的に、すべての要素を取り出すと、count()は再び0を返します。

このようにSplQueue::count()メソッドは、キューの現在のサイズを正確に把握するために利用でき、キューを操作するプログラムにおいて非常に便利です。