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

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

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

作成日: 更新日:

基本的な使い方

getModifiedメソッドは、PharDataアーカイブに含まれる特定のファイルやディレクトリの最終変更時刻を取得するメソッドです。このメソッドは、PharDataクラスのインスタンスに対して呼び出され、主に.tarや.zipなどのアーカイブファイル内の各要素がいつ更新されたかを確認するために利用されます。

引数には、変更時刻を知りたいアーカイブ内のエントリのパスを文字列で指定します。例えば、アーカイブ内に保存されている「data/config.ini」というファイルの変更時刻を知りたい場合、「getModified('data/config.ini')」のように記述します。

戻り値は、指定されたエントリの最終変更時刻をUnixタイムスタンプ形式の整数値で返します。Unixタイムスタンプは、1970年1月1日00:00:00 UTCからの経過秒数で表されるため、取得した時刻を人間が読める形式に変換するには、date()関数などPHPの他の関数と組み合わせて利用することが一般的です。

このメソッドは、アーカイブ内の特定のファイルの鮮度をチェックしたり、前回の更新日時と比較して同期処理を行う場合などに非常に有用です。指定されたエントリがアーカイブ内に存在しない場合は、PharExceptionがスローされるため、適切なエラー処理を実装することが推奨されます。

構文(syntax)

1<?php
2$pharData = new PharData('archive.tar');
3$modifiedTimestamp = $pharData->getModified();
4?>

引数(parameters)

string $entry

  • string $entry: Pharアーカイブ内のエントリ(ファイルまたはディレクトリ)のパスを指定する文字列

戻り値(return)

int

このメソッドは、Pharアーカイブの最終更新日時をUnixタイムスタンプ(1970年1月1日午前0時0分0秒からの経過秒数)で返します。

関連コンテンツ