Stars: 205
Forks: 8
Pull Requests: 11
Issues: 3
Watchers: 7
Last Updated: 2023-01-10 13:55:39
A helper to control the flow of time
License: MIT License
Languages: PHP
https://freek.dev/1378-a-package-to-control-the-flow-of-time
Carbon is an excellent library to work with time in PHP projects. The Spatie\TestTime\TestTime
class contains a few functions that under the hood manipulate the time that's considered the current time by Carbon.
// the flow of time is frozen
TestTime::freeze();
// we're now one year in the future
TestTime::addYear();
// will report the real current year + 1
$year = (new Carbon())->format('Y');
In this video, you'll learn how we use this package to test time sensitive functionality in Mailcoach.
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
You can install the package via composer:
composer require spatie/test-time
You can freeze the time with:
TestTime::freeze();
Alternatively you can pass in a carbon instance that will be used as the current time.
TestTime::freeze($carbonInstance);
You can also pass a format and time.
TestTime::freeze('Y-m-d', '2019-06-12');
You can progress the time with any of the carbon functions starting with add
or sub
.
TestTime::addMinute();
TestTime::subHours(5);
// you can also chain calls
TestTime::addMonth(3)->addYear();
To let time flow naturally again, call unfreeze
.
TestTime::unfreeze();
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards on our company website.
The MIT License (MIT). Please see License File for more information.