oihana / php-files
The Oihana PHP Files library
1.0.0
2025-08-13 09:05 UTC
Requires
- php: >=8.4
- ext-fileinfo: *
- ext-openssl: *
- devium/toml: ^1.0
- oihana/php-core: dev-main
- oihana/php-reflect: dev-main
Requires (Dev)
- ext-posix: *
- mikey179/vfsstream: ^1.6
- nunomaduro/collision: ^8.8
- phpdocumentor/shim: ^3.8
- phpunit/phpunit: ^12
README
A versatile PHP library for seamless and portable file and path handling.
๐ Documentation
Full project documentation is available at:
๐ https://bcommebois.github.io/oihana-php-files
๐ Features
- ๐ Cross-platform path and file utilities โ Normalize, join, and manipulate file paths with ease.
- ๐ File encryption and decryption powered by OpenSSL.
- ๐๏ธ Create, compress and extract archives (.tar and .tar.gz).
- ๐ Recursive file discovery with advanced filters and options.
- ๐งช Full unit test coverage ensuring reliability and maintainability.
๐ก Designed to be lightweight, testable, and compatible with any PHP 8.4+ project.
๐ฆ Installation
Requires PHP 8.4+
Install via Composer:
composer require oihana/php-files
โ Running Unit Tests
To run all tests:
composer run-script test
To run a specific test file:
composer run test ./tests/oihana/files/OpenSSLFileEncryptionTest.php
๐งพ License
This project is licensed under the Mozilla Public License 2.0 (MPL-2.0).
๐ค About the author
- Author : Marc ALCARAZ (aka eKameleon)
- Mail : marc@ooop.fr
- Website : http://www.ooop.fr
๐ ๏ธ Generate the Documentation
We use phpDocumentor to generate the documentation into the ./docs folder.
Usage
Run the command :
composer doc
๐ Related packages
oihana/php-core
โ core helpers and utilities used by this library:https://github.com/BcommeBois/oihana-php-core
oihana/php-reflect
โ reflection and hydration utilities:https://github.com/BcommeBois/oihana-php-reflect
oihana/php-enums
โ a collection of strongly-typed constant enumerations for PHP.:https://github.com/BcommeBois/oihana-php-enums