README

Zorachka Clock

This package provides an implementation of the PSR-20 ClockInterface.

Installation

You can install the package via composer:

composer require zorachka/clock

Usage

Pass ClockInterface to the method in which you want to get the current date in the desired time zone:

<?php

declare(strict_types=1);

namespace Project\Reviews\Application\AddReview;

use Psr\Clock\ClockInterface;
use Project\Reviews\Domain\Review;
// ...

final class Handler
{
    private ClockInterface $clock;

    public function __construct(
        ClockInterface $clock,
        // ...
    ) {
        $this->clock = $clock;
        // ...
    }

    public function __invoke(Command $command): void
    {
        $review = Review::add(
            // ...
            $this->clock->now(),
        );

        // ...
    }
}

or use the right one directly:

<?php

declare(strict_types=1);

$clock = new TimeZoneAwareClock(new DateTimeZone('Europe/Minsk'));
$now = $clock->now();

If you use the ClockServiceProvider then the default ClockInterface is implemented by TimeZoneAwareClock with UTC timezone.

You can change the timezone by setting it in the config settings.

<?php

declare(strict_types=1);

use Zorachka\Container\ServiceProvider;
use Zorachka\Clock\ClockConfig;

new class implements ServiceProvider {
    
    // ...

    /**
     * @inheritDoc
     */
    public static function getExtensions(): array
    {
        return [
            ClockConfig::class => static function ($config, ContainerInterface $container): stdClass {
                $config->withTimezone('Europe/Minsk');

                return $config;
            }
        ];
    }
}

Testing

make test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Siarhei Bautrukevich
• All Contributors

License

The MIT License (MIT). Please see License File for more information.