konecnyjakub/clock

Collection of PSR-20 clocks

1.0.0 2024-09-15 13:45 UTC

Requires

• php: >=8.3.0
• psr/clock: ^1.0

Requires (Dev)

• konecnyjakub/mytester: ^6.0
• php-parallel-lint/php-console-highlighter: ^0.5
• php-parallel-lint/php-parallel-lint: ^1.4
• phpstan/phpstan: ^1.12
• squizlabs/php_codesniffer: ^3.10

Provides

• psr/clock-implementation: 1.0

BSD-3-Clause

• Jakub Konečný

• clock
• psr-20

README

Collection of PSR-20 clocks

Installation

The best way to install Clock is via Composer. Just add konecnyjakub/clock to your dependencies.

Usage

System clock

This clock returns current time. It uses default timezone in PHP by default but it is possible to set a different one.

<?php
declare(strict_types=1);

use DateTimeZone;
use Konecnyjakub\Clock\SystemClock;

(new SystemClock())->now();
(new SystemClock(new DateTimeZone("Europe/Prague")))->now();

Frozen clock

This clock always returns set time which makes it useful for tests.

<?php
declare(strict_types=1);

use DateTimeImmutable;
use Konecnyjakub\Clock\FrozenClock;

(new FrozenClock(new DateTimeImmutable("1970-01-01")))->now();

UTC clock

This clock return current time in UTC.

<?php
declare(strict_types=1);

use DateTimeImmutable;
use Konecnyjakub\Clock\UTCClock;

(new UTCClock())->now();