Inheritance diagram for ilCalendarCronRemoteReader:

Collaboration diagram for ilCalendarCronRemoteReader:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...

	hasFlexibleSchedule ()

	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)

	hasCustomSettings ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	run ()

Public Member Functions inherited from ILIAS\Cron\CronJob
	setDateTimeProvider (?\Closure $date_time_provider)

	isDue (?\DateTimeImmutable $last_run, ?JobScheduleType $schedule_type, ?int $schedule_value, bool $is_manually_executed=false)

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule (?JobScheduleType $a_type, ?int $a_value)
	Update current schedule (if flexible) More...

	getAllScheduleTypes ()
	Get all available schedule types. More...

	getScheduleTypesWithValues ()

	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...

	isManuallyExecutable ()

	hasCustomSettings ()

	usesLegacyForms ()

	getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, \ilLanguage $lng)

	addCustomSettingsToForm (\ilPropertyFormGUI $a_form)

	saveCustomConfiguration (mixed $form_data)

	saveCustomSettings (\ilPropertyFormGUI $a_form)

	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)

	activationWasToggled (\ilDBInterface $db, \ilSetting $setting, bool $a_currently_active)
	Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed. More...

	getId ()

	getTitle ()

	getDescription ()

	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	run ()

Private Attributes
const	DEFAULT_SYNC_HOURS = 1

ilLanguage	$lng

ilLogger	$logger

ilCalendarSettings	$calendar_settings = null

Additional Inherited Members
Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

Definition at line 25 of file class.ilCalendarCronRemoteReader.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarCronRemoteReader::__construct ( )

Definition at line 34 of file class.ilCalendarCronRemoteReader.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->logger = $DIC->logger()->cal();
        $this->calendar_settings = ilCalendarSettings::_getInstance();
    }

References $DIC, ilCalendarSettings\_getInstance(), ILIAS\Repository\lng(), and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

◆ addToExternalSettingsForm()

ilCalendarCronRemoteReader::addToExternalSettingsForm	(	int	$a_form_id,
		array &	$a_fields,
		bool	$a_is_active
	)

Parameters

array<string,mixed> $a_fields

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 70 of file class.ilCalendarCronRemoteReader.php.

                                                                                                  : void
    {
        switch ($a_form_id) {
            case ilAdministrationSettingsFormHandler::FORM_CALENDAR:
                $a_fields['cal_webcal_sync'] = $a_is_active ?
                    $this->lng->txt('enabled') :
                    $this->lng->txt('disabled');
                break;
        }
    }

References ilAdministrationSettingsFormHandler\FORM_CALENDAR, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getDefaultScheduleType()

ilCalendarCronRemoteReader::getDefaultScheduleType ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 86 of file class.ilCalendarCronRemoteReader.php.

                                            : CronJobScheduleType
    {
        return CronJobScheduleType::IN_MINUTES;
    }

◆ getDefaultScheduleValue()

ilCalendarCronRemoteReader::getDefaultScheduleValue ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 91 of file class.ilCalendarCronRemoteReader.php.

                                             : ?int
    {
        if ($this->calendar_settings === null) {
            return self::DEFAULT_SYNC_HOURS;
        }
        return $this->calendar_settings->getWebCalSyncHours();
    }

References DEFAULT_SYNC_HOURS.

◆ getDescription()

ilCalendarCronRemoteReader::getDescription ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 54 of file class.ilCalendarCronRemoteReader.php.

                                    : string
    {
        $this->lng->loadLanguageModule('dateplaner');
        return $this->lng->txt('cal_cronjob_remote_description');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getId()

ilCalendarCronRemoteReader::getId ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 43 of file class.ilCalendarCronRemoteReader.php.

                           : string
    {
        return 'cal_remote_reader';
    }

◆ getTitle()

ilCalendarCronRemoteReader::getTitle ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 48 of file class.ilCalendarCronRemoteReader.php.

                              : string
    {
        $this->lng->loadLanguageModule('dateplaner');
        return $this->lng->txt('cal_cronjob_remote_title');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ hasAutoActivation()

ilCalendarCronRemoteReader::hasAutoActivation ( )

Is to be activated on "installation", does only work for ILIAS core cron jobs.

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 60 of file class.ilCalendarCronRemoteReader.php.

                                       : bool
    {
        return false;
    }

◆ hasCustomSettings()

ilCalendarCronRemoteReader::hasCustomSettings ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 81 of file class.ilCalendarCronRemoteReader.php.

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilCalendarCronRemoteReader::hasFlexibleSchedule ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 65 of file class.ilCalendarCronRemoteReader.php.

                                         : bool
    {
        return true;
    }

◆ run()

ilCalendarCronRemoteReader::run ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 99 of file class.ilCalendarCronRemoteReader.php.

                         : JobResult
    {
        $status = JobResult::STATUS_NO_ACTION;
 
        $counter = 0;
        foreach (ilCalendarCategories::lookupRemoteCalendars() as $remoteCalendar) {
            $status = JobResult::STATUS_CRASHED;
 
            $reader = new ilCalendarRemoteReader($remoteCalendar->getRemoteUrl());
            $reader->setUser($remoteCalendar->getRemoteUser());
            $reader->setPass($remoteCalendar->getRemotePass());
            try {
                $reader->read();
                $reader->import($remoteCalendar);
            } catch (Exception $e) {
                $this->logger->warning('Remote Calendar: ' . $remoteCalendar->getCategoryID());
                $this->logger->warning('Reading remote calendar failed with message: ' . $e->getMessage());
            }
            $remoteCalendar->setRemoteSyncLastExecution(new ilDateTime(time(), IL_CAL_UNIX));
            $remoteCalendar->update();
            $status = JobResult::STATUS_OK;
            ++$counter;
        }
        $result = new JobResult();
        $result->setStatus($status);
        return $result;
    }