localheinz / clock
Provides abstractions of a clock.
Installs: 12 692
Dependents: 1
Suggesters: 0
Security: 0
Stars: 30
Watchers: 3
Forks: 1
Open Issues: 0
Requires
- php: ~7.0.0 || ~7.1.0 || ~7.2.0 || ~7.3.0 || ~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0
- psr/clock: ^1.0.0
Requires (Dev)
- ergebnis/composer-normalize: ^2.42.0
- ergebnis/license: ^2.4.0
- ergebnis/php-cs-fixer-config: ^6.22.0
- infection/infection: ~0.26.6
- phpunit/phpunit: ^6.5.14 || ^7.5.20 || ^8.5.19 || ^9.6.16
- psalm/plugin-phpunit: ~0.18.4
- rector/rector: ^1.0.1
- vimeo/psalm: ^5.22.1
Provides
- psr/clock-implementation: 1.0.0
This package is auto-updated.
Last update: 2024-10-08 18:17:39 UTC
README
This project provides a composer
package with abstractions of a clock, following the suggestion by Martin Fowler, and compatible with PSR-20.
Installation
Run
composer require ergebnis/clock
Usage
SystemClock
Create a new system clock and use it to determine the current time:
<?php declare(strict_types=1); use Ergebnis\Clock; $timeZone = new \DateTimeZone('Europe/Berlin'); $clock = new Clock\SystemClock($timeZone); $now = $clock->now();
FrozenClock
Create a new frozen clock and use it in tests:
<?php declare(strict_types=1); use Ergebnis\Clock; $now = new \DateTimeImmutable(); $clock = new Clock\FrozenClock($now); sleep(5); $stillNow = $clock->now();
Alternatively, create a new frozen clock by freezing a system clock:
<?php declare(strict_types=1); use Ergebnis\Clock; $timeZone = new \DateTimeZone('Europe/Berlin'); $clock = new Clock\SystemClock($timeZone); $frozenClock = $clock->freeze(); $now = $clock->now(); sleep(5); $stillNow = $clock->now();
Changelog
The maintainers of this project record notable changes to this project in a changelog.
Contributing
The maintainers of this project suggest following the contribution guide.
Code of Conduct
The maintainers of this project ask contributors to follow the code of conduct.
General Support Policy
The maintainers of this project provide limited support.
You can support the maintenance of this project by sponsoring @localheinz or requesting an invoice for services related to this project.
PHP Version Support Policy
This project supports PHP versions with active and security support.
The maintainers of this project add support for a PHP version following its initial release and drop support for a PHP version when it has reached the end of security support.
Security Policy
This project has a security policy.
License
This project uses the MIT license.
Credits
This project is inspired by lcobucci/clock
(originally licensed under MIT by Luís Cobucci).
Social
Follow @localheinz and @ergebnis on Twitter.