読み込み中...

【簡単】PHPのパス操作の具体例10選

PHPのパス操作の例を表現したイラスト PHP
この記事は約12分で読めます。

【サイト内のコードはご自由に個人利用・商用利用いただけます】

この記事では、プログラムの基礎知識を前提に話を進めています。

説明のためのコードや、サンプルコードもありますので、もちろん初心者でも理解できるように表現してあります。

本記事のサンプルコードを活用して機能追加、目的を達成できるように作ってありますので、是非ご活用ください。

※この記事は、一般的にプロフェッショナルの指標とされる『実務経験10,000時間以上』を満たす現役のプログラマチームによって監修されています。

※Japanシーモアは、常に解説内容のわかりやすさや記事の品質に注力しております。不具合、分かりにくい説明や不適切な表現、動かないコードなど気になることがございましたら、記事の品質向上の為にお問い合わせフォームにてご共有いただけますと幸いです。
(送信された情報は、プライバシーポリシーのもと、厳正に取扱い、処分させていただきます。)

はじめに

この記事を読めば、PHPでのパス操作が身につきます。

PHPとパス操作が初めての方でも、具体的な使い方と実践的なコード例を10個紹介するので、理解できるようになります。

●PHPとパス操作とは

PHPはサーバーサイドのスクリプト言語で、データベース操作やファイル操作、パス操作といった処理を行います。

パス操作とは、ファイルやディレクトリの場所を示すパスに関する操作のことです。

パス操作により、特定のファイルを開いたり、ディレクトリを作成・削除したりすることが可能になります。

○ファイルパスとディレクトリパスの違い

ファイルパスは特定のファイルまでの道のりを表し、ディレクトリパスは特定のディレクトリ(フォルダ)までの道のりを示します。

ディレクトリパスはファイルパスの一部でもあります。

●PHPでのパス操作の基本

PHPでのパス操作にはいくつかの関数が用意されています。

それぞれの関数がどのような役割を持ち、どのように使用するのかを把握することで、より効率的なプログラミングが可能となります。

○パス操作に使う関数の概要

PHPにはパス操作のための関数がいくつかあります。

例えば、realpath()は指定したパスの絶対パスを返します。

dirname()は指定したパスのディレクトリ名を返し、basename()は指定したパスのファイル名を返します。

pathinfo()はパスに関する情報を配列として返します。

●PHPのパス操作の具体例10選

PHPのパス操作を理解するために、具体的なコード例を10個紹介します。

これらのコード例を通じて、PHPのパス操作について深く理解することができます。

○サンプルコード1:現在のスクリプトの絶対パスを取得

下記のコードは、PHPの__FILE__マジック定数とrealpath()関数を使用して、現在のスクリプトの絶対パスを取得します。

// 現在のスクリプトの絶対パスを取得
$scriptPath = realpath(__FILE__);
echo $scriptPath;

この例では、__FILE__マジック定数を使って現在のスクリプトのファイルパスを取得し、それをrealpath()関数に渡して絶対パスを取得しています。

__FILE__は現在のスクリプトのフルパス(絶対パス)を含む特殊な定数です。

しかし、このパスにはシンボリックリンクや相対パスが含まれる場合があります。

そこでrealpath()関数を使用して絶対パスを正規化し、シンボリックリンクを解決します。

これにより、どこからスクリプトを実行しても同じ絶対パスを得ることができます。

○サンプルコード2:ディレクトリ名を取得

次のコードは、PHPのdirname()関数を使用して、指定したパスのディレクトリ名を取得します。

// パスを指定
$path = '/var/www/html/index.php';

// ディレクトリ名を取得
$dirName = dirname($path);
echo $dirName;

このコードでは、dirname()関数を使って指定したパスのディレクトリ部分を取得しています。

この例では/var/www/html/index.phpというパスから/var/www/htmlというディレクトリ名を取得しています。

dirname()関数は、指定したファイルパスからそのファイルが所在するディレクトリのパスを返すため、ファイルの所在するディレクトリを知ることが可能です。

これは、特定のファイルに対する操作やそのファイルの情報取得を行う前に、そのファイルが所在するディレクトリを確認する際に役立ちます。

○サンプルコード3:ファイル名を取得

次に、指定したパスからファイル名を取得するためのコードを見てみましょう。

PHPのbasename()関数を使用します。

// パスを指定
$path = '/var/www/html/index.php';

// ファイル名を取得
$fileName = basename($path);
echo $fileName;

上記の例では、basename()関数を用いて、指定したパス/var/www/html/index.phpからファイル名index.phpを取得しています。

