Inheritance diagram for ilCronEcsTaskScheduler:

Collaboration diagram for ilCronEcsTaskScheduler:

Public Member Functions
	__construct ()

	getTitle ()

	getDescription ()

	getId ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

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

Data Fields
const	ID = 'ecs_task_handler'

const	DEFAULT_SCHEDULE_VALUE = 1

Private Attributes
ilLogger	$logger

ilLanguage	$lng

JobResult	$result

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

Class ilCronEcsTaskScheduler.

Start execution of ecs tasks.

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

Constructor & Destructor Documentation

◆ __construct()

ilCronEcsTaskScheduler::__construct ( )

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilCronEcsTaskScheduler::getDefaultScheduleType ( )

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

                                             : JobScheduleType
     {
         return JobScheduleType::IN_HOURS;
     }

◆ getDefaultScheduleValue()

ilCronEcsTaskScheduler::getDefaultScheduleValue ( )

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

                                              : ?int
     {
         return self::DEFAULT_SCHEDULE_VALUE;
     }

◆ getDescription()

ilCronEcsTaskScheduler::getDescription ( )

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ getId()

ilCronEcsTaskScheduler::getId ( )

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

                            : string
     {
         return self::ID;
     }

◆ getTitle()

ilCronEcsTaskScheduler::getTitle ( )

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ hasAutoActivation()

ilCronEcsTaskScheduler::hasAutoActivation ( )

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

                                        : bool
     {
         return false;
     }

◆ hasFlexibleSchedule()

ilCronEcsTaskScheduler::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return true;
     }

◆ run()

ilCronEcsTaskScheduler::run ( )

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

References Vendor\Package\$e, $result, $server, ilECSTaskScheduler\_getInstanceByServerId(), ilECSServerSettings\ACTIVE_SERVER, ilECSServerSettings\getInstance(), ILIAS\Repository\logger(), and ILIAS\BackgroundTasks\Task\Job\JobResult\setStatus().

                          : JobResult
     {
         $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(\ILIAS\Cron\Job\JobResult::STATUS_CRASHED);
                 $this->result->setMessage(
                     mb_substr(sprintf('Exc.: %s / %s', $e->getMessage(), $e->getTraceAsString()), 0, 400)
                 );
                 $this->logger->error('ECS task execution failed with message: ' . $e->getMessage());
                 $this->logger->error($e->getTraceAsString());
                 return $this->result;
             }
         }
         $this->result->setStatus(\ILIAS\Cron\Job\JobResult::STATUS_OK);
         return $this->result;
     }