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

__toStringメソッドは、DirectoryIteratorオブジェクトを文字列として扱おうとした際に自動的に呼び出される特別なメソッドです。このメソッドは、現在DirectoryIteratorが指し示しているファイルまたはディレクトリのフルパスを文字列として返します。

例えば、DirectoryIteratorのインスタンスをecho文で直接出力したり、文字列連結のオペランドとして使用したり、明示的に文字列型にキャストしたりすると、この__toStringメソッドが実行されます。これにより、DirectoryIteratorで反復処理を行っている際に、個々のファイルやディレクトリのパスを簡単に取得し、例えばログ出力やデバッグ、あるいは他のファイル操作関数への引数として利用することができます。

プログラマが明示的にパス取得用のメソッドを呼び出す手間を省き、オブジェクトをより直感的かつ簡潔に文字列として扱えるように設計されています。この機能は、特にファイルシステムを走査する処理において、コードの可読性と記述性を向上させるのに役立ちます。__toStringはPHP 8以降、例外をスローすることも可能ですが、一般的には文字列表現の取得にのみ利用され、内部でエラーが発生した場合は注意が必要です。

Copy
1<?php
2
3$directoryIterator = new DirectoryIterator('.');
4
5// DirectoryIterator オブジェクトを文字列として扱った場合、
6// __toString() メソッドが自動的に呼び出され、
7// 現在イテレータが指しているファイルまたはディレクトリの名前が返されます。
8echo $directoryIterator;

引数なし

引数はありません

string

DirectoryIterator::__toString メソッドは、現在のディレクトリ要素のパス名を文字列として返します。