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

Copy
1<?php
2
3// SplObjectStorage は、PHPが提供する特別なデータ構造（コレクション）の一つです。
4// これはオブジェクトをキーとして、他のオブジェクトやデータを格納・管理するのに使われます。
5// 特に、同じオブジェクトインスタンスかどうかを厳密に比較する点で通常の配列とは異なります。
6
7// サンプルコードで使用するオブジェクトのクラスを定義します。
8class MySampleObject
9{
10    private string $id;
11
12    public function __construct(string $id)
13    {
14        $this->id = $id;
15    }
16
17    public function getId(): string
18    {
19        return $this->id;
20    }
21}
22
23// SplObjectStorage の新しいインスタンスを作成します。
24$storage = new SplObjectStorage();
25
26// いくつかのオブジェクトを作成します。
27$objectA = new MySampleObject('A-101');
28$objectB = new MySampleObject('B-202');
29$objectC = new MySampleObject('C-303');
30
31// オブジェクトを SplObjectStorage に追加（格納）します。
32// attach() メソッドは、オブジェクトをコレクションに追加します。
33// 第2引数には、そのオブジェクトに関連付ける任意のデータも格納できます。
34$storage->attach($objectA, '関連データ for A');
35$storage->attach($objectB); // 関連データなしで追加することも可能です
36$storage->attach($objectC, '関連データ for C');
37
38echo "--- SplObjectStorage::current() の動作確認（手動イテレーション）---" . PHP_EOL;
39echo "イテレータを手動で操作して、現在のオブジェクトを確認します。" . PHP_EOL;
40
41// rewind() メソッドは、コレクションのイテレータ（現在位置を示すポインタ）を先頭に戻します。
42// これにより、コレクションの最初から要素をたどることができます。
43$storage->rewind();
44
45// valid() メソッドは、現在のイテレータの位置に有効なオブジェクトがあるかをチェックします。
46// オブジェクトがある限りループを続けます。
47while ($storage->valid()) {
48    // current() メソッドは、イテレータが現在指し示している「オブジェクト」を返します。
49    // このオブジェクトは、SplObjectStorage::attach() で格納された元のオブジェクトインスタンスです。
50    $currentObject = $storage->current();
51    echo "  現在のオブジェクトID: " . $currentObject->getId() . PHP_EOL;
52
53    // getInfo() メソッドは、current() で取得したオブジェクトに関連付けられたデータを返します。
54    // attach() の第2引数で指定したデータがあればそれが、なければ null が返ります。
55    $relatedData = $storage->getInfo();
56    echo "  関連データ: " . ($relatedData ?? 'データなし') . PHP_EOL;
57
58    // next() メソッドは、イテレータをコレクションの次の要素に進めます。
59    // これにより、次のループで次のオブジェクトが current() で取得できるようになります。
60    $storage->next();
61    echo "--------------------" . PHP_EOL;
62}
63
64echo PHP_EOL;
65echo "--- foreach ループでの SplObjectStorage の利用例 ---" . PHP_EOL;
66echo "（foreach は内部で current() や next() を自動的に呼び出しています）" . PHP_EOL;
67
68// SplObjectStorage は PHP の Iterator インターフェースを実装しているため、
69// foreach ループを使ってシンプルにオブジェクトを順番に取り出すことができます。
70foreach ($storage as $objectInLoop) {
71    // ここで $objectInLoop は、SplObjectStorage::current() が返すオブジェクトと同じです。
72    echo "  foreachで取得されたオブジェクトID: " . $objectInLoop->getId() . PHP_EOL;
73    // foreach ループ内でも getInfo() を使って関連データを取得できます。
74    echo "  関連データ: " . ($storage->getInfo() ?? 'データなし') . PHP_EOL;
75    echo "--------------------" . PHP_EOL;
76}
77

SplObjectStorageは、オブジェクトをキーとして他のオブジェクトやデータを格納・管理するPHPの特別なデータ構造（コレクション）です。これは、通常の配列とは異なり、オブジェクトの同一性（同じインスタンスであるか）を厳密に比較する特徴があります。

SplObjectStorage::current()メソッドは、このコレクションの内部イテレータ（現在位置を示すポインタ）が現在指し示しているオブジェクトを返します。このメソッドは引数を取りません。戻り値はmixed型で、コレクションに格納されている任意のオブジェクト、またはイテレータが有効な要素を指していない場合はfalseとなります。

サンプルコードでは、まずrewind()メソッドでイテレータをコレクションの先頭に戻しています。その後のwhile ($storage->valid())ループ内で、current()メソッドを使って現在のオブジェクトを取得し、そのオブジェクトのメソッド（例: getId()）を呼び出して表示しています。current()で取得されたオブジェクトに関連付けられたデータは、getInfo()メソッドで取得できます。ループの最後にnext()メソッドを呼び出すことで、イテレータは次のオブジェクトに進み、次のループで新しいオブジェクトがcurrent()によって返されます。

PHPのforeachループは、SplObjectStorageのようなイテレータを実装したクラスに対して、内部でcurrent()やnext()といったイテレータ操作を自動的に行い、コレクションの各オブジェクトを順番に処理するため、より簡潔に利用できます。

Copy
1<?php
2
3/**
4 * 現在の月番号と月名を取得して表示する関数。
5 *
6 * この関数は、PHPのdate()関数を使用して、システムの日付に基づいた現在の月情報を取得します。
7 * date()関数のフォーマット文字 'n' は先頭にゼロが付かない月番号 (1-12) を返し、
8 * 'F' は月の完全なテキスト表現 (例: "January") を返します。
9 */
10function displayCurrentMonthInformation(): void
11{
12    // date()関数にフォーマット文字 'n' を指定して、現在の月番号（1から12）を取得します。
13    // 例: 1月なら '1'、12月なら '12'
14    $currentMonthNumber = date('n');
15
16    // date()関数にフォーマット文字 'F' を指定して、現在の月名（英語のフルネーム）を取得します。
17    // 例: 1月なら 'January'、12月なら 'December'
18    $currentMonthName = date('F');
19
20    echo "現在の月は番号で「{$currentMonthNumber}」です。\n";
21    echo "現在の月は名前で「{$currentMonthName}」です。\n";
22}
23
24// 関数を実行して現在の月情報を表示します。
25displayCurrentMonthInformation();

このサンプルコードは、PHPの組み込み関数であるdate()関数を使用して、現在のシステム日付から月に関する情報を取得し、画面に表示する方法を示しています。date()関数は、指定されたフォーマットに従って日付や時刻を整形した文字列を返します。

具体的には、まずdate('n')という記述により、現在の月を数字で取得しています。ここでdate()関数の引数として指定されている'n'は、月の番号を1から12の範囲で、先頭にゼロを付けずに表現するフォーマット文字です。これにより、例えば1月であれば「1」、12月であれば「12」といった値が返されます。

次に、date('F')と記述することで、現在の月の名前を英語の完全なテキスト形式で取得しています。この場合の引数'F'は、例えば1月なら「January」、12月なら「December」のように、月のフルネームを文字列として返すフォーマット文字です。

これらの取得した月番号と月名はそれぞれ変数$currentMonthNumberと$currentMonthNameに格納され、最後にecho文を使ってユーザーにとって分かりやすい形式で画面に出力されます。date()関数は、引数として日付のフォーマット文字列を受け取り、その結果として整形された日付や時刻の情報を文字列として戻り値で返します。この関数は特定のクラスに属するメソッドではなく、PHPで日付情報を扱うための汎用的なグローバル関数として利用できます。