dir

ディレクトリクラスのインスタンスを返す

説明

Directoryfalse dir(string $directory, resourcenull $context = null)

ディレクトリを読むための疑似オブジェクト指向の機構です。 指定した directory がオープンされます。

パラメータ

directory

オープンするディレクトリ。

context

ストリームコンテキストリソース

戻り値

Directory のインスタンスを返します。 エラーの場合は false を返します。

変更履歴

バージョン 説明
8.0.0 context は、nullable になりました。

例1 dir の例

以下の例で、Directory::read の戻り値をどのように調べているかに 注目してください。戻り値が false と一致することを、明示的に (値が等しく、かつ型も等しい - 詳細は 比較演算子 を参照ください)調べています。なぜなら、そうしないと false と評価されてしまうディレクトリエントリがあった場合にループが とまってしまうからです。

<?php
$d = dir("/etc/php5");
echo "Handle: " . $d->handle . "\n";
echo "Path: " . $d->path . "\n";
while (false !== ($entry = $d->read())) {
   echo $entry."\n";
}
$d->close();
?>

上の例の出力は、 たとえば以下のようになります。

Handle: Resource id #2
Path: /etc/php5
.
..
apache
cgi
cli

注意

注意:

読み込みにより返されるディレクトリエントリの順番は、システムに依存します。