dir

(PHP 3, PHP 4, PHP 5)

dir -- ディレクトリクラス

説明

class dir {

dir ( string directory )

string path

resource handle

string read ( void )

void rewind ( void )

void close ( void )

}

ディレクトリを読むための疑似オブジェクト指向の機構です。 指定した directory がオープンされます。 いったんディレクトリがオープンされると、2 つのプロパティを使用 できるようになります。handle プロパティは、readdir (), rewinddir(), closedir() のような他のディレクトリ関数と組み合わせて 使用可能です。path プロパティには、オープンするディレクトリのパス がセットされます。read, rewind, close の 3 種類のメソッドが 使用できます。

例 1. dir() の例

以下の例で、dir() の返り値をどのように調べているかに 注目してください。返り値が 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

注意

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

注意: この関数は内部クラス Directory を定義します。つまり、これと同じ名前の クラスを独自に作成することはできないということです。PHP で事前に 定義されているクラスの一覧は、予約済みのクラス を参照ください。