league/period

A time range immutable value object

3.3.0 2016-09-19 10:33 UTC

README

Author Latest Version Software License Build Status Coverage Status Quality Score Total Downloads

Period is PHP's missing time range API. It is based on Resolving Feature Envy in the Domain by Mathias Verraes and extends the concept to cover all basic operations regarding time ranges.

Highlights

  • Treats a time range as an immutable value object
  • Exposes many named constructors to ease time range creation
  • Covers all basic manipulations related to time range
  • Fully documented
  • Framework-agnostic
  • Composer ready, PSR-2, and PSR-4 compliant

Documentation

Full documentation can be found at period.thephpleague.com.

System Requirements

You need PHP >= 5.5.9 but the latest stable version of PHP is recommended.

Install

Install Period using Composer.

$ composer require league/period

Testing

Period has a PHPUnit test suite and a coding style compliance test suite using PHP CS Fixer. To run the tests, run the following command from the project folder.

$ composer test

Contributing

Contributions are welcome and will be fully credited. Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email nyamsprod@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see LICENSE for more information.