15768680547

Committed 27 May 2025 01:19PM UTC coverage: 100.0%. Remained the same

Build # 15768680547

Build Type

push

github

Committed by

paulbalandan

Commit Message

Add clock extension API for writing time-sensitive classes

Run Details

30 of 30 new or added lines in 4 files covered. (100.0%)

988 of 988 relevant lines covered (100.0%)

7.0 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

100.0

/src/Nexus/Clock/Extension/ClockAware.php

<?php

declare(strict_types=1);

/**
 * This file is part of the Nexus framework.
 *
 * (c) John Paul E. Balandan, CPA <paulbalandan@gmail.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace Nexus\Clock\Extension;

use Nexus\Clock\Clock;
use Nexus\Clock\FrozenClock;
use Nexus\Clock\InternalClock;
use Psr\Clock\ClockInterface;

/**
 * A trait to help write time-sensitive classes.
 *
 * @phpstan-require-implements ClockAwareInterface
 */
trait ClockAware
{
    private ?ClockInterface $clock = null;

    public function setClock(?ClockInterface $clock): self
    {
        $this->clock = $clock;

        return $this;
    }

    public function getClock(): Clock
    {
        if (null === $this->clock) {
            return InternalClock::getCurrent();
        }

        if (! $this->clock instanceof Clock) {
            return new FrozenClock($this->clock->now());
        }

        return $this->clock;
    }

    /**
     * Gets the current timestamp.
     */
    private function now(): int
    {
        return $this->getClock()->now()->getTimestamp();
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/**
6	* This file is part of the Nexus framework.
7	*
8	* (c) John Paul E. Balandan, CPA <paulbalandan@gmail.com>
9	*
10	* For the full copyright and license information, please view
11	* the LICENSE file that was distributed with this source code.
12	*/
13
14	namespace Nexus\Clock\Extension;
15
16	use Nexus\Clock\Clock;
17	use Nexus\Clock\FrozenClock;
18	use Nexus\Clock\InternalClock;
19	use Psr\Clock\ClockInterface;
20
21	/**
22	* A trait to help write time-sensitive classes.
23	*
24	* @phpstan-require-implements ClockAwareInterface
25	*/
26	trait ClockAware
27	{
28	private ?ClockInterface $clock = null;
29
30	public function setClock(?ClockInterface $clock): self
31	{
32	$this->clock = $clock;	8✔
33
34	return $this;	8✔
35	}
36
37	public function getClock(): Clock
38	{
39	if (null === $this->clock) {	8✔
40	return InternalClock::getCurrent();	2✔
41	}
42
43	if (! $this->clock instanceof Clock) {	6✔
44	return new FrozenClock($this->clock->now());	2✔
45	}
46
47	return $this->clock;	4✔
48	}
49
50	/**
51	* Gets the current timestamp.
52	*/
53	private function now(): int
54	{
55	return $this->getClock()->now()->getTimestamp();	8✔
56	}
57	}

NexusPHP / framework / 15768680547

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous