eventsauce/clock

Consume time from a Clock

Maintainers

Details

github.com/EventSaucePHP/Clock

Source

Issues

Fund package maintenance!
frankdejonge

Installs: 695 363

Dependents: 1

Suggesters: 0

Security: 0

Stars: 3

Watchers: 1

Forks: 1

Open Issues: 0

1.2.1 2024-03-04 20:22 UTC

Requires

Requires (Dev)

Provides

MIT 05fecd1d43f005006d94de0dc19fb14ff06d5872

  • Frank de Jonge <info.woop@frenky.net>

timeclockEventSauce

This package is auto-updated.

Last update: 2024-11-04 22:06:18 UTC

README

This is the EventSauce Clock component, which provides a straight forward way to consume time. Using a clock makes your code easier to test.

Installation

composer require eventsauce/clock

Usage

This package provides two implementations of the EventSauce\Clock\Clock interface.

In your production configuration, use the EventSauce\Clock\SystemClock implementation.

<?php

use EventSauce\Clock\SystemClock;

$clock = new SystemClock(new DateTimeZone('UTC') /* timezone optional */);

$dateTimeImmutable = $clock->now();
$timezone = $clock->timeZone();

In your test configuration, use the EventSauce\Clock\TestClock implementation.

<?php

use EventSauce\Clock\TestClock;

$testClock = new TestClock();
$dateTimeImmutable = $testClock->now();
$timezone = $testClock->timeZone();

// move the clock forward
$testClock->moveForward(DateInterval::createFromDateString('1 day'));

// Skip to system "now"
$testClock->tick();

// Fixate the clock to a specific date and time
$testClock->fixate('1987-11-24 18:33:10');