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

Collaboration diagram for ilDidacticTemplateGUI:

Public Member Functions
	__construct (object $a_parent_obj, int $requested_template_id=0)

	getParentObject ()

	executeCommand ()

	appendToolbarSwitch (ilToolbarGUI $toolbar, string $a_obj_type, int $a_ref_id)

Protected Member Functions
	initTemplateIdFromPost ()

	confirmTemplateSwitch ()
	Show didactic template switch confirmation screen. More...

	cancel ()
	Return to parent gui. More...

	switchTemplate ()

Private Attributes
object	$parent_object

ilLanguage	$lng

ilCtrl	$ctrl

ilTabsGUI	$tabs

ilGlobalTemplateInterface	$tpl

int	$requested_template_id

ILIAS HTTP GlobalHttpState	$http

ILIAS Refinery Factory	$refinery

ilLogger	$logger

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

@ilCtrl_IsCalledBy ilDidacticTemplateGUI: ilPermissionGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateGUI::__construct	(	object	$a_parent_obj,
		int	$requested_template_id = `0`
	)

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

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->tabs = $DIC->tabs();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('didactic');
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->logger = $DIC->logger()->otpl();
 
        $this->parent_object = $a_parent_obj;
        if ($requested_template_id === 0) {
            $this->initTemplateIdFromPost();
        } else {
            $this->requested_template_id = $requested_template_id;
        }
    }

References $DIC, $requested_template_id, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), initTemplateIdFromPost(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\refinery(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

Member Function Documentation

◆ appendToolbarSwitch()

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

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

                                                                                                 : bool
    {
        $tpls = ilDidacticTemplateSettings::getInstanceByObjectType($a_obj_type)->getTemplates();
        $value = ilDidacticTemplateObjSettings::lookupTemplateId($this->getParentObject()->getObject()->getRefId());
 
        if (0 === $value && 0 === count($tpls)) {
            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($a_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 (($excl_tpl && $value === 0) || !array_key_exists($value, $options)) {
            $options[$value] = $this->lng->txt('not_available');
        }
 
        if (count($options) < 2) {
            return false;
        }
 
        $tpl_selection = new ilSelectInputGUI(
            $this->lng->txt('didactic_selected_tpl_option'),
            'tplid'
        );
        $tpl_selection->setOptions($options);
        $tpl_selection->setValue((string) $value);
        $toolbar->addInputItem($tpl_selection);
 
        // Apply templates switch
        $toolbar->addFormButton($this->lng->txt('change'), 'confirmTemplateSwitch');
        return true;
    }

References $tpl, ilToolbarGUI\addFormButton(), ilToolbarGUI\addInputItem(), ilToolbarGUI\addText(), ilDidacticTemplateSettings\getInstanceByObjectType(), getParentObject(), ILIAS\Repository\lng(), and ilDidacticTemplateObjSettings\lookupTemplateId().

Here is the call graph for this function:

◆ cancel()

ilDidacticTemplateGUI::cancel ( )

protected

Return to parent gui.

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

                               : void
    {
        $this->ctrl->returnToParent($this);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ confirmTemplateSwitch()

ilDidacticTemplateGUI::confirmTemplateSwitch ( )

protected

Show didactic template switch confirmation screen.

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

                                              : void
    {
        // Check if template is changed
        $new_tpl_id = $this->requested_template_id;
        if ($new_tpl_id === ilDidacticTemplateObjSettings::lookupTemplateId($this->getParentObject()->getObject()->getRefId())) {
            $this->logger->debug('Template id: ' . $new_tpl_id);
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('didactic_not_changed'), true);
            $this->ctrl->returnToParent($this);
        }
 
        $this->tabs->clearTargets();
        $this->tabs->clearSubTabs();
 
        $confirm = new ilConfirmationGUI();
        $confirm->setFormAction($this->ctrl->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) {
            $dtpl = new ilDidacticTemplateSetting($new_tpl_id);
 
            $confirm->addItem(
                'tplid',
                (string) $new_tpl_id,
                $dtpl->getPresentationTitle() .
                '<div class="il_Description">' .
                $dtpl->getPresentationDescription() . ' ' .
                '</div>'
            );
        } else {
            $confirm->addItem(
                'tplid',
                (string) $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()->getObject()->getType())
                ) .
                '</div>'
            );
        }
        $this->tpl->setContent($confirm->getHTML());
    }

References $requested_template_id, ILIAS\Repository\ctrl(), getParentObject(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ilDidacticTemplateObjSettings\lookupTemplateId(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ executeCommand()

ilDidacticTemplateGUI::executeCommand ( )

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

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            default:
                if (!$cmd) {
                    $cmd = 'overview';
                }
                $this->$cmd();
 
                break;
        }
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getParentObject()

ilDidacticTemplateGUI::getParentObject ( )

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

                                     : object
    {
        return $this->parent_object;
    }

References $parent_object.

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

Here is the caller graph for this function:

◆ initTemplateIdFromPost()

ilDidacticTemplateGUI::initTemplateIdFromPost ( )

protected

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

    {
        $this->requested_template_id = 0;
        if ($this->http->wrapper()->post()->has('tplid')) {
            $this->requested_template_id = $this->http->wrapper()->post()->retrieve(
                'tplid',
                $this->refinery->kindlyTo()->int()
            );
        }
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ switchTemplate()

ilDidacticTemplateGUI::switchTemplate ( )

protected

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

                                       : void
    {
        $new_tpl_id = $this->requested_template_id;
        ilDidacticTemplateUtils::switchTemplate($this->getParentObject()->getObject()->getRefId(), $new_tpl_id);
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('didactic_template_applied'), true);
        $this->ctrl->returnToParent($this);
    }