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

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList を使用して要素をリストの末尾に追加する例。
5 *
6 * SplDoublyLinkedList は、PHPの標準配列とは異なる「双方向リンクリスト」を実装するクラスです。
7 * push メソッドは、引数として渡された $value をリストの末尾に（最後尾として）追加します。
8 * これは、配列の array_push() や $array[] = $value と同様に、要素を末尾に追加する操作です。
9 * このメソッドには戻り値がありません。
10 */
11function demonstrateSplDoublyLinkedListPush(): void
12{
13    // 新しい SplDoublyLinkedList インスタンスを作成
14    $list = new SplDoublyLinkedList();
15
16    echo "--- 要素追加前のリストの状態 ---" . PHP_EOL;
17    echo "リストの要素数: " . $list->count() . PHP_EOL; // 現在の要素数を表示
18
19    // push メソッドを使用して複数の要素をリストの末尾に追加
20    // 引数 $value は mixed 型なので、様々な型の値を追加できます。
21    $list->push('First item'); // 文字列を追加
22    echo "要素 'First item' をプッシュしました。" . PHP_EOL;
23
24    $list->push(123); // 数値を追加
25    echo "要素 123 をプッシュしました。" . PHP_EOL;
26
27    $list->push(true); // 真偽値を追加
28    echo "要素 true をプッシュしました。" . PHP_EOL;
29
30    echo PHP_EOL . "--- 要素追加後のリストの内容 ---" . PHP_EOL;
31    echo "現在のリストの要素数: " . $list->count() . PHP_EOL;
32
33    // リストの要素を先頭から順にイテレートして表示
34    // foreach ループで SplDoublyLinkedList を反復すると、要素が追加された順に取得されます。
35    $index = 0;
36    foreach ($list as $item) {
37        // 真偽値は echo で直接表示すると空文字列や '1' になるため、明示的に文字列化
38        $displayValue = is_bool($item) ? ($item ? 'true' : 'false') : $item;
39        echo "要素 [" . $index++ . "]: " . $displayValue . PHP_EOL;
40    }
41}
42
43// 関数を実行して動作を確認
44demonstrateSplDoublyLinkedListPush();

SplDoublyLinkedListクラスは、PHPに標準で用意されている配列とは異なる、「双方向リンクリスト」というデータ構造を実装するクラスです。これは、要素が前後に連結されているため、リストの任意の場所への追加や削除を効率的に行える特徴を持ちます。

このSplDoublyLinkedListクラスのpushメソッドは、リストの末尾に新しい要素を追加するために使用されます。引数には$valueとして追加したい値を指定します。この$valueはmixed型であるため、文字列、数値、真偽値、オブジェクトなど、どのような型の値でもリストに追加することが可能です。

pushメソッドは、PHPの標準配列におけるarray_push()関数や$array[] = $valueのように、要素をデータ構造の一番後ろに追加する操作と概念的に同じです。引数で渡された値は、常に現在のリストの最終要素の次、つまり一番後ろに追加されます。このメソッド自体には戻り値がありませんので、実行後に何らかの値を返すことはありません。

サンプルコードでは、まず新しいSplDoublyLinkedListのインスタンスを作成しています。その後、pushメソッドを複数回呼び出し、異なる型の要素（文字列、数値、真偽値）をリストの末尾に順次追加しています。要素追加後には、count()メソッドで現在の要素数を確認し、foreachループを使ってリストの要素を先頭から順に表示しています。これにより、pushメソッドが正しく要素をリストの末尾に追加し、追加された順番で要素が格納されていることを確認できます。SplDoublyLinkedListは、特に大規模なデータセットに対して要素の追加・削除を頻繁に行う場合に役立つデータ構造です。

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList を使用して、通知メッセージのキューを作成する例です。
5 * SplDoublyLinkedList::push メソッドは、リストの末尾に要素を追加します。
6 * ここでは、「push通知」の「push」を、通知をキューに追加する操作として関連付けています。
7 */
8
9// 通知メッセージを格納するためのキュー（両方向リスト）を作成します。
10$notificationQueue = new SplDoublyLinkedList();
11
12echo "--- 通知メッセージのキューに要素を追加します ---\n";
13
14// push メソッドを使用して、新しい通知メッセージをキューの末尾に追加します。
15// push メソッドは引数として任意の型の値 (mixed $value) を受け取り、戻り値はありません。
16$notificationQueue->push("ユーザーAが新しい投稿をしました。");
17echo "追加: ユーザーAが新しい投稿をしました。\n";
18
19$notificationQueue->push("システムメンテナンスのお知らせ: 3月15日 2:00-4:00 AM");
20echo "追加: システムメンテナンスのお知らせ: 3月15日 2:00-4:00 AM\n";
21
22$notificationQueue->push("ご注文 #12345 が出荷されました。");
23echo "追加: ご注文 #12345 が出荷されました。\n";
24
25echo "\n--- 現在の通知キューの内容 ---\n";
26
27// キューの要素を順に表示します。
28// SplDoublyLinkedList はイテラブルなので、foreach で簡単にアクセスできます。
29// (通常、通知キューは pop() や shift() で要素を取り出して処理します。)
30if ($notificationQueue->isEmpty()) {
31    echo "通知キューは空です。\n";
32} else {
33    foreach ($notificationQueue as $index => $message) {
34        echo "通知 " . ($index + 1) . ": " . $message . "\n";
35    }
36}
37
38echo "\n--- さらに通知を追加します ---\n";
39$notificationQueue->push("プロモーション情報: 新製品がリリースされました！");
40echo "追加: プロモーション情報: 新製品がリリースされました！\n";
41
42echo "\n--- 更新後の通知キューの内容 ---\n";
43foreach ($notificationQueue as $index => $message) {
44    echo "通知 " . ($index + 1) . ": " . $message . "\n";
45}
46
47?>

PHPのSplDoublyLinkedList::pushメソッドは、両方向リストの末尾に新しい要素を追加するために使用されます。このメソッドは、データが追加された順に処理されるキューのようなデータ構造を構築する際に非常に役立ちます。例えば、ユーザーに送信する「push通知」のようなメッセージを一時的に保存するキューに、新しい通知メッセージを「プッシュ」（追加）していくといった場面で利用されます。

pushメソッドは、mixed $valueという引数を一つ受け取ります。このmixedという指定は、文字列、数値、オブジェクトなど、どのような型のデータでも引数として渡すことができることを意味します。そのため、柔軟に様々な情報をリストに追加することが可能です。メソッドを呼び出した際に、特定の値を返すことはありません（戻り値なし）。リストに要素を追加するという動作のみを実行します。

提供されたサンプルコードでは、SplDoublyLinkedListのインスタンスを通知メッセージのキューとして用意し、pushメソッドを使って「ユーザーAが新しい投稿をしました。」や「システムメンテナンスのお知らせ」といった複数の通知メッセージを、そのキューの末尾に順番に追加しています。これにより、新しい通知が常に既存の通知の最後に追加され、キューが効率的に構築されていく様子を確認できます。このように、pushメソッドはリストの最後にデータを効率よく追加する操作を実現し、システムのイベント処理やタスク管理に活用できます。