Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

getPathメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

getPathメソッドは、RecursiveDirectoryIteratorクラスにおいて、現在イテレータが指している要素(ファイルやディレクトリ)が存在するディレクトリのパスを取得するメソッドです。

RecursiveDirectoryIteratorは、PHPでファイルシステム内のディレクトリを再帰的に走査し、その中のファイルやサブディレクトリを順番に処理する際に利用されるクラスです。このクラスを使用すると、指定したディレクトリとそのサブディレクトリに含まれるすべてのファイルやフォルダを効率的に探索できます。

このgetPathメソッドは、イテレータが現在処理中のファイルやディレクトリについて、そのファイル名やディレクトリ名を含まず、それらが格納されている親ディレクトリの絶対パスを文字列として返します。例えば、イテレータが/var/www/html/index.phpというファイルに到達した場合、getPath()メソッドを呼び出すと/var/www/htmlという文字列が得られます。これに対し、同じクラスのgetFilename()メソッドはindex.phpを返し、getPathname()メソッドはファイル名を含む完全なパス/var/www/html/index.phpを返します。

getPathメソッドは、ファイルの具体的な名前ではなく、それがどのディレクトリに属しているかを正確に把握したい場合に特に有用です。特定のディレクトリ内のファイルを対象にした処理や、ファイルパスを動的に構築する際の基点として活用できます。ファイルシステムを効率的に操作するための基本的なツールの一つとして、システムエンジニアを目指す方にとって重要な知識となるでしょう。

構文(syntax)

1<?php
2
3$iterator = new RecursiveDirectoryIterator('/path/to/directory');
4$path = $iterator->getPath();
5
6?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

現在のエントリのファイルシステム上のパスを文字列として返します。