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

Copy
1<?php
2
3/**
4 * SplStack::current() メソッドのサンプルコード。
5 *
6 * SplStack は LIFO (後入れ先出し) のデータ構造を提供するPHPの標準拡張クラスです。
7 * current() メソッドは、SplStackが実装するIteratorインターフェースの現在位置にある要素を返します。
8 *
9 * ここでは、いくつかのディレクトリパスをスタックに格納し、イテレータを使って現在のパスを取得する例を示します。
10 * これはシステム上の「現在の作業ディレクトリ」ではなく、SplStackインスタンスが管理する「現在のディレクトリパス」を意味します。
11 */
12function demonstrateSplStackCurrent(): void
13{
14    // ディレクトリパスを格納するためのSplStackインスタンスを作成
15    $directoryStack = new SplStack();
16
17    // いくつかのディレクトリパスをスタックにプッシュ（追加）します。
18    // SplStackはLIFOなので、最初に追加されたものがスタックの底に、最後に追加されたものがスタックの頂点（イテレータの開始位置）になります。
19    // プッシュ順: '/projectA' -> '/projectA/src' -> '/projectA/src/Controllers'
20    $directoryStack->push('/var/www/html/projectA');
21    $directoryStack->push('/var/www/html/projectA/src');
22    $directoryStack->push('/var/www/html/projectA/src/Controllers');
23
24    echo "--- SplStack::current() の使用例 ---\n";
25
26    // SplStackはIteratorインターフェースを実装しているため、イテレータを操作して要素を順に辿ることができます。
27
28    // 1. イテレータをスタックの先頭（最後にプッシュされた要素）にリセットします。
29    //    この場合、'/var/www/html/projectA/src/Controllers' が先頭になります。
30    $directoryStack->rewind();
31    echo "イテレータを先頭にリセット (rewind()) 後:\n";
32    echo "現在の要素 (current()): " . var_export($directoryStack->current(), true) . "\n\n";
33
34    // 2. イテレータを一つ進めます (next())。
35    //    次の要素は '/var/www/html/projectA/src' です。
36    $directoryStack->next();
37    echo "イテレータを一つ進めた (next()) 後:\n";
38    echo "現在の要素 (current()): " . var_export($directoryStack->current(), true) . "\n\n";
39
40    // 3. イテレータをさらに一つ進めます (next())。
41    //    次の要素は '/var/www/html/projectA' です。
42    $directoryStack->next();
43    echo "イテレータをさらに一つ進めた (next()) 後:\n";
44    echo "現在の要素 (current()): " . var_export($directoryStack->current(), true) . "\n\n";
45
46    // 4. イテレータがスタックの範囲外に出ると、current() は null を返します。
47    $directoryStack->next();
48    echo "イテレータがスタックの範囲外に出た (next()) 後:\n";
49    echo "現在の要素 (current()): " . var_export($directoryStack->current(), true) . "\n\n";
50}
51
52// 関数を実行して動作を確認します。
53demonstrateSplStackCurrent();
54

PHP 8のSplStack::current()メソッドは、LIFO（後入れ先出し）のデータ構造を提供するSplStackクラスに属する機能です。このメソッドは、SplStackが実装するIteratorインターフェースの「現在位置」にある要素を返します。引数は必要なく、戻り値は現在の要素の値を表すmixed型です。

SplStackに要素をpush（追加）すると、最後に追加されたものがスタックの先頭になります。current()メソッドは、このスタックの要素を順に辿るためのイテレータが、現在指し示している要素の値を取得するために使用されます。

サンプルコードでは、ディレクトリパスをSplStackに格納し、イテレータを使って現在のパスを取得する例を示しています。rewind()メソッドでイテレータをスタックの先頭（最後にpushされた要素）にリセットした後、current()でその要素を取得できます。その後、next()メソッドでイテレータを一つ進めるたびに、current()を呼び出すことで次の要素が順に取得されます。イテレータがスタックの範囲外に出た場合、current()はnullを返します。

このメソッドが取得する「現在の要素」は、PHPが実行されているシステム上の「現在の作業ディレクトリ」を指すものではなく、あくまでSplStackインスタンス内に格納されているデータのうち、イテレータが現在指している値であることをご理解ください。スタック内のデータをイテレータを使って処理する際に重要な役割を果たします。

