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

Copy
1<?php
2
3// SplQueueクラスは、キュー（待ち行列）というデータ構造を扱います。
4// キューはFIFO（First-In, First-Out、先入れ先出し）の原則に従い、
5// 最初に追加された要素が最初に取得されます。
6//
7// このサンプルコードでは、SplQueueに要素を追加する `push` メソッドの使い方を示します。
8// 配列に要素を追加する操作（例: $array[] = $value;）と似ていますが、
9// 内部的にはキューとして機能します。
10
11// 新しいSplQueueオブジェクトを作成します。
12$queue = new SplQueue();
13
14echo "--- キューへの要素追加 (push) ---\n";
15
16// キューに文字列を追加します。
17// pushメソッドは引数として任意の型の値（mixed $value）を受け入れ、戻り値はありません。
18$queue->push("最初のタスク");
19echo "追加: '最初のタスク'\n";
20
21// キューに数値を追加します。
22$queue->push(100);
23echo "追加: 100\n";
24
25// キューに配列を追加します。
26$queue->push(['item1', 'item2']);
27echo "追加: ['item1', 'item2']\n";
28
29// キューが空になるまで要素を取り出し（pop）、その内容を表示します。
30echo "\n--- キューからの要素取り出し (pop) ---\n";
31while (!$queue->isEmpty()) {
32    $element = $queue->pop(); // popはキューの先頭から要素を取り出します。
33    echo "取り出し: ";
34    if (is_array($element)) {
35        print_r($element);
36    } else {
37        echo $element . "\n";
38    }
39}
40
41echo "\nキューは空になりました。\n";
42
43?>

PHP 8のSplQueueクラスは、データ構造の一種である「キュー（待ち行列）」を扱うためのものです。キューは、最初に追加した要素が最初に取得される「先入れ先出し（FIFO）」という原則に従って動作します。

このサンプルコードでは、SplQueueに要素を追加するpushメソッドの使い方を紹介しています。pushメソッドは、キューの末尾に新しい要素を追加します。引数にはmixed $valueとあるように、文字列、数値、配列など、どのような型の値でも指定して追加できます。要素の追加に成功した場合でも、このメソッドは何も値を返しません。

コードでは、まず新しいSplQueueオブジェクトを作成し、pushメソッドを使って「最初のタスク」という文字列、数値の100、そして配列の['item1', 'item2']を順に追加しています。その後、while (!$queue->isEmpty())というループでキューが空になるまでpopメソッドを使用して要素を取り出し、その内容を表示しています。これにより、pushで追加した順序で要素が取り出され、キューの先入れ先出しの特性が確認できます。SplQueueを利用することで、タスクの順番待ちやメッセージ処理など、多くのシーンでデータの順序を管理できます。

Copy
1<?php
2
3/**
4 * SplQueue クラスの push メソッドを使用して、連想配列をキューに追加するデモンストレーションを行います。
5 *
6 * SplQueue は、First-In, First-Out (FIFO) の原則でデータを管理するキュー構造を提供します。
7 * push メソッドは、キューの末尾に要素を追加するために使用されます。
8 */
9function demonstrateSplQueueAssociativeArrayPush(): void
10{
11    // 新しい SplQueue オブジェクトを作成します。
12    // キューはデータを一時的に保持するための列のようなものです。
13    $queue = new SplQueue();
14
15    echo "--- SplQueue への連想配列の追加 (push) デモンストレーション ---" . PHP_EOL . PHP_EOL;
16
17    // キューに追加する連想配列データを作成します。
18    // 連想配列は、キーと値のペアでデータを管理するのに便利です。
19    $product1 = [
20        'id'    => 101,
21        'name'  => 'プログラミング入門',
22        'price' => 3500,
23        'stock' => 50
24    ];
25
26    $product2 = [
27        'id'    => 102,
28        'name'  => 'データベース基礎',
29        'price' => 4200,
30        'stock' => 30
31    ];
32
33    $product3 = [
34        'id'    => 103,
35        'name'  => 'Web開発実践',
36        'price' => 5800,
37        'stock' => 20
38    ];
39
40    // SplQueue::push() メソッドを使って、連想配列をキューの末尾に追加します。
41    // push メソッドは戻り値を持ちません。
42    echo "連想配列 \$product1 をキューに追加します。" . PHP_EOL;
43    $queue->push($product1);
44    echo "現在のキューの要素数: " . $queue->count() . PHP_EOL . PHP_EOL;
45
46    echo "連想配列 \$product2 をキューに追加します。" . PHP_EOL;
47    $queue->push($product2);
48    echo "現在のキューの要素数: " . $queue->count() . PHP_EOL . PHP_EOL;
49
50    echo "連想配列 \$product3 をキューに追加します。" . PHP_EOL;
51    $queue->push($product3);
52    echo "現在のキューの要素数: " . $queue->count() . PHP_EOL . PHP_EOL;
53
54    echo "--- キューからの要素取り出し (pop) デモンストレーション ---" . PHP_EOL . PHP_EOL;
55
56    // キューから要素を取り出し、追加された順序（FIFO）を確認します。
57    // pop メソッドはキューの先頭から要素を取り除き、その要素を返します。
58    while (!$queue->isEmpty()) {
59        $poppedItem = $queue->pop();
60        echo "キューから取り出された要素:" . PHP_EOL;
61        print_r($poppedItem); // 取り出された連想配列の内容を表示
62        echo "現在のキューの要素数: " . $queue->count() . PHP_EOL . PHP_EOL;
63    }
64
65    echo "すべての要素がキューから取り出され、キューは空になりました。" . PHP_EOL;
66}
67
68// デモンストレーション関数を実行します。
69demonstrateSplQueueAssociativeArrayPush();

PHP 8のSplQueueクラスは、データを「先入れ先出し（First-In, First-Out; FIFO）」の原則で管理するキュー構造を提供します。これは、最初に入ったものが最初に出ていく順番待ちの列のように機能します。

そのSplQueueクラスのpushメソッドは、このキューの末尾に新しい要素を追加する役割を担います。引数$valueには、数値や文字列といった基本的なデータ型はもちろん、今回のサンプルコードのように、複数の情報をキーと値のペアでまとめた「連想配列」など、あらゆる型のデータを指定して追加できます。これにより、複雑なデータ構造もキューを使って効率的に管理することが可能です。pushメソッドはキューに要素を追加するだけで、特定の戻り値は持ちません。

サンプルコードでは、商品の情報を示す連想配列$product1、$product2、$product3を順番にSplQueue::push()メソッドでキューに追加しています。これにより、これらの商品データが、追加された順序を保ったままキュー内に格納されます。その後、popメソッドで要素を取り出すと、pushしたときと同じ順序でデータが得られることが確認できます。pushメソッドは、このようにデータの処理順序を保証したい場合に非常に有用です。