oihana/php-files

The Oihana PHP Files library

1.0.0 2025-08-13 09:05 UTC

This package is auto-updated.

Last update: 2025-08-21 17:24:10 UTC


README

Oihana PHP Files

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

Latest Version
Total Downloads
License

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

๐Ÿ› ๏ธ 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