afpinedac/common-value-objects

A collection of reusable value objects for PHP

dev-main 2025-02-28 02:08 UTC

Requires

• php: >=8.0

Requires (Dev)

• pestphp/pest: ^3.7

MIT

• Andrés Pineda

README

CommonValueObjects is a PHP package that provides a collection of reusable Value Objects for common data types, ensuring immutability, validation, and consistency in your applications.

📌 Installation

Install the package via Composer:

composer require afpinedac/common-value-objects

🚀 Features

• ✅ Immutable Value Objects for safer data handling.
• ✅ Strict Validation to prevent invalid values.
• ✅ PSR-4 Autoloading for seamless integration.
• ✅ Compatible with PHP 8+.

📂 Available Value Objects

Class	Description
Percentage	Represents a percentage value (e.g., 25%)
URL	Represents a valid URL
Email	Represents a valid Email
File	Represents a File

🛠 Usage

Example: Using Percentage

use Afpinedac\CommonValueObjects\Numeric\Percentage;

$percentage = new Percentage(0.25);
echo $percentage->getFormatted(); // Output: 25.00%

Example: Using Latitude

use Afpinedac\CommonValueObjects\Geographic\Latitude;

$latitude = new Latitude(40.7128);
echo $latitude; // Output: 40.7128

✅ Running Tests

This package uses PestPHP for testing. To run tests, use:

vendor/bin/pest

📜 License

This package is released under the MIT License.

🤝 Contributing

Contributions are welcome! Feel free to submit pull requests or open issues on GitHub.

📬 Contact

For questions or feature requests, contact [Your Name] at [e-mail].

🚀 Start using CommonValueObjects today to improve data consistency in your PHP projects!