78 lines
1.9 KiB
PHP
78 lines
1.9 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
/*
|
||
|
|
* This file is part of the Symfony package.
|
||
|
|
*
|
||
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
||
|
|
*
|
||
|
|
* For the full copyright and license information, please view the LICENSE
|
||
|
|
* file that was distributed with this source code.
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace Symfony\Component\Clock\Test;
|
||
|
|
|
||
|
|
use PHPUnit\Framework\Attributes\After;
|
||
|
|
use PHPUnit\Framework\Attributes\Before;
|
||
|
|
use PHPUnit\Framework\Attributes\BeforeClass;
|
||
|
|
use Psr\Clock\ClockInterface;
|
||
|
|
use Symfony\Component\Clock\Clock;
|
||
|
|
use Symfony\Component\Clock\MockClock;
|
||
|
|
|
||
|
|
use function Symfony\Component\Clock\now;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Helps with mocking the time in your test cases.
|
||
|
|
*
|
||
|
|
* This trait provides one self::mockTime() method that freezes the time.
|
||
|
|
* It restores the global clock after each test case.
|
||
|
|
* self::mockTime() accepts either a string (eg '+1 days' or '2022-12-22'),
|
||
|
|
* a DateTimeImmutable, or a boolean (to freeze/restore the global clock).
|
||
|
|
*
|
||
|
|
* @author Nicolas Grekas <p@tchwork.com>
|
||
|
|
*/
|
||
|
|
trait ClockSensitiveTrait
|
||
|
|
{
|
||
|
|
public static function mockTime(string|\DateTimeImmutable|bool $when = true): ClockInterface
|
||
|
|
{
|
||
|
|
Clock::set(match (true) {
|
||
|
|
false === $when => self::saveClockBeforeTest(false),
|
||
|
|
true === $when => new MockClock(),
|
||
|
|
$when instanceof \DateTimeImmutable => new MockClock($when),
|
||
|
|
default => new MockClock(now($when)),
|
||
|
|
});
|
||
|
|
|
||
|
|
return Clock::get();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @beforeClass
|
||
|
|
*
|
||
|
|
* @before
|
||
|
|
*
|
||
|
|
* @internal
|
||
|
|
*/
|
||
|
|
#[Before]
|
||
|
|
#[BeforeClass]
|
||
|
|
public static function saveClockBeforeTest(bool $save = true): ClockInterface
|
||
|
|
{
|
||
|
|
static $originalClock;
|
||
|
|
|
||
|
|
if ($save && $originalClock) {
|
||
|
|
self::restoreClockAfterTest();
|
||
|
|
}
|
||
|
|
|
||
|
|
return $save ? $originalClock = Clock::get() : $originalClock;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @after
|
||
|
|
*
|
||
|
|
* @internal
|
||
|
|
*/
|
||
|
|
#[After]
|
||
|
|
protected static function restoreClockAfterTest(): void
|
||
|
|
{
|
||
|
|
Clock::set(self::saveClockBeforeTest(false));
|
||
|
|
}
|
||
|
|
}
|