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

openFileメソッドは、SplFileObjectクラスに属し、既に開かれているファイルへの接続を、指定された新しいモードで再度確立するために実行するメソッドです。

SplFileObjectのインスタンスが一度ファイルを開いた後でも、このメソッドを使用することで、同じファイルに対して、読み込みモードから書き込みモードへといったように、ファイルの開くモードを柔軟に変更できます。これにより、ファイルを閉じて開く手間なく、コードを簡潔に保ちます。

このメソッドは、第一引数にファイルを開く「モード」を文字列で指定します。モードはPHPの標準的なfopen()関数と同じ書式で、「r」（読み込み専用）、「w」（書き込み専用、既存内容上書き）、「a」（追記）などがあります。オプション引数として、include_pathからのファイル検索を制御するuse_include_path、およびストリームコンテキストを指定するcontextがあります。

成功時にはtrueを、失敗時にはfalseを返します。ファイルを開けない等のエラー発生時には、RuntimeException例外がスローされることがあります。そのため、適切なエラーハンドリングが重要です。このopenFileメソッドは、ファイル操作の柔軟性を高め、幅広いファイル処理を支援します。

Copy
1<?php
2
3$file = new SplFileObject('path/to/file.txt', 'r', false, stream_context_create());
4
5?>

string $mode = 'r', bool $useIncludePath = false, ?resource $context = null

• string $mode = 'r': ファイルを開くモードを指定します。デフォルトは読み取りモード('r')です。
• bool $useIncludePath = false: include_path を検索するかどうかを指定します。デフォルトは false です。
• ?resource $context = null: ストリームコンテキストを指定します。デフォルトは null です。

戻り値なし

戻り値はありません