ilOrgUnitTypeGUI Class Reference

Class ilOrgUnitTypeGUI. More...

Inheritance diagram for ilOrgUnitTypeGUI:

Collaboration diagram for ilOrgUnitTypeGUI:

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

Protected Member Functions
	getIconForm (string $section_title=null, string $current_identifier=null)
	getAvailableAMDRecords ()
	getCurrentOrgUnitType ()
	getAmdForm (string $action, array $available_records, ilOrgUnitType $type)
	create ()
	Create (save) type. More...

Protected Attributes
ilLanguage	$lng
ILIAS UI Component Link Factory	$link_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
Refinery	$refinery
ServerRequestInterface	$request

Private Member Functions
	checkAccess ()
	setSubTabsEdit (string $active_tab_id)
	editCustomIcons ()
	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

Detailed Description

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 33 of file class.ilOrgUnitTypeGUI.php.

Constructor & Destructor Documentation

__construct()

ilOrgUnitTypeGUI::__construct

(

private ilObjOrgUnitGUI

$parent_gui

)

Parameters

ilObjOrgUnitGUI

$parent_gui

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

References $DIC, ILIAS\Repository\access(), checkAccess(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), 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->lng->loadLanguageModule('orgu');
        $this->ctrl->saveParameter($this, 'type_id');
        $this->lng->loadLanguageModule('meta');
        $this->checkAccess();
        $this->link_factory = $DIC['ui.factory']->link();
        $this->ui_factory = $DIC['ui.factory'];
        $this->ui_renderer = $DIC['ui.renderer'];
        $this->refinery = $DIC['refinery'];
        $this->request = $DIC->http()->request();
        $this->lng->loadLanguageModule('meta');
    }

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 344 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 130 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 363 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 391 of file class.ilOrgUnitTypeGUI.php.

References $_GET, Vendor\Package\$e, 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 353 of file class.ilOrgUnitTypeGUI.php.

References $_GET.

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 295 of file class.ilOrgUnitTypeGUI.php.

References ILIAS\Repository\ctrl(), getAmdForm(), getAvailableAMDRecords(), and getCurrentOrgUnitType().

