ilOrgUnitTypeGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilOrgUnitTypeGUI:

Public Member Functions
	__construct (ilObjOrgUnitGUI $parent_gui)
	executeCommand ()

Protected Member Functions
	create ()
	Create (save) type. More...

Private Member Functions
	checkAccess ()
	setSubTabsEdit (string $active_tab_id)
	editCustomIcons ()
	Display form for editing custom icons. More...
	updateCustomIcons ()
	editAMD ()
	updateAMD ()
	listTypes ()
	Display all types in a table with actions to edit/delete. More...
	add ()
	Display form to create a new OrgUnit type. More...
	edit ()
	Display form to edit an existing OrgUnit type. More...
	update ()
	Update (save) type. More...
	delete ()
	Delete a type. More...

Private Attributes
ilCtrl	$ctrl
ilGlobalTemplateInterface	$tpl
ilTabsGUI	$tabs
ilAccessHandler	$access
ilToolbarGUI	$toolbar
ilSetting	$settings
ilLanguage	$lng
ilObjOrgUnitGUI	$parent_gui

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilOrgUnitTypeGUI

Author

Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

__construct()

ilOrgUnitTypeGUI::__construct

(

ilObjOrgUnitGUI

$parent_gui

)

Parameters

ilObjOrgUnitGUI

$parent_gui

Definition at line 38 of file class.ilOrgUnitTypeGUI.php.

References $DIC, $parent_gui, ILIAS\Repository\access(), checkAccess(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

    {
        global $DIC;

        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->access =$DIC->access();
        $this->toolbar = $DIC->toolbar();
        $this->tabs =  $DIC->tabs();
        $this->lng = $DIC->language();
        $this->settings = $DIC->settings();
        $this->parent_gui = $parent_gui;
        $this->lng->loadLanguageModule('orgu');
        $this->ctrl->saveParameter($this, 'type_id');
        $this->lng->loadLanguageModule('meta');
        $this->checkAccess();
    }

Here is the call graph for this function:

Member Function Documentation

add()

ilOrgUnitTypeGUI::add ( )

private

Display form to create a new OrgUnit type.

Definition at line 183 of file class.ilOrgUnitTypeGUI.php.

Referenced by executeCommand().

                          : void
    {
        $form = new ilOrgUnitTypeFormGUI($this, new ilOrgUnitType());
        $this->tpl->setContent($form->getHTML());
    }

Here is the caller graph for this function:

checkAccess()

ilOrgUnitTypeGUI::checkAccess ( )

private

Definition at line 105 of file class.ilOrgUnitTypeGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by __construct().

                                  : void
    {
        if (!$this->access->checkAccess("write", "", $this->parent_gui->object->getRefId())) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("permission_denied"), true);
            $this->ctrl->redirect($this->parent_gui);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

create()

ilOrgUnitTypeGUI::create ( )

protected

Create (save) type.

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

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                               : void
    {
        $form = new ilOrgUnitTypeFormGUI($this, new ilOrgUnitType());
        if ($form->saveObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_created'), true);
            $this->ctrl->redirect($this);
        } else {
            $this->tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilOrgUnitTypeGUI::delete ( )

private

Delete a type.

Definition at line 230 of file class.ilOrgUnitTypeGUI.php.

References $_GET, Vendor\Package\$e, $type, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                             : void
    {
        $type = new ilOrgUnitType((int) $_GET['type_id']);
        try {
            $type->delete();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('orgu_type_msg_deleted'), true);
            $this->ctrl->redirect($this);
        } catch (ilException $e) {
            $this->tpl->setOnScreenMessage('failure', $e->getMessage(), true);
            $this->ctrl->redirect($this);
        }
    }

Here is the call graph for this function:

edit()

ilOrgUnitTypeGUI::edit ( )

private

Display form to edit an existing OrgUnit type.

Definition at line 192 of file class.ilOrgUnitTypeGUI.php.

References $_GET, and $type.

Referenced by executeCommand().

                           : void
    {
        $type = new ilOrgUnitType((int) $_GET['type_id']);
        $form = new ilOrgUnitTypeFormGUI($this, $type);
        $this->tpl->setContent($form->getHTML());
    }

Here is the caller graph for this function:

editAMD()

ilOrgUnitTypeGUI::editAMD ( )

private

Definition at line 149 of file class.ilOrgUnitTypeGUI.php.

References $_GET.

Referenced by executeCommand().

                              : void
    {
        $form = new ilOrgUnitTypeAdvancedMetaDataFormGUI($this, new ilOrgUnitType((int) $_GET['type_id']));
        $this->tpl->setContent($form->getHTML());
    }

Here is the caller graph for this function:

editCustomIcons()

ilOrgUnitTypeGUI::editCustomIcons ( )

private

Display form for editing custom icons.

Definition at line 132 of file class.ilOrgUnitTypeGUI.php.

References $_GET.

Referenced by executeCommand().

                                      : void
    {
        $form = new ilOrgUnitTypeCustomIconsFormGUI($this, new ilOrgUnitType((int) $_GET['type_id']));
        $this->tpl->setContent($form->getHTML());
    }

Here is the caller graph for this function:

executeCommand()

ilOrgUnitTypeGUI::executeCommand

(

)

Definition at line 56 of file class.ilOrgUnitTypeGUI.php.

References add(), create(), ILIAS\Repository\ctrl(), edit(), editAMD(), editCustomIcons(), listTypes(), setSubTabsEdit(), update(), updateAMD(), and updateCustomIcons().

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass($this);
        switch ($next_class) {
            case '':
                switch ($cmd) {
                    case '':
                    case 'listTypes':
                        $this->listTypes();
                        break;
                    case 'add':
                        $this->add();
                        break;
                    case 'edit':
                        $this->setSubTabsEdit('general');
                        $this->edit();
                        break;
                    case 'editCustomIcons':
                        $this->setSubTabsEdit('custom_icons');
                        $this->editCustomIcons();
                        break;
                    case 'editAMD':
                        $this->setSubTabsEdit('amd');
                        $this->editAMD();
                        break;
                    case 'updateAMD':
                        $this->setSubTabsEdit('amd');
                        $this->updateAMD();
                        break;
                    case 'updateCustomIcons':
                        $this->setSubTabsEdit('custom_icons');
                        $this->updateCustomIcons();
                        break;
                    case 'create':
                        $this->create();
                        break;
                    case 'update':
                        $this->setSubTabsEdit('general');
                        $this->update();
                        break;
                    case 'delete':
                        $this->delete();
                        break;
                }
                break;
        }
    }

Here is the call graph for this function:

listTypes()

ilOrgUnitTypeGUI::listTypes ( )

private

Display all types in a table with actions to edit/delete.

Definition at line 169 of file class.ilOrgUnitTypeGUI.php.

References ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), and ILIAS\Repository\toolbar().