basename()関数は指定したパスから最後の部分、つまりファイル名を返す関数です。

ディレクトリ名とファイル名を一緒に扱うパスから、具体的なファイル名を単独で取得する場合に便利です。

○サンプルコード4:拡張子を取得

PHPのpathinfo()関数を使うことで、パスの情報からファイル名やディレクトリ名、拡張子などを取得することが可能です。

ここでは、特に拡張子を取得する方法を見てみましょう。

// パスを指定
$path = '/var/www/html/index.php';

// 拡張子を取得
$extension = pathinfo($path, PATHINFO_EXTENSION);
echo $extension;

このコードではpathinfo()関数を使って指定したパス/var/www/html/index.phpから拡張子phpを取得しています。

pathinfo()関数はファイルパスの情報を配列で返しますが、第二引数に特定の定数を指定することで、その定数に対応する情報だけを取得することも可能です。

ここではPATHINFO_EXTENSIONを指定して、拡張子のみを取得しています。

ファイルの種類を判別するためや、特定の拡張子のファイルだけを操作する場合などに活用できます。

○サンプルコード5:パスの正規化

パスを扱う際には、”.”や”..”といった相対パスが混ざっていることがあります。

これらのパスを正規化(絶対パスに変換)するために、PHPのrealpath()関数を用います。

// 相対パスを指定
$path = './index.php';

// パスの正規化
$normalizedPath = realpath($path);
echo $normalizedPath;

このコードでは、realpath()関数を使って相対パス./index.phpを正規化しています。

realpath()関数は、指定したパスを絶対パスに変換し、かつシンボリックリンクを解決したパスを返します。

これにより、システムに依存しない絶対パスを得ることができます。

また、存在しないパスを指定した場合は、realpath()関数はfalseを返すため、パスの存在確認にも使うことができます。

○サンプルコード6:相対パスから絶対パスへの変換

PHPにおいては相対パスを絶対パスに変換することもできます。

それにはrealpath()関数を使用します。

これは先程紹介したrealpath()関数をもう一度活用します。

// 相対パスを指定
$relativePath = '../public_html/index.php';

// 相対パスから絶対パスへの変換
$absolutePath = realpath($relativePath);
echo $absolutePath;

このコードでは、realpath()関数を使って相対パス../public_html/index.phpを絶対パスに変換しています。

realpath()関数は、指定したパスが存在する場合、その絶対パスを返します。

つまり、シンボリックリンクを解決したり、相対パスを絶対パスに変換したりすることが可能です。

○サンプルコード7:パスの情報を配列で取得

次に、パスの各部分を配列として取得する方法を見てみましょう。

これにはpathinfo()関数を使用します。

// パスを指定
$path = '/var/www/html/index.php';

// パスの情報を配列で取得
$pathInfo = pathinfo($path);
print_r($pathInfo);

このコードでは、pathinfo()関数を使って指定したパス/var/www/html/index.phpの情報を配列で取得しています。

pathinfo()関数は、パスの情報を下記のキーを持つ連想配列で返します。

  • dirname:ディレクトリのパス
  • basename:ファイル名
  • extension:ファイルの拡張子
  • filename:拡張子を除いたファイル名

つまり、このコードを実行すると次のような出力が得られます。

Array
(
    [dirname] => /var/www/html
    [basename] => index.php
    [extension] => php
    [filename] => index
)

これらの情報を利用することで、パスに含まれるディレクトリのパスやファイル名、拡張子を個別に操作したり、抽出したりすることが可能になります。

○サンプルコード8:ディレクトリ内のファイル一覧取得

特定のディレクトリ内のファイル一覧を取得したい場合は、PHPのscandir()関数を利用します。

下記のサンプルコードでは、指定したディレクトリ内の全てのファイルとディレクトリの一覧を取得しています。

// ディレクトリを指定
$directory = '/var/www/html/';

// ディレクトリ内のファイル一覧を取得
$files = scandir($directory);
print_r($files);

このコードでは、scandir()関数を使って指定したディレクトリ/var/www/html/内の全てのファイルとディレクトリの一覧を取得しています。

scandir()関数は指定したディレクトリ内のファイルとディレクトリの名前を配列で返します。

そのため、このコードを実行すると次のような出力が得られます(出力は環境により異なります)。

Array
(
    [0] => .
    [1] => ..
    [2] => index.php
    [3] => style.css
    [4] => images
)

これらの情報を利用して、ディレクトリ内のファイルやサブディレクトリを調べたり、特定のファイルが存在するかどうかを確認したりすることが可能になります。

