oihana/php-files

The Oihana PHP Files library

dev-main 2025-07-20 16:05 UTC

This package is auto-updated.

Last update: 2025-07-20 16:05:15 UTC


README

Oihana PHP Files

๐Ÿ“š Documentation

Full project documentation is available at:
๐Ÿ‘‰ https://bcommebois.github.io/oihana-php-files

๐Ÿš€ Features

  • ๐Ÿ“ Cross-platform path and file utilities
  • ๐Ÿ” File encryption and decryption with OpenSSL
  • ๐Ÿ—œ๏ธ Tar and compressed .tar.gz archive creation and extraction
  • ๐Ÿ“‚ Recursive file discovery with filters and options
  • ๐Ÿงช Full unit test coverage

๐Ÿ“ฆ 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

๐Ÿงพ Licence

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

๐Ÿ‘ค About the author

๐Ÿ› ๏ธ Generate the Documentation

We use phpDocumentor to generate the documentation into the ./docs folder.

Usage

Run the command :

composer doc