PHPackages                             painless-php/filesystem - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [File & Storage](/categories/file-storage)
4. /
5. painless-php/filesystem

ActiveLibrary[File & Storage](/categories/file-storage)

painless-php/filesystem
=======================

Filesystem helper functionality

030PHP

Since May 23Pushed 1y ago1 watchersCompare

[ Source](https://github.com/painless-php/filesystem)[ Packagist](https://packagist.org/packages/painless-php/filesystem)[ RSS](/packages/painless-php-filesystem/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependenciesVersions (2)Used By (0)

filesystem
==========

[](#filesystem)

Filesystem helper functionality for PHP.

Installation
------------

[](#installation)

```
composer require painless-php/filesystem

```

Public API
----------

[](#public-api)

#### Core

[](#core)

- Filesystem
- FilesystemObject
    - File
    - Directory
- DirectoryIteratorConfig

#### Exception

[](#exception)

- FilesystemException
    - FileNotFoundException
    - FilesystemPermissionException

#### Interface

[](#interface)

- FilesystemFilter
- DirectoryContentIterator

Usage examples
--------------

[](#usage-examples)

#### Reading directory contents

[](#reading-directory-contents)

```
// with iterator
$iterator = Directory::createFromPath($path)->getIterator(
    recursive: true,
    config: new DirectoryIteratorConfig(
        resultFilters: [
            fn(FilesystemObject $file) =>  $file->getExtension() === 'php'
        ]
    )
);

// loop over iterator items
foreach($iterator as FileObject $file) {
    var_dump($file);
}

// turn iterator into array
$array = $iterator->toArray();

// with getContents
$files = Directory::createFromPath($path)->getContents(
    recursive: true,
    config: new DirectoryIteratorConfig(
        resultFilters: [
            fn(FilesystemObject $file) =>  $file->getExtension() === 'php'
        ]
    )
);
```

Notes
-----

[](#notes)

- isRoot() will probably not work on windows (as well as functions that rely on it like findUpwards)

#### DirectoryContentIterator structure

[](#directorycontentiterator-structure)

- DirectoryContentIterator (FilterIterator)
    - RecursiveIteratorIterator
    - RecursiveFilterIterator
    - RecursiveDirectoryIterator

###  Health Score

19

—

LowBetter than 9% of packages

Maintenance34

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity24

Early-stage or recently created project

 Bus Factor1

Top contributor holds 80.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/3839f3fb0c50b415aacf70b6cd2f41ff254d93af78dfd58e4e41e57aa5a676cb?d=identicon)[PainlessPHP](/maintainers/PainlessPHP)

---

Top Contributors

[![nonetallt](https://avatars.githubusercontent.com/u/22174322?v=4)](https://github.com/nonetallt "nonetallt (89 commits)")[![xHeaven](https://avatars.githubusercontent.com/u/14284867?v=4)](https://github.com/xHeaven "xHeaven (22 commits)")

### Embed Badge

![Health badge](/badges/painless-php-filesystem/health.svg)

```
[![Health](https://phpackages.com/badges/painless-php-filesystem/health.svg)](https://phpackages.com/packages/painless-php-filesystem)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)