【PHP8.x】finfo::set_flags()メソッドの使い方
set_flagsメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
set_flagsメソッドは、ファイル情報を取得するためのfinfoオブジェクトのオプション（フラグ）を設定または変更するために実行するメソッドです。このメソッドは、finfoクラスのコンストラクタで指定したオプションを、オブジェクト作成後に動的に上書きしたい場合に使用します。引数には、どのような情報を取得するか、またはどのようにファイルを扱うかを指定するための、FILEINFO_NONEやFILEINFO_MIME_TYPEといった定義済みの定数を渡します。例えば、FILEINFO_MIME_TYPEフラグを設定すると、finfo::fileメソッドなどがファイルの種類を"text/plain"のようなMIMEタイプ形式で返すようになります。また、複数のオプションを同時に設定したい場合は、ビット単位の論理和演算子「|」を用いて、FILEINFO_MIME_TYPE | FILEINFO_MIME_ENCODINGのように連結して指定することが可能です。このメソッドは、実際にfinfo::fileやfinfo::bufferメソッドを呼び出してファイル情報を取得する前に実行する必要があります。処理が成功した場合はtrueを、失敗した場合はfalseを返します。
構文(syntax)
1public finfo::set_flags(int $flags): bool
引数(parameters)
int $flags
- int $flags: ファイル情報の取得方法を制御するビットフラグを指定する整数
戻り値(return)
bool
finfo::set_flags メソッドは、MIME タイプ情報の取得方法を設定します。操作が成功した場合は true を、失敗した場合は false を返します。