GlobIterator::__construct »

« FilterIterator::valid

The GlobIterator class

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

Introduction

Iterates through a file system in a similar fashion to glob() .

Class synopsis

class GlobIterator extends FilesystemIterator implements Countable {

/* Inherited constants */

public const int FilesystemIterator::CURRENT_MODE_MASK ;

public const int FilesystemIterator::CURRENT_AS_PATHNAME ;

public const int FilesystemIterator::CURRENT_AS_FILEINFO ;

public const int FilesystemIterator::CURRENT_AS_SELF ;

public const int FilesystemIterator::KEY_MODE_MASK ;

public const int FilesystemIterator::KEY_AS_PATHNAME ;

public const int FilesystemIterator::FOLLOW_SYMLINKS ;

public const int FilesystemIterator::KEY_AS_FILENAME ;

public const int FilesystemIterator::NEW_CURRENT_AND_KEY ;

public const int FilesystemIterator::OTHER_MODE_MASK ;

public const int FilesystemIterator::SKIP_DOTS ;

public const int FilesystemIterator::UNIX_PATHS ;

/* Methods */

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

public count (): int

/* Inherited methods */

public FilesystemIterator::current (): string |SplFileInfo |FilesystemIterator

public FilesystemIterator::getFlags (): int

public FilesystemIterator::key (): string

public FilesystemIterator::next (): void

public FilesystemIterator::rewind (): void

public FilesystemIterator::setFlags (int $flags): void

public DirectoryIterator::current (): mixed

public DirectoryIterator::getBasename (string $suffix = ""): string

public DirectoryIterator::getExtension (): string

public DirectoryIterator::getFilename (): string

public DirectoryIterator::isDot (): bool

public DirectoryIterator::key (): mixed

public DirectoryIterator::next (): void

public DirectoryIterator::rewind (): void

public DirectoryIterator::seek (int $offset): void

public DirectoryIterator::__toString (): string

public DirectoryIterator::valid (): bool

public SplFileInfo::getATime (): int |false

public SplFileInfo::getBasename (string $suffix = ""): string

public SplFileInfo::getCTime (): int |false

public SplFileInfo::getExtension (): string

public SplFileInfo::getFileInfo (? string $class = null ): SplFileInfo

public SplFileInfo::getFilename (): string

public SplFileInfo::getGroup (): int |false

public SplFileInfo::getInode (): int |false

public SplFileInfo::getLinkTarget (): string |false

public SplFileInfo::getMTime (): int |false

public SplFileInfo::getOwner (): int |false

public SplFileInfo::getPath (): string

public SplFileInfo::getPathInfo (? string $class = null ): ? SplFileInfo

public SplFileInfo::getPathname (): string

public SplFileInfo::getPerms (): int |false

public SplFileInfo::getRealPath (): string |false

public SplFileInfo::getSize (): int |false

public SplFileInfo::getType (): string |false

public SplFileInfo::isDir (): bool

public SplFileInfo::isExecutable (): bool

public SplFileInfo::isFile (): bool

public SplFileInfo::isLink (): bool

public SplFileInfo::isReadable (): bool

public SplFileInfo::isWritable (): bool

public SplFileInfo::openFile (string $mode = "r", bool $useIncludePath = false , ? resource $context = null ): SplFileObject

public SplFileInfo::setFileClass (string $class = SplFileObject::class): void

public SplFileInfo::setInfoClass (string $class = SplFileInfo::class): void

public SplFileInfo::__toString (): string

}

Table of Contents

GlobIterator::__construct — Construct a directory using glob
GlobIterator::count — Get the number of directories and files

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

User Contributed Notes 2 notes

up

down

2

info at ensostudio dot ru ¶

5 years ago

Fix problem with braces in template:
<?php
class GlobStreamWrapper
{
 private $generator;

 protected function createGenerator(array $paths): Generator
 {
 return yield from $paths;
 }

 public function dir_opendir(string $pattern, int $options = 0): bool
 {
 $pattern = substr($pattern, 7); // crop 'glob://' prefix
 $pattern = str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $pattern);
 $paths = (array) glob($pattern, GLOB_BRACE | GLOB_NOSORT);
 $this->generator = $this->createGenerator($paths);
 return $this->generator->valid();
 }

 public function dir_readdir(): string
 {
 $path = $this->generator->current() ?: '';
 $this->generator->next();
 return $path;
 }

 public function dir_rewinddir(): bool
 {
 $this->generator->rewind();
 return $this->generator->valid();
 }

 public function dir_closedir(): bool
 {
 $this->generator = null;
 return true;
 }
}
?>
Replace glob wrapper:
<?php
stream_wrapper_unregister('glob');
stream_wrapper_register('glob', 'GlobStreamWrapper');
?>
Example:
<?php
$iterator = new GlobIterator(__DIR__ . '/{application,system}/src/*.php');
while ($iterator->valid()) {
 echo $iterator->current()->getFilename() . '</br>';
 $iterator->next();
}
?>

up

down

1

info at ensostudio dot ru ¶

4 years ago

NOTE: "similar fashion to glob()" GlobIterator use stream wrapper "glob://" = use glob()