Referenced by executeCommand().

                                : void
    {
        $button = ilLinkButton::getInstance();
        $button->setCaption('orgu_type_add');
        $button->setUrl($this->ctrl->getLinkTarget($this, 'add'));
        $this->toolbar->addButtonInstance($button);

        $table = new ilOrgUnitTypeTableGUI($this, 'listTypes');
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSubTabsEdit()

ilOrgUnitTypeGUI::setSubTabsEdit ( string  $active_tab_id )

private

Definition at line 113 of file class.ilOrgUnitTypeGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\tabs().

Referenced by executeCommand().

                                                          : void
    {
        $this->tabs->addSubTab('general', $this->lng->txt('meta_general'), $this->ctrl->getLinkTarget($this, 'edit'));
        if ($this->settings->get('custom_icons')) {
            $this->tabs->addSubTab(
                'custom_icons',
                $this->lng->txt('icon_settings'),
                $this->ctrl->getLinkTarget($this, 'editCustomIcons')
            );
        }
        if (count(ilOrgUnitType::getAvailableAdvancedMDRecordIds())) {
            $this->tabs->addSubTab('amd', $this->lng->txt('md_advanced'), $this->ctrl->getLinkTarget($this, 'editAMD'));
        }
        $this->tabs->setSubTabActive($active_tab_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilOrgUnitTypeGUI::update ( )

private

Update (save) type.

Definition at line 216 of file class.ilOrgUnitTypeGUI.php.

References $_GET, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                             : void
    {
        $form = new ilOrgUnitTypeFormGUI($this, new ilOrgUnitType((int) $_GET['type_id']));
        if ($form->saveObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
            $this->ctrl->redirect($this);
        } else {
            $this->tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateAMD()

ilOrgUnitTypeGUI::updateAMD ( )

private

Definition at line 155 of file class.ilOrgUnitTypeGUI.php.

References $_GET, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                                : void
    {
        $form = new ilOrgUnitTypeAdvancedMetaDataFormGUI($this, new ilOrgUnitType((int) $_GET['type_id']));
        if ($form->saveObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
            $this->ctrl->redirect($this);
        } else {
            $this->tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateCustomIcons()

ilOrgUnitTypeGUI::updateCustomIcons ( )

private

Definition at line 138 of file class.ilOrgUnitTypeGUI.php.

References $_GET, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                                        : void
    {
        $form = new ilOrgUnitTypeCustomIconsFormGUI($this, new ilOrgUnitType((int) $_GET['type_id']));
        if ($form->saveObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
            $this->ctrl->redirect($this);
        } else {
            $this->tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilOrgUnitTypeGUI::$access

private

Definition at line 29 of file class.ilOrgUnitTypeGUI.php.

$ctrl

ilCtrl ilOrgUnitTypeGUI::$ctrl

private

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

$lng

ilLanguage ilOrgUnitTypeGUI::$lng

private

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

$parent_gui

ilObjOrgUnitGUI ilOrgUnitTypeGUI::$parent_gui

private

Definition at line 33 of file class.ilOrgUnitTypeGUI.php.

Referenced by __construct().

$settings

ilSetting ilOrgUnitTypeGUI::$settings

private

Definition at line 31 of file class.ilOrgUnitTypeGUI.php.

$tabs

ilTabsGUI ilOrgUnitTypeGUI::$tabs

private

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

$toolbar

ilToolbarGUI ilOrgUnitTypeGUI::$toolbar

private

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

$tpl

ilGlobalTemplateInterface ilOrgUnitTypeGUI::$tpl

private

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

---

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

• Modules/OrgUnit/classes/Types/class.ilOrgUnitTypeGUI.php