【PHP8.x】CURRENT_AS_PATHNAME定数の使い方

CURRENT_AS_PATHNAME定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

FilesystemIterator::CURRENT_AS_PATHNAME定数は、PHPのFilesystemIteratorクラスにおいて、ディレクトリ内の各項目(ファイルやサブディレクトリ)をどのように表現するかを設定するための定数です。FilesystemIteratorは、指定されたディレクトリの中身を一つずつ順番に処理する際に利用される特殊なイテレータで、例えば特定のフォルダ内にある全てのファイルに対して何らかの操作を行いたい場合などに便利です。

このCURRENT_AS_PATHNAME定数をFilesystemIteratorの動作フラグとして設定すると、イテレータが現在指し示している項目を「完全なパス名」として返します。具体的には、ディレクトリ名からファイル名までを含んだ絶対パスまたは相対パスの文字列として、その項目の位置を提供します。

例えば、/var/www/html/というディレクトリをFilesystemIteratorで走査し、その中にindex.phpというファイルがあった場合、CURRENT_AS_PATHNAMEフラグが設定されていれば、イテレータが返す値は単にindex.phpというファイル名ではなく、/var/www/html/index.phpという完全なパス文字列になります。これにより、取得したパスをそのままfile_get_contents()のようなファイル操作関数に渡すなど、後続の処理で簡単に利用できるようになり、コードの記述をより簡潔に進めることが可能です。この定数は、特にファイルやディレクトリの正確な位置情報が必要な場合に非常に役立ちます。

構文(syntax)

1<?php
2
3$iterator = new FilesystemIterator('/path/to/directory', FilesystemIterator::CURRENT_AS_PATHNAME);
4
5?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません