<?php /** * 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; trait Test { /////////////////////////////////////////////////////////////////// ///////////////////////// TESTING AIDS //////////////////////////// /////////////////////////////////////////////////////////////////// /** * A test Carbon instance to be returned when now instances are created. * * @var static|CarbonInterface */ protected static $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(). * * 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. * * To clear the test instance call this method using the default * parameter of null. * * /!\ Use this method for unit tests only. * * @param CarbonInterface|string|null $testNow real or mock Carbon instance */ public static function setTestNow($testNow = null) { static::$testNow = is_string($testNow) ? static::parse($testNow) : $testNow; } /** * Get the Carbon instance (real or mock) to be returned when a "now" * instance is created. * * @return static|CarbonInterface the current instance used for testing */ public static function getTestNow() { return static::$testNow; } /** * 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() { return static::getTestNow() !== null; } protected static function mockConstructorParameters(&$time, &$tz) { /** @var \Carbon\CarbonImmutable|\Carbon\Carbon $testInstance */ $testInstance = clone static::getTestNow(); //shift the time according to the given time zone if ($tz !== null && $tz !== static::getTestNow()->getTimezone()) { $testInstance = $testInstance->setTimezone($tz); } else { $tz = $testInstance->getTimezone(); } if (static::hasRelativeKeywords($time)) { $testInstance = $testInstance->modify($time); } $time = $testInstance instanceof self ? $testInstance->rawFormat(static::MOCK_DATETIME_FORMAT) : $testInstance->format(static::MOCK_DATETIME_FORMAT); } }