php / 8.1.5 / class.directory.html /

The Directory class

Introduction

(PHP 4, PHP 5, PHP 7, PHP 8)

Instances of Directory are created by calling the dir() function, not by the new operator.

Class synopsis

class Directory {
/* Properties */
public readonly string $path;
public readonly resource $handle;
/* Methods */
public close(): void
public read(): string|false
public rewind(): void
}

Properties

path

The directory that was opened.

handle

Can be used with other directory functions such as readdir(), rewinddir() and closedir().

Changelog

Version Description
8.1.0 The path and handle properties are now readonly.

Table of Contents

© 1997–2021 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.directory.php