ergebnis/clock

Provides abstractions of a clock.

2.10.0 2024-11-18 11:28 UTC

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 || ~8.4.0
• psr/clock: ^1.0.0

Requires (Dev)

• ergebnis/composer-normalize: ^2.44.0
• ergebnis/license: ^2.6.0
• ergebnis/php-cs-fixer-config: ^6.37.0
• infection/infection: ~0.26.6
• phpstan/extension-installer: ^1.4.3
• phpstan/phpstan: ^1.12.10
• phpstan/phpstan-deprecation-rules: ^1.2.1
• phpstan/phpstan-phpunit: ^1.4.0
• phpstan/phpstan-strict-rules: ^1.6.1
• phpunit/phpunit: ^6.5.14 || ^7.5.20 || ^8.5.19 || ^9.6.16
• rector/rector: ^1.2.10

Provides

• psr/clock-implementation: 1.0.0

MIT

• Andreas Möller

• clock
• system-clock
• test-clock

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 SystemClock and use it to determine the current time in a specific time zone:

<?php

declare(strict_types=1);

use Ergebnis\Clock;

$clock = new Clock\SystemClock(new \DateTimeZone('Europe/Berlin'));

$now = $clock->now();

Freeze a SystemClock to turn it into a FrozenClock:

<?php

declare(strict_types=1);

use Ergebnis\Clock;

$clock = new Clock\SystemClock(new \DateTimeZone('Europe/Berlin'));

$frozenClock = $clock->freeze();

$now = $clock->now();

sleep(5);

$stillNow = $clock->now();

UtcClock

Create a new UtcClock and use it to determine the current time in the UTC time zone:

<?php

declare(strict_types=1);

use Ergebnis\Clock;

$clock = new Clock\UtcClock();

$now = $clock->now();

Freeze a UtcClock to turn it into a FrozenClock:

<?php

declare(strict_types=1);

use Ergebnis\Clock;

$clock = new Clock\UtcClock();

$frozenClock = $clock->freeze();

$now = $clock->now();

sleep(5);

$stillNow = $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();

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 @ergebnis.

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.