Collaboration diagram for ilObjectActivationGUI:

Public Member Functions
	__construct (int $ref_id, int $item_id)

	executeCommand ()

	getItemId ()

	getTimingMode ()

	getParentId ()

	getActivation ()

	cancel ()

	edit (ilPropertyFormGUI $form=null)

	update ()

Protected Member Functions
	initFormEdit ()

	__setTabs ()

	initTimingMode ()

	initItem ()

Protected Attributes
ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilErrorHandling	$error

ilTabsGUI	$tabs_gui

ilAccessHandler	$access

ilTree	$tree

ilObjUser	$user

ilHelpGUI	$help

ILIAS HTTP Wrapper RequestWrapper	$request_wrapper

ILIAS Refinery Factory	$refinery

int	$parent_ref_id

int	$item_id

int	$timing_mode = null

ilObjectActivation	$activation = null

Detailed Description

Class ilObjectActivationGUI.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

ilObjectActivationGUI: ilConditionHandlerGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectActivationGUI::__construct	(	int	$ref_id,
		int	$item_id
	)

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

References $DIC, $item_id, $ref_id, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule('crs');
         $this->error = $DIC['ilErr'];
         $this->tabs_gui = $DIC->tabs();
         $this->access = $DIC->access();
         $this->tree = $DIC->repositoryTree();
         $this->user = $DIC->user();
         $this->help = $DIC["ilHelp"];
         $this->request_wrapper = $DIC->http()->wrapper()->query();
         $this->refinery = $DIC->refinery();
 
         $this->parent_ref_id = $ref_id;
         $this->item_id = $item_id;
 
         $this->ctrl->saveParameter($this, 'item_id');
     }

Here is the call graph for this function:

Member Function Documentation

◆ __setTabs()

ilObjectActivationGUI::__setTabs ( )

protected

Definition at line 248 of file class.ilObjectActivationGUI.php.

References $ref_id, ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by executeCommand().

                                   : bool
     {
         $this->tabs_gui->clearTargets();
 
         $this->help->setScreenIdComponent("obj");
 
         $this->ctrl->setParameterByClass("ilrepositorygui", "ref_id", $this->parent_ref_id);
         $back_link = $this->ctrl->getLinkTargetByClass("ilrepositorygui", "");
         $ref_id = $this->request_wrapper->retrieve("ref_id", $this->refinery->kindlyTo()->string());
         $this->ctrl->setParameterByClass("ilrepositorygui", "ref_id", $ref_id);
         $this->tabs_gui->setBackTarget($this->lng->txt('btn_back'), $back_link);
 
         $this->tabs_gui->addTarget(
             "timings",
             $this->ctrl->getLinkTarget($this, 'edit'),
             "edit",
             get_class($this)
         );
 
         $this->ctrl->setParameterByClass('ilconditionhandlergui', 'item_id', $this->item_id);
         $this->tabs_gui->addTarget(
             "preconditions",
             $this->ctrl->getLinkTargetByClass('ilConditionHandlerGUI', 'listConditions'),
             "",
             "ilConditionHandlerGUI"
         );
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancel()

ilObjectActivationGUI::cancel ( )

Definition at line 130 of file class.ilObjectActivationGUI.php.

References ILIAS\Repository\ctrl().

                             : void
     {
         $this->ctrl->setParameterByClass('ilrepositorygui', 'ref_id', $this->parent_ref_id);
         $this->ctrl->redirectByClass('ilrepositorygui');
     }

Here is the call graph for this function:

◆ edit()

ilObjectActivationGUI::edit ( ilPropertyFormGUI $form = null )

Definition at line 136 of file class.ilObjectActivationGUI.php.

References ILIAS\Repository\access(), getActivation(), getItemId(), initFormEdit(), ILIAS\Repository\lng(), and ilObjectActivation\TIMINGS_PRESETTING.

Referenced by update().

                                                         : void
     {
         // #19997 - see ilObjectListGUI::insertTimingsCommand()
         if (
             !$this->access->checkAccess('write', '', $this->parent_ref_id) &&
             !$this->access->checkAccess('write', '', $this->getItemId())
         ) {
             $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
         }
 
         if (!$form instanceof ilPropertyFormGUI) {
             // show edit warning if timings are on
             if ($this->tree->checkForParentType($this->getParentId(), 'crs')) {
                 if ($this->getActivation()->getTimingType() == ilObjectActivation::TIMINGS_PRESETTING) {
                     $this->tpl->setOnScreenMessage('info', $this->lng->txt('crs_timings_warning_timing_exists'));
                 }
             }
 
             $form = $this->initFormEdit();
         }
         $this->tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjectActivationGUI::executeCommand ( )

Definition at line 71 of file class.ilObjectActivationGUI.php.

References __setTabs(), ILIAS\Repository\ctrl(), initItem(), initTimingMode(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                     : void
     {
         $this->__setTabs();
 
         $cmd = $this->ctrl->getCmd();
 
         // Check if item id is given and valid
         if (!$this->item_id) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("crs_no_item_id_given"), true);
             $this->ctrl->returnToParent($this);
         }
 
         $this->tpl->loadStandardTemplate();
 
         switch ($this->ctrl->getNextClass($this)) {
             case 'ilconditionhandlergui':
                 // preconditions for single course items
                 $this->ctrl->saveParameter($this, 'item_id');
                 $item_id = $this->request_wrapper->retrieve("item_id", $this->refinery->kindlyTo()->int());
                 $new_gui = new ilConditionHandlerGUI($item_id);
                 $this->ctrl->forwardCommand($new_gui);
                 $this->tabs_gui->setTabActive('preconditions');
                 break;
 
             default:
                 $this->initTimingMode();
                 $this->initItem();
                 $this->tabs_gui->setTabActive('timings');
                 if (!$cmd) {
                     $cmd = 'edit';
                 }
                 $this->$cmd();
                 $this->tabs_gui->setTabActive('timings');
                 break;
         }
 
         $this->tpl->printToStdout();
     }

Here is the call graph for this function:

◆ getActivation()

ilObjectActivationGUI::getActivation ( )

Definition at line 125 of file class.ilObjectActivationGUI.php.

References $activation.

Referenced by edit(), initFormEdit(), initItem(), and update().

                                    : ?ilObjectActivation
     {
         return $this->activation;
     }

Here is the caller graph for this function:

◆ getItemId()

ilObjectActivationGUI::getItemId ( )

Definition at line 110 of file class.ilObjectActivationGUI.php.

References $item_id.

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

                                : int
     {
         return $this->item_id;
     }

Here is the caller graph for this function:

◆ getParentId()

ilObjectActivationGUI::getParentId ( )

Definition at line 120 of file class.ilObjectActivationGUI.php.

References $parent_ref_id.

Referenced by initItem(), and update().

                                  : int
     {
         return $this->parent_ref_id;
     }

Here is the caller graph for this function:

◆ getTimingMode()

ilObjectActivationGUI::getTimingMode ( )

Definition at line 115 of file class.ilObjectActivationGUI.php.

References $timing_mode.

                                    : ?int
     {
         return $this->timing_mode;
     }

◆ initFormEdit()

ilObjectActivationGUI::initFormEdit ( )

protected

Definition at line 159 of file class.ilObjectActivationGUI.php.

References ilObject\_lookupObjId(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), getActivation(), getItemId(), IL_CAL_UNIX, ILIAS\Repository\lng(), ilDateTimeInputGUI\setDate(), ilFormPropertyGUI\setInfo(), ilCheckboxInputGUI\setValue(), and ilObjectActivation\TIMINGS_ACTIVATION.

Referenced by edit(), and update().

                                      : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this));
 
         $title = htmlspecialchars(
             ilObject::_lookupTitle(ilObject::_lookupObjId($this->getItemId())),
             ENT_QUOTES | ENT_SUBSTITUTE,
             'utf-8'
         );
         $form->setTitle($title . ': ' . $this->lng->txt('crs_edit_timings'));
 
         $availability = new ilCheckboxInputGUI($this->lng->txt('crs_timings_availability_enabled'), 'availability');
         $availability->setValue("1");
         $availability->setChecked($this->getActivation()->getTimingType() == ilObjectActivation::TIMINGS_ACTIVATION);
 
         $start = new ilDateTimeInputGUI($this->lng->txt('crs_timings_start'), 'timing_start');
         $start->setDate(new ilDateTime($this->getActivation()->getTimingStart(), IL_CAL_UNIX));
         $start->setShowTime(true);
         $availability->addSubItem($start);
 
         $end = new ilDateTimeInputGUI($this->lng->txt('crs_timings_end'), 'timing_end');
         $end->setDate(new ilDateTime($this->getActivation()->getTimingEnd(), IL_CAL_UNIX));
         $end->setShowTime(true);
         $availability->addSubItem($end);
 
         $isv = new ilCheckboxInputGUI($this->lng->txt('crs_timings_visibility_short'), 'visible');
         $isv->setInfo($this->lng->txt('crs_timings_visibility'));
         $isv->setValue("1");
         $isv->setChecked($this->getActivation()->enabledVisible());
         $availability->addSubItem($isv);
 
         $form->addItem($availability);
 
         $form->addCommandButton('update', $this->lng->txt('save'));
         $form->addCommandButton('cancel', $this->lng->txt('cancel'));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initItem()