Copy
1<?php
2
3/**
4 * SplStack::current() の使用例と、現在の月に関連するデータ操作のデモンストレーション関数。
5 *
6 * SplStack は、PHP の標準ライブラリ (SPL) で提供される、
7 * LIFO (Last-In, First-Out: 最後に入れたものが最初に出る) の原則に基づくスタックデータ構造です。
8 *
9 * SplStack::current() メソッドは、イテレータが現在指しているスタックの要素を返します。
10 * これは通常、スタックをループ処理する際に、各要素の値を取得するために使用されます。
11 */
12function demonstrateSplStackCurrentWithMonths(): void
13{
14    echo "--- SplStack::current() のデモンストレーション（月データと共に） ---\n\n";
15
16    // 1. SplStack オブジェクトを初期化します。
17    // このスタックに月名を格納し、後で取り出してみます。
18    $monthsStack = new SplStack();
19
20    // 2. 1月から12月までの月名をスタックにプッシュします。
21    // SplStack は LIFO (Last-In, First-Out) なので、
22    // ここで 'January' を最初、'December' を最後にプッシュすると、
23    // スタックから取り出す際は 'December'、'November' の順になります。
24    $monthNames = [
25        'January', 'February', 'March', 'April', 'May', 'June',
26        'July', 'August', 'September', 'October', 'November', 'December'
27    ];
28    foreach ($monthNames as $month) {
29        $monthsStack->push($month);
30    }
31    echo "スタックに12ヶ月分の月名をプッシュしました。\n";
32    echo "スタックの現在の要素数: " . $monthsStack->count() . "\n\n";
33
34    // 3. PHPのdate関数を使って、現在の月名を取得します。
35    $currentSystemMonth = date('F'); // 例: "November"
36    echo "システムの現在の月 (date('F') から): " . $currentSystemMonth . "\n\n";
37
38    echo "=== SplStackをイテレータとして操作し、要素を順に取り出します ===\n";
39    echo "（SplStackはLIFOなので、最後にプッシュされた月が最初に取り出されます）\n";
40
41    // SplStackはIteratorインターフェースを実装しているため、
42    // rewind(), current(), next(), valid() メソッドを使って手動でイテレータを操作できます。
43
44    // rewind()：イテレータを最初の要素（この場合、スタックの一番上にある要素）にリセットします。
45    $monthsStack->rewind();
46
47    $foundMatch = false;
48    $iterationCount = 0;
49
50    // valid()：イテレータが有効な位置（まだ要素があるか）にある間、ループを続けます。
51    while ($monthsStack->valid()) {
52        // current()：イテレータが現在指している要素の値を返します。
53        // ここでは、スタックから順に取り出される月名です。
54        $monthFromStack = $monthsStack->current();
55
56        echo "  [" . ($iterationCount + 1) . "回目] スタックから取得: " . $monthFromStack;
57
58        // キーワード「php current month」に関連付けるため、
59        // スタックから取り出した月名がシステムの現在の月と一致するか確認します。
60        if ($monthFromStack === $currentSystemMonth) {
61            echo " <- これはシステムの現在の月と同じです！";
62            $foundMatch = true;
63        }
64        echo "\n";
65
66        // next()：イテレータを次の要素に進めます。
67        // SplStackの場合、現在取り出した要素の次にスタックの奥にある要素に進みます。
68        $monthsStack->next();
69        $iterationCount++;
70    }
71
72    echo "\n=== スタックの走査が完了しました ===\n";
73    if ($foundMatch) {
74        echo "スタック内にシステムの現在の月 ('" . $currentSystemMonth . "') が見つかりました。\n";
75    } else {
76        echo "スタック内にシステムの現在の月 ('" . $currentSystemMonth . "') は見つかりませんでした。\n";
77    }
78}
79
80// 関数を実行してデモンストレーションを開始します。
81demonstrateSplStackCurrentWithMonths();
82
83?>

PHPのSplStack::current()メソッドは、LIFO（Last-In, First-Out: 最後に入れたものが最初に出る）という原則を持つスタックデータ構造であるSplStackにおいて、イテレータが現在指している要素の値を取得するために使用されます。このメソッドは引数を持ちません。戻り値はスタックに格納された任意のデータ型（mixed）です。

サンプルコードでは、12ヶ月分の月名をSplStackに格納し、その要素を順に処理するデモンストレーションを行っています。SplStackはイテレータとして扱えるため、rewind()メソッドでイテレータを先頭（この場合、最後にプッシュされた月）にリセットした後、valid()とnext()メソッドを組み合わせてループ処理を進めます。ループ内で$monthsStack->current()が呼ばれるたびに、イテレータが現在指す月名が取得されます。取得した月名と、date('F')関数で得られるシステムの現在の月を比較することで、「php current month」というキーワードに関連するデータ操作の具体例を示しています。current()は、スタック内の各要素を走査し、その値を取得する際に中心的な役割を果たすメソッドです。