mirror of
https://github.com/itflow-org/itflow
synced 2026-03-14 01:34:51 +00:00
Reintroduce Webklex IMAP for ticket processing as PHP-IMAP is no longer being developed. This is optional for now and considered beta can be found in cron/ticket_email_parser.php
This commit is contained in:
185
plugins/vendor/nesbot/carbon/src/Carbon/Traits/Test.php
vendored
Normal file
185
plugins/vendor/nesbot/carbon/src/Carbon/Traits/Test.php
vendored
Normal file
@@ -0,0 +1,185 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of the Carbon package.
|
||||
*
|
||||
* (c) Brian Nesbitt <brian@nesbot.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Carbon\Traits;
|
||||
|
||||
use Carbon\CarbonInterface;
|
||||
use Carbon\CarbonTimeZone;
|
||||
use Carbon\Factory;
|
||||
use Carbon\FactoryImmutable;
|
||||
use Closure;
|
||||
use DateTimeImmutable;
|
||||
use DateTimeInterface;
|
||||
use DateTimeZone;
|
||||
|
||||
trait Test
|
||||
{
|
||||
///////////////////////////////////////////////////////////////////
|
||||
///////////////////////// TESTING AIDS ////////////////////////////
|
||||
///////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Set a Carbon instance (real or mock) to be returned when a "now"
|
||||
* instance is created. The provided instance will be returned
|
||||
* specifically under the following conditions:
|
||||
* - A call to the static now() method, ex. Carbon::now()
|
||||
* - When a null (or blank string) is passed to the constructor or parse(), ex. new Carbon(null)
|
||||
* - When the string "now" is passed to the constructor or parse(), ex. new Carbon('now')
|
||||
* - When a string containing the desired time is passed to Carbon::parse().
|
||||
*
|
||||
* Note the timezone parameter was left out of the examples above and
|
||||
* has no affect as the mock value will be returned regardless of its value.
|
||||
*
|
||||
* Only the moment is mocked with setTestNow(), the timezone will still be the one passed
|
||||
* as parameter of date_default_timezone_get() as a fallback (see setTestNowAndTimezone()).
|
||||
*
|
||||
* To clear the test instance call this method using the default
|
||||
* parameter of null.
|
||||
*
|
||||
* /!\ Use this method for unit tests only.
|
||||
*
|
||||
* @param DateTimeInterface|Closure|static|string|false|null $testNow real or mock Carbon instance
|
||||
*/
|
||||
public static function setTestNow(mixed $testNow = null): void
|
||||
{
|
||||
FactoryImmutable::getDefaultInstance()->setTestNow($testNow);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a Carbon instance (real or mock) to be returned when a "now"
|
||||
* instance is created. The provided instance will be returned
|
||||
* specifically under the following conditions:
|
||||
* - A call to the static now() method, ex. Carbon::now()
|
||||
* - When a null (or blank string) is passed to the constructor or parse(), ex. new Carbon(null)
|
||||
* - When the string "now" is passed to the constructor or parse(), ex. new Carbon('now')
|
||||
* - When a string containing the desired time is passed to Carbon::parse().
|
||||
*
|
||||
* It will also align default timezone (e.g. call date_default_timezone_set()) with
|
||||
* the second argument or if null, with the timezone of the given date object.
|
||||
*
|
||||
* To clear the test instance call this method using the default
|
||||
* parameter of null.
|
||||
*
|
||||
* /!\ Use this method for unit tests only.
|
||||
*
|
||||
* @param DateTimeInterface|Closure|static|string|false|null $testNow real or mock Carbon instance
|
||||
*/
|
||||
public static function setTestNowAndTimezone($testNow = null, $timezone = null): void
|
||||
{
|
||||
FactoryImmutable::getDefaultInstance()->setTestNowAndTimezone($testNow, $timezone);
|
||||
}
|
||||
|
||||
/**
|
||||
* Temporarily sets a static date to be used within the callback.
|
||||
* Using setTestNow to set the date, executing the callback, then
|
||||
* clearing the test instance.
|
||||
*
|
||||
* /!\ Use this method for unit tests only.
|
||||
*
|
||||
* @template T
|
||||
*
|
||||
* @param DateTimeInterface|Closure|static|string|false|null $testNow real or mock Carbon instance
|
||||
* @param Closure(): T $callback
|
||||
*
|
||||
* @return T
|
||||
*/
|
||||
public static function withTestNow(mixed $testNow, callable $callback): mixed
|
||||
{
|
||||
return FactoryImmutable::getDefaultInstance()->withTestNow($testNow, $callback);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Carbon instance (real or mock) to be returned when a "now"
|
||||
* instance is created.
|
||||
*
|
||||
* @return Closure|CarbonInterface|null the current instance used for testing
|
||||
*/
|
||||
public static function getTestNow(): Closure|CarbonInterface|null
|
||||
{
|
||||
return FactoryImmutable::getInstance()->getTestNow();
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if there is a valid test instance set. A valid test instance
|
||||
* is anything that is not null.
|
||||
*
|
||||
* @return bool true if there is a test instance, otherwise false
|
||||
*/
|
||||
public static function hasTestNow(): bool
|
||||
{
|
||||
return FactoryImmutable::getInstance()->hasTestNow();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the mocked date passed in setTestNow() and if it's a Closure, execute it.
|
||||
*/
|
||||
protected static function getMockedTestNow(DateTimeZone|string|int|null $timezone): ?CarbonInterface
|
||||
{
|
||||
$testNow = FactoryImmutable::getInstance()->handleTestNowClosure(static::getTestNow(), $timezone);
|
||||
|
||||
if ($testNow === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$testNow = $testNow->avoidMutation();
|
||||
|
||||
return $timezone ? $testNow->setTimezone($timezone) : $testNow;
|
||||
}
|
||||
|
||||
private function mockConstructorParameters(&$time, ?CarbonTimeZone $timezone): void
|
||||
{
|
||||
$clock = $this->clock?->unwrap();
|
||||
$now = $clock instanceof Factory
|
||||
? $clock->getTestNow()
|
||||
: $this->nowFromClock($timezone);
|
||||
$testInstance = $now ?? self::getMockedTestNowClone($timezone);
|
||||
|
||||
if (!$testInstance) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($testInstance instanceof DateTimeInterface) {
|
||||
$testInstance = $testInstance->setTimezone($timezone ?? date_default_timezone_get());
|
||||
}
|
||||
|
||||
if (static::hasRelativeKeywords($time)) {
|
||||
$testInstance = $testInstance->modify($time);
|
||||
}
|
||||
|
||||
$factory = $this->getClock()?->unwrap();
|
||||
|
||||
if (!($factory instanceof Factory)) {
|
||||
$factory = FactoryImmutable::getInstance();
|
||||
}
|
||||
|
||||
$testInstance = $factory->handleTestNowClosure($testInstance, $timezone);
|
||||
|
||||
$time = $testInstance instanceof self
|
||||
? $testInstance->rawFormat(static::MOCK_DATETIME_FORMAT)
|
||||
: $testInstance->format(static::MOCK_DATETIME_FORMAT);
|
||||
}
|
||||
|
||||
private function getMockedTestNowClone($timezone): CarbonInterface|self|null
|
||||
{
|
||||
$mock = static::getMockedTestNow($timezone);
|
||||
|
||||
return $mock ? clone $mock : null;
|
||||
}
|
||||
|
||||
private function nowFromClock(?CarbonTimeZone $timezone): ?DateTimeImmutable
|
||||
{
|
||||
$now = $this->clock?->now();
|
||||
|
||||
return $now && $timezone ? $now->setTimezone($timezone) : null;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user