ilObjectActivationGUI::initItem ( )

protected

Definition at line 290 of file class.ilObjectActivationGUI.php.

References getActivation(), and getParentId().

Referenced by executeCommand().

                                  : void
     {
         $this->activation = new ilObjectActivation();
         $this->getActivation()->read($this->item_id, $this->getParentId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initTimingMode()

ilObjectActivationGUI::initTimingMode ( )

protected

Definition at line 277 of file class.ilObjectActivationGUI.php.

References ilObject\_lookupObjId(), ilCourseConstants\IL_CRS_VIEW_TIMING_ABSOLUTE, and ilObjCourse\lookupTimingMode().

Referenced by executeCommand().

                                        : void
     {
         // Check for parent course and if available read timing mode (abs | rel)
         $crs_ref_id = $this->tree->checkForParentType($this->parent_ref_id, 'crs');
         $crs_obj_id = ilObject::_lookupObjId($crs_ref_id);
 
         if ($crs_obj_id) {
             $this->timing_mode = ilObjCourse::lookupTimingMode($crs_obj_id);
         } else {
             $this->timing_mode = ilCourseConstants::IL_CRS_VIEW_TIMING_ABSOLUTE;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilObjectActivationGUI::update ( )

Definition at line 199 of file class.ilObjectActivationGUI.php.

References $valid, ilDateTime\_after(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), edit(), getActivation(), getItemId(), getParentId(), IL_CAL_UNIX, initFormEdit(), ILIAS\Repository\lng(), ilObjectActivation\read(), ilObjectActivation\TIMINGS_ACTIVATION, ilObjectActivation\TIMINGS_DEACTIVATED, and ilObjectActivation\TIMINGS_PRESETTING.

                             : void
     {
         // #19997 - see ilObjectListGUI::insertTimingsCommand()
         if (
             !$this->access->checkAccess('write', '', $this->parent_ref_id) &&
             !$this->access->checkAccess('write', '', $this->getItemId())
         ) {
             $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
         }
 
         $form = $this->initFormEdit();
         if ($form->checkInput()) {
             $valid = true;
             $activation = new ilObjectActivation();
             $activation->read($this->getItemId());
 
             if ($form->getInput('availability')) {
                 $this->getActivation()->setTimingType(ilObjectActivation::TIMINGS_ACTIVATION);
 
                 $timing_start = $form->getItemByPostVar('timing_start')->getDate();
                 $timing_end = $form->getItemByPostVar('timing_end')->getDate();
 
                 if ($timing_start && $timing_end && ilDateTime::_after($timing_start, $timing_end)) {
                     $form->getItemByPostVar('timing_start')->setAlert($this->lng->txt('crs_timing_err_start_end'));
                     $form->getItemByPostVar('timing_end')->setAlert($this->lng->txt('crs_timing_err_start_end'));
                     $valid = false;
                 }
 
                 $this->getActivation()->setTimingStart($timing_start ? $timing_start->get(IL_CAL_UNIX) : null);
                 $this->getActivation()->setTimingEnd($timing_end ? $timing_end->get(IL_CAL_UNIX) : null);
 
                 $this->getActivation()->toggleVisible((bool) $form->getInput('visible'));
             } elseif ($this->getActivation()->getTimingType() != ilObjectActivation::TIMINGS_PRESETTING) {
                 $this->getActivation()->setTimingType(ilObjectActivation::TIMINGS_DEACTIVATED);
             }
 
             if ($valid) {
                 $this->getActivation()->update($this->getItemId(), $this->getParentId());
                 $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
                 $this->ctrl->redirect($this, "edit");
             } else {
                 $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
             }
         }
 
         $form->setValuesByPost();
         $this->edit($form);
     }