Inheritance diagram for ilCronEcsTaskScheduler:

Collaboration diagram for ilCronEcsTaskScheduler:

Public Member Functions
	__construct ()

	getTitle ()

	getDescription ()

	getId ()

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

	hasFlexibleSchedule ()

	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 ()

Data Fields
const	ID = 'ecs_task_handler'

const	DEFAULT_SCHEDULE_VALUE = 1

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...

Private Attributes
ilLogger	$logger

ilLanguage	$lng

ilCronJobResult	$result

Additional Inherited Members
Protected Attributes inherited from ilCronJob
int	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

Class ilCronEcsTaskScheduler.

Start execution of ecs tasks.

Definition at line 11 of file class.ilCronEcsTaskScheduler.php.

Constructor & Destructor Documentation

◆ __construct()

ilCronEcsTaskScheduler::__construct ( )

Definition at line 20 of file class.ilCronEcsTaskScheduler.php.

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->wsrv();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('ecs');
 
        $this->result = new \ilCronJobResult();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilCronEcsTaskScheduler::getDefaultScheduleType ( )

Reimplemented from ilCronJob.

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

                                            : int
    {
        return self::SCHEDULE_TYPE_IN_HOURS;
    }

References ilCronJob\SCHEDULE_TYPE_IN_HOURS.

◆ getDefaultScheduleValue()

ilCronEcsTaskScheduler::getDefaultScheduleValue ( )

Reimplemented from ilCronJob.

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

                                             : ?int
    {
        return self::DEFAULT_SCHEDULE_VALUE;
    }

References DEFAULT_SCHEDULE_VALUE.

◆ getDescription()

ilCronEcsTaskScheduler::getDescription ( )

Reimplemented from ilCronJob.

Definition at line 36 of file class.ilCronEcsTaskScheduler.php.

                                    : string
    {
        return $this->lng->txt('ecs_cron_task_scheduler_info');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getId()

ilCronEcsTaskScheduler::getId ( )

Reimplemented from ilCronJob.

Definition at line 41 of file class.ilCronEcsTaskScheduler.php.

                           : string
    {
        return self::ID;
    }

References ID.

◆ getTitle()

ilCronEcsTaskScheduler::getTitle ( )

Reimplemented from ilCronJob.

Definition at line 31 of file class.ilCronEcsTaskScheduler.php.

                              : string
    {
        return $this->lng->txt('ecs_cron_task_scheduler');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ hasAutoActivation()

ilCronEcsTaskScheduler::hasAutoActivation ( )

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

Reimplemented from ilCronJob.

Definition at line 46 of file class.ilCronEcsTaskScheduler.php.

                                       : bool
    {
        return false;
    }

◆ hasFlexibleSchedule()

ilCronEcsTaskScheduler::hasFlexibleSchedule ( )

Reimplemented from ilCronJob.

Definition at line 51 of file class.ilCronEcsTaskScheduler.php.

                                         : bool
    {
        return true;
    }

◆ run()

ilCronEcsTaskScheduler::run ( )

Reimplemented from ilCronJob.

Definition at line 66 of file class.ilCronEcsTaskScheduler.php.

                         : ilCronJobResult
    {
        $this->logger->debug('Starting ecs task scheduler...');
 
        $servers = \ilECSServerSettings::getInstance();
 
        foreach ($servers->getServers(ilECSServerSettings::ACTIVE_SERVER) as $server) {
            try {
                $this->logger->info('Starting task execution for ecs server: ' . $server->getTitle());
                $scheduler = \ilECSTaskScheduler::_getInstanceByServerId($server->getServerId());
                $scheduler->startTaskExecution();
            } catch (\Exception $e) {
                $this->result->setStatus(\ilCronJobResult::STATUS_CRASHED);
                $this->result->setMessage($e->getMessage());
                $this->logger->warning('ECS task execution failed with message: ' . $e->getMessage());
                return $this->result;
            }
        }
        $this->result->setStatus(\ilCronJobResult::STATUS_OK);
        return $this->result;
    }