○サンプルコード9:ディレクトリの作成

次に、新たにディレクトリを作成する方法を見てみましょう。

PHPではmkdir()関数を使用して新しいディレクトリを作成することができます。

// 作成するディレクトリのパスを指定
$directory = '/var/www/html/new_directory';

// ディレクトリを作成
if (mkdir($directory)) {
    echo "ディレクトリ '{$directory}' を作成しました。";
} else {
    echo "ディレクトリ '{$directory}' の作成に失敗しました。";
}

このコードでは、mkdir()関数を使って新しいディレクトリ/var/www/html/new_directoryを作成しています。

mkdir()関数は指定したパスに新しいディレクトリを作成し、成功するとtrueを返し、失敗するとfalseを返します。

このため、このコードを実行するとディレクトリが正常に作成できた場合は「ディレクトリ ‘/var/www/html/new_directory’ を作成しました。」と表示され、作成に失敗した場合は「ディレクトリ ‘/var/www/html/new_directory’ の作成に失敗しました。」と表示されます。

○サンプルコード10:ディレクトリの削除

ディレクトリを削除するためには、PHPのrmdir()関数を使用します。

この関数は指定されたディレクトリを削除しますが、そのディレクトリが空でなければならないという点に注意が必要です。

下記に表すのは、rmdir()関数を使用してディレクトリを削除するサンプルコードです。

// 削除するディレクトリのパスを指定
$directory = '/var/www/html/new_directory';

// ディレクトリを削除
if (rmdir($directory)) {
    echo "ディレクトリ '{$directory}' を削除しました。";
} else {
    echo "ディレクトリ '{$directory}' の削除に失敗しました。";
}

このコードでは、rmdir()関数を使って指定したディレクトリ/var/www/html/new_directoryを削除しています。

rmdir()関数はディレクトリの削除に成功するとtrueを返し、失敗するとfalseを返します。

したがって、このコードを実行するとディレクトリが正常に削除された場合は「ディレクトリ ‘/var/www/html/new_directory’ を削除しました。」と表示され、削除に失敗した場合は「ディレクトリ ‘/var/www/html/new_directory’ の削除に失敗しました。」と表示されます。

ここまでで、PHPを用いたパス操作の基本的な手法を学んできました。

これらの手法は、ファイルシステムを扱う際の基本的な操作であり、さまざまなアプリケーションで利用されます。

●パス操作の注意点

PHPにおけるパス操作を行う際には、いくつかの注意点があります。

最初に、パスを操作する際には、そのパスが存在し、かつ適切な権限があることを確認することが重要です。

また、パスの指定方法には絶対パスと相対パスの2種類があり、それぞれ適切な場面で使い分けることが求められます。

その上で、特にファイルやディレクトリを削除する際には、不要なデータを誤って削除しないように、慎重な操作が求められます。

常に最新のバックアップを保持しておくことも重要な対策の一つと言えるでしょう。

●PHPにおけるパス操作の応用例

基本的なパス操作を身につけたら、次に考えるべきはそれらを組み合わせてどのように活用するか、ということです。

例えば、ファイルシステムを走査して特定のファイルを探すプログラムを作成したり、ディレクトリの階層を動的に作成したり、ログファイルを定期的に削除するスクリプトを作成したりと、実用的な応用例は無数に存在します。

まとめ

ここまで、PHPによるパス操作の具体例として、ファイルやディレクトリのパスを取得する方法、ファイル名やディレクトリ名を取得する方法、パスの情報を取得する方法、ディレクトリ内のファイル一覧を取得する方法、ディレクトリの作成や削除の方法など、10の実用的なコード例を見てきました。

これらの手法は、データの保存や管理、システムの動作の制御など、様々な場面で利用することができます。

これらのパス操作の方法を理解し、自身のコードに適切に活用することで、より効率的かつ確実なプログラミングが可能になります。

また、これらの基本的な操作を組み合わせることで、更に複雑なパス操作も可能になるでしょう。

なお、パス操作を行う際には、パスの存在と権限の確認、パスの指定方法(絶対パスと相対パス)、データの安全性など、いくつかの注意点を念頭に置くことが重要です。

本記事が、PHPにおけるパス操作の基本を理解し、自身のプログラミングスキルを向上させる一助となれば幸いです。

プログラミングは継続的な学びが必要な分野ですので、常に新たな知識を取り入れ、実践的なコード作成に励むことをおすすめします。

今後もPHPを始めとするプログラミング言語に関する様々な知識やテクニックを深めていきましょう。