NN2024010801/vendor/nesbot/carbon/tests/Carbon/GettersTest.php

<?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 Tests\Carbon;

use Carbon\Carbon;
use Generator;
use InvalidArgumentException;
use Tests\AbstractTestCase;

class GettersTest extends AbstractTestCase
{
    public function testGettersThrowExceptionOnUnknownGetter()
    {
        $this->expectExceptionObject(new InvalidArgumentException(
            "Unknown getter 'doesNotExit'"
        ));

        /** @var mixed $d */
        $d = Carbon::create(1234, 5, 6, 7, 8, 9);
        $d->doesNotExit;
    }

    public function testGet()
    {
        $d = Carbon::create(1234, 5, 6, 7, 8, 9);
        $this->assertSame(5, $d->get('month'));
    }

    public function testMillenniumGetter()
    {
        $d = Carbon::create(1234, 5, 6, 7, 8, 9);
        $this->assertSame(2, $d->millennium);
        $d = Carbon::create(2000, 5, 6, 7, 8, 9);
        $this->assertSame(2, $d->millennium);
        $d = Carbon::create(2001, 5, 6, 7, 8, 9);
        $this->assertSame(3, $d->millennium);
        $d = Carbon::create(1, 5, 6, 7, 8, 9);
        $this->assertSame(1, $d->millennium);
        $d = Carbon::create(-1, 5, 6, 7, 8, 9);
        $this->assertSame(-1, $d->millennium);
        $d = Carbon::create(-100, 5, 6, 7, 8, 9);
        $this->assertSame(-1, $d->millennium);
        $d = Carbon::create(-101, 5, 6, 7, 8, 9);
        $this->assertSame(-1, $d->millennium);
        $d = Carbon::create(-1000, 5, 6, 7, 8, 9);
        $this->assertSame(-1, $d->millennium);
        $d = Carbon::create(-1001, 5, 6, 7, 8, 9);
        $this->assertSame(-2, $d->millennium);
    }

    public function testCenturyGetter()
    {
        $d = Carbon::create(1234, 5, 6, 7, 8, 9);
        $this->assertSame(13, $d->century);
        $d = Carbon::create(2000, 5, 6, 7, 8, 9);
        $this->assertSame(20, $d->century);
        $d = Carbon::create(2001, 5, 6, 7, 8, 9);
        $this->assertSame(21, $d->century);
        $d = Carbon::create(1, 5, 6, 7, 8, 9);
        $this->assertSame(1, $d->century);
        $d = Carbon::create(-1, 5, 6, 7, 8, 9);
        $this->assertSame(-1, $d->century);
        $d = Carbon::create(-100, 5, 6, 7, 8, 9);
        $this->assertSame(-1, $d->century);
        $d = Carbon::create(-101, 5, 6, 7, 8, 9);
        $this->assertSame(-2, $d->century);
    }

    public function testDecadeGetter()
    {
        $d = Carbon::create(1234, 5, 6, 7, 8, 9);
        $this->assertSame(124, $d->decade);
    }

    public function testYearGetter()
    {
        $d = Carbon::create(1234, 5, 6, 7, 8, 9);
        $this->assertSame(1234, $d->year);
    }

    public function testYearIsoGetter()
    {
        $d = Carbon::createFromDate(2012, 12, 31);
        $this->assertSame(2013, $d->yearIso);
    }

    public function testMonthGetter()
    {
        $d = Carbon::create(1234, 5, 6, 7, 8, 9);
        $this->assertSame(5, $d->month);
    }

    public function testDayGetter()
    {
        $d = Carbon::create(1234, 5, 6, 7, 8, 9);
        $this->assertSame(6, $d->day);
    }

    public function testHourGetter()
    {
        $d = Carbon::create(1234, 5, 6, 7, 8, 9);
        $this->assertSame(7, $d->hour);
    }

    public function testMinuteGetter()
    {
        $d = Carbon::create(1234, 5, 6, 7, 8, 9);
        $this->assertSame(8, $d->minute);
    }

    public function testSecondGetter()
    {
        $d = Carbon::create(1234, 5, 6, 7, 8, 9);
        $this->assertSame(9, $d->second);
    }

    public function testMicroGetter()
    {
        $micro = 345678;
        $d = Carbon::parse('2014-01-05 12:34:11.'.$micro);
        $this->assertSame($micro, $d->micro);
    }

    public function testMicroGetterWithDefaultNow()
    {
        $now = Carbon::getTestNow();
        Carbon::setTestNow(null);

        $start = microtime(true);
        usleep(10000);
        $d = Carbon::now();
        usleep(10000);
        $end = microtime(true);
        $microTime = $d->getTimestamp() + $d->micro / 1000000;

        $this->assertGreaterThan($start, $microTime);
        $this->assertLessThan($end, $microTime);

        Carbon::setTestNow($now);
    }

    public function testDayOfWeekGetter()
    {
        $d = Carbon::create(2012, 5, 7, 7, 8, 9);
        $this->assertSame(Carbon::MONDAY, $d->dayOfWeek);
        $d = Carbon::create(2012, 5, 8, 7, 8, 9);
        $this->assertSame(Carbon::TUESDAY, $d->dayOfWeek);
        $d = Carbon::create(2012, 5, 9, 7, 8, 9);
        $this->assertSame(Carbon::WEDNESDAY, $d->dayOfWeek);
        $d = Carbon::create(2012, 5, 10, 0, 0, 0);
        $this->assertSame(Carbon::THURSDAY, $d->dayOfWeek);
        $d = Carbon::create(2012, 5, 11, 23, 59, 59);
        $this->assertSame(Carbon::FRIDAY, $d->dayOfWeek);
        $d = Carbon::create(2012, 5, 12, 12, 0, 0);
        $this->assertSame(Carbon::SATURDAY, $d->dayOfWeek);
        $d = Carbon::create(2012, 5, 13, 12, 0, 0);
        $this->assertSame(Carbon::SUNDAY, $d->dayOfWeek);
    }

    public function testDayOfWeekIsoGetter()
    {
        $d = Carbon::create(2012, 5, 7, 7, 8, 9);
        $this->assertSame(1, $d->dayOfWeekIso);
        $d = Carbon::create(2012, 5, 8, 7, 8, 9);
        $this->assertSame(2, $d->dayOfWeekIso);
        $d = Carbon::create(2012, 5, 9, 7, 8, 9);
        $this->assertSame(3, $d->dayOfWeekIso);
        $d = Carbon::create(2012, 5, 10, 0, 0, 0);
        $this->assertSame(4, $d->dayOfWeekIso);
        $d = Carbon::create(2012, 5, 11, 23, 59, 59);
        $this->assertSame(5, $d->dayOfWeekIso);
        $d = Carbon::create(2012, 5, 12, 12, 0, 0);
        $this->assertSame(6, $d->dayOfWeekIso);
        $d = Carbon::create(2012, 5, 13, 12, 0, 0);
        $this->assertSame(7, $d->dayOfWeekIso);
    }

    public function testStringGetters()
    {
        $d = Carbon::create(2012, 1, 9, 7, 8, 9);
        $this->assertSame('Monday', $d->englishDayOfWeek);
        $this->assertSame('Mon', $d->shortEnglishDayOfWeek);
        $this->assertSame('January', $d->englishMonth);
        $this->assertSame('Jan', $d->shortEnglishMonth);
    }

    public function testLocalizedGetters()
    {
        Carbon::useStrictMode(false);

        $currentLocale = setlocale(LC_ALL, '0');
        if (setlocale(LC_ALL, 'fr_FR.UTF-8', 'fr_FR.utf8', 'fr_FR', 'fr') === false) {
            $this->markTestSkipped('testSetLocaleToAuto test need fr_FR.UTF-8.');
        }
        $d = Carbon::create(2019, 7, 15, 7, 8, 9);
        $this->assertSame('lundi', $d->localeDayOfWeek);
        $this->assertSame('lun.', $d->shortLocaleDayOfWeek);
        $this->assertSame('juillet', $d->localeMonth);
        $this->assertSame('juil.', $d->shortLocaleMonth);
        setlocale(LC_ALL, $currentLocale);
    }

    public function testDayOfYearGetter()
    {
        $d = Carbon::createFromDate(2012, 5, 7);
        $this->assertSame(128, $d->dayOfYear);
    }

    public function testDaysInMonthGetter()
    {
        $d = Carbon::createFromDate(2012, 5, 7);
        $this->assertSame(31, $d->daysInMonth);
    }

    public function testTimestampGetter()
    {
        $d = Carbon::create();
        $d->setTimezone('GMT');
        $this->assertSame(0, $d->setDateTime(1970, 1, 1, 0, 0, 0)->timestamp);
    }

    public function testGetAge()
    {
        $d = Carbon::now();
        $this->assertSame(0, $d->age);
    }

    public function testGetAgeWithRealAge()
    {
        $d = Carbon::createFromDate(1975, 5, 21);
        $age = (int) (substr((string) ((int) (date('Ymd')) - (int) (date('Ymd', $d->timestamp))), 0, -4));

        $this->assertSame($age, $d->age);
    }

    public static function dataForTestQuarter(): Generator
    {
        yield [1, 1];
        yield [2, 1];
        yield [3, 1];
        yield [4, 2];
        yield [5, 2];
        yield [6, 2];
        yield [7, 3];
        yield [8, 3];
        yield [9, 3];
        yield [10, 4];
        yield [11, 4];
        yield [12, 4];
    }

    /**
     * @dataProvider \Tests\Carbon\GettersTest::dataForTestQuarter
     *
     * @param int $month
     * @param int $quarter
     */
    public function testQuarterFirstOfMonth($month, $quarter)
    {
        $c = Carbon::create(2015, $month, 1)->startOfMonth();
        $this->assertSame($quarter, $c->quarter);
    }

    /**
     * @dataProvider \Tests\Carbon\GettersTest::dataForTestQuarter
     *
     * @param int $month
     * @param int $quarter
     */
    public function testQuarterMiddleOfMonth($month, $quarter)
    {
        $c = Carbon::create(2015, $month, 15, 12, 13, 14);
        $this->assertSame($quarter, $c->quarter);
    }

    /**
     * @dataProvider \Tests\Carbon\GettersTest::dataForTestQuarter
     *
     * @param int $month
     * @param int $quarter
     */
    public function testQuarterLastOfMonth($month, $quarter)
    {
        $c = Carbon::create(2015, $month, 1)->endOfMonth();
        $this->assertSame($quarter, $c->quarter);
    }

    public function testGetLocalTrue()
    {
        // Default timezone has been set to America/Toronto in AbstractTestCase.php
        // @see : https://en.wikipedia.org/wiki/List_of_UTC_time_offsets
        $this->assertTrue(Carbon::createFromDate(2012, 1, 1, 'America/Toronto')->local);
        $this->assertTrue(Carbon::createFromDate(2012, 1, 1, 'America/Toronto')->isLocal());
        $this->assertTrue(Carbon::createFromDate(2012, 1, 1, 'America/New_York')->local);
        $this->assertTrue(Carbon::createFromDate(2012, 1, 1, 'America/New_York')->isLocal());
    }

    public function testGetLocalFalse()
    {
        $this->assertFalse(Carbon::createFromDate(2012, 7, 1, 'UTC')->local);
        $this->assertFalse(Carbon::createFromDate(2012, 7, 1, 'UTC')->isLocal());
        $this->assertFalse(Carbon::createFromDate(2012, 7, 1, 'Europe/London')->local);
        $this->assertFalse(Carbon::createFromDate(2012, 7, 1, 'Europe/London')->isLocal());
    }

    public function testGetUtcFalse()
    {
        $this->assertFalse(Carbon::createFromDate(2013, 1, 1, 'America/Toronto')->utc);
        $this->assertFalse(Carbon::createFromDate(2013, 1, 1, 'America/Toronto')->isUtc());
        /** @var object $date */
        $date = Carbon::createFromDate(2013, 1, 1, 'America/Toronto');
        $this->assertFalse($date->isUTC());
        $this->assertFalse(Carbon::createFromDate(2013, 1, 1, 'Europe/Paris')->utc);
        $this->assertFalse(Carbon::createFromDate(2013, 1, 1, 'Europe/Paris')->isUtc());
        /** @var object $date */
        $date = Carbon::createFromDate(2013, 1, 1, 'Europe/Paris');
        $this->assertFalse($date->isUTC());
    }

    public function testGetUtcTrue()
    {
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'Atlantic/Reykjavik')->utc);
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'Atlantic/Reykjavik')->isUtc());
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'Europe/Lisbon')->utc);
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'Europe/Lisbon')->isUtc());
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'Africa/Casablanca')->utc);
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'Africa/Casablanca')->isUtc());
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'Africa/Dakar')->utc);
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'Africa/Dakar')->isUtc());
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'Europe/Dublin')->utc);
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'Europe/Dublin')->isUtc());
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'Europe/London')->utc);
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'Europe/London')->isUtc());
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'UTC')->utc);
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'UTC')->isUtc());
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'GMT')->utc);
        $this->assertTrue(Carbon::createFromDate(2013, 1, 1, 'GMT')->isUtc());
    }

    public function testGetDstFalse()
    {
        $this->assertFalse(Carbon::createFromDate(2012, 1, 1, 'America/Toronto')->dst);
        $this->assertFalse(Carbon::createFromDate(2012, 1, 1, 'America/Toronto')->isDST());
    }

    public function testGetDstTrue()
    {
        $this->assertTrue(Carbon::createFromDate(2012, 7, 1, 'America/Toronto')->dst);
        $this->assertTrue(Carbon::createFromDate(2012, 7, 1, 'America/Toronto')->isDST());
    }

    public function testGetMidDayAt()
    {
        $d = Carbon::now();
        $this->assertSame(12, $d->getMidDayAt());
    }

    public function testOffsetForTorontoWithDST()
    {
        $this->assertSame(-18000, Carbon::createFromDate(2012, 1, 1, 'America/Toronto')->offset);
    }

    public function testOffsetForTorontoNoDST()
    {
        $this->assertSame(-14400, Carbon::createFromDate(2012, 6, 1, 'America/Toronto')->offset);
    }

    public function testOffsetForGMT()
    {
        $this->assertSame(0, Carbon::createFromDate(2012, 6, 1, 'GMT')->offset);
    }

    public function testOffsetHoursForTorontoWithDST()
    {
        $this->assertSame(-5, Carbon::createFromDate(2012, 1, 1, 'America/Toronto')->offsetHours);
    }

    public function testOffsetHoursForTorontoNoDST()
    {
        $this->assertSame(-4, Carbon::createFromDate(2012, 6, 1, 'America/Toronto')->offsetHours);
    }

    public function testOffsetHoursForGMT()
    {
        $this->assertSame(0, Carbon::createFromDate(2012, 6, 1, 'GMT')->offsetHours);
    }

    public function testIsLeapYearTrue()
    {
        $this->assertTrue(Carbon::createFromDate(2012, 1, 1)->isLeapYear());
    }

    public function testIsLeapYearFalse()
    {
        $this->assertFalse(Carbon::createFromDate(2011, 1, 1)->isLeapYear());
    }

    public function testIsLongYearTrue()
    {
        $this->assertTrue(Carbon::createFromDate(2015, 1, 1)->isLongYear());
        $this->assertTrue(Carbon::createFromDate(2020, 1, 1)->isLongYear());
    }

    public function testIsLongIsoYearTrue()
    {
        $this->assertTrue(Carbon::createFromDate(2015, 1, 1)->isLongIsoYear());
        $this->assertTrue(Carbon::createFromDate(2016, 1, 1)->isLongIsoYear());
        $this->assertTrue(Carbon::createFromDate(2019, 12, 30)->isLongIsoYear());
    }

    public function testIsLongYearFalse()
    {
        $this->assertFalse(Carbon::createFromDate(2016, 1, 1)->isLongYear());
        $this->assertFalse(Carbon::createFromDate(2019, 12, 29)->isLongYear());
        $this->assertFalse(Carbon::createFromDate(2019, 12, 30)->isLongYear());
    }

    public function testIsLongIsoYearFalse()
    {
        $this->assertTrue(Carbon::createFromDate(2016, 1, 3)->isLongIsoYear());
        $this->assertFalse(Carbon::createFromDate(2019, 12, 29)->isLongIsoYear());
        $this->assertFalse(Carbon::createFromDate(2018, 12, 31)->isLongIsoYear());
    }

    public function testWeekOfMonth()
    {
        $this->assertSame(5, Carbon::createFromDate(2012, 9, 30)->weekOfMonth);
        $this->assertSame(4, Carbon::createFromDate(2012, 9, 28)->weekOfMonth);
        $this->assertSame(3, Carbon::createFromDate(2012, 9, 20)->weekOfMonth);
        $this->assertSame(2, Carbon::createFromDate(2012, 9, 8)->weekOfMonth);
        $this->assertSame(1, Carbon::createFromDate(2012, 9, 1)->weekOfMonth);
    }

    public function testWeekNumberInMonthIsNotFromTheBeginning()
    {
        $this->assertSame(5, Carbon::createFromDate(2017, 2, 28)->weekNumberInMonth);
        $this->assertSame(5, Carbon::createFromDate(2017, 2, 27)->weekNumberInMonth);
        $this->assertSame(4, Carbon::createFromDate(2017, 2, 26)->weekNumberInMonth);
        $this->assertSame(4, Carbon::createFromDate(2017, 2, 20)->weekNumberInMonth);
        $this->assertSame(3, Carbon::createFromDate(2017, 2, 19)->weekNumberInMonth);
        $this->assertSame(3, Carbon::createFromDate(2017, 2, 13)->weekNumberInMonth);
        $this->assertSame(2, Carbon::createFromDate(2017, 2, 12)->weekNumberInMonth);
        $this->assertSame(2, Carbon::createFromDate(2017, 2, 6)->weekNumberInMonth);
        $this->assertSame(1, Carbon::createFromDate(2017, 2, 1)->weekNumberInMonth);
        $this->assertSame(1, Carbon::createFromDate(2018, 7, 1)->weekNumberInMonth);
        $this->assertSame(2, Carbon::createFromDate(2018, 7, 2)->weekNumberInMonth);
        $this->assertSame(2, Carbon::createFromDate(2018, 7, 5)->weekNumberInMonth);
        $this->assertSame(2, Carbon::createFromDate(2018, 7, 8)->weekNumberInMonth);
        $this->assertSame(3, Carbon::createFromDate(2018, 7, 9)->weekNumberInMonth);
        $this->assertSame(5, Carbon::createFromDate(2018, 7, 29)->weekNumberInMonth);
        $this->assertSame(6, Carbon::createFromDate(2018, 7, 30)->weekNumberInMonth);
    }

    public function testWeekOfYearFirstWeek()
    {
        $this->assertSame(52, Carbon::createFromDate(2012, 1, 1)->weekOfYear);
        $this->assertSame(1, Carbon::createFromDate(2012, 1, 2)->weekOfYear);
    }

    public function testWeekOfYearLastWeek()
    {
        $this->assertSame(52, Carbon::createFromDate(2012, 12, 30)->weekOfYear);
        $this->assertSame(1, Carbon::createFromDate(2012, 12, 31)->weekOfYear);
    }

    public function testGetTimezone()
    {
        $dt = Carbon::createFromDate(2000, 1, 1, 'America/Toronto');
        $this->assertSame('America/Toronto', $dt->timezone->getName());

        $dt = Carbon::createFromDate(2000, 1, 1, -5);
        $this->assertSame('America/Chicago', $dt->timezone->getName());

        $dt = Carbon::createFromDate(2000, 1, 1, '-5');
        $this->assertSame('-05:00', $dt->timezone->getName());
    }

    public function testGetTz()
    {
        $dt = Carbon::createFromDate(2000, 1, 1, 'America/Toronto');
        $this->assertSame('America/Toronto', $dt->tz->getName());

        $dt = Carbon::createFromDate(2000, 1, 1, -5);
        $this->assertSame('America/Chicago', $dt->tz->getName());

        $dt = Carbon::createFromDate(2000, 1, 1, '-5');
        $this->assertSame('-05:00', $dt->tz->getName());
    }

    public function testGetTimezoneName()
    {
        $dt = Carbon::createFromDate(2000, 1, 1, 'America/Toronto');
        $this->assertSame('America/Toronto', $dt->timezoneName);

        $dt = Carbon::createFromDate(2000, 1, 1, -5);
        $this->assertSame('America/Chicago', $dt->timezoneName);

        $dt = Carbon::createFromDate(2000, 1, 1, '-5');
        $this->assertSame('-05:00', $dt->timezoneName);
    }

    public function testGetTzName()
    {
        $dt = Carbon::createFromDate(2000, 1, 1, 'America/Toronto');
        $this->assertSame('America/Toronto', $dt->tzName);

        $dt = Carbon::createFromDate(2000, 1, 1, -5);
        $this->assertSame('America/Chicago', $dt->timezoneName);

        $dt = Carbon::createFromDate(2000, 1, 1, '-5');
        $this->assertSame('-05:00', $dt->timezoneName);
    }

    public function testShortDayName()
    {
        $dt = Carbon::createFromDate(2018, 8, 6);
        $this->assertSame('Mon', $dt->shortDayName);
        $this->assertSame('lun.', $dt->locale('fr')->shortDayName);
    }

    public function testMinDayName()
    {
        $dt = Carbon::createFromDate(2018, 8, 6);
        $this->assertSame('Mo', $dt->minDayName);
        $this->assertSame('lu', $dt->locale('fr')->minDayName);
    }

    public function testShortMonthName()
    {
        $dt = Carbon::createFromDate(2018, 7, 6);
        $this->assertSame('Jul', $dt->shortMonthName);
        $this->assertSame('juil.', $dt->locale('fr')->shortMonthName);
    }

    public function testGetDays()
    {
        $days = [
            Carbon::SUNDAY => 'Sunday',
            Carbon::MONDAY => 'Monday',
            Carbon::TUESDAY => 'Tuesday',
            Carbon::WEDNESDAY => 'Wednesday',
            Carbon::THURSDAY => 'Thursday',
            Carbon::FRIDAY => 'Friday',
            Carbon::SATURDAY => 'Saturday',
        ];

        $this->assertSame($days, Carbon::getDays());
    }
}