Collaboration diagram for ilObjectActivationGUI:

Public Member Functions
	__construct ($a_ref_id, $a_item_id)
	ilObjectActivationGUI constructor. More...

	executeCommand ()
	Execute command. More...

	getItemId ()

	getTimingMode ()

	getParentId ()
	Get parent ref_id. More...

	getActivation ()
	Get item object. More...

	cancel ()
	cancel action handler More...

	edit (ilPropertyFormGUI $form=null)
	edit timings More...

	update ()
	update More...

Protected Member Functions
	initFormEdit ()
	init form edit More...

	__setTabs ()

	initTimingMode ()
	Init type of timing mode. More...

	initItem ()
	Init item. More...

Protected Attributes
	$error

	$tabs_gui

	$access

	$tree

	$user

	$help

	$parent_ref_id

	$item_id

	$tpl

	$ctrl

	$lng

	$timing_mode = null

	$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 11 of file class.ilObjectActivationGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectActivationGUI::__construct	(	$a_ref_id,
		$a_item_id
	)

ilObjectActivationGUI constructor.

Parameters

$a_ref_id
$a_item_id

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

References $DIC, and 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->parent_ref_id = $a_ref_id;
         $this->item_id = $a_item_id;
 
         $this->ctrl->saveParameter($this, 'item_id');
     }

Here is the call graph for this function:

Member Function Documentation

◆ __setTabs()

ilObjectActivationGUI::__setTabs ( )

protected

Returns: bool

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

References $_GET, $ctrl, $help, and $ilCtrl.

Referenced by executeCommand().

     {
         $ilCtrl = $this->ctrl;
         $ilHelp = $this->help;
         
         $this->tabs_gui->clearTargets();
 
         $ilHelp->setScreenIdComponent("obj");
 
         $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $this->parent_ref_id);
         $back_link = $ilCtrl->getLinkTargetByClass("ilrepositorygui", "");
         $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $_GET["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 caller graph for this function:

◆ cancel()

ilObjectActivationGUI::cancel ( )

cancel action handler

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

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

◆ edit()

ilObjectActivationGUI::edit ( ilPropertyFormGUI $form = null )

edit timings

public

Returns

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

References $access, $error, $form, $GLOBALS, $ilErr, $tpl, getActivation(), getItemId(), getParentId(), initFormEdit(), ilUtil\sendInfo(), and ilObjectActivation\TIMINGS_PRESETTING.

Referenced by update().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjectActivationGUI::executeCommand ( )

Execute command.

Exceptions

ilCtrlException

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

References $_GET, $tpl, __setTabs(), initItem(), initTimingMode(), and ilUtil\sendFailure().

     {
         $tpl = $this->tpl;
 
         $this->__setTabs();
 
         $cmd = $this->ctrl->getCmd();
 
         // Check if item id is given and valid
         if (!$this->item_id) {
             ilUtil::sendFailure($this->lng->txt("crs_no_item_id_given"), true);
             $this->ctrl->returnToParent($this);
         }
         
         $tpl->getStandardTemplate();
         
         switch ($this->ctrl->getNextClass($this)) {
             case 'ilconditionhandlergui':
                 // preconditions for single course items
                 $this->ctrl->saveParameter($this, 'item_id', $_GET['item_id']);
                 $new_gui = new ilConditionHandlerGUI($this, (int) $_GET['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;
         }
         
         $tpl->show();
     }

Here is the call graph for this function:

◆ getActivation()

ilObjectActivationGUI::getActivation ( )

Get item object.

Returns: ilObjectActivation

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

References $activation.

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

     {
         return $this->activation;
     }

Here is the caller graph for this function:

◆ getItemId()

ilObjectActivationGUI::getItemId ( )

Returns: int

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

References $item_id.

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

     {
         return $this->item_id;
     }

Here is the caller graph for this function:

◆ getParentId()

ilObjectActivationGUI::getParentId ( )

Get parent ref_id.

Returns: int

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

References $parent_ref_id.

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

     {
         return $this->parent_ref_id;
     }

Here is the caller graph for this function:

◆ getTimingMode()

ilObjectActivationGUI::getTimingMode ( )

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

References $timing_mode.

     {
         return $this->timing_mode;
     }

◆ initFormEdit()

ilObjectActivationGUI::initFormEdit ( )

protected

init form edit

protected

Returns

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

References $end, $form, $start, $title, $tree, ilObject\_lookupObjId(), ilObject\_lookupTitle(), getActivation(), getItemId(), IL_CAL_UNIX, ilFormPropertyGUI\setInfo(), ilCheckboxInputGUI\setValue(), and ilObjectActivation\TIMINGS_ACTIVATION.

Referenced by edit(), and update().

     {
         $tree = $this->tree;
 
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this));
 
         $title = ilObject::_lookupTitle(ilObject::_lookupObjId($this->getItemId()));
         $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((bool) $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

Init item.

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

References getActivation(), and getParentId().

Referenced by executeCommand().

     {
         $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

Init type of timing mode.

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

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

Referenced by executeCommand().

     {
         // Check for parent course and if available read timing mode (abs | rel)
         $crs_ref_id = $GLOBALS['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 ( )

update

public

Returns

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

References $access, $activation, $error, $form, $ilErr, $ilUser, $tpl, $user, $valid, ilDateTime\_after(), edit(), getActivation(), getItemId(), getParentId(), IL_CAL_UNIX, initFormEdit(), ilUtil\sendFailure(), ilObjectActivation\TIMINGS_ACTIVATION, ilObjectActivation\TIMINGS_DEACTIVATED, and ilObjectActivation\TIMINGS_PRESETTING.

     {
         $ilErr = $this->error;
         $ilAccess = $this->access;
         $tpl = $this->tpl;
         $ilUser = $this->user;
 
         // #19997 - see ilObjectListGUI::insertTimingsCommand()
         if (
             !$ilAccess->checkAccess('write', '', $this->parent_ref_id) &&
             !$ilAccess->checkAccess('write', '', $this->getItemId())) {
             $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->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());
                 ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
                 $this->ctrl->redirect($this, "edit");
             } else {
                 ilUtil::sendFailure($this->lng->txt('form_input_not_valid'));
             }
         }
 
         $form->setValuesByPost();
         $this->edit($form);
     }