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

getRealPathメソッドは、RecursiveDirectoryIteratorクラスに属するメソッドです。このメソッドは、現在処理中のファイルやディレクトリについて、「正規化された絶対パス」を取得するために使用されます。

「正規化された絶対パス」とは、シンボリックリンク（別のファイルやディレクトリへのショートカットのようなもの）が存在する場合に、それが実際に指し示している元の物理的なパスを特定し、さらにパスに含まれる「.」（現在のディレクトリ）や「..」（親ディレクトリ）といった相対的な要素をすべて解決して、システム上で一意に決まる完全なパスを指します。

具体的には、たとえば、ファイルがシンボリックリンクであった場合、getRealPathメソッドはそのシンボリックリンク自身のアドレスではなく、そのリンクが指し示す実際のファイルのパスを返します。これにより、ファイルの実体を正確に把握することができます。

このメソッドは、ファイルやディレクトリの操作を行う際に、パスの曖昧さをなくし、実際の物理的な位置を確実に特定したい場合に非常に役立ちます。特に、セキュリティ上の理由や、異なるシステム間で正確なパス情報が必要となる場面で、その真価を発揮します。PHP 8では、通常、文字列として正規化された絶対パスが返されますが、指定されたパスが存在しないなど、解決できない状況ではfalseが返されることがあります。

Copy
1<?php
2
3$targetDirectory = __DIR__;
4
5$directoryIterator = new RecursiveDirectoryIterator($targetDirectory);
6
7foreach ($directoryIterator as $fileInfoObject) {
8    $absolutePath = $fileInfoObject->getRealPath();
9}

引数なし

引数はありません

string|false

RecursiveDirectoryIterator::getRealPathメソッドは、対象となるファイルまたはディレクトリの絶対パスを文字列で返します。ただし、パスが存在しない、またはアクセスできない場合はfalseを返します。