BlueGit

projects-timfalken-com microchess

Files

microchess / web / lib / push / vendor / psr / clock / README.md

README.md

README.md 1.5 KiB Download Raw

PSR Clock

This repository holds the interface for [PSR-20][psr-url].

Note that this is not a clock of its own. It is merely an interface that describes a clock. See the specification for more details.

Installation

composer require psr/clock

Usage

If you need a clock, you can use the interface like this:

<?php

use Psr\Clock\ClockInterface;

class Foo
{
    private ClockInterface $clock;

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

    public function doSomething()
    {
        /** @var DateTimeImmutable $currentDateAndTime */
        $currentDateAndTime = $this->clock->now();
        // do something useful with that information
    }
}

You can then pick one of the [implementations][implementation-url] of the interface to get a clock.

If you want to implement the interface, you can require this package and implement Psr\Clock\ClockInterface in your code.

Don't forget to add psr/clock-implementation to your composer.jsons provides-section like this:

{
  "provides": {
    "psr/clock-implementation": "1.0"
  }
}

And please read the [specification text][specification-url] for details on the interface.

[psr-url]: https://www.php-fig.org/psr/psr-20 [package-url]: https://packagist.org/packages/psr/clock [implementation-url]: https://packagist.org/providers/psr/clock-implementation [specification-url]: https://github.com/php-fig/fig-standards/blob/master/proposed/clock.md

Source
1# PSR Clock
2
3This repository holds the interface for [PSR-20][psr-url].
4
5Note that this is not a clock of its own. It is merely an interface that
6describes a clock. See the specification for more details.
7
8## Installation
9
10```bash
11composer require psr/clock
12```
13
14## Usage
15
16If you need a clock, you can use the interface like this:
17
18```php
19<?php
20
21use Psr\Clock\ClockInterface;
22
23class Foo
24{
25 private ClockInterface $clock;
26
27 public function __construct(ClockInterface $clock)
28 {
29 $this->clock = $clock;
30 }
31
32 public function doSomething()
33 {
34 /** @var DateTimeImmutable $currentDateAndTime */
35 $currentDateAndTime = $this->clock->now();
36 // do something useful with that information
37 }
38}
39```
40
41You can then pick one of the [implementations][implementation-url] of the interface to get a clock.
42
43If you want to implement the interface, you can require this package and
44implement `Psr\Clock\ClockInterface` in your code.
45
46Don't forget to add `psr/clock-implementation` to your `composer.json`s `provides`-section like this:
47
48```json
49{
50 "provides": {
51 "psr/clock-implementation": "1.0"
52 }
53}
54```
55
56And please read the [specification text][specification-url] for details on the interface.
57
58[psr-url]: https://www.php-fig.org/psr/psr-20
59[package-url]: https://packagist.org/packages/psr/clock
60[implementation-url]: https://packagist.org/providers/psr/clock-implementation
61[specification-url]: https://github.com/php-fig/fig-standards/blob/master/proposed/clock.md