README

Carbon is awesome. Immutable carbon is just a little bit more awesome. An attempt to make the Carbon date library immutable. It is simply a wrapper class around the Carbon\Carbon class so you can just use it as if you were using the actual class. Just keep in mind that it is immutable - thus you can no longer set values by calling $instance->property = 'whatever'.

This was a hobby project to attempt to make Carbon immutable - but you should probably check out Chronos for any large project.

Installation

You can install using composer from Packagist

composer require timacdonald/immutable-carbon

Versioning

This package uses Semantic Versioning. You can find out more about what this is and why it matters by reading the spec or for something more readable, check out this post.

Basic Usage

Here is a quick example. You'll noticed the API is the same as the base library.

$now = Carbon::now();

$tomorrow = $now->addDay();

Once this code has run $now is still todays date, i.e. $now == Carbon::now(), however $tomorrow == Carbon::now()->addDay().

Contributing

Please feel free to suggest new ideas or send through pull requests to make this better. If you'd like to discuss the project, feel free to reach out on Twitter. I just throw my ideas for the project in the issues list if you want to help implement anything.

License

This package is under the MIT License. See LICENSE file for details.

Thanks

Big thanks to everyone who has contributed to the Carbon date library and Freek Van der Herten for inspiring me to give this a go.

timacdonald / immutable-carbon

Maintainers

Details