Phar::offsetGet

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 1.0.0)

Phar::offsetGet — 指定したファイルの PharFileInfo オブジェクトを取得する

説明

public function Phar::offsetGet(string $localName): SplFileInfo

これは ArrayAccess インターフェイスを実装したものです。これにより、Phar アーカイブの内容に対して配列形式の角括弧を使用したアクセスが可能となります。 Phar::offsetGet() を使用して、Phar アーカイブからファイルを取得します。

パラメータ

localName: Phar 内で探すファイル名 (相対パス)。

戻り値

PharFileInfo オブジェクトを返します。これを使用して、ファイルの内容を順に処理したりファイルの情報を取得したりします。

エラー / 例外

そのファイルが Phar アーカイブ内に存在しない場合に、このメソッドは BadMethodCallException をスローします。

例

例1 Phar::offsetGet() の例

ArrayAccess インターフェイスを実装した他のクラスと同様、 Phar::offsetGet() は [] 演算子を使用した場合に自動的にコールされます。

<?php
$p = new Phar(dirname(__FILE__) . '/myphar.phar', 0, 'myphar.phar');
$p['exists.txt'] = "file exists\n";
try {
    // 自動的に offsetGet() をコールします
    echo $p['exists.txt'];
    echo $p['doesnotexist.txt'];
} catch (BadMethodCallException $e) {
    echo $e;
}
?>

上の例の出力は以下となります。

file exists
Entry doesnotexist.txt does not exist

参考

Phar::offsetExists() - ファイルが phar 内に存在するかどうかを調べる
Phar::offsetSet() - 内部ファイルに、外部ファイルの内容を設定する
Phar::offsetUnset() - ファイルを phar から削除する

関連キーワード:

Phar offsetGet phar PharFileInfo exists アーカイブ offsetExists offsetSet localName ArrayAccess インターフェイス実装 BadMethodCallException 自動的 myphar doesnotexist SplFileInfo 角括弧相対演算子 dirname catch Entry exist 参考