zero-to-prod/filesystem

Helpers for interacting with a filesystem.

v0.2.0 2025-02-16 00:00 UTC

Requires

• php: >=7.1
• zero-to-prod/package-helper: ^1.1.3

Requires (Dev)

• mikey179/vfsstream: ^1.6
• phpunit/phpunit: <12.0

MIT

• David Smith

• filesystem
• zero-to-prod

README

Contents

• Introduction
• Requirements
• Installation
• Documentation Publishing
  • Automatic Documentation Publishing
• Usage
  • getFilesByExtension()
  • getFilesByExtensionRecursive()
• Local Development
• Contributing

Introduction

Helpers for interacting with a filesystem.

Requirements

• PHP 7.1 or higher.

Installation

Install Zerotoprod\Filesystem via Composer:

composer require zero-to-prod/filesystem

This will add the package to your project's dependencies and create an autoloader entry for it.

Documentation Publishing

You can publish this README to your local documentation directory.

This can be useful for providing documentation for AI agents.

This can be done using the included script:

# Publish to default location (./docs/zero-to-prod/filesystem)
vendor/bin/zero-to-prod-filesystem

# Publish to custom directory
vendor/bin/zero-to-prod-filesystem /path/to/your/docs

Automatic Documentation Publishing

You can automatically publish documentation by adding the following to your composer.json:

{
    "scripts": {
        "post-install-cmd": [
            "zero-to-prod-filesystem"
        ],
        "post-update-cmd": [
            "zero-to-prod-filesystem"
        ]
    }
}

Usage

getFilesByExtension()

Return all files by extension in a directory.

use Zerotoprod\Filesystem\Filesystem;

$files = Filesystem::getFilesByExtension('dir', 'php')

getFilesByExtensionRecursive()

Return all files by extension in a directory recursively.

use Zerotoprod\Filesystem\Filesystem;

$files = Filesystem::getFilesByExtensionRecursive('dir', 'php')

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Commit changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature-branch).
5. Create a new Pull Request.