Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

getATimeメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

getATimeメソッドは、SplTempFileObjectクラスのインスタンスが扱うファイルへの最終アクセス時刻を取得するメソッドです。このメソッドは、ファイルが最後に読み込まれたり、アクセスされたりした時刻をUNIXタイムスタンプ形式の整数値で返します。

UNIXタイムスタンプとは、1970年1月1日00:00:00 UTC(協定世界時)からの経過秒数を表す数値です。このタイムスタンプは、PHPのdate()関数などを用いて、年、月、日、時、分、秒といった人間が読みやすい形式に変換できます。

SplTempFileObjectは、主にメモリ上やシステムの一時ディレクトリに、スクリプトの実行中のみ存在する一時ファイルを効率的に扱うためのPHPの組み込みクラスです。このクラスで作成された一時ファイルに対してgetATimeメソッドを使用することで、そのファイルがいつ最後に読み取り操作などによってアクセスされたかを確認できます。

ファイルへのアクセス時刻は、ファイルの読み込みや、stat()関数のようなファイル情報を取得する操作によって更新されることがあります。しかし、全てのファイルシステムがアクセス時刻を正確に記録するわけではなく、またOSの設定によっては更新されない場合もあるため、その点には注意が必要です。メソッドの実行に失敗した場合は、falseが返されることがあります。このメソッドは、一時ファイルの利用状況を監視したり、特定の処理がいつファイルにアクセスしたかを確認したりする際に役立ちます。

構文(syntax)

1<?php
2
3// SplTempFileObjectのインスタンスを作成
4// 'php://memory' はメモリ上に一時ファイルストリームを作成します
5$tempFile = new SplTempFileObject('php://memory', 'r+');
6
7// ファイルに内容を書き込み、アクセスを発生させる
8$tempFile->fwrite("Sample content for the temporary file.\n");
9$tempFile->rewind(); // ポインタを先頭に戻すことで、読み込み準備が整い、アクセス時刻が更新されやすくなります
10
11// getATime() メソッドを呼び出し、ファイルの最終アクセス時刻を取得します
12// 戻り値はUnixタイムスタンプ形式(整数)です
13$accessTime = $tempFile->getATime();
14
15// 取得したタイムスタンプを読みやすい日付形式に変換して出力します
16echo date('Y-m-d H:i:s', $accessTime);
17
18?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int|false

SplTempFileObject::getATime() は、ファイルが最後にアクセスされた時刻を Unix タイムスタンプ形式の整数で返します。アクセスに失敗した場合は false を返します。

関連コンテンツ