Home/ Manual/ spl / globiterator/ GlobIterator::__construct

GlobIterator::__construct

PHP function Edit on GitHub ✎

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

Construct a directory using glob

Description

GlobIterator::__construct(string $pattern, int $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO)

Constructs a new directory iterator from a glob expression.

Parameters

pattern: A glob() pattern.
flags: Option flags, the flags may be a bitmask of the FilesystemIterator constants.

Errors/Exceptions

Throws an UnexpectedValueException if the directory does not exist.

Throws a ValueError if the directory is an empty string.

Changelog

Version	Description
8.0.0	Now throws a `ValueError` if `directory` is an empty string; previously it threw a `RuntimeException`.

Examples

GlobIterator example

php

<?php
$iterator = new GlobIterator('*.dll', FilesystemIterator::KEY_AS_FILENAME);

if (!$iterator->count()) {
    echo 'No matches';
} else {
    $n = 0;

    printf("Matched %d item(s)\r\n", $iterator->count());

    foreach ($iterator as $item) {
        printf("[%d] %s\r\n", ++$n, $iterator->key());
    }
}
?>

The above example will output something similar to:

output

Matched 2 item(s)
[1] php5ts.dll
[2] php_gd2.dll