ilCronManagerGUI Class Reference

ilCronManagerGUI: ilPropertyFormGUI ilCronManagerGUI: ilAdministrationGUI More...

Collaboration diagram for ilCronManagerGUI:

Public Member Functions
	executeCommand ()
	edit (?ILIAS\UI\Component\Input\Container\Form\Form $form=null)
	editLegacy (?ilPropertyFormGUI $a_form=null)
	update ()
	updateLegacy ()
	run ()
	confirmedRun ()
	activate ()
	confirmedActivate ()
	deactivate ()
	confirmedDeactivate ()
	reset ()
	confirmedReset ()
	addToExternalSettingsForm (int $a_form_id)

Data Fields
const	FORM_PARAM_MAIN_SECTION = 'main'
const	FORM_PARAM_JOB_INPUT = 'additional_job_input'
const	FORM_PARAM_GROUP_SCHEDULE = 'schedule'

Protected Member Functions
	render ()
	getScheduleValueFormElementName (JobScheduleType $schedule_type)
	hasScheduleValue (JobScheduleType $schedule_type)
	initEditForm (?CronJob $job)
	initLegacyEditForm (?CronJob $job)
	getMultiActionData ()
	confirm (string $a_action)

Private Member Functions
	retrieveTableActionJobIds ()
	getTableActionParameterName ()
	addProblematicItemsInfo (\ILIAS\Cron\Job\JobCollection $filtered_jobs, \ILIAS\UI\Component\MessageBox\MessageBox $message, array $components)
	getJobIdParameterName ()
	getRequestValue (string $key, \ILIAS\Refinery\Transformation $trafo, bool $force_retrieval=false, $default=null)
	handleTableActions ()
	getScheduleTypeFormElementName (JobScheduleType $schedule_type)

Private Attributes
const	TABLE_ACTION_NAMESPACE = ['cron', 'jobs']
const	TABLE_ACTION_PARAM_NAME = 'table_action'
const	TABLE_ACTION_IDENTIFIER_NAME = 'jid'
const	FORM_PARAM_SCHEDULE_PREFIX = 'schedule_'
readonly ilLanguage	$lng
readonly ilCtrlInterface	$ctrl
readonly ilSetting	$settings
readonly ilGlobalTemplateInterface	$tpl
readonly Factory	$ui_factory
readonly Renderer	$ui_renderer
readonly ilUIService	$ui_service
readonly JobRepository	$cron_repository
readonly ILIAS DI RBACServices	$rbac
readonly ilErrorHandling	$error
readonly WrapperFactory	$http_wrapper
readonly ILIAS HTTP GlobalHttpState	$http
readonly ILIAS Refinery Factory	$refinery
readonly JobManager	$cron_manager
readonly ilObjUser	$actor

Detailed Description

ilCronManagerGUI: ilPropertyFormGUI ilCronManagerGUI: ilAdministrationGUI

Definition at line 38 of file class.ilCronManagerGUI.php.

Member Function Documentation

activate()

ilCronManagerGUI::activate

(

)

Definition at line 706 of file class.ilCronManagerGUI.php.

References confirm().

