PHP マニュアル: ファイルの SplFileObject オブジェクトを取得する

説明

public SplFileObject SplFileInfo::openFile(string $mode = "r", bool $useIncludePath = false, resourcenull $context = null)

ファイルの SplFileObject オブジェクトを作成します。これが便利なのは、SplFileObject にはファイルを操作するためのさまざまなメソッドが追加されているからです。 SplFileInfo には、たとえばファイルが書き込み可能かどうかなどといった情報を取得するだけの機能しかありません。

パラメータ

mode: ファイルを開く際のモード。使用できるモードについての説明は fopen のドキュメントを参照ください。デフォルトは読み込み専用となります。
useIncludePath: true に設定すると、このファイル名を include_path の中からも探します。
context: コンテキスト についての説明は、マニュアルのコンテキストの節を参照ください。

戻り値

オープンしたファイルを SplFileObject オブジェクトで返します。

エラー / 例外

ファイルをオープンできない (アクセス権限が適切でないなど) 場合に RuntimeException が発生します。

変更履歴

バージョン	説明
8.0.0	`context` は、nullable になりました。

例

例1 SplFileInfo::openFile の例

<?php
$fileinfo = new SplFileInfo('/tmp/foo.txt');

if ($fileinfo->isWritable()) {

    $fileobj = $fileinfo->openFile('a');

    $fileobj->fwrite("appended this sample text");
}
?>

参考

SplFileObject
stream_context_create
fopen