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 ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)

	isDue (?DateTimeImmutable $last_run, ?int $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 (?int $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 ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	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
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_MINUTES = 2
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_HOURS = 3
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_DAYS = 4
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_WEEKLY = 5
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_MONTHLY = 6
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_QUARTERLY = 7
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_YEARLY = 8
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

Protected Attributes inherited from ilCronJob
int	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarCronRemoteReader::__construct ( )

Definition at line 30 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
	)

Reimplemented from ilCronJob.

Definition at line 66 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 ilCronJob.

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

                                            : int
    {
        return self::SCHEDULE_TYPE_IN_HOURS;
    }

References ilCronJob\SCHEDULE_TYPE_IN_HOURS.

◆ getDefaultScheduleValue()

ilCalendarCronRemoteReader::getDefaultScheduleValue ( )

Reimplemented from ilCronJob.

Definition at line 87 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 ilCronJob.

Definition at line 50 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 ilCronJob.

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

                           : string
    {
        return 'cal_remote_reader';
    }

◆ getTitle()

ilCalendarCronRemoteReader::getTitle ( )

Reimplemented from ilCronJob.

Definition at line 44 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 ilCronJob.

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

                                       : bool
    {
        return false;
    }

◆ hasCustomSettings()

ilCalendarCronRemoteReader::hasCustomSettings ( )

Reimplemented from ilCronJob.

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

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilCalendarCronRemoteReader::hasFlexibleSchedule ( )

Reimplemented from ilCronJob.

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

                                         : bool
    {
        return true;
    }

◆ run()

ilCalendarCronRemoteReader::run ( )

Reimplemented from ilCronJob.

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

                         : ilCronJobResult
    {
        $status = ilCronJobResult::STATUS_NO_ACTION;
 
        $counter = 0;
        foreach (ilCalendarCategories::lookupRemoteCalendars() as $remoteCalendar) {
            $status = ilCronJobResult::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 = ilCronJobResult::STATUS_OK;
            ++$counter;
        }
        $result = new ilCronJobResult();
        $result->setStatus($status);
        return $result;
    }