Referenced by handleTableActions().

                              : void
    {
        $this->confirm('activate');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addProblematicItemsInfo()

ilCronManagerGUI::addProblematicItemsInfo ( \ILIAS\Cron\Job\JobCollection  $filtered_jobs, \ILIAS\UI\Component\MessageBox\MessageBox  $message, array  $components  )

private

Parameters

list<

Definition at line 146 of file class.ilCronManagerGUI.php.

References $components, ILIAS\BackgroundTasks\Task\Job\JobEntity\getEffectiveJobId(), ILIAS\BackgroundTasks\Task\Job\JobEntity\getEffectiveTitle(), ILIAS\BackgroundTasks\Task\Job\JobEntity\getJobResultStatus(), and ILIAS\Repository\lng().

     : array {
        $problematic_jobs = $filtered_jobs->filter(static function (JobEntity $entity): bool {
            return $entity->getJobResultStatus() === JobResult::STATUS_CRASHED;
        });
        if (count($problematic_jobs) > 0) {
            $problematic_jobs_info = $this->ui_factory->messageBox()->info(
                $this->lng->txt('cron_jobs_with_required_intervention')
            )->withLinks(
                array_map(
                    function (JobEntity $entity): \ILIAS\UI\Component\Link\Standard {
                        return $this->ui_factory->link()->standard(
                            $entity->getEffectiveTitle(),
                            '#job-' . $entity->getEffectiveJobId()
                        );
                    },
                    (new OrderedJobEntities(
                        $problematic_jobs,
                        OrderedJobEntities::ORDER_BY_NAME
                    ))->toArray()
                )
            );

            if (in_array($message, $components, true)) {
                $components = array_merge(
                    array_slice($components, 0, array_search($message, $components, true) + 1),
                    [$problematic_jobs_info],
                    array_slice($components, array_search($message, $components, true) + 1)
                );
            } else {
                array_unshift($components, $problematic_jobs_info);
            }
        }

        return $components;
    }

Here is the call graph for this function:

addToExternalSettingsForm()

ilCronManagerGUI::addToExternalSettingsForm

(

int

$a_form_id

)

Returns

array<string, mixed>

Definition at line 867 of file class.ilCronManagerGUI.php.

References $data, and null.

                                                             : array
    {
        $form_elements = [];
        $fields = [];
        $data = $this->cron_repository->getCronJobData();
        foreach ($data as $item) {
            $job = $this->cron_repository->getJobInstance(
                $item['job_id'],
                $item['component'],
                $item['class']
            );
            if ($job !== null) {
                $job->addToExternalSettingsForm($a_form_id, $fields, (bool) $item['job_status']);
            }
        }

        if ($fields !== []) {
            $form_elements = [
                'cron_jobs' => [
                    'jumpToCronJobs',
                    $fields
                ]
            ];
        }

        return $form_elements;
    }

confirm()

ilCronManagerGUI::confirm ( string  $a_action )

protected

Definition at line 807 of file class.ilCronManagerGUI.php.

References ILIAS\Repository\ctrl(), getJobIdParameterName(), getMultiActionData(), ILIAS\Cron\CronJob\isManuallyExecutable(), ILIAS\Repository\lng(), ILIAS\Repository\rbac(), and SYSTEM_FOLDER_ID.

Referenced by activate(), deactivate(), reset(), and run().

                                                : void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $jobs = $this->getMultiActionData();
        if ($jobs === []) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_checkbox'), true);
            $this->ctrl->redirect($this, 'render');
        }

        if ($a_action === 'run') {
            $jobs = array_filter($jobs, static function (CronJob $job): bool {
                return $job->isManuallyExecutable();
            });

            if ($jobs === []) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('cron_no_executable_job_selected'), true);
                $this->ctrl->redirect($this, 'render');
            }
        }

        $cgui = new ilConfirmationGUI();

        if (count($jobs) === 1) {
            $jobKeys = array_keys($jobs);
            $job_id = array_pop($jobKeys);
            $job = array_pop($jobs);
            $title = $job->getTitle();
            if (!$title) {
                $title = preg_replace('[^A-Za-z0-9_\-]', '', $job->getId());
            }

            $cgui->setHeaderText(
                sprintf(
                    $this->lng->txt('cron_action_' . $a_action . '_sure'),
                    $title
                )
            );

            $cgui->addHiddenItem($this->getJobIdParameterName() . '[]', $job_id);
        } else {
            $cgui->setHeaderText($this->lng->txt('cron_action_' . $a_action . '_sure_multi'));

            foreach ($jobs as $job_id => $job) {
                $cgui->addItem($this->getJobIdParameterName() . '[]', $job_id, $job->getTitle());
            }
        }

        $cgui->setFormAction($this->ctrl->getFormAction($this, 'confirmed' . ucfirst($a_action)));
        $cgui->setCancel($this->lng->txt('cancel'), 'render');
        $cgui->setConfirm($this->lng->txt('cron_action_' . $a_action), 'confirmed' . ucfirst($a_action));

        $this->tpl->setContent($cgui->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmedActivate()

ilCronManagerGUI::confirmedActivate

(

)

Definition at line 711 of file class.ilCronManagerGUI.php.

References ILIAS\Repository\ctrl(), getMultiActionData(), ILIAS\Repository\lng(), ILIAS\Repository\rbac(), and SYSTEM_FOLDER_ID.

                                       : void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $jobs = $this->getMultiActionData();
        if ($jobs !== []) {
            foreach ($jobs as $job) {
                if ($this->cron_manager->isJobInactive($job->getId())) {
                    $this->cron_manager->resetJob($job, $this->actor);
                }
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('cron_action_activate_success'), true);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_checkbox'), true);
        }

        $this->ctrl->redirect($this, 'render');
    }

Here is the call graph for this function:

confirmedDeactivate()

ilCronManagerGUI::confirmedDeactivate

(

)

Definition at line 738 of file class.ilCronManagerGUI.php.

References ILIAS\Repository\ctrl(), getMultiActionData(), ILIAS\Repository\lng(), ILIAS\Repository\rbac(), and SYSTEM_FOLDER_ID.

                                         : void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $jobs = $this->getMultiActionData();
        if ($jobs !== []) {
            foreach ($jobs as $job) {
                if ($this->cron_manager->isJobActive($job->getId())) {
                    $this->cron_manager->deactivateJob($job, $this->actor, true);
                }
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('cron_action_deactivate_success'), true);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_checkbox'), true);
        }

        $this->ctrl->redirect($this, 'render');
    }

Here is the call graph for this function:

confirmedReset()

ilCronManagerGUI::confirmedReset

(

)

Definition at line 765 of file class.ilCronManagerGUI.php.

