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

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList::pop メソッドのサンプルコード
5 *
6 * SplDoublyLinkedList は、要素を両端から追加・削除できるデータ構造です。
7 * pop メソッドは、リストの末尾から要素を取り出し（削除し）、その要素を返します。
8 * システムエンジニアを目指す初心者向けに、基本的な動作を示します。
9 */
10function demonstrateSplDoublyLinkedListPop(): void
11{
12    // SplDoublyLinkedList の新しいインスタンスを作成
13    $list = new SplDoublyLinkedList();
14
15    // リストにいくつかの要素を追加 (push メソッドで末尾に追加)
16    echo "--- 初期状態 ---\n";
17    $list->push('First Item');
18    $list->push('Second Item');
19    $list->push('Third Item');
20    echo "リストに要素を追加しました。現在の要素数: " . $list->count() . "\n";
21    echo "リストの内容: [";
22    $items = [];
23    foreach ($list as $item) {
24        $items[] = $item;
25    }
26    echo implode(', ', $items) . "]\n\n";
27
28    // pop メソッドを使用して末尾の要素を取り出す
29    echo "--- pop 1回目 ---\n";
30    $poppedElement1 = $list->pop(); // 末尾の 'Third Item' が取り出される
31    echo "取り出された要素: " . $poppedElement1 . "\n";
32    echo "pop後の要素数: " . $list->count() . "\n";
33    echo "リストの内容: [";
34    $items = [];
35    foreach ($list as $item) {
36        $items[] = $item;
37    }
38    echo implode(', ', $items) . "]\n\n";
39
40    // もう一度 pop メソッドを呼び出す
41    echo "--- pop 2回目 ---\n";
42    $poppedElement2 = $list->pop(); // 残りのリストの末尾 'Second Item' が取り出される
43    echo "取り出された要素: " . $poppedElement2 . "\n";
44    echo "pop後の要素数: " . $list->count() . "\n";
45    echo "リストの内容: [";
46    $items = [];
47    foreach ($list as $item) {
48        $items[] = $item;
49    }
50    echo implode(', ', $items) . "]\n\n";
51
52    // リストが空になるまで pop する
53    echo "--- リストを空にするまで pop ---\n";
54    while (!$list->isEmpty()) {
55        $element = $list->pop();
56        echo "取り出された要素: " . $element . "\n";
57    }
58    echo "現在の要素数: " . $list->count() . "\n";
59    echo "リストは空です。\n\n";
60
61    // 空のリストに対して pop を試みる (RuntimeException が発生する)
62    echo "--- 空のリストからの pop (例外処理) ---\n";
63    try {
64        $list->pop();
65    } catch (RuntimeException $e) {
66        echo "エラー: " . $e->getMessage() . " (空のリストからは pop できません)\n";
67    }
68}
69
70// 関数を実行
71demonstrateSplDoublyLinkedListPop();

PHPのSplDoublyLinkedListクラスは、要素をリストの先頭と末尾のどちらからでも追加・削除できる、柔軟なデータ構造を提供します。このクラスに属するpopメソッドは、リストの末尾に存在する要素を一つ取り出し、その要素をリストから削除する機能を持っています。

popメソッドは引数を一切取りません。戻り値はmixed型で、取り出された要素そのものが返されます。これは、リストに格納された様々な種類のデータ（文字列、数値、オブジェクトなど）に対応するためです。

サンプルコードでは、まずSplDoublyLinkedListに複数の要素を順番に追加しています。例えば、「First Item」「Second Item」「Third Item」と追加した後、popメソッドを呼び出すと、最後に追加された「Third Item」が取り出され、リストから削除されます。再度popを呼び出すと、残った要素の末尾にあたる「Second Item」が同様に取り出されます。このように、popメソッドはリストの末尾から要素を順番に処理する際に非常に役立ちます。

リストが空になった状態でpopメソッドを呼び出すと、取り出すべき要素が存在しないためRuntimeExceptionが発生します。これは、プログラムが不正な操作を行おうとしたことを示し、適切にエラーを処理する必要があります。この機能は、後入れ先出し（LIFO）の原則に基づいたスタックのようなデータ構造を扱う際に特に便利です。

Copy
1<?php
2
3/**
4 * 外部コマンドの出力をSplDoublyLinkedListに格納し、
5 * その後popメソッドで末尾から要素を取り出して処理するサンプルコードです。
6 *
7 * この例では、`popen`関数を使って外部プロセス（例: `ls -l`）を実行し、
8 * その出力を一行ずつ`SplDoublyLinkedList`に格納します。
9 * その後、`pop`メソッドを使ってリストの末尾から要素を一つずつ取り出し、
10 * 処理を行います。
11 *
12 * @param string $command 実行するシェルコマンド。
13 *                        例: 'ls -l' (Linux/macOS), 'dir' (Windows)
14 * @return void
15 */
16function processCommandOutputWithLinkedList(string $command): void
17{
18    // SplDoublyLinkedListの新しいインスタンスを作成します。
19    // これは、両方向から要素を追加・削除できる特別なリストです。
20    $list = new SplDoublyLinkedList();
21
22    // popen関数を使用して、指定されたコマンドを実行し、
23    // その出力に対するファイルポインタ（$handle）を開きます。
24    // 'r' は読み込みモードを意味します。
25    $handle = popen($command, 'r');
26
27    // コマンドの実行に失敗した場合の処理
28    if ($handle === false) {
29        echo "エラー: コマンド '{$command}' を実行できませんでした。\n";
30        return;
31    }
32
33    echo "--- コマンド出力の読み込みとリストへの格納 ---\n";
34    // fgets関数を使って、`popen`で開いたパイプから一行ずつデータを読み込みます。
35    while (($line = fgets($handle)) !== false) {
36        $trimmedLine = trim($line); // 行末の改行文字などを削除します。
37        // 空行でなければリストの末尾に追加（プッシュ）します。
38        if ($trimmedLine !== '') {
39            echo "リストに要素を追加: '{$trimmedLine}'\n";
40            $list->push($trimmedLine);
41        }
42    }
43
44    // `popen`で開いたパイプを閉じます。
45    // これにより、関連するリソースが解放されます。
46    pclose($handle);
47
48    echo "\n--- リストから要素をポップして処理 ---\n";
49    // リストが空になるまでループを続けます。
50    // SplDoublyLinkedList::isEmpty() メソッドでリストの状態を確認します。
51    while (!$list->isEmpty()) {
52        // SplDoublyLinkedList::pop() メソッドを呼び出します。
53        // このメソッドはリストの末尾から要素を削除し、その削除された要素を返します。
54        $item = $list->pop();
55        echo "リストからポップされた要素: '{$item}'\n";
56        // ここで、$item（ポップされた要素）に対する追加の処理を行うことができます。
57        // 例: var_dump($item);
58    }
59
60    echo "\nリストは空になりました。\n";
61}
62
63// 実際のコマンドを指定して関数を実行します。
64// 環境に合わせて適切なコマンドを選択してください。
65// Linux/macOSの場合:
66processCommandOutputWithLinkedList('ls -l');
67
68// Windowsの場合:
69// processCommandOutputWithLinkedList('dir');

このサンプルコードは、PHPのSplDoublyLinkedListクラスが提供するpopメソッドの具体的な利用方法を説明します。SplDoublyLinkedListは、要素をリストの両端から効率的に追加したり削除したりできる、特殊な二重リンクリストです。

まず、このコードではpopen関数を使用し、指定された外部コマンド（例: 'ls -l'）を実行して、その標準出力を一行ずつ読み込んでいます。読み込んだ各行はSplDoublyLinkedList::push()メソッドを通じて、リストの末尾に順次追加されます。これにより、コマンドの出力内容がリスト内に格納されます。

その後、リストが空になるまでSplDoublyLinkedList::pop()メソッドを繰り返し呼び出します。pop()メソッドは、リストの末尾から要素を削除し、その削除された要素を戻り値として返します。このメソッドは引数を取りません。戻り値の型はmixedであり、リストに格納されたあらゆる型の要素を受け取ることができます。サンプルコードでは、ポップされた要素を画面に表示していますが、実際にはここで取得した要素に対して任意のデータ処理を行うことができます。この一連の流れにより、外部コマンドの出力をリストに格納し、その内容を末尾から順番に処理する手順が示されています。