Referenced by executeCommand().

                              : void
    {
        $form = $this->getAmdForm(
            $this->ctrl->getFormAction($this, 'updateAMD'),
            $this->getAvailableAMDRecords(),
            $this->getCurrentOrgUnitType()
        );
        $this->tpl->setContent(
            $this->ui_renderer->render($form)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editCustomIcons()

ilOrgUnitTypeGUI::editCustomIcons ( )

private

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

References $_GET, and getIconForm().

Referenced by executeCommand().

                                      : void
    {
        $type = new ilOrgUnitType((int) $_GET['type_id']);
        $form = $this->getIconForm(
            $type->getTitle() . ': ',
            $type->getIconIdentifier()
        );
        $this->tpl->setContent($this->ui_renderer->render($form));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilOrgUnitTypeGUI::executeCommand

(

)

Definition at line 75 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 strtolower(ilOrgUnitTypeUploadHandlerGUI::class):
                $this->ctrl->forwardCommand(
                    new ilOrgUnitTypeUploadHandlerGUI()
                );
                break;

            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:

getAmdForm()

ilOrgUnitTypeGUI::getAmdForm ( string  $action, array  $available_records, ilOrgUnitType  $type  )

protected

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

References ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by editAMD(), mock_ilOrgUnitTypeGUI\mockGetAmdForm(), and updateAMD().

     : StandardForm {
        $options = [];
        foreach ($available_records as $record) {
            $options[$record->getRecordId()] = $record->getTitle();
        }
        $selected_ids = $type->getAssignedAdvancedMDRecordIds();

        $trafo = $this->refinery->custom()->transformation(
            fn($v) => is_array($v) ? array_shift($v) : []
        );

        $field = $this->ui_factory->input()->field()->multiselect(
            $this->lng->txt('orgu_type_available_amd_sets'),
            $options
        )
        ->withValue($selected_ids);

        $section = $this->ui_factory->input()->field()->section(
            [$field],
            $this->lng->txt('orgu_type_assign_amd_sets')
        )
        ->withAdditionalTransformation($trafo);

        $store = $this->refinery->custom()->transformation(
            function (?array $record_ids) use ($type, $selected_ids) {
                $record_ids = $record_ids ?? [];
                $record_ids_removed = array_diff($selected_ids, $record_ids);
                $record_ids_added = array_diff($record_ids, $selected_ids);
                foreach ($record_ids_added as $record_id) {
                    $type->assignAdvancedMDRecord((int)$record_id);
                }
                foreach ($record_ids_removed as $record_id) {
                    $type->deassignAdvancedMdRecord((int)$record_id);
                }
                return true;
            }
        );

        return $this->ui_factory->input()->container()->form()->standard($action, [$section])
           ->withAdditionalTransformation($trafo)
           ->withAdditionalTransformation($store);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAvailableAMDRecords()

ilOrgUnitTypeGUI::getAvailableAMDRecords ( )

protected

Returns

ilAdvancedMDRecord[]

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

References ilOrgUnitType\getAvailableAdvancedMDRecords().

Referenced by editAMD(), and updateAMD().

                                               : array
    {
        return ilOrgUnitType::getAvailableAdvancedMDRecords();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentOrgUnitType()

ilOrgUnitTypeGUI::getCurrentOrgUnitType ( )

protected

Returns

ilOrgUnitType

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

References $_GET.

Referenced by editAMD(), and updateAMD().

                                              : ilOrgUnitType
    {
        return new ilOrgUnitType((int) $_GET['type_id']);
    }

Here is the caller graph for this function:

getIconForm()

ilOrgUnitTypeGUI::getIconForm ( string  $section_title = null, string  $current_identifier = null  )

protected

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

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

Referenced by editCustomIcons(), and updateCustomIcons().

     : StandardForm {
        $handler_gui = new ilOrgUnitTypeUploadHandlerGUI();

        $input = $this->ui_factory->input()->field()->file(
            $handler_gui,
            $this->lng->txt('icon'),
            $this->lng->txt('file_allowed_suffixes') . ' .svg'
        );

        if($current_identifier) {
            $input = $input->withValue([$current_identifier]);
        }

        $section = $this->ui_factory->input()->field()->section(
            ['iconfile' => $input],
            $section_title . $this->lng->txt('orgu_type_custom_icon'),
            $this->lng->txt('orgu_type_custom_icon_info')
        );

        $form_action = $this->ctrl->getFormAction($this, 'updateCustomIcons');
        $form = $this->ui_factory->input()->container()->form()->standard(
            $form_action,
            [$section]
        );

        $form = $form->withAdditionalTransformation(
            $this->refinery->custom()->transformation(
                function ($values) {
                    return array_shift($values)['iconfile'];
                }
            )
        );
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listTypes()

ilOrgUnitTypeGUI::listTypes ( )

private

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

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

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

Referenced by executeCommand().

                                : void
    {
        $url = $this->ctrl->getLinkTarget($this, 'add');
        $link = $this->link_factory->standard(
            $this->lng->txt('orgu_type_add'),
            $url
        );
        $this->toolbar->addComponent($link);

        $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 138 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 377 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 307 of file class.ilOrgUnitTypeGUI.php.

References ILIAS\Repository\ctrl(), getAmdForm(), getAvailableAMDRecords(), getCurrentOrgUnitType(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                                : void
    {
        $form = $this->getAmdForm(
            $this->ctrl->getFormAction($this, 'updateAMD'),
            $this->getAvailableAMDRecords(),
            $this->getCurrentOrgUnitType()
        )
        ->withRequest($this->request);

        if($form->getData()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
            $this->ctrl->redirect($this);
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('error'), true);
            $this->tpl->setContent($this->ui_renderer->render($form));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateCustomIcons()

ilOrgUnitTypeGUI::updateCustomIcons ( )

private

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

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

Referenced by executeCommand().

                                        : void
    {
        $type = new ilOrgUnitType((int) $_GET['type_id']);
        $form = $this->getIconForm(
            $type->getTitle() . ': ',
            $type->getIconIdentifier()
        )
        ->withRequest($this->request);

        $data = $form->getData();

        if(! is_null($data)) {
            $new_icon_id = current($data) ? current($data) : '';
            $identifier = $type->getIconIdentifier();
            if($identifier && $new_icon_id == '') {
                $type->removeIconFromIrss($identifier);
            }
            $type = $type->withIconIdentifier($new_icon_id);
            $type->save();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
            $this->ctrl->redirect($this);
        } else {
            $this->tpl->setContent($this->ui_renderer->render($form));
        }
    }

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 38 of file class.ilOrgUnitTypeGUI.php.

$ctrl

ilCtrl ilOrgUnitTypeGUI::$ctrl

private

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

$link_factory

ILIAS UI Component Link Factory ilOrgUnitTypeGUI::$link_factory

protected

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

$lng

ilLanguage ilOrgUnitTypeGUI::$lng

protected

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

Referenced by mock_ilOrgUnitTypeGUI\__construct().

$refinery

Refinery ilOrgUnitTypeGUI::$refinery

protected

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

Referenced by ilModulesOrgUnitTypeTest\getRefinery(), and ilModulesOrgUnitTypeTest\getUIFactory().

$request

ServerRequestInterface ilOrgUnitTypeGUI::$request

protected

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

$settings

ilSetting ilOrgUnitTypeGUI::$settings

private

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

$tabs

ilTabsGUI ilOrgUnitTypeGUI::$tabs

private

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

$toolbar

ilToolbarGUI ilOrgUnitTypeGUI::$toolbar

private

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

$tpl

ilGlobalTemplateInterface ilOrgUnitTypeGUI::$tpl

private

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

$ui_factory

UIFactory ilOrgUnitTypeGUI::$ui_factory

protected

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

$ui_renderer

UIRenderer ilOrgUnitTypeGUI::$ui_renderer

protected

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

---

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

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