dir

(PHP 4, PHP 5, PHP 7)

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

説明

dir ( string $directory [, resource $context ] ) : Directory

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

パラメータ

directory

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

context

注意: コンテキストのサポートは、 PHP 5.0.0 で追加されました。contexts の説明に関しては、ストリームを参照してください。

返り値

Directory のインスタンスを返します。パラメータが間違っている場合は NULL、それ以外のエラーの場合は FALSE を返します。

例

例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

注意

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