ilDidacticTemplateGUI Class Reference

GUI class for didactic template settings inside repository objects. More...

Collaboration diagram for ilDidacticTemplateGUI:

Public Member Functions
	__construct ($a_parent_obj)
	Constructor. More...
	getParentObject ()
	executeCommand ()
	Execute command. More...
	appendToolbarSwitch (ilToolbarGUI $toolbar, $a_obj_type, $a_ref_id)

Protected Member Functions
	confirmTemplateSwitch ()
	cancel ()
	Return to parent gui. More...
	switchTemplate ()
	Switch Template. More...

Private Attributes
	$parent_object
	$lng

Detailed Description

GUI class for didactic template settings inside repository objects.

Author

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

ilDidacticTemplateGUI: ilPermissionGUI

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

Constructor & Destructor Documentation

__construct()

ilDidacticTemplateGUI::__construct

(

$a_parent_obj

)

Constructor.

Definition at line 21 of file class.ilDidacticTemplateGUI.php.

References $DIC, and $lng.

    {
        global $DIC;

        $lng = $DIC['lng'];
        
        $this->parent_object = $a_parent_obj;
        $this->lng = $lng;
        $this->lng->loadLanguageModule('didactic');
    }

Member Function Documentation

appendToolbarSwitch()

ilDidacticTemplateGUI::appendToolbarSwitch	(	ilToolbarGUI	$toolbar,
			$a_obj_type,
			$a_ref_id
	)

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

References $_GET, PHPMailer\PHPMailer\$options, $tpl, ilToolbarGUI\addFormButton(), ilToolbarGUI\addInputItem(), ilToolbarGUI\addText(), ilDidacticTemplateSettings\getInstanceByObjectType(), getParentObject(), and ilDidacticTemplateObjSettings\lookupTemplateId().

    {
        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateSettings.php';
        $tpls = ilDidacticTemplateSettings::getInstanceByObjectType($a_obj_type)->getTemplates();

        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateObjSettings.php';
        $value = ilDidacticTemplateObjSettings::lookupTemplateId($this->getParentObject()->object->getRefId());

        if (!count($tpls) && !$value) {
            return false;
        }

        // Add template switch
        $toolbar->addText($this->lng->txt('didactic_selected_tpl_option'));

        // Show template options
        $options = array(0 => $this->lng->txt('didactic_default_type'));
        $excl_tpl = false;

        foreach ($tpls as $tpl) {
            //just add if template is effective except template is already applied to this object
            if ($tpl->isEffective($_GET['ref_id'])) {
                $options[$tpl->getId()] = $tpl->getPresentationTitle();

                if ($tpl->isExclusive()) {
                    $excl_tpl = true;
                }
            }
        }

        if ($excl_tpl && $value != 0) {
            //remove default entry if an exclusive template exists but only if the actual entry isn't the default
            unset($options[0]);
        }

        if (!in_array($value, array_keys($options)) || ($excl_tpl && $value == 0)) {
            $options[$value] = $this->lng->txt('not_available');
        }

        if (count($options) < 2) {
            return false;
        }

        include_once './Services/Form/classes/class.ilSelectInputGUI.php';
        $tpl_selection = new ilSelectInputGUI(
            '',
            'tplid'
        );
        $tpl_selection->setOptions($options);
        $tpl_selection->setValue($value);
        $toolbar->addInputItem($tpl_selection);

        // Apply templates switch
        $toolbar->addFormButton($this->lng->txt('change'), 'confirmTemplateSwitch');
        return true;
    }

Here is the call graph for this function:

cancel()

ilDidacticTemplateGUI::cancel ( )

protected

Return to parent gui.

Definition at line 181 of file class.ilDidacticTemplateGUI.php.

References $DIC, and $ilCtrl.

    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];
        
        $ilCtrl->returnToParent($this);
    }

confirmTemplateSwitch()

ilDidacticTemplateGUI::confirmTemplateSwitch ( )

