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

Copy
1<?php
2
3/**
4 * SplTempFileObject を使用して、一時ファイルの作成時刻または最終ステータス変更時刻を取得するサンプルコードです。
5 *
6 * SplTempFileObject::getCTime() メソッドは、ファイルの inode (メタデータ) が
7 * 最後に変更された時刻を Unix タイムスタンプで返します。
8 * Unix系システムではファイルのパーミッションや所有者などのメタデータ変更でも更新される時刻を指し、
9 * Windowsでは一般的にファイルが作成された時刻を返します。
10 */
11
12// SplTempFileObject のインスタンスを作成します。
13// これはメモリ上または一時ファイルシステム上に一時ファイルを作成します。
14$tempFile = new SplTempFileObject();
15
16// getCTime() メソッドを呼び出して、ファイルの作成時刻または最終ステータス変更時刻を
17// Unix タイムスタンプ形式で取得します。
18$creationTimestamp = $tempFile->getCTime();
19
20echo "一時ファイルの作成時刻または最終ステータス変更時刻 (Unixタイムスタンプ): " . $creationTimestamp . "\n";
21
22// 取得したUnixタイムスタンプを、人間が読みやすい日付時刻形式に変換して表示します。
23// date() 関数は、タイムスタンプを特定のフォーマットで日付文字列に変換するために使用されます。
24echo "読みやすい形式: " . date('Y-m-d H:i:s', $creationTimestamp) . "\n";
25
26// スクリプトの実行終了時、SplTempFileObject は自動的に一時ファイルをクリーンアップします。
27
28?>

SplTempFileObject::getCTime()は、PHPで一時ファイルを扱うSplTempFileObjectクラスのメソッドです。このメソッドは引数を取らず、一時ファイルの作成時刻、またはファイルのメタデータが最後に変更された時刻を整数値のUnixタイムスタンプとして返します。Unix系システムではファイルのパーミッションや所有者などのメタデータ変更時刻を指すことが多く、Windowsシステムでは一般的にファイルが作成された時刻を返します。

サンプルコードでは、まずnew SplTempFileObject()でメモリ上または一時ファイルシステムに一時ファイルを作成し、そのインスタンスを取得します。次に、作成した$tempFileオブジェクトのgetCTime()メソッドを呼び出すことで、前述の時刻を表すUnixタイムスタンプが$creationTimestamp変数に格納されます。この数値は、1970年1月1日00:00:00 UTCからの経過秒数を表します。

取得したUnixタイムスタンプはそのままでは人間が読みづらいため、date()関数と組み合わせてdate('Y-m-d H:i:s', $creationTimestamp)のように使用することで、「年-月-日 時:分:秒」といった分かりやすい形式に変換して表示できます。このメソッドは、一時ファイルの管理において、作成やステータス変更のタイミングを正確に把握する際に役立ちます。SplTempFileObjectで作成された一時ファイルは、スクリプトの実行終了時に自動的にクリーンアップされます。

Copy
1<?php
2
3/**
4 * SplTempFileObject::getCTime() の使用例
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、
7 * PHPのSplTempFileObjectクラスの一時ファイルの作成時刻（inode変更時刻）を
8 * 取得する方法を示します。
9 */
10function demonstrateSplTempFileObjectGetCTime(): void
11{
12    echo "SplTempFileObject::getCTime() のデモンストレーションを開始します。\n\n";
13
14    try {
15        // 1. SplTempFileObject のインスタンスを作成します。
16        //    'php://temp' を使用すると、一時ファイルがメモリまたは必要に応じてディスクに作成されます。
17        //    'r+' は読み書きモードを意味し、ファイルが存在しない場合は作成されます。
18        //    SplTempFileObject はファイルポインタ（fopenの戻り値）を渡しても、
19        //    直接ファイルパスを渡してもインスタンス化できます。
20        $tempFile = new SplTempFileObject('php://temp', 'r+');
21
22        echo "一時ファイルを作成しました。\n";
23
24        // 2. 一時ファイルにデータを書き込みます。（この操作は必須ではありませんが、ファイルが使われていることを示します）
25        $tempFile->fwrite("これは一時ファイルの内容です。\n");
26        $tempFile->fwrite("追加のデータ行。\n");
27
28        echo "一時ファイルにデータを書き込みました。\n";
29
30        // 3. getCTime() メソッドを呼び出して、一時ファイルの作成時刻（inode変更時刻）のタイムスタンプを取得します。
31        //    戻り値は、1970年1月1日 00:00:00 UTC からの秒数（UNIXタイムスタンプ）を表す整数です。
32        $creationTimestamp = $tempFile->getCTime();
33
34        echo "\n取得した作成時刻（UNIXタイムスタンプ）: " . $creationTimestamp . "\n";
35
36        // 4. 取得したUNIXタイムスタンプを人間が読める日付・時刻形式に変換して表示します。
37        //    date() 関数は、タイムスタンプを指定されたフォーマットの文字列に変換します。
38        //    'Y-m-d H:i:s' は「年-月-日 時:分:秒」の形式です。
39        echo "取得した作成時刻（人間が読める形式）: " . date('Y-m-d H:i:s', $creationTimestamp) . "\n";
40
41    } catch (Exception $e) {
42        // 例外（エラー）が発生した場合、そのメッセージを表示します。
43        echo "\nエラーが発生しました: " . $e->getMessage() . "\n";
44    }
45
46    echo "\nデモンストレーションを終了します。\n";
47    // スクリプトの実行が終了するか、SplTempFileObjectオブジェクトがスコープ外に出ると、
48    // 一時ファイルは自動的に閉じられ、削除されます。
49}
50
51// 関数を実行してデモンストレーションを開始します。
52demonstrateSplTempFileObjectGetCTime();
53
54?>

このサンプルコードは、PHPのSplTempFileObjectクラスに属するgetCTime()メソッドの基本的な使い方を、システムエンジニアを目指す初心者向けに解説しています。SplTempFileObjectは、一時的なファイル（メモリ上やディスク上）を簡単に作成し、操作するためのクラスです。

getCTime()メソッドは、この一時ファイルの作成時刻、より正確にはファイルシステムのinode変更時刻をUNIXタイムスタンプとして取得するために使用されます。コードでは最初にnew SplTempFileObject('php://temp', 'r+')という記述で、メモリ上の一時ファイルを作成しています。このファイルにデータを書き込んだ後、$tempFile->getCTime()を呼び出すことで、作成時刻を示す整数値（UNIXタイムスタンプ）が取得されます。

getCTime()メソッドは引数を必要としません。戻り値は、1970年1月1日00:00:00 UTCからの経過秒数を表す整数値です。取得したこの整数値は、date()関数を利用することで「年-月-日 時:分:秒」のような人間が読みやすい日付・時刻形式に変換して表示することができます。なお、SplTempFileObjectで作成された一時ファイルは、スクリプトの実行が終了するか、オブジェクトがスコープ外に出ると自動的に閉じられ、削除されるため、ファイルのクリーンアップを意識する必要はありません。