【PHP8.x】__toStringメソッドの使い方

__toStringメソッドは、オブジェクトが文字列として扱われた際に、そのオブジェクトの文字列表現を返すために実行されるメソッドです。これはPHPの特殊なマジックメソッドの一つとして定義されており、オブジェクトを直接echoで出力したり、文字列連結のコンテキストで使用したりする際に自動的に呼び出されます。

FilesystemIteratorクラスにおける__toStringメソッドは、現在のイテレータが指し示しているファイルまたはディレクトリのフルパスを文字列として返します。FilesystemIteratorは、ファイルシステム内の項目を反復処理するためのイテレータであり、このメソッドを実装することで、イテレータのインスタンスを文字列として扱うだけで、現在処理中のファイルやディレクトリのパスを簡単に取得できるようになります。

具体的には、FilesystemIteratorのオブジェクトをecho文で出力したり、文字列と連結したりすると、この__toStringメソッドが自動的に実行され、そのオブジェクトが現在指している要素のパス名（例えば /path/to/file.txt のような形式）が文字列として返されます。これにより、明示的にgetPathname()のようなメソッドを呼び出すことなく、オブジェクトから直接パス情報を得られるため、コードの記述をより簡潔にし、可読性を向上させることができます。デバッグ時やログ出力時など、現在のファイルパスを素早く確認したい場合に特に有用です。

Copy
1class FilesystemIteratorExample {
2    public function __toString(): string {}
3}

引数なし

引数はありません

string

このメソッドは、FilesystemIterator オブジェクトを文字列として表したものを返します。