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

Copy
1<?php
2
3/**
4 * SplTempFileObject クラスの getMTime メソッドのサンプルコード
5 *
6 * この関数は、SplTempFileObject を使用して一時ファイルにデータを書き込み、
7 * そのファイルの最終更新時刻を getMTime メソッドで取得し、表示します。
8 *
9 * @return void
10 */
11function demonstrateSplTempFileObjectGetMTime(): void
12{
13    // SplTempFileObject のインスタンスを作成します。
14    // 'php://memory' は、一時ファイルを物理ディスクではなくメモリ上で扱うことを指定します。
15    // これにより、ファイル操作が高速になり、ディスクに痕跡を残しません。
16    $tempFile = new SplTempFileObject('php://memory');
17
18    echo "--- SplTempFileObject::getMTime() デモンストレーション ---" . PHP_EOL;
19
20    // 一時ファイルに内容を書き込みます。
21    // この操作によって、ファイルの最終更新時刻 (modification time) が設定または更新されます。
22    $tempFile->fwrite("これは SplTempFileObject を使用して書き込まれた一時データです。\n");
23    $tempFile->fwrite("さらにデータが追加されました。\n");
24
25    echo "一時ファイルにデータを書き込みました。" . PHP_EOL;
26
27    // getMTime() メソッドを呼び出して、ファイルの最終更新時刻を取得します。
28    // 戻り値は、Unixタイムスタンプ（1970年1月1日00:00:00 UTCからの秒数）です。
29    $modificationTimestamp = $tempFile->getMTime();
30
31    echo "取得した最終更新時刻 (Unixタイムスタンプ): " . $modificationTimestamp . PHP_EOL;
32
33    // Unixタイムスタンプを人間が読める形式の日付と時刻に変換して表示します。
34    // date() 関数は、指定されたフォーマット文字列に従ってタイムスタンプを変換します。
35    echo "人間が読める形式の最終更新時刻: " . date('Y-m-d H:i:s', $modificationTimestamp) . PHP_EOL;
36
37    echo "-----------------------------------------------------------" . PHP_EOL;
38
39    // スクリプトの終了時に $tempFile オブジェクトがスコープ外に出ると、
40    // メモリ上のファイルは自動的に解放されます。
41}
42
43// 関数を実行して、getMTime メソッドの動作を確認します。
44demonstrateSplTempFileObjectGetMTime();
45

SplTempFileObject::getMTime メソッドは、PHPで一時ファイルを扱うための SplTempFileObject クラスに属し、その一時ファイルの最終更新時刻を取得するために使用されます。

このメソッドは引数を一切必要としません。呼び出されると、対象となる一時ファイルが最後に変更された日時をUnixタイムスタンプとして整数（int）型で返します。Unixタイムスタンプとは、1970年1月1日00:00:00 UTC（協定世界時）からの経過秒数を表す数値です。この数値は人間には直接読み解きにくいため、通常は date() 関数などと組み合わせて「YYYY-MM-DD HH:MM:SS」といった分かりやすい形式に変換して利用されます。

サンプルコードでは、SplTempFileObject('php://memory') を使ってメモリ上に一時ファイルを作成し、データが書き込まれた後に getMTime() メソッドで最終更新時刻を取得しています。php://memory を使用することで、物理ディスクではなくメモリ上で高速にファイル操作が行われ、スクリプト終了時にファイルが自動的に削除されるため、一時ファイルの管理が容易になります。このメソッドにより、ファイルの鮮度や更新履歴をプログラムで確認することが可能です。