ergebnis/clock

Provides a simple abstraction of a clock.

2.7.0 2023-11-01 14:47 UTC

Requires

• php: ~8.1.0 || ~8.2.0 || ~8.3.0
• psr/clock: ^1.0.0

Requires (Dev)

• ergebnis/composer-normalize: ^2.39.0
• ergebnis/license: ^2.2.0
• ergebnis/php-cs-fixer-config: ~6.10.0
• ergebnis/phpunit-slow-test-detector: ^2.3.2
• infection/infection: ~0.27.6
• phpunit/phpunit: ^10.4.2
• psalm/plugin-phpunit: ~0.18.4
• rector/rector: ~0.18.6
• vimeo/psalm: ^5.15.0

Provides

• psr/clock-implementation: 1.0.0

MIT

• Andreas Möller

• clock
• system-clock
• test-clock

README

This package provides a simple abstraction 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 package record notable changes to this project in a changelog.

Contributing

The maintainers of this package suggest following the contribution guide.

Code of Conduct

The maintainers of this package ask contributors to follow the code of conduct.

General Support Policy

The maintainers of this package provide limited support.

You can support the maintenance of this package by sponsoring @localheinz or requesting an invoice for services related to this package.

PHP Version Support Policy

This package supports PHP versions with active support.

The maintainers of this package add support for a PHP version following its initial release and drop support for a PHP version when it has reached its end of active support.

Security Policy

This package has a security policy.

License

This package uses the MIT license.

Credits

This package is inspired by lcobucci/clock (originally licensed under MIT by Luís Cobucci).

Social

Follow @localheinz and @ergebnis on Twitter.