glob
(PHP 4 >= 4.3.0, PHP 5, PHP 7)
glob — パターンにマッチするパス名を探す
説明
glob
( string $pattern
[, int $flags
= 0
] ) : array
glob() 関数は libc の glob()
関数で使われるルールに基づいて
pattern
にマッチする全てのパス名を検索します。
ルールは、一般のシェルで使われるルールと似ています。
パラメータ
pattern
パターン。チルダの展開やパラメータ置換は行いません。
Special characters:
-
*
- ゼロ文字以上の文字にマッチします。 -
?
- 正確に(任意の)一文字にだけマッチします。 -
[...]
- グループ化された文字のうち、一文字にマッチします。 はじめの文字が!
だった場合、 グループにないあらゆる文字にマッチします。 -
\
- 次に来る文字をエスケープします。 但し、GLOB_NOESCAPE
が使われている場合は除きます。
-
flags
有効なフラグは次のとおりです。
-
GLOB_MARK
- 各ディレクトリにスラッシュ (Windows ではバックスラッシュ) を追加します -
GLOB_NOSORT
- ディレクトリに存在するファイルを返します (ソートはされません)。このフラグを使わない場合は、パス名をアルファベット順にソートします。 -
GLOB_NOCHECK
- 検索パターンにマッチするファイルが見つからない場合に、 検索パターン自身を返します -
GLOB_NOESCAPE
- バックスラッシュによるメタ文字のクォートを行いません -
GLOB_BRACE
- {a,b,c} を展開し「a」、「b」あるいは「c」のいずれかにマッチさせます -
GLOB_ONLYDIR
- パターンにマッチするディレクトリのみを返します -
GLOB_ERR
- (ディレクトリが読めないなどの) 読み込みエラー時に停止します。デフォルトではエラーは無視されます。
注意:
GLOB_BRACE
フラグは、Solaris などの非 GNU システムでは動作しないことがあります。-
返り値
マッチするファイル/ディレクトリを含む配列を返します。
マッチするファイルがなかった場合には空の配列、
そして失敗した場合には false
を返します。
注意:
システムによっては、何もマッチしなかった場合とエラーが発生した場合を区別できないものもあります。
例
例1 glob() が opendir() と関連する関数群の代替策になるかを示す簡便な方法
<?phpforeach (glob("*.txt") as $filename) { echo "$filename size " . filesize($filename) . "\n";}?>
上の例の出力は、 たとえば以下のようになります。
funclist.txt size 44686 funcsummary.txt size 267625 quickref.txt size 137820
注意
注意:
この関数では、リモートファイル を 使用することはできません。これは、処理されるファイルがサーバーの ファイルシステムによりアクセスできる必要があるためです。
注意:
この関数が使用できないシステムも存在します (例: 昔の Sun OS など)。
参考
- opendir() - ディレクトリハンドルをオープンする
- readdir() - ディレクトリハンドルからエントリを読み込む
- closedir() - ディレクトリハンドルをクローズする
- fnmatch() - ファイル名がパターンにマッチするか調べる