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

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList クラスの current() メソッドの使用例を示します。
5 * current() メソッドは、リストの現在のイテレータ位置にある要素を返します。
6 *
7 * SplDoublyLinkedList は、PHP の標準ライブラリ (SPL) で提供される、
8 * 双方向連結リストを実装したクラスです。要素を効率的に追加、削除、走査できます。
9 */
10function demonstrateSplDoublyLinkedListCurrent(): void
11{
12    // SplDoublyLinkedList の新しいインスタンスを作成します。
13    $list = new SplDoublyLinkedList();
14
15    // リストに複数の要素を追加します。
16    // push() はリストの最後に要素を追加します。
17    $list->push('Apple');
18    $list->push('Banana');
19    $list->push('Cherry');
20
21    echo "--- リストの要素を順に取得する例 ---\n";
22
23    // イテレータをリストの先頭に巻き戻します。
24    // current() メソッドはイテレータが指す現在の要素を返します。
25    // イテレータは初期状態では無効な位置にあるため、通常は最初に rewind() を呼び出します。
26    $list->rewind();
27
28    // イテレータが有効な位置にある間、ループを続けます。
29    while ($list->valid()) {
30        // current() を使用して、現在のイテレータ位置にある要素を取得します。
31        echo "現在の要素: " . $list->current() . "\n";
32        // next() を使用して、イテレータを次の要素に進めます。
33        $list->next();
34    }
35
36    echo "\n--- リストの特定の要素を取得する例 ---\n";
37
38    // 再びイテレータを先頭に巻き戻します。
39    $list->rewind();
40    echo "先頭に巻き戻しました。現在の要素: " . $list->current() . "\n"; // 出力: Apple
41
42    // イテレータを1つ進めます。
43    $list->next();
44    echo "次の要素へ移動しました。現在の要素: " . $list->current() . "\n"; // 出力: Banana
45
46    // イテレータをさらに1つ進めます。
47    $list->next();
48    echo "さらに次の要素へ移動しました。現在の要素: " . $list->current() . "\n"; // 出力: Cherry
49
50    // リストの終端を超えてイテレータを進めた場合、valid() は false を返し、
51    // current() は null を返します。
52    $list->next();
53    echo "終端を超えました。有効な要素ですか? " . ($list->valid() ? 'はい' : 'いいえ') . "\n";
54    echo "終端を超えた後の現在の要素: ";
55    var_dump($list->current()); // 出力: NULL
56}
57
58// 関数を実行して、SplDoublyLinkedList::current() の動作を確認します。
59demonstrateSplDoublyLinkedListCurrent();

PHPのバージョン8で利用できるSplDoublyLinkedListクラスのcurrent()メソッドについてご説明します。SplDoublyLinkedListは、要素を前後に効率良くたどることができる双方向連結リストを提供するクラスです。

current()メソッドは、このリスト内で「現在の位置」にある要素を取得するために使用されます。引数はなく、現在のイテレータが指している要素を戻り値として返します。リストに要素が存在しない場合や、イテレータがリストの終端を超えて無効な位置にある場合は、nullを返します。

このメソッドは単独で使うことは少なく、通常はrewind()メソッドでイテレータをリストの先頭に巻き戻し、next()メソッドでイテレータを次の要素に進めながら、valid()メソッドでイテレータが有効な位置にあるかを確認するループの中で利用されます。これにより、リスト内の要素を順に処理したり、特定の要素を取得したりすることが可能になります。

例えば、サンプルコードではApple、Banana、Cherryと追加されたリストに対して、rewind()で先頭に戻った後にcurrent()でAppleを取得し、next()で進めてBananaやCherryを取得する様子が示されています。このようにcurrent()は、リストを走査する際の現在の参照位置にあるデータを効率的に取り出すための重要な役割を担っています。