protected

Definition at line 122 of file class.ilDidacticTemplateGUI.php.

References $DIC, $ilCtrl, $tpl, ilLoggerFactory\getLogger(), getParentObject(), ilDidacticTemplateObjSettings\lookupTemplateId(), and ilUtil\sendInfo().

    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];
        $ilTabs = $DIC['ilTabs'];
        $tpl = $DIC['tpl'];

        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateObjSettings.php';

        // Check if template is changed
        $new_tpl_id = (int) $_REQUEST['tplid'];
        if ($new_tpl_id == ilDidacticTemplateObjSettings::lookupTemplateId($this->getParentObject()->object->getRefId())) {
            ilLoggerFactory::getLogger('otpl')->debug('Template id: ' . $new_tpl_id);
            ilUtil::sendInfo($this->lng->txt('didactic_not_changed'), true);
            $ilCtrl->returnToParent($this);
        }

        $ilTabs->clearTargets();
        $ilTabs->clearSubTabs();

        include_once './Services/Utilities/classes/class.ilConfirmationGUI.php';
        $confirm = new ilConfirmationGUI();
        $confirm->setFormAction($ilCtrl->getFormAction($this));
        $confirm->setHeaderText($this->lng->txt('didactic_confirm_apply_new_template'));
        $confirm->setConfirm($this->lng->txt('apply'), 'switchTemplate');
        $confirm->setCancel($this->lng->txt('cancel'), 'cancel');

        if ($new_tpl_id) {
            include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateSetting.php';
            $dtpl = new ilDidacticTemplateSetting($new_tpl_id);

            $confirm->addItem(
                'tplid',
                $new_tpl_id,
                $dtpl->getPresentationTitle() .
                '<div class="il_Description">' .
                $dtpl->getPresentationDescription() . ' ' .
                '</div>'
            );
        } else {
            $confirm->addItem(
                'tplid',
                $new_tpl_id,
                $this->lng->txt('default') . ' ' .
                '<div class="il_Description">' .
                sprintf(
                    $this->lng->txt('didactic_default_type_info'),
                    $this->lng->txt('objs_' . $this->getParentObject()->object->getType())
                ) .
                '</div>'
            );
        }
        $tpl->setContent($confirm->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilDidacticTemplateGUI::executeCommand

(

)

Execute command.

Returns

<type>

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

References $DIC, and $ilCtrl.

    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];

        $next_class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd();

        switch ($next_class) {
            default:
                if (!$cmd) {
                    $cmd = 'overview';
                }
                $this->$cmd();

                break;
        }
        return true;
    }

getParentObject()

ilDidacticTemplateGUI::getParentObject

(

)

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

References $parent_object.

Referenced by appendToolbarSwitch(), confirmTemplateSwitch(), and switchTemplate().

    {
        return $this->parent_object;
    }

Here is the caller graph for this function:

switchTemplate()

ilDidacticTemplateGUI::switchTemplate ( )

protected

Switch Template.

Definition at line 193 of file class.ilDidacticTemplateGUI.php.

References $DIC, $ilCtrl, getParentObject(), and ilDidacticTemplateUtils\switchTemplate().

    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];
        
        $new_tpl_id = (int) $_REQUEST['tplid'];

        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateUtils.php';
        ilDidacticTemplateUtils::switchTemplate($this->getParentObject()->object->getRefId(), $new_tpl_id);

        ilUtil::sendSuccess($this->lng->txt('didactic_template_applied'), true);
        $ilCtrl->returnToParent($this);
    }

Here is the call graph for this function:

Field Documentation

$lng

ilDidacticTemplateGUI::$lng

private

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

Referenced by __construct().

$parent_object

ilDidacticTemplateGUI::$parent_object

private

Definition at line 15 of file class.ilDidacticTemplateGUI.php.

Referenced by getParentObject().

---

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

• Services/DidacticTemplate/classes/class.ilDidacticTemplateGUI.php