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

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

作成日: 更新日:

基本的な使い方

getPathメソッドは、SplFileInfoオブジェクトが表すファイルまたはディレクトリの親ディレクトリのパスを取得するメソッドです。

このメソッドは、PHPの標準拡張機能であるStandard PHP Library(SPL)の一部として提供されるSplFileInfoクラスに属しています。SplFileInfoクラスは、ファイルやディレクトリに関する様々な情報をオブジェクト指向的に扱うための便利な機能を提供し、ファイルシステムの操作をより簡単かつ安全に行えるように設計されています。

getPathメソッドを呼び出すと、SplFileInfoオブジェクトが示すファイルまたはディレクトリの、ファイル名やディレクトリ名自体を含まない親ディレクトリのパスが文字列として返されます。例えば、/path/to/my_file.txtというパスを持つSplFileInfoオブジェクトに対してこのメソッドを実行すると、/path/toという文字列が返されます。同様に、/var/log/myapp/というディレクトリを表すオブジェクトに対しては、/var/logが返されます。

このメソッドは、ファイルやディレクトリの親階層に位置するディレクトリに対して何らかの処理を行いたい場合に特に有用です。例えば、ファイルが格納されているディレクトリの権限を確認したり、そのディレクトリ内に別の関連ファイルを生成したりする際に、正確な親ディレクトリのパスを効率的に取得するために利用されます。戻り値は常に文字列型であり、ファイルシステムの階層構造をプログラムで扱う上で非常に基本的ながら重要な情報を提供します。

構文(syntax)

1<?php
2$fileInfo = new SplFileInfo('/var/www/html/index.php');
3$directoryPath = $fileInfo->getPath();
4?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

SplFileInfo::getPath メソッドは、SplFileInfo オブジェクトが表すファイルの絶対パスから、ディレクトリ部分の文字列を返します。

【PHP8.x】getPathメソッドの使い方 | いっしー@Webエンジニア