Copy
1<?php
2
3/**
4 * 現在のUnixタイムスタンプと、様々なフォーマットでの現在日時を取得し表示する関数です。
5 *
6 * システムエンジニアを目指す初心者の方にも分かりやすいように、
7 * PHPで現在時刻を扱う基本的な方法を複数紹介します。
8 */
9function displayCurrentTimestamps(): void
10{
11    // 1. Unixタイムスタンプ (エポックからの秒数) を取得
12    // time() 関数は、1970年1月1日 00:00:00 UTC (UNIXエポック) から現在までの秒数を返します。
13    // これは整数値で、データベースやAPIでの日時表現によく用いられます。
14    $unixTimestamp = time();
15    echo "現在のUnixタイムスタンプ: " . $unixTimestamp . PHP_EOL;
16
17    // 2. 指定されたフォーマットで現在日時を文字列として取得
18    // date() 関数は、指定されたフォーマット文字列とタイムスタンプ (省略時は現在のタイムスタンプ) を元に
19    // フォーマットされた日付/時刻文字列を返します。
20    // 'Y-m-d H:i:s' は「年-月-日 時:分:秒」の形式です。
21    $formattedDateTime = date('Y-m-d H:i:s');
22    echo "現在の日時 (Y-m-d H:i:s): " . $formattedDateTime . PHP_EOL;
23
24    // 3. タイムゾーンを指定して現在日時を取得
25    // date_default_timezone_set() でスクリプトのデフォルトタイムゾーンを設定できます。
26    // これにより、date() や DateTime オブジェクトが正しいタイムゾーンで動作します。
27    date_default_timezone_set('Asia/Tokyo');
28    $tokyoDateTime = date('Y/m/d H:i:s');
29    echo "現在の日時 (Asia/Tokyo): " . $tokyoDateTime . PHP_EOL;
30
31    // 4. DateTimeImmutable オブジェクトを使用して現在日時を取得 (PHP 5.5+ 推奨)
32    // DateTimeImmutable クラスは、日時をよりオブジェクト指向的に、かつ安全に扱えます。
33    // 不変 (Immutable) なため、一度作成されたオブジェクトは変更されません。
34    $dateTimeObject = new DateTimeImmutable();
35    echo "現在の日時 (DateTimeImmutableオブジェクト): " . $dateTimeObject->format('Y/m/d H:i:s.v') . PHP_EOL;
36
37    // 5. 現在のマイクロタイムスタンプを取得 (小数点以下の秒数を含む)
38    // microtime() 関数は、現在のUnixタイムスタンプとマイクロ秒を文字列または浮動小数点数で返します。
39    // より高精度な時間測定が必要な場合に使用します。
40    $microTimestamp = microtime(true); // true を渡すと浮動小数点数で返る
41    echo "現在のマイクロタイムスタンプ: " . $microTimestamp . PHP_EOL;
42}
43
44// 関数を実行して結果を表示します。
45displayCurrentTimestamps();

このPHPサンプルコードは、現在時刻を取得し、様々な形式で表示する基本的な方法を紹介しています。システムエンジニアを目指す方にとって、日時処理は多くのシステム開発で必要となる基礎知識です。

まず、time()関数は引数を取らず、現在のUnixタイムスタンプ、つまり1970年1月1日 00:00:00 UTCからの秒数を整数で返します。これは日付の内部表現や計算によく使われます。次に、date()関数は、第一引数に指定されたフォーマット文字列（例: 'Y-m-d H:i:s'）と、省略可能な第二引数に渡されるタイムスタンプを元に、整形された日時文字列を返します。これにより、人間が読みやすい形式で日時を表示できます。

さらに、date_default_timezone_set()関数で 'Asia/Tokyo' のようにタイムゾーンを設定することで、その地域に合わせた正確な日時を取得できるようになります。この関数は引数にタイムゾーン文字列を取り、戻り値はありません。これは、世界中で利用されるシステムを開発する上で非常に重要です。

PHP 5.5以降で推奨されるDateTimeImmutableクラスは、new DateTimeImmutable()としてオブジェクトを作成し、そのformat()メソッドで日時をより安全かつオブジェクト指向的に扱います。このオブジェクトは不変（Immutable）であるため、一度作成されると内容が変更されることはありません。最後に、microtime(true)関数は、引数にtrueを渡すと、現在のUnixタイムスタンプに加えてマイクロ秒（小数点以下の秒数）も含む浮動小数点数で返します。これは、より高い精度での時間測定や処理時間の計測に役立ちます。これらの方法は、PHPアプリケーションで現在時刻を扱うための基本的な選択肢となります。