ilCronManagerGUI Class Reference

Class ilCronManagerGUI. More...

Collaboration diagram for ilCronManagerGUI:

Public Member Functions
	__construct ()
	ilCronManagerGUI constructor. More...
	executeCommand ()
	edit (ilPropertyFormGUI $a_form=null)
	update ()
	run ()
	confirmedRun ()
	activate ()
	confirmedActivate ()
	deactivate ()
	confirmedDeactivate ()
	reset ()
	confirmedReset ()
	addToExternalSettingsForm ($a_form_id)

Protected Member Functions
	render ()
	getScheduleTypeFormElementName (int $scheduleTypeId)
	getScheduleValueFormElementName (int $scheduleTypeId)
	hasScheduleValue (int $scheduleTypeId)
	initEditForm ($a_job_id)
	getMultiActionData ()

Protected Attributes
	$lng
	$ctrl
	$settings
	$tpl

Private Attributes
	$uiFactory
	$uiRenderer
	$uiService
	$repository
	$rbac
	$error
	$dic

Detailed Description

Class ilCronManagerGUI.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilCronManagerGUI: ilPropertyFormGUI

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

Constructor & Destructor Documentation

__construct()

ilCronManagerGUI::__construct

(

)

ilCronManagerGUI constructor.

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

References $DIC, repository(), and settings().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->settings = $DIC->settings();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->uiFactory = $DIC->ui()->factory();
        $this->uiRenderer = $DIC->ui()->renderer();
        $this->uiRenderer = $DIC->ui()->renderer();
        $this->uiService = $DIC->uiService();
        $this->dic = $DIC;
        $this->rbac = $DIC->rbac();
        $this->error = $DIC['ilErr'];
        $this->repository = new ilCronJobRepositoryImpl();

        $this->lng->loadLanguageModule('cron');
        $this->lng->loadLanguageModule('cmps');
    }

Here is the call graph for this function:

Member Function Documentation

activate()

ilCronManagerGUI::activate

(

)

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

    {
        $this->confirm("activate");
    }

addToExternalSettingsForm()

ilCronManagerGUI::addToExternalSettingsForm

(

$a_form_id

)

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

References $data, ilCronManager\getCronJobData(), and ilCronManager\getJobInstance().

    {
        $fields = array();
        
        $data = ilCronManager::getCronJobData();
        foreach ($data as $item) {
            $job = ilCronManager::getJobInstance(
                $item["job_id"],
                $item["component"],
                $item["class"],
                $item["path"]
            );
            
            if (method_exists($job, "addToExternalSettingsForm")) {
                $job->addToExternalSettingsForm($a_form_id, $fields, $item["job_status"]);
            }
        }
        
        if (sizeof($fields)) {
            return array("cron_jobs" => array("jumpToCronJobs", $fields));
        }
    }

Here is the call graph for this function:

confirmedActivate()

ilCronManagerGUI::confirmedActivate

(

)

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

References ilCronManager\activateJob(), getMultiActionData(), ilCronManager\isJobInactive(), ilCronManager\resetJob(), and SYSTEM_FOLDER_ID.

    {
        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 (ilCronManager::isJobInactive($job->getId())) {
                    ilCronManager::resetJob($job);
                    ilCronManager::activateJob($job, true);
                }
            }
            
            ilUtil::sendSuccess($this->lng->txt("cron_action_activate_success"), true);
        }

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

Here is the call graph for this function:

confirmedDeactivate()

ilCronManagerGUI::confirmedDeactivate

(

)

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

References ilCronManager\deactivateJob(), getMultiActionData(), ilCronManager\isJobActive(), and SYSTEM_FOLDER_ID.

    {
        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 (ilCronManager::isJobActive($job->getId())) {
                    ilCronManager::deactivateJob($job, true);
                }
            }
            
            ilUtil::sendSuccess($this->lng->txt("cron_action_deactivate_success"), true);
        }

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

