A versatile PHP library for seamless and portable file and path handling.

📚 Documentation

Narrative user guides (FR + EN), with examples and security notes:

• 🇬🇧 English documentation
• 🇫🇷 Documentation française

You are currently browsing the auto-generated API reference (phpDocumentor).

🚀 Features

• 📁 Cross-platform path and file utilities — normalize, join, and manipulate file paths with ease.
• 🔐 Authenticated file encryption/decryption (AES-256-GCM) powered by OpenSSL.
• 🗜️ Create, compress and extract archives (.tar, .tar.gz, .tar.bz2).
• 📂 Recursive file discovery with advanced filters and options.
• 🧪 100% unit-test line coverage, ensuring reliability and maintainability.

📦 Installation

This library requires PHP 8.4+ and is installed via Composer:

composer require oihana/php-files

✅ Tests & coverage

Run the unit-test suite (PHPUnit, strict mode):

composer test

Run a single test case:

./vendor/bin/phpunit --filter OpenSSLFileEncryptionTest

Measure coverage (requires Xdebug or PCOV):

composer coverage
composer coverage:md

The suite covers 100% of lines (1416/1416). See the testing guide: English · Français.

🧾 License

This project is licensed under the Mozilla Public License 2.0 (MPL-2.0).

👤 About the Author

• Name: Marc ALCARAZ (aka eKameleon)
• Website: www.ooop.fr
• Email: marc@ooop.fr

🔗 Related packages

• oihana/php-core — core helpers and utilities used by this library.
• oihana/php-reflect — reflection and hydration utilities.
• oihana/php-enums — strongly-typed constant enumerations.

🔗 Project on GitHub

View the full source code and contribute on GitHub: github.com/BcommeBois/oihana-php-files.