References ILIAS\Repository\ctrl(), getMultiActionData(), ILIAS\Repository\lng(), ILIAS\Repository\rbac(), and SYSTEM_FOLDER_ID.

                                    : void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $jobs = $this->getMultiActionData();
        if ($jobs !== []) {
            foreach ($jobs as $job) {
                $this->cron_manager->resetJob($job, $this->actor);
            }
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('cron_action_reset_success'), true);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_checkbox'), true);
        }

        $this->ctrl->redirect($this, 'render');
    }

Here is the call graph for this function:

confirmedRun()

ilCronManagerGUI::confirmedRun

(

)

Definition at line 685 of file class.ilCronManagerGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\rbac(), retrieveTableActionJobIds(), and SYSTEM_FOLDER_ID.

                                  : void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $job_ids = $this->retrieveTableActionJobIds();
        if (count($job_ids) !== 1) {
            $this->ctrl->redirect($this, 'render');
        }

        $job_id = current($job_ids);
        if ($this->cron_manager->runJobManual($job_id, $this->actor)) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('cron_action_run_success'), true);
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('cron_action_run_fail'), true);
        }

        $this->ctrl->redirect($this, 'render');
    }

Here is the call graph for this function:

deactivate()

ilCronManagerGUI::deactivate

(

)

Definition at line 733 of file class.ilCronManagerGUI.php.

References confirm().

Referenced by handleTableActions().

                                : void
    {
        $this->confirm('deactivate');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

edit()

ilCronManagerGUI::edit

(

?ILIAS\UI\Component\Input\Container\Form\Form

$form = null

)

Definition at line 327 of file class.ilCronManagerGUI.php.

References ILIAS\Repository\ctrl(), getJobIdParameterName(), initEditForm(), ILIAS\Repository\lng(), null, ILIAS\Repository\rbac(), retrieveTableActionJobIds(), and SYSTEM_FOLDER_ID.

Referenced by handleTableActions(), and update().

                                                                                    : void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        if ($form === null) {
            $job_ids = $this->retrieveTableActionJobIds();
            if (count($job_ids) !== 1) {
                $this->ctrl->redirect($this, 'render');
            }

            $job_id = current($job_ids);
            $job = $this->cron_repository->getJobInstanceById($job_id);
            if ($job && $job->usesLegacyForms()) {
                $this->ctrl->setParameter($this, $this->getJobIdParameterName(), $job->getId());
                $this->ctrl->redirect($this, 'editLegacy');
            }

            $form = $this->initEditForm($job);
        }

        $this->tpl->setContent($this->ui_renderer->render($form));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editLegacy()

ilCronManagerGUI::editLegacy

(

?ilPropertyFormGUI

$a_form = null

)

Definition at line 352 of file class.ilCronManagerGUI.php.

References ILIAS\Repository\ctrl(), initLegacyEditForm(), ILIAS\Repository\lng(), null, ILIAS\Repository\rbac(), retrieveTableActionJobIds(), and SYSTEM_FOLDER_ID.

Referenced by updateLegacy().

                                                                 : void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        if ($a_form === null) {
            $job_ids = $this->retrieveTableActionJobIds();
            if (count($job_ids) !== 1) {
                $this->ctrl->redirect($this, 'render');
            }

            $job_id = current($job_ids);
            $job = $this->cron_repository->getJobInstanceById($job_id);
            $a_form = $this->initLegacyEditForm($job);
        }

        $this->tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilCronManagerGUI::executeCommand

(

)

Definition at line 226 of file class.ilCronManagerGUI.php.

References ILIAS\Repository\ctrl(), getJobIdParameterName(), getRequestValue(), initLegacyEditForm(), ILIAS\Repository\lng(), ILIAS\Repository\rbac(), ILIAS\Repository\refinery(), ilUtil\stripSlashes(), and SYSTEM_FOLDER_ID.

                                    : void
    {
        if (!$this->rbac->system()->checkAccess('visible,read', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $class = $this->ctrl->getNextClass($this);

        switch (strtolower($class)) {
            case strtolower(ilPropertyFormGUI::class):
                $job_id = $this->getRequestValue($this->getJobIdParameterName(), $this->refinery->kindlyTo()->string());
                $job = $this->cron_repository->getJobInstanceById(ilUtil::stripSlashes($job_id));
                $form = $this->initLegacyEditForm($job);
                $this->ctrl->forwardCommand($form);
                break;
        }

        $cmd = $this->ctrl->getCmd('render');
        $this->$cmd();
    }

Here is the call graph for this function:

getJobIdParameterName()

ilCronManagerGUI::getJobIdParameterName ( )

private

Definition at line 186 of file class.ilCronManagerGUI.php.

Referenced by confirm(), edit(), executeCommand(), initEditForm(), initLegacyEditForm(), retrieveTableActionJobIds(), update(), and updateLegacy().

                                            : string
    {
        return implode('_', array_merge(self::TABLE_ACTION_NAMESPACE, [self::TABLE_ACTION_IDENTIFIER_NAME]));
    }

Here is the caller graph for this function:

getMultiActionData()

ilCronManagerGUI::getMultiActionData ( )

protected

Returns

array<string, CronJob>

Definition at line 787 of file class.ilCronManagerGUI.php.

References $res, and retrieveTableActionJobIds().

Referenced by confirm(), confirmedActivate(), confirmedDeactivate(), and confirmedReset().

                                           : array
    {
        $res = [];

        $job_ids = [];
        try {
            $job_ids = $this->retrieveTableActionJobIds();
        } catch (\ILIAS\Refinery\ConstraintViolationException|OutOfBoundsException) {
        }

        foreach ($job_ids as $job_id) {
            $job = $this->cron_repository->getJobInstanceById($job_id);
            if ($job instanceof CronJob) {
                $res[$job_id] = $job;
            }
        }

        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRequestValue()

ilCronManagerGUI::getRequestValue ( string  $key, \ILIAS\Refinery\Transformation  $trafo, bool  $force_retrieval = false,   $default = null  )

private

Parameters

mixed

$default

Returns

mixed|null

Definition at line 195 of file class.ilCronManagerGUI.php.

References Vendor\Package\$e, and null.

Referenced by executeCommand(), update(), and updateLegacy().

      {
        $exc = null;

        try {
            if ($force_retrieval || $this->http_wrapper->query()->has($key)) {
                return $this->http_wrapper->query()->retrieve($key, $trafo);
            }
        } catch (OutOfBoundsException $e) {
            $exc = $e;
        }

        try {
            if ($force_retrieval || $this->http_wrapper->post()->has($key)) {
                return $this->http_wrapper->post()->retrieve($key, $trafo);
            }
        } catch (OutOfBoundsException $e) {
            $exc = $e;
        }

        if ($force_retrieval && $exc) {
            throw $exc;
        }

        return $default ?? null;
    }

Here is the caller graph for this function:

getScheduleTypeFormElementName()

ilCronManagerGUI::getScheduleTypeFormElementName ( JobScheduleType  $schedule_type )

private

Definition at line 372 of file class.ilCronManagerGUI.php.

References ILIAS\Repository\lng(), and ILIAS\Cron\Job\Schedule\YEARLY.

Referenced by initEditForm(), and initLegacyEditForm().

                                                                                   : string
    {
        return match ($schedule_type) {
            JobScheduleType::DAILY => $this->lng->txt('cron_schedule_daily'),
            JobScheduleType::WEEKLY => $this->lng->txt('cron_schedule_weekly'),
            JobScheduleType::MONTHLY => $this->lng->txt('cron_schedule_monthly'),
            JobScheduleType::QUARTERLY => $this->lng->txt('cron_schedule_quarterly'),
            JobScheduleType::YEARLY => $this->lng->txt('cron_schedule_yearly'),
            JobScheduleType::IN_MINUTES => sprintf($this->lng->txt('cron_schedule_in_minutes'), 'x'),
            JobScheduleType::IN_HOURS => sprintf($this->lng->txt('cron_schedule_in_hours'), 'x'),
            JobScheduleType::IN_DAYS => sprintf($this->lng->txt('cron_schedule_in_days'), 'x'),
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getScheduleValueFormElementName()

ilCronManagerGUI::getScheduleValueFormElementName ( JobScheduleType  $schedule_type )

protected

Definition at line 386 of file class.ilCronManagerGUI.php.

Referenced by initEditForm(), initLegacyEditForm(), and update().

                                                                                      : string
    {
        return match ($schedule_type) {
            JobScheduleType::IN_MINUTES => 'smini',
            JobScheduleType::IN_HOURS => 'shri',
            JobScheduleType::IN_DAYS => 'sdyi',
            default => throw new InvalidArgumentException(
                sprintf(
                    'The passed argument %s is invalid!',
                    var_export($schedule_type, true)
                )
            ),
        };
    }

Here is the caller graph for this function:

getTableActionParameterName()

ilCronManagerGUI::getTableActionParameterName ( )

private

Definition at line 137 of file class.ilCronManagerGUI.php.

Referenced by handleTableActions().

                                                  : string
    {
        return implode('_', array_merge(self::TABLE_ACTION_NAMESPACE, [self::TABLE_ACTION_PARAM_NAME]));
    }

Here is the caller graph for this function:

handleTableActions()

ilCronManagerGUI::handleTableActions ( )

private

Definition at line 247 of file class.ilCronManagerGUI.php.

References activate(), deactivate(), edit(), getTableActionParameterName(), ILIAS\Repository\refinery(), render(), reset(), and run().

                                         : void
    {
        $action = $this->http_wrapper->query()->retrieve(
            $this->getTableActionParameterName(),
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always('')
            ])
        );
        match ($action) {
            'run' => $this->run(),
            'activate' => $this->activate(),
            'deactivate' => $this->deactivate(),
            'reset' => $this->reset(),
            'edit' => $this->edit(),
            default => $this->render()
        };
    }

Here is the call graph for this function:

hasScheduleValue()

ilCronManagerGUI::hasScheduleValue ( JobScheduleType  $schedule_type )

protected

Definition at line 401 of file class.ilCronManagerGUI.php.

Referenced by update(), and updateLegacy().

                                                                       : bool
    {
        return in_array($schedule_type, [
            JobScheduleType::IN_MINUTES,
            JobScheduleType::IN_HOURS,
            JobScheduleType::IN_DAYS
        ], true);
    }

Here is the caller graph for this function:

initEditForm()

ilCronManagerGUI::initEditForm ( ?CronJob  $job )

protected

Definition at line 410 of file class.ilCronManagerGUI.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\ctrl(), ILIAS\Cron\CronJob\getAllScheduleTypes(), ILIAS\Cron\CronJob\getCustomConfigurationInput(), ILIAS\Cron\CronJob\getId(), getJobIdParameterName(), getScheduleTypeFormElementName(), ILIAS\Cron\CronJob\getScheduleTypesWithValues(), getScheduleValueFormElementName(), ILIAS\Cron\CronJob\getTitle(), ILIAS\Cron\CronJob\getValidScheduleTypes(), ILIAS\Cron\CronJob\hasCustomSettings(), ILIAS\Cron\CronJob\hasFlexibleSchedule(), ILIAS\Repository\lng(), null, ILIAS\Repository\refinery(), and ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation().

Referenced by edit(), and update().

                                                  : ILIAS\UI\Component\Input\Container\Form\Form
    {
        if (!($job instanceof CronJob)) {
            $this->ctrl->redirect($this, 'render');
        }

        $this->ctrl->setParameter($this, $this->getJobIdParameterName(), $job->getId());

        $jobs_data = $this->cron_repository->getCronJobData($job->getId());
        $job_data = $jobs_data[0];

        $section_inputs = [];
        if ($job->hasFlexibleSchedule()) {
            $schedule_type_groups = [];
            foreach ($job->getAllScheduleTypes() as $schedule_type) {
                if (!in_array($schedule_type, $job->getValidScheduleTypes(), true)) {
                    continue;
                }

                $schedule_type_inputs = [];
                if (in_array($schedule_type, $job->getScheduleTypesWithValues(), true)) {
                    $schedule_value_input = $this->ui_factory
                        ->input()
                        ->field()
                        ->numeric(
                            $this->lng->txt('cron_schedule_value')
                        )->withAdditionalTransformation(
                            $this->refinery->in()->series([
                                $this->refinery->int()->isGreaterThanOrEqual(1)
                            ])
                        )->withRequired(true);

                    if (is_numeric($job_data['schedule_type']) &&
                        JobScheduleType::tryFrom((int) $job_data['schedule_type']) === $schedule_type) {
                        $schedule_value_input = $schedule_value_input->withValue(
                            $job_data['schedule_value'] === null ? null : (int) $job_data['schedule_value']
                        );
                    }

                    $schedule_type_inputs = [
                        $this->getScheduleValueFormElementName($schedule_type) => $schedule_value_input
                    ];
                }

                $schedule_type_groups[self::FORM_PARAM_SCHEDULE_PREFIX . $schedule_type->value] = $this->ui_factory
                    ->input()
                    ->field()
                    ->group(
                        $schedule_type_inputs,
                        $this->getScheduleTypeFormElementName($schedule_type)
                    )
                    ->withDedicatedName(self::FORM_PARAM_SCHEDULE_PREFIX . $schedule_type->value);
            }

            $default_schedule_type = current($job->getValidScheduleTypes())->value;

            $section_inputs['schedule'] = $this->ui_factory
                ->input()
                ->field()
                ->switchableGroup(
                    $schedule_type_groups,
                    $this->lng->txt('cron_schedule_type')
                )
                ->withRequired(true)
                ->withValue(
                    $job_data['schedule_type'] === null ?
                        self::FORM_PARAM_SCHEDULE_PREFIX . $default_schedule_type :
                        self::FORM_PARAM_SCHEDULE_PREFIX . $job_data['schedule_type']
                );
        }

        $main_section = $this->ui_factory->input()->field()->section(
            $section_inputs,
            $this->lng->txt('cron_action_edit') . ': "' . $job->getTitle() . '"'
        );

        $inputs = [
            self::FORM_PARAM_MAIN_SECTION => $main_section
        ];

        if ($job->hasCustomSettings()) {
            $inputs = array_merge(
                $inputs,
                [
                    self::FORM_PARAM_JOB_INPUT =>
                        $job->getCustomConfigurationInput(
                            $this->ui_factory,
                            $this->refinery,
                            $this->lng
                        )
                ]
            );
        }

        return $this->ui_factory
            ->input()
            ->container()
            ->form()
            ->standard($this->ctrl->getFormAction($this, 'update'), $inputs)
            ->withDedicatedName('cron_form');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initLegacyEditForm()

ilCronManagerGUI::initLegacyEditForm ( ?CronJob  $job )

protected

Deprecated:

Definition at line 516 of file class.ilCronManagerGUI.php.

References ILIAS\Cron\CronJob\addCustomSettingsToForm(), ilNumberInputGUI\allowDecimals(), ILIAS\Repository\ctrl(), ILIAS\Cron\CronJob\getAllScheduleTypes(), ILIAS\Cron\CronJob\getId(), getJobIdParameterName(), getScheduleTypeFormElementName(), ILIAS\Cron\CronJob\getScheduleTypesWithValues(), getScheduleValueFormElementName(), ILIAS\Cron\CronJob\getTitle(), ILIAS\Cron\CronJob\getValidScheduleTypes(), ILIAS\Cron\CronJob\hasCustomSettings(), ILIAS\Cron\CronJob\hasFlexibleSchedule(), ILIAS\Repository\lng(), null, and ilFormPropertyGUI\setRequired().

Referenced by editLegacy(), executeCommand(), and updateLegacy().

                                                        : ilPropertyFormGUI
    {
        if (!($job instanceof CronJob)) {
            $this->ctrl->redirect($this, 'render');
        }

        $this->ctrl->setParameter($this, $this->getJobIdParameterName(), $job->getId());

        $jobs_data = $this->cron_repository->getCronJobData($job->getId());
        $job_data = $jobs_data[0];

        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'updateLegacy'));
        $form->setTitle($this->lng->txt('cron_action_edit') . ': "' . $job->getTitle() . '"');

        if ($job->hasFlexibleSchedule()) {
            $type = new ilRadioGroupInputGUI($this->lng->txt('cron_schedule_type'), 'type');
            $type->setRequired(true);
            $type->setValue($job_data['schedule_type'] === null ? null : (string) $job_data['schedule_type']);

            foreach ($job->getAllScheduleTypes() as $schedule_type) {
                if (!in_array($schedule_type, $job->getValidScheduleTypes(), true)) {
                    continue;
                }

                $option = new ilRadioOption(
                    $this->getScheduleTypeFormElementName($schedule_type),
                    (string) $schedule_type->value
                );
                $type->addOption($option);

                if (in_array($schedule_type, $job->getScheduleTypesWithValues(), true)) {
                    $scheduleValue = new ilNumberInputGUI(
                        $this->lng->txt('cron_schedule_value'),
                        $this->getScheduleValueFormElementName($schedule_type)
                    );
                    $scheduleValue->allowDecimals(false);
                    $scheduleValue->setRequired(true);
                    $scheduleValue->setSize(5);
                    if (is_numeric($job_data['schedule_type']) &&
                        JobScheduleType::tryFrom((int) $job_data['schedule_type']) === $schedule_type) {
                        $scheduleValue->setValue(
                            $job_data['schedule_value'] === null ? null : (string) $job_data['schedule_value']
                        );
                    }
                    $option->addSubItem($scheduleValue);
                }
            }

            $form->addItem($type);
        }

        if ($job->hasCustomSettings()) {
            $job->addCustomSettingsToForm($form);
        }

        $form->addCommandButton('updateLegacy', $this->lng->txt('save'));
        $form->addCommandButton('render', $this->lng->txt('cancel'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

render()

ilCronManagerGUI::render ( )

protected

Definition at line 266 of file class.ilCronManagerGUI.php.

References $cron_repository, $ctrl, $lng, $message, ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ILIAS\FileDelivery\http(), IL_CAL_UNIX, ILIAS\Repository\lng(), ILIAS\Repository\rbac(), ILIAS\Repository\settings(), and SYSTEM_FOLDER_ID.

Referenced by handleTableActions().

                               : void
    {
        $tstamp = $this->lng->txt('cronjob_last_start_unknown');
        if ($this->settings->get('last_cronjob_start_ts')) {
            $tstamp = ilDatePresentation::formatDate(
                new ilDateTime(
                    $this->settings->get('last_cronjob_start_ts'),
                    IL_CAL_UNIX
                )
            );
        }

        $message = $this->ui_factory->messageBox()->info($this->lng->txt('cronjob_last_start') . ': ' . $tstamp);

        $cronJobs = $this->cron_repository->findAll();

        $tableFilterMediator = new JobTableFilterMediator(
            $cronJobs,
            $this->ui_factory,
            $this->ui_service,
            $this->lng
        );
        $filter = $tableFilterMediator->filter(
            $this->ctrl->getFormAction(
                $this,
                'render',
                '',
                true
            )
        );

        $filtered_jobs = $tableFilterMediator->filteredJobs(
            $filter
        );

        $tbl = new JobTable(
            $this,
            'handleTableActions',
            self::TABLE_ACTION_NAMESPACE,
            self::TABLE_ACTION_PARAM_NAME,
            self::TABLE_ACTION_IDENTIFIER_NAME,
            $this->ui_factory,
            $this->http->request(),
            $this->ctrl,
            $this->lng,
            $filtered_jobs,
            $this->cron_repository,
            $this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)
        );

        $this->tpl->setContent(
            $this->ui_renderer->render(
                $this->addProblematicItemsInfo(
                    $filtered_jobs,
                    $message,
                    [$message, $filter, $tbl->getComponent()]
                )
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

ilCronManagerGUI::reset

(

)

Definition at line 760 of file class.ilCronManagerGUI.php.

References confirm().

Referenced by handleTableActions().

                           : void
    {
        $this->confirm('reset');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

retrieveTableActionJobIds()

ilCronManagerGUI::retrieveTableActionJobIds ( )

private

Returns

list<string>

Definition at line 92 of file class.ilCronManagerGUI.php.

References $lng, $ui_factory, $ui_service, ILIAS\Repository\ctrl(), ILIAS\BackgroundTasks\Task\Job\Manager\UI\JobTableFilterMediator\filter(), ILIAS\BackgroundTasks\Task\Job\JobEntity\getEffectiveJobId(), getJobIdParameterName(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by confirmedRun(), edit(), editLegacy(), and getMultiActionData().

                                                : array
    {
        $retrieval = $this->http_wrapper->query();
        if (strtoupper($this->http->request()->getMethod()) === 'POST') {
            $retrieval = $this->http_wrapper->post();
        }

        $trafo = $this->refinery->byTrying([
            $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string()),
            $this->refinery->always([])
        ]);

        $ids = $retrieval->retrieve(
            $this->getJobIdParameterName(),
            $trafo
        );

        if (count($ids) === 1 && $ids[0] === 'ALL_OBJECTS') {
            $tableFilterMediator = new JobTableFilterMediator(
                $this->cron_repository->findAll(),
                $this->ui_factory,
                $this->ui_service,
                $this->lng
            );
            $filter = $tableFilterMediator->filter(
                $this->ctrl->getFormAction(
                    $this,
                    'render',
                    '',
                    true
                )
            );
            $ids = array_map(
                static function (JobEntity $entity): string {
                    return $entity->getEffectiveJobId();
                },
                $tableFilterMediator->filteredJobs(
                    $filter
                )->toArray()
            );
        }

        return $ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

run()

ilCronManagerGUI::run

(

)

Definition at line 680 of file class.ilCronManagerGUI.php.

References confirm().

Referenced by handleTableActions().

                         : void
    {
        $this->confirm('run');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilCronManagerGUI::update

(

)

Definition at line 578 of file class.ilCronManagerGUI.php.

References ILIAS\Repository\ctrl(), edit(), ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), getJobIdParameterName(), getRequestValue(), getScheduleValueFormElementName(), hasScheduleValue(), ILIAS\FileDelivery\http(), initEditForm(), ILIAS\Repository\int(), ILIAS\Repository\lng(), null, ILIAS\Repository\rbac(), ILIAS\Repository\refinery(), and SYSTEM_FOLDER_ID.

                            : void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $job_id = $this->getRequestValue($this->getJobIdParameterName(), $this->refinery->kindlyTo()->string());
        if (!$job_id) {
            $this->ctrl->redirect($this, 'render');
        }

        $job = $this->cron_repository->getJobInstanceById($job_id);
        $form = $this->initEditForm($job);

        $form_valid = false;
        $form_data = null;
        if ($this->http->request()->getMethod() === 'POST') {
            $form = $form->withRequest($this->http->request());
            $form_data = $form->getData();
            $form_valid = $form_data !== null;
        }

        if (!$form_valid) {
            $this->edit($form);
            return;
        }

        if ($job instanceof CronJob) {
            if ($job->hasFlexibleSchedule()) {
                $schedule_group = $form_data[self::FORM_PARAM_MAIN_SECTION][self::FORM_PARAM_GROUP_SCHEDULE];

                $type = JobScheduleType::from(
                    (int) ltrim($schedule_group[0], self::FORM_PARAM_SCHEDULE_PREFIX)
                );

                $value = match (true) {
                    $this->hasScheduleValue($type) => (int) $schedule_group[1][$this->getScheduleValueFormElementName(
                        $type
                    )],
                    default => null,
                };

                $this->cron_repository->updateJobSchedule($job, $type, $value);
            }

            if ($job->hasCustomSettings()) {
                $job->saveCustomConfiguration($form_data[self::FORM_PARAM_JOB_INPUT]);
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('cron_action_edit_success'), true);
            $this->ctrl->redirect($this, 'render');
        }

        $this->edit($form);
    }

Here is the call graph for this function:

updateLegacy()

ilCronManagerGUI::updateLegacy

(

)

Deprecated:

Definition at line 638 of file class.ilCronManagerGUI.php.

References $valid, ILIAS\Repository\ctrl(), editLegacy(), ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), getJobIdParameterName(), getRequestValue(), hasScheduleValue(), initLegacyEditForm(), ILIAS\Repository\int(), ILIAS\Repository\lng(), null, ILIAS\Repository\rbac(), ILIAS\Repository\refinery(), and SYSTEM_FOLDER_ID.

                                  : void
    {
        if (!$this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        $job_id = $this->getRequestValue($this->getJobIdParameterName(), $this->refinery->kindlyTo()->string());
        if (!$job_id) {
            $this->ctrl->redirect($this, 'render');
        }

        $job = $this->cron_repository->getJobInstanceById($job_id);

        $form = $this->initLegacyEditForm($job);
        if ($job instanceof CronJob && $form->checkInput()) {
            $valid = true;
            if ($job->hasCustomSettings() && !$job->saveCustomSettings($form)) {
                $valid = false;
            }

            if ($valid && $job->hasFlexibleSchedule()) {
                $type = JobScheduleType::from((int) $form->getInput('type'));
                $value = match (true) {
                    $this->hasScheduleValue($type) => (int) $form->getInput(
                        $this->getScheduleValueFormElementName($type)
                    ),
                    default => null,
                };

                $this->cron_repository->updateJobSchedule($job, $type, $value);
            }

            if ($valid) {
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('cron_action_edit_success'), true);
                $this->ctrl->redirect($this, 'render');
            }
        }

        $form->setValuesByPost();
        $this->editLegacy($form);
    }

Here is the call graph for this function:

Field Documentation

$actor

readonly ilObjUser ilCronManagerGUI::$actor

private

Definition at line 62 of file class.ilCronManagerGUI.php.

$cron_manager

readonly JobManager ilCronManagerGUI::$cron_manager

private

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

$cron_repository

readonly JobRepository ilCronManagerGUI::$cron_repository

private

Definition at line 55 of file class.ilCronManagerGUI.php.

Referenced by render().

$ctrl

readonly ilCtrlInterface ilCronManagerGUI::$ctrl

private

Definition at line 49 of file class.ilCronManagerGUI.php.

Referenced by render().

$error

readonly ilErrorHandling ilCronManagerGUI::$error

private

Definition at line 57 of file class.ilCronManagerGUI.php.

$http

readonly ILIAS HTTP GlobalHttpState ilCronManagerGUI::$http

private

Definition at line 59 of file class.ilCronManagerGUI.php.

$http_wrapper

readonly WrapperFactory ilCronManagerGUI::$http_wrapper

private

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

$lng

readonly ilLanguage ilCronManagerGUI::$lng

private

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

Referenced by render(), and retrieveTableActionJobIds().

$rbac

readonly ILIAS DI RBACServices ilCronManagerGUI::$rbac

private

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

$refinery

readonly ILIAS Refinery Factory ilCronManagerGUI::$refinery

private

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

$settings

readonly ilSetting ilCronManagerGUI::$settings

private

Definition at line 50 of file class.ilCronManagerGUI.php.

$tpl

readonly ilGlobalTemplateInterface ilCronManagerGUI::$tpl

private

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

$ui_factory

readonly Factory ilCronManagerGUI::$ui_factory

private

Definition at line 52 of file class.ilCronManagerGUI.php.

Referenced by retrieveTableActionJobIds().

$ui_renderer

readonly Renderer ilCronManagerGUI::$ui_renderer

private

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

$ui_service

readonly ilUIService ilCronManagerGUI::$ui_service

private

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

Referenced by retrieveTableActionJobIds().

FORM_PARAM_GROUP_SCHEDULE

const ilCronManagerGUI::FORM_PARAM_GROUP_SCHEDULE = 'schedule'

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

FORM_PARAM_JOB_INPUT

const ilCronManagerGUI::FORM_PARAM_JOB_INPUT = 'additional_job_input'

Definition at line 45 of file class.ilCronManagerGUI.php.

FORM_PARAM_MAIN_SECTION

const ilCronManagerGUI::FORM_PARAM_MAIN_SECTION = 'main'

Definition at line 44 of file class.ilCronManagerGUI.php.

FORM_PARAM_SCHEDULE_PREFIX

const ilCronManagerGUI::FORM_PARAM_SCHEDULE_PREFIX = 'schedule_'

private

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

TABLE_ACTION_IDENTIFIER_NAME

const ilCronManagerGUI::TABLE_ACTION_IDENTIFIER_NAME = 'jid'

private

Definition at line 42 of file class.ilCronManagerGUI.php.

TABLE_ACTION_NAMESPACE

const ilCronManagerGUI::TABLE_ACTION_NAMESPACE = ['cron', 'jobs']

private

Definition at line 40 of file class.ilCronManagerGUI.php.

TABLE_ACTION_PARAM_NAME

const ilCronManagerGUI::TABLE_ACTION_PARAM_NAME = 'table_action'

private

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

---

The documentation for this class was generated from the following file:

• components/ILIAS/Cron/classes/class.ilCronManagerGUI.php