Here is the call graph for this function:

confirmedReset()

ilCronManagerGUI::confirmedReset

(

)

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

References getMultiActionData(), ilCronManager\resetJob(), and SYSTEM_FOLDER_ID.

    {
        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) {
                ilCronManager::resetJob($job);
            }
            ilUtil::sendSuccess($this->lng->txt("cron_action_reset_success"), true);
        }

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

Here is the call graph for this function:

confirmedRun()

ilCronManagerGUI::confirmedRun

(

)

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

References $_GET, ilCronManager\runJobManual(), ilUtil\sendFailure(), and SYSTEM_FOLDER_ID.

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

        $job_id = $_GET["jid"];
        if ($job_id) {
            if (ilCronManager::runJobManual($job_id)) {
                ilUtil::sendSuccess($this->lng->txt("cron_action_run_success"), true);
            } else {
                ilUtil::sendFailure($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 369 of file class.ilCronManagerGUI.php.

    {
        $this->confirm("deactivate");
    }

edit()

ilCronManagerGUI::edit

(

ilPropertyFormGUI

$a_form = null

)

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

References initEditForm(), and SYSTEM_FOLDER_ID.

Referenced by update().

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

        $id = $_REQUEST["jid"];
        if (!$id) {
            $this->ctrl->redirect($this, "render");
        }
        
        if (!$a_form) {
            $a_form = $this->initEditForm($id);
        }
        
        $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 62 of file class.ilCronManagerGUI.php.

References initEditForm(), 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):
                $form = $this->initEditForm(ilUtil::stripSlashes($_REQUEST['jid']));
                $this->ctrl->forwardCommand($form);
                break;
        }

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

Here is the call graph for this function:

getMultiActionData()

ilCronManagerGUI::getMultiActionData ( )

protected

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

References $res, ilCronManager\getJobInstanceById(), ilUtil\sendFailure(), and SYSTEM_FOLDER_ID.

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

    {
        $res = array();
        
        if ($_REQUEST["jid"]) {
            $job_id = trim($_REQUEST["jid"]);
            $job = ilCronManager::getJobInstanceById($job_id);
            if ($job) {
                $res[$job_id] = $job;
            }
        } elseif (is_array($_REQUEST["mjid"])) {
            foreach ($_REQUEST["mjid"] as $job_id) {
                $job = ilCronManager::getJobInstanceById($job_id);
                if ($job) {
                    $res[$job_id] = $job;
                }
            }
        }
    
        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getScheduleTypeFormElementName()

ilCronManagerGUI::getScheduleTypeFormElementName ( int  $scheduleTypeId )

protected

Parameters

int

$scheduleTypeId

Returns

string

Exceptions

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

References ilCronJob\SCHEDULE_TYPE_DAILY, ilCronJob\SCHEDULE_TYPE_IN_DAYS, ilCronJob\SCHEDULE_TYPE_IN_HOURS, ilCronJob\SCHEDULE_TYPE_IN_MINUTES, ilCronJob\SCHEDULE_TYPE_MONTHLY, ilCronJob\SCHEDULE_TYPE_QUARTERLY, ilCronJob\SCHEDULE_TYPE_WEEKLY, and ilCronJob\SCHEDULE_TYPE_YEARLY.

Referenced by initEditForm().

    {
        switch ($scheduleTypeId) {
            case ilCronJob::SCHEDULE_TYPE_DAILY:
                return $this->lng->txt('cron_schedule_daily');

            case ilCronJob::SCHEDULE_TYPE_WEEKLY:
                return $this->lng->txt('cron_schedule_weekly');

            case ilCronJob::SCHEDULE_TYPE_MONTHLY:
                return $this->lng->txt('cron_schedule_monthly');

            case ilCronJob::SCHEDULE_TYPE_QUARTERLY:
                return $this->lng->txt('cron_schedule_quarterly');

            case ilCronJob::SCHEDULE_TYPE_YEARLY:
                return $this->lng->txt('cron_schedule_yearly');

            case ilCronJob::SCHEDULE_TYPE_IN_MINUTES:
                return sprintf($this->lng->txt('cron_schedule_in_minutes'), 'x');

            case ilCronJob::SCHEDULE_TYPE_IN_HOURS:
                return sprintf($this->lng->txt('cron_schedule_in_hours'), 'x');

            case ilCronJob::SCHEDULE_TYPE_IN_DAYS:
                return sprintf($this->lng->txt('cron_schedule_in_days'), 'x');
        }

        throw new \InvalidArgumentException(sprintf('The passed argument %s is invalid!', var_export($scheduleTypeId, 1)));
    }

Here is the caller graph for this function:

getScheduleValueFormElementName()

ilCronManagerGUI::getScheduleValueFormElementName ( int  $scheduleTypeId )

protected

Parameters

int

$scheduleTypeId

Returns

string

Exceptions

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

References ilCronJob\SCHEDULE_TYPE_IN_DAYS, ilCronJob\SCHEDULE_TYPE_IN_HOURS, and ilCronJob\SCHEDULE_TYPE_IN_MINUTES.

Referenced by initEditForm(), and update().

    {
        switch ($scheduleTypeId) {
            case ilCronJob::SCHEDULE_TYPE_IN_MINUTES:
                return 'smini';

            case ilCronJob::SCHEDULE_TYPE_IN_HOURS:
                return 'shri';

            case ilCronJob::SCHEDULE_TYPE_IN_DAYS:
                return 'sdyi';
        }

        throw new \InvalidArgumentException(sprintf('The passed argument %s is invalid!', var_export($scheduleTypeId, 1)));
    }

Here is the caller graph for this function:

hasScheduleValue()

ilCronManagerGUI::hasScheduleValue ( int  $scheduleTypeId )

protected

Parameters

int

$scheduleTypeId

Returns

bool

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

References ilCronJob\SCHEDULE_TYPE_IN_DAYS, ilCronJob\SCHEDULE_TYPE_IN_HOURS, and ilCronJob\SCHEDULE_TYPE_IN_MINUTES.

Referenced by update().

                                                             : bool
    {
        return in_array(
            $scheduleTypeId,
            [
                ilCronJob::SCHEDULE_TYPE_IN_MINUTES,
                ilCronJob::SCHEDULE_TYPE_IN_HOURS,
                ilCronJob::SCHEDULE_TYPE_IN_DAYS
            ]
        );
    }

Here is the caller graph for this function:

initEditForm()

ilCronManagerGUI::initEditForm (   $a_job_id )

protected

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

References $data, $type, ilNumberInputGUI\allowDecimals(), ilCronManager\getCronJobData(), ilCronManager\getJobInstanceById(), getScheduleTypeFormElementName(), and getScheduleValueFormElementName().

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

    {
        $job = ilCronManager::getJobInstanceById($a_job_id);
        if (!$job) {
            $this->ctrl->redirect($this, "render");
        }

        $this->ctrl->setParameter($this, "jid", $a_job_id);

        $jobData = ilCronManager::getCronJobData($job->getId());
        $data = array_pop($jobData);

        include_once("Services/Cron/classes/class.ilCronJob.php");
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, "update"));
        $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($data['schedule_type']);

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

                $option = new ilRadioOption(
                    $this->getScheduleTypeFormElementName($typeId),
                    $typeId
                );
                $type->addOption($option);

                if (in_array($typeId, $job->getScheduleTypesWithValues())) {
                    $scheduleValue = new ilNumberInputGUI(
                        $this->lng->txt('cron_schedule_value'),
                        $this->getScheduleValueFormElementName($typeId)
                    );
                    $scheduleValue->allowDecimals(false);
                    $scheduleValue->setRequired(true);
                    $scheduleValue->setSize(5);
                    if ($data['schedule_type'] == $typeId) {
                        $scheduleValue->setValue($data['schedule_value']);
                    }
                    $option->addSubItem($scheduleValue);
                }
            }

            $form->addItem($type);
        }
        
        if ($job->hasCustomSettings()) {
            $job->addCustomSettingsToForm($form);
        }
        
        $form->addCommandButton("update", $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 81 of file class.ilCronManagerGUI.php.

References $message, ilDatePresentation\formatDate(), IL_CAL_UNIX, repository(), settings(), and SYSTEM_FOLDER_ID.

                                : 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->uiFactory->messageBox()->info($this->lng->txt('cronjob_last_start') . ': ' . $tstamp);

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

        $tableFilterMediator = new ilCronManagerTableFilterMediator(
            $cronJobs,
            $this->uiFactory,
            $this->uiService,
            $this->lng
        );
        $filter = $tableFilterMediator->filter($this->ctrl->getFormAction(
            $this,
            'render',
            '',
            true
        ));

        $tbl = new ilCronManagerTableGUI(
            $this,
            'render',
            $this->dic,
            $this->rbac->system()->checkAccess('write', SYSTEM_FOLDER_ID)
        );
        $this->tpl->setContent(implode('', [
            $this->uiRenderer->render([$message, $filter]),
            $tbl->populate(
                $tableFilterMediator->filteredJobs(
                    $filter
                )
            )->getHTML()
        ]));
    }

Here is the call graph for this function:

reset()

ilCronManagerGUI::reset

(

)

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

    {
        $this->confirm("reset");
    }

run()

ilCronManagerGUI::run

(

)

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

    {
        $this->confirm("run");
    }

update()

ilCronManagerGUI::update

(

)

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

References $type, $valid, edit(), ilCronManager\getJobInstanceById(), getScheduleValueFormElementName(), hasScheduleValue(), initEditForm(), SYSTEM_FOLDER_ID, and ilCronManager\updateJobSchedule().

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

        $id = $_REQUEST["jid"];
        if (!$id) {
            $this->ctrl->redirect($this, "render");
        }

        $form = $this->initEditForm($id);
        if ($form->checkInput()) {
            $job = ilCronManager::getJobInstanceById($id);
            if ($job) {
                $valid = true;
                if ($job->hasCustomSettings() &&
                    !$job->saveCustomSettings($form)) {
                    $valid = false;
                }
                
                if ($valid && $job->hasFlexibleSchedule()) {
                    $type = $form->getInput("type");
                    switch (true) {
                        case $this->hasScheduleValue($type):
                            $value = $form->getInput($this->getScheduleValueFormElementName($type));
                            break;

                        default:
                            $value = null;
                            break;
                    }

                    ilCronManager::updateJobSchedule($job, $type, $value);
                }
                if ($valid) {
                    ilUtil::sendSuccess($this->lng->txt("cron_action_edit_success"), true);
                    $this->ctrl->redirect($this, "render");
                }
            }
        }
        
        $form->setValuesByPost();
        $this->edit($form);
    }

Here is the call graph for this function:

Field Documentation

$ctrl

ilCronManagerGUI::$ctrl

protected

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

$dic

ilCronManagerGUI::$dic

private

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

$error

ilCronManagerGUI::$error

private

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

$lng

ilCronManagerGUI::$lng

protected

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

$rbac

ilCronManagerGUI::$rbac

private

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

$repository

ilCronManagerGUI::$repository

private

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

$settings

ilCronManagerGUI::$settings

protected

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

$tpl

ilCronManagerGUI::$tpl

protected

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

$uiFactory

ilCronManagerGUI::$uiFactory

private

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

$uiRenderer

ilCronManagerGUI::$uiRenderer

private

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

$uiService

ilCronManagerGUI::$uiService

private

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

---

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

• Services/Cron/classes/class.ilCronManagerGUI.php