ilCalendarRecurrenceCalculationTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use PHPUnit\Framework\TestCase;
use ILIAS\DI\Container;

class ilCalendarRecurrenceCalculationTest extends TestCase
{
    protected $backupGlobals = false;
    protected Container $dic;

    protected function setUp(): void
    {
        $this->initDependencies();
        parent::setUp();
    }

    public function testCalculatorConstruct(): void
    {
        $entry = new ilCalendarEntry(0);
        $entry->setStart(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setEnd(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setFullday(true);
        $entry->setTitle('First');
        $rec = new ilCalendarRecurrence(0);

        $calc = new ilCalendarRecurrenceCalculator(
            $entry,
            $rec
        );
        $this->assertInstanceOf(ilCalendarRecurrenceCalculator::class, $calc);
    }

    public function testYearly()
    {
        $entry = new ilCalendarEntry(0);
        $entry->setStart(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setEnd(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setFullday(true);

        $rec = new ilCalendarRecurrence(0);
        $rec->setFrequenceType(ilCalendarRecurrence::FREQ_YEARLY);
        $rec->setInterval(1);
        $rec->setFrequenceUntilCount(1);

        $calc = new ilCalendarRecurrenceCalculator(
            $entry,
            $rec
        );
        $dl = $calc->calculateDateList(
            new ilDateTime('2021-12-31', IL_CAL_DATE),
            new ilDate('2023-12-31', IL_CAL_DATE),
            -1
        );
        $this->assertCount(1, $dl);
        foreach ($dl as $date) {
            $this->assertTrue(strcmp($date->get(IL_CAL_DATE), '2022-01-01') === 0);
        }
    }

    public function testYearlyByDay(): void
    {
        $entry = new ilCalendarEntry(0);
        $entry->setStart(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setEnd(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setFullday(true);

        // first saturday and second monday in january and december
        $rec = new ilCalendarRecurrence(0);
        $rec->setFrequenceType(ilCalendarRecurrence::FREQ_YEARLY);
        $rec->setBYDAY('1SA,2MO');
        $rec->setBYMONTH('1,12');
        $rec->setInterval(1);
        $rec->setFrequenceUntilCount(6);

        $calc = new ilCalendarRecurrenceCalculator(
            $entry,
            $rec
        );
        $dl = $calc->calculateDateList(
            new ilDateTime('2021-12-31', IL_CAL_DATE),
            new ilDate('2023-12-31', IL_CAL_DATE),
            -1
        );
        $result = new ilDateList(ilDateList::TYPE_DATE);
        $result->add(new ilDate('2022-01-01', IL_CAL_DATE));
        $result->add(new ilDate('2022-01-10', IL_CAL_DATE));
        $result->add(new ilDate('2022-12-03', IL_CAL_DATE));
        $result->add(new ilDate('2022-12-12', IL_CAL_DATE));
        $result->add(new ilDate('2023-01-07', IL_CAL_DATE));
        $result->add(new ilDate('2023-01-09', IL_CAL_DATE));

        $this->assertTrue($result == $dl);
    }

    public function testMonthly()
    {
        $entry = new ilCalendarEntry(0);
        $entry->setStart(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setEnd(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setFullday(true);

        $rec = new ilCalendarRecurrence(0);
        $rec->setFrequenceType(ilCalendarRecurrence::FREQ_MONTHLY);
        $rec->setInterval(1);
        $rec->setFrequenceUntilCount(2);

        $calc = new ilCalendarRecurrenceCalculator(
            $entry,
            $rec
        );
        $dl = $calc->calculateDateList(
            new ilDateTime('2021-12-31', IL_CAL_DATE),
            new ilDate('2023-12-31', IL_CAL_DATE),
            -1
        );
        $result = new ilDateList(ilDateList::TYPE_DATE);
        $result->add(new ilDate('2022-01-01', IL_CAL_DATE));
        $result->add(new ilDate('2022-02-01', IL_CAL_DATE));

        $this->assertTrue($result == $dl);
    }

    public function testMonthlyByDay()
    {
        $entry = new ilCalendarEntry(0);
        $entry->setStart(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setEnd(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setFullday(true);

        // next two first days of the month which are on saturday  => (2022-01-01, 2022-10-01)
        $rec = new ilCalendarRecurrence(0);
        $rec->setFrequenceType(ilCalendarRecurrence::FREQ_MONTHLY);
        $rec->setBYDAY('SA');
        $rec->setBYMONTHDAY('1');
        $rec->setInterval(1);
        $rec->setFrequenceUntilCount(2);

        $calc = new ilCalendarRecurrenceCalculator(
            $entry,
            $rec
        );
        $dl = $calc->calculateDateList(
            new ilDateTime('2021-12-31', IL_CAL_DATE),
            new ilDate('2023-12-31', IL_CAL_DATE),
            -1
        );
        $result = new ilDateList(ilDateList::TYPE_DATE);
        $result->add(new ilDate('2022-01-01', IL_CAL_DATE));
        $result->add(new ilDate('2022-10-01', IL_CAL_DATE));
        $this->assertTrue($result == $dl);
    }

    public function testWeekly(): void
    {
        $entry = new ilCalendarEntry(0);
        $entry->setStart(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setEnd(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setFullday(true);

        $rec = new ilCalendarRecurrence(0);
        $rec->setFrequenceType(ilCalendarRecurrence::FREQ_WEEKLY);
        $rec->setInterval(1);
        $rec->setFrequenceUntilCount(2);

        $calc = new ilCalendarRecurrenceCalculator(
            $entry,
            $rec
        );
        $dl = $calc->calculateDateList(
            new ilDateTime('2021-12-31', IL_CAL_DATE),
            new ilDate('2023-12-31', IL_CAL_DATE),
            -1
        );
        $result = new ilDateList(ilDateList::TYPE_DATE);
        $result->add(new ilDate('2022-01-01', IL_CAL_DATE));
        $result->add(new ilDate('2022-01-08', IL_CAL_DATE));

        $this->assertTrue($result == $dl);
    }

    public function testWeeklyByDay(): void
    {
        $entry = new ilCalendarEntry(0);
        $entry->setStart(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setEnd(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setFullday(true);

        $rec = new ilCalendarRecurrence(0);
        $rec->setFrequenceType(ilCalendarRecurrence::FREQ_WEEKLY);
        $rec->setBYDAY('MO,SA');
        $rec->setInterval(1);
        $rec->setFrequenceUntilCount(3);

        $calc = new ilCalendarRecurrenceCalculator(
            $entry,
            $rec
        );
        $dl = $calc->calculateDateList(
            new ilDateTime('2021-12-31', IL_CAL_DATE),
            new ilDate('2023-12-31', IL_CAL_DATE),
            -1
        );
        $result = new ilDateList(ilDateList::TYPE_DATE);
        $result->add(new ilDate('2022-01-01', IL_CAL_DATE));
        $result->add(new ilDate('2022-01-03', IL_CAL_DATE));
        $result->add(new ilDate('2022-01-08', IL_CAL_DATE));

        $this->assertTrue($result == $dl);
    }

    public function testDaily(): void
    {
        $entry = new ilCalendarEntry(0);
        $entry->setStart(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setEnd(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setFullday(true);

        $rec = new ilCalendarRecurrence(0);
        $rec->setFrequenceType(ilCalendarRecurrence::FREQ_DAILY);
        $rec->setInterval(1);
        $rec->setFrequenceUntilCount(2);

        $calc = new ilCalendarRecurrenceCalculator(
            $entry,
            $rec
        );
        $dl = $calc->calculateDateList(
            new ilDateTime('2021-12-31', IL_CAL_DATE),
            new ilDate('2023-12-31', IL_CAL_DATE),
            -1
        );
        $result = new ilDateList(ilDateList::TYPE_DATE);
        $result->add(new ilDate('2022-01-01', IL_CAL_DATE));
        $result->add(new ilDate('2022-01-02', IL_CAL_DATE));

        $this->assertTrue($result == $dl);
    }

    public function testUntilEndDateInclusive(): void
    {
        $entry = new ilCalendarEntry(0);
        $entry->setStart(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setEnd(new ilDate('2022-01-01', IL_CAL_DATE));
        $entry->setFullday(true);

        $rec = new ilCalendarRecurrence(0);
        $rec->setFrequenceType(ilCalendarRecurrence::FREQ_DAILY);
        $rec->setInterval(1);
        $rec->setFrequenceUntilDate(new ilDate('2022-01-02', IL_CAL_DATE));

        $calc = new ilCalendarRecurrenceCalculator(
            $entry,
            $rec
        );
        $dl = $calc->calculateDateList(
            new ilDateTime('2021-12-31', IL_CAL_DATE),
            new ilDate('2023-12-31', IL_CAL_DATE),
            -1
        );
        $result = new ilDateList(ilDateList::TYPE_DATE);
        $result->add(new ilDate('2022-01-01', IL_CAL_DATE));
        $result->add(new ilDate('2022-01-02', IL_CAL_DATE));

        $this->assertTrue($result == $dl);
    }

    protected function setGlobalVariable(string $name, $value): void
    {
        global $DIC;

        $GLOBALS[$name] = $value;
        unset($DIC[$name]);
        $DIC[$name] = static function (\ILIAS\DI\Container $c) use ($value) {
            return $value;
        };
    }

    protected function initDependencies(): void
    {
        $this->dic = new Container();
        $GLOBALS['DIC'] = $this->dic;

        $this->setGlobalVariable('ilDB', $this->createMock(ilDBInterface::class));
        $this->setGlobalVariable('lng', $this->createMock(ilLanguage::class));
        $this->setGlobalVariable('ilErr', $this->createMock(ilErrorHandling::class));

        $logger = $this->getMockBuilder(ilLogger::class)
                       ->disableOriginalConstructor()
                       ->getMock();

        $logger_factory = $this->getMockBuilder(ilLoggerFactory::class)
                               ->disableOriginalConstructor()
                               ->onlyMethods(['getComponentLogger'])
                               ->getMock();
        $logger_factory->method('getComponentLogger')->willReturn($logger);
        $this->setGlobalVariable('ilLoggerFactory', $logger_factory);
    }
}