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

Copy
1<?php
2
3/**
4 * PHPのSplQueueクラスはキュー（FIFO: 先入れ先出し）として動作するため、
5 * 直接的な prev() メソッドは持ちません。イテレータは通常、next() で前方にのみ進みます。
6 *
7 * もしリストの要素を前後に移動させるイテレータ機能（prev()）が必要な場合は、
8 * SplQueueの親クラスである SplDoublyLinkedList を使用します。
9 * 以下のサンプルコードは、SplDoublyLinkedList クラスでの prev() メソッドの利用例です。
10 * SplQueue のインスタンスで prev() を呼び出すとエラーになりますのでご注意ください。
11 */
12
13// SplDoublyLinkedList クラスのインスタンスを作成します。
14// これは SplQueue ではないことに注意してください。
15$list = new SplDoublyLinkedList();
16
17// リストに要素を追加します。
18$list->push('First Item');
19$list->push('Second Item');
20$list->push('Third Item');
21
22// イテレータをリストの先頭に巻き戻します。
23$list->rewind();
24
25// イテレータを 'Third Item' の位置まで進めます。
26$list->next(); // ポインタが 'First Item' から 'Second Item' へ
27$list->next(); // ポインタが 'Second Item' から 'Third Item' へ
28
29echo "現在の要素: " . $list->current() . PHP_EOL; // 出力: Third Item
30
31// prev() メソッドを呼び出して、イテレータを前の要素に移動させます。
32$list->prev();
33echo "prev() 実行後の要素: " . $list->current() . PHP_EOL; // 出力: Second Item
34
35// もう一度 prev() を呼び出し、さらに前の要素へ移動します。
36$list->prev();
37echo "prev() 実行後の要素: " . $list->current() . PHP_EOL; // 出力: First Item
38
39// prev() を使って先頭より前に移動しようとしても、ポインタは先頭にとどまります。
40$list->prev();
41echo "prev() 実行後の要素 (先頭): " . $list->current() . PHP_EOL; // 出力: First Item
42
43?>

PHPのSplQueueクラスは、データが先入れ先出し（FIFO）の原則で管理されるキュー構造であり、通常はイテレータを前方にのみ進めるnext()メソッドを使用します。そのため、リファレンス情報にSplQueue::prevとありますが、実際のSplQueueクラスには直接的なprev()メソッドは存在しません。SplQueueのインスタンスでprev()を呼び出すとエラーになりますのでご注意ください。

このサンプルコードは、SplQueueの親クラスにあたるSplDoublyLinkedListクラスにおけるprev()メソッドの利用例を示しています。SplDoublyLinkedListは両方向からのアクセスが可能なリスト構造であり、イテレータを前後に移動させることができます。SplDoublyLinkedList::prev()メソッドは、引数を受け取らず、現在のイテレータをリストの前の要素に移動させます。戻り値は特にありませんが、メソッド実行後にcurrent()を呼び出すことで、移動後の現在の要素を取得できます。

サンプルコードでは、まずSplDoublyLinkedListに複数の要素を追加し、rewind()でイテレータを先頭に巻き戻します。その後、next()を複数回呼び出してイテレータを特定の要素まで進め、その位置からprev()メソッドを呼び出すことで、イテレータが一つ前の要素へ移動する様子を確認できます。これにより、リストを順方向だけでなく逆方向にも辿ることが可能になります。prev()を繰り返し呼び出すことで、リストの先頭まで遡ることができますが、先頭より前には移動しない仕組みになっています。

Copy
1<?php
2
3/**
4 * SplQueue::prev() メソッドのサンプルコード。
5 *
6 * SplQueue は SplDoublyLinkedList を継承しており、双方向イテレータの機能を提供します。
7 * prev() メソッドは、イテレータをリストの前の要素に移動させます。
8 * この例では、「php previous year question paper」というキーワードを想定し、
9 * 過去の試験問題のリストを前後に辿るシナリオをシミュレートします。
10 */
11function managePreviousExamQuestions(): void
12{
13    // SplQueue のインスタンスを作成
14    // SplQueue は SplDoublyLinkedList を継承しているため、イテレータ機能が利用可能です。
15    $examQuestions = new SplQueue();
16
17    // 過去の試験問題をキューに追加
18    echo "--- 過去の試験問題の追加 ---\n";
19    $examQuestions->push("2022年 PHP基礎に関する選択問題");
20    echo "追加: 2022年 PHP基礎\n";
21    $examQuestions->push("2023年 PHPフレームワークの設計に関する記述問題");
22    echo "追加: 2023年 PHPフレームワーク\n";
23    $examQuestions->push("2024年 PHPの新機能に関する穴埋め問題");
24    echo "追加: 2024年 PHP新機能\n";
25
26    echo "\n--- イテレータを使った問題の参照 ---\n";
27
28    // イテレータをリストの先頭に設定
29    $examQuestions->rewind();
30    echo "先頭の問題 (rewind後): " . ($examQuestions->valid() ? $examQuestions->current() : "無効な位置") . "\n";
31
32    // イテレータを一つ進める
33    $examQuestions->next();
34    echo "次の問題 (next後): " . ($examQuestions->valid() ? $examQuestions->current() : "無効な位置") . "\n";
35
36    // イテレータをさらに一つ進める
37    $examQuestions->next();
38    echo "次の問題 (next後): " . ($examQuestions->valid() ? $examQuestions->current() : "無効な位置") . "\n";
39
40    // SplQueue::prev() メソッドを使用してイテレータを前の要素に戻す
41    echo "\n--- prev() メソッドで前の問題に戻る ---\n";
42    if ($examQuestions->valid()) {
43        $examQuestions->prev(); // 例: 2024年から2023年の問題へ移動
44        echo "前の問題 (prev()後): " . $examQuestions->current() . "\n";
45    } else {
46        echo "イテレータが有効な位置にありません。\n";
47    }
48
49    if ($examQuestions->valid()) {
50        $examQuestions->prev(); // 例: 2023年から2022年の問題へ移動
51        echo "前の問題 (prev()後): " . $examQuestions->current() . "\n";
52    } else {
53        echo "イテレータが有効な位置にありません。\n";
54    }
55
56    // さらに prev() を呼び出すと、リストの先頭を超えて無効な位置になる
57    echo "\n--- prev() でリストの先頭を超えた場合 ---\n";
58    if ($examQuestions->valid()) {
59        $examQuestions->prev();
60        echo "前の問題 (prev()後): " . ($examQuestions->valid() ? $examQuestions->current() : "無効な位置") . "\n";
61    }
62
63    echo "イテレータが有効な位置か: " . ($examQuestions->valid() ? 'はい' : 'いいえ') . "\n";
64}
65
66// 関数を実行
67managePreviousExamQuestions();

PHP 8のSplQueueクラスは、データの追加や削除を効率的に行うためのリスト構造を提供します。このクラスはSplDoublyLinkedListを継承しているため、要素を順番に辿る「イテレータ」という機能を持っており、リストの前後を行き来できるのが特徴です。

SplQueue::prev()メソッドは、このイテレータを現在の位置から「前の要素」へ移動させるためのメソッドです。引数は必要なく、特定の戻り値もありません。イテレータの位置が変更されることで、current()メソッドを呼び出した際に、前の要素の内容を取得できるようになります。

例えば、過去の試験問題をリストに格納し、next()メソッドで順番に閲覧している際に、一度見た問題に再度戻りたい場合にprev()メソッドが活躍します。現在の問題から一つ前の問題へ移動し、簡単に参照をやり直すことが可能です。

ただし、イテレータが既にリストの先頭にある状態でprev()を呼び出すと、イテレータは有効な位置ではなくなり、valid()メソッドはfalseを返すようになりますので注意が必要です。prev()は、リスト内のデータ参照をより柔軟にするための重要なメソッドです。