Collaboration diagram for ilStudyProgrammeTypeGUI:

Public Member Functions
	__construct (public ilGlobalTemplateInterface $tpl, public ilCtrl $ctrl, protected ilAccess $access, protected ilToolbarGUI $toolbar, protected ilLanguage $lng, protected ILIAS $ilias, protected ilTabsGUI $tabs, protected ilObjUser $user, protected ilStudyProgrammeTypeRepository $type_repository, protected UIFactory $ui_factory, protected Renderer $renderer, DataFactory $data_factory, protected Psr\Http\Message\ServerRequestInterface $request, protected Refinery\Factory $refinery, protected RequestWrapper $request_wrapper)

	executeCommand ()

	setParentGUI ($parent_gui)

Protected Member Functions
	getCommandFromQueryToken (string $default)

	getTypeIdFromQueryToken ()

	getUrl (string $action, ?int $type_id=null)

	checkAccess ()

	setSubTabsEdit (string $active_tab_id)

	getIconForm (?string $section_title=null, ?string $current_identifier=null)

	editCustomIcons ()

	updateCustomIcons ()

	editAMD ()

	updateAMD ()

	listTypes ()

	buildForm (string $submit_action, string $type_action)

	add ()

	edit (int $type_id)

	create ()

	update ()

	delete ()

	buildModalHeading (string $title, string $default_lng)

	buildLanguagesForms (?ilStudyProgrammeType $type=null)

	getInstalledLanguages ()

Protected Attributes
	$parent_gui

array	$installed_languages = null

Input Factory	$input_factory

ilStudyProgrammeType	$type = null

URLBuilder	$url_builder

URLBuilderToken	$action_token

URLBuilderToken	$id_token

Detailed Description

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; Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de; Daniel Weise danie.nosp@m.l.we.nosp@m.ise@c.nosp@m.once.nosp@m.pts-a.nosp@m.nd-t.nosp@m.raini.nosp@m.ng.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeTypeGUI::__construct	(	public ilGlobalTemplateInterface	$tpl,
		public ilCtrl	$ctrl,
		protected ilAccess	$access,
		protected ilToolbarGUI	$toolbar,
		protected ilLanguage	$lng,
		protected ILIAS	$ilias,
		protected ilTabsGUI	$tabs,
		protected ilObjUser	$user,
		protected ilStudyProgrammeTypeRepository	$type_repository,
		protected UIFactory	$ui_factory,
		protected Renderer	$renderer,
		DataFactory	$data_factory,
		protected Psr\Http\Message\ServerRequestInterface	$request,
		protected Refinery\Factory	$refinery,
		protected RequestWrapper	$request_wrapper
	)

Definition at line 52 of file class.ilStudyProgrammeTypeGUI.php.

      {
        $this->lng->loadLanguageModule('prg');
        $this->lng->loadLanguageModule('meta');
        $this->input_factory = $ui_factory->input();
 
        $here_uri = $data_factory->uri($this->request->getUri()->__toString());
        $url_builder = new URLBuilder($here_uri);
        $namespace = ['prgtypes'];
        list($url_builder, $action_token, $id_token) =
        $url_builder->acquireParameters(
            $namespace,
            "table_action",
            "type_ids"
        );
 
        $this->url_builder = $url_builder;
        $this->action_token = $action_token;
        $this->id_token = $id_token;
    }

References $action_token, $id_token, $namespace, $url_builder, ILIAS\UI\URLBuilder\acquireParameters(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilStudyProgrammeTypeGUI::add ( )

protected

Definition at line 386 of file class.ilStudyProgrammeTypeGUI.php.

                            : void
    {
        $form = $this->buildForm(
            $this->getUrl('create'),
            $this->lng->txt('prg_type_add')
        );
 
        $this->tpl->setContent($this->renderer->render($form));
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildForm()

ilStudyProgrammeTypeGUI::buildForm	(	string	$submit_action,
		string	$type_action
	)

protected

Definition at line 363 of file class.ilStudyProgrammeTypeGUI.php.

     : Input\Container\Form\Form {
        $default_lng = $this->type ? $this->type->getDefaultLang() : "";
        return $this->input_factory->container()->form()->standard(
            $submit_action,
            [
                "default_lang" => $this->buildModalHeading($type_action, $default_lng),
                "info" => $this->buildLanguagesForms($this->type)
            ]
        )->withAdditionalTransformation(
            $this->refinery->custom()->transformation(
                function ($values) {
                    return [
                        'default_lang' => $values['default_lang']['default_lang'],
                        'info' => $values['info']
                    ];
                }
            )
        );
    }

◆ buildLanguagesForms()

ilStudyProgrammeTypeGUI::buildLanguagesForms ( ?ilStudyProgrammeType $type = null )

protected

Definition at line 493 of file class.ilStudyProgrammeTypeGUI.php.

                                                                              : InputField
    {
        $return = [];
        foreach ($this->getInstalledLanguages() as $lng_code) {
            $title = null;
            $description = null;
            if (!is_null($type)) {
                $title = $type->getTitle($lng_code);
                $description = $type->getDescription($lng_code);
            }
            $lng_field = new ilStudyProgrammeTypeInfo($title, $description, $lng_code);
            $return[] = $lng_field->toFormInput(
                $this->input_factory->field(),
                $this->lng,
                $this->refinery
            );
        }
 
        return $this->input_factory->field()->group($return);
    }

References ilStudyProgrammeType\getDescription(), and ilStudyProgrammeType\getTitle().

Here is the call graph for this function:

◆ buildModalHeading()

ilStudyProgrammeTypeGUI::buildModalHeading	(	string	$title,
		string	$default_lng
	)

protected

Definition at line 476 of file class.ilStudyProgrammeTypeGUI.php.

                                                                            : InputField
    {
        $options = [];
        foreach ($this->getInstalledLanguages() as $lang_code) {
            $options[$lang_code] = $this->lng->txt("meta_l_$lang_code");
        }
 
        $select = $this->input_factory->field()->select(
            $this->lng->txt('default_language'),
            $options,
            ''
        )->withValue($default_lng)
         ->withRequired(true);
 
        return $this->input_factory->field()->section(['default_lang' => $select], $title);
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ checkAccess()

ilStudyProgrammeTypeGUI::checkAccess ( )

protected

Definition at line 189 of file class.ilStudyProgrammeTypeGUI.php.

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

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilStudyProgrammeTypeGUI::create ( )

protected

Definition at line 407 of file class.ilStudyProgrammeTypeGUI.php.

                               : void
    {
        $form = $this->buildForm(
            $this->getUrl('create'),
            $this->lng->txt('prg_type_add')
        )->withRequest($this->request);
 
        $result = $form->getData();
        if (!is_null($result)) {
            $type = $this->type_repository->createType($this->lng->getDefaultLanguage());
            $this->updateTypeFromFormResult($type, $result);
            $this->tpl->setOnScreenMessage("success", $this->lng->txt('msg_obj_modified'), true);
            $this->ctrl->redirect($this, 'view');
        } else {
            $this->tpl->setOnScreenMessage("failure", $this->lng->txt("msg_fill_required"), true);
            $this->tpl->setContent($this->renderer->render($form));
        }
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilStudyProgrammeTypeGUI::delete ( )

protected

Definition at line 462 of file class.ilStudyProgrammeTypeGUI.php.

                               : void
    {
        $type_id = $this->getTypeIdFromQueryToken();
        try {
            $type = $this->type_repository->getType($type_id);
            $this->type_repository->deleteType($type);
            $this->tpl->setOnScreenMessage("success", $this->lng->txt('prg_type_msg_deleted'), true);
            $this->ctrl->redirect($this);
        } catch (Exception $e) {
            $this->tpl->setOnScreenMessage("failure", $e->getMessage(), true);
            $this->ctrl->redirect($this);
        }
    }

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

Here is the call graph for this function:

◆ edit()

ilStudyProgrammeTypeGUI::edit ( int $type_id )

protected

Definition at line 396 of file class.ilStudyProgrammeTypeGUI.php.

                                         : void
    {
        $this->type = $this->type_repository->getType($type_id);
        $form = $this->buildForm(
            $this->getUrl('update', $type_id),
            $this->lng->txt('prg_type_edit')
        );
 
        $this->tpl->setContent($this->renderer->render($form));
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editAMD()

ilStudyProgrammeTypeGUI::editAMD ( )

protected

Definition at line 299 of file class.ilStudyProgrammeTypeGUI.php.

                                : void
    {
        $type_id = $this->getTypeIdFromQueryToken();
        $type = $this->type_repository->getType($type_id);
        $form = new ilStudyProgrammeTypeAdvancedMetaDataFormGUI(
            $this->getUrl('updateAMD', $type_id),
            $this->type_repository,
            $this->tpl,
            $this->lng
        );
        $form->fillForm($type);
        $this->tpl->setContent($form->getHTML());
    }

References ILIAS\Repository\lng().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editCustomIcons()

ilStudyProgrammeTypeGUI::editCustomIcons ( )

protected

Definition at line 265 of file class.ilStudyProgrammeTypeGUI.php.

                                        : void
    {
        $type = $this->type_repository->getType($this->getTypeIdFromQueryToken());
        $form = $this->getIconForm(
            $type->getTitle() . ': ',
            $type->getIconIdentifier()
        );
        $this->tpl->setContent($this->renderer->render($form));
    }

References ilStudyProgrammeType\getIconIdentifier(), ilStudyProgrammeType\getTitle(), and renderer().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilStudyProgrammeTypeGUI::executeCommand ( )

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

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        switch ($next_class) {
            case strtolower(ilStudyProgrammeTypeUploadHandlerGUI::class):
                $type_id = $this->getTypeIdFromQueryToken();
                $type = $this->type_repository->getType($type_id);
                $this->ctrl->forwardCommand(
                    new ilStudyProgrammeTypeUploadHandlerGUI($type->getIconIdentifier())
                );
                break;
        }
 
        $this->checkAccess();
        $cmd = $this->getCommandFromQueryToken('view');
 
        switch ($cmd) {
            case 'view':
            case 'listTypes':
                $this->listTypes();
                break;
            case 'add':
                $this->add();
                break;
            case 'edit':
                $this->setSubTabsEdit('general');
                $this->edit($this->getTypeIdFromQueryToken());
                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;
            case 'cancel':
                $this->ctrl->redirect($this->parent_gui);
                break;
            default:
                throw new LogicException("Unknown command: $cmd");
        }
    }

References $type, add(), checkAccess(), create(), ILIAS\Repository\ctrl(), edit(), editAMD(), editCustomIcons(), getCommandFromQueryToken(), ilStudyProgrammeType\getIconIdentifier(), getTypeIdFromQueryToken(), listTypes(), setSubTabsEdit(), update(), updateAMD(), and updateCustomIcons().

Here is the call graph for this function:

◆ getCommandFromQueryToken()

ilStudyProgrammeTypeGUI::getCommandFromQueryToken ( string $default )

protected

Definition at line 89 of file class.ilStudyProgrammeTypeGUI.php.

                                                                : string
    {
        if($this->request_wrapper->has($this->action_token->getName())) {
            return $this->request_wrapper->retrieve($this->action_token->getName(), $this->refinery->to()->string());
        }
        return $default;
    }

Referenced by executeCommand().

Here is the caller graph for this function:

◆ getIconForm()

ilStudyProgrammeTypeGUI::getIconForm	(	?string	$section_title = `null`,
		?string	$current_identifier = `null`
	)

protected

Definition at line 225 of file class.ilStudyProgrammeTypeGUI.php.

     : StandardForm {
        $handler_gui = new ilStudyProgrammeTypeUploadHandlerGUI();
 
        $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('prg_type_custom_icon'),
            $this->lng->txt('prg_type_custom_icon_info')
        );
 
        $this->ctrl->setParameter($this, $this->id_token->getName(), $this->getTypeIdFromQueryToken());
        $this->ctrl->setParameter($this, $this->action_token->getName(), 'updateCustomIcons');
        $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;
    }

◆ getInstalledLanguages()

ilStudyProgrammeTypeGUI::getInstalledLanguages ( )

protected

Definition at line 514 of file class.ilStudyProgrammeTypeGUI.php.

                                              : array
    {
        if (is_null($this->installed_languages)) {
            $this->installed_languages = $this->lng->getInstalledLanguages();
        }
 
        return $this->installed_languages;
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getTypeIdFromQueryToken()

ilStudyProgrammeTypeGUI::getTypeIdFromQueryToken ( )

protected

Definition at line 97 of file class.ilStudyProgrammeTypeGUI.php.

                                                : int
    {
        if($this->request_wrapper->has($this->id_token->getName())) {
            $type_id = $this->request_wrapper->retrieve(
                $this->id_token->getName(),
                $this->refinery->byTrying([
                    $this->refinery->kindlyTo()->int(),
                    $this->refinery->custom()->transformation(static fn($v): int => (int)current($v)),
                ])
            );
            return $type_id;
        }
        throw new \Exception('No type id found in query.');
    }

Referenced by executeCommand(), and setSubTabsEdit().

Here is the caller graph for this function:

◆ getUrl()

ilStudyProgrammeTypeGUI::getUrl	(	string	$action,
		?int	$type_id = `null`
	)

protected

Definition at line 112 of file class.ilStudyProgrammeTypeGUI.php.

                                                                   : string
    {
        $url_builder = $this->url_builder->withParameter($this->action_token, $action);
        if($type_id) {
            $url_builder = $url_builder->withParameter($this->id_token, [$type_id]);
        }
        return $url_builder->buildURI()->__toString();
    }

References $url_builder, ILIAS\UI\URLBuilder\buildURI(), and ILIAS\UI\URLBuilder\withParameter().

Here is the call graph for this function:

◆ listTypes()

ilStudyProgrammeTypeGUI::listTypes ( )

protected

Definition at line 332 of file class.ilStudyProgrammeTypeGUI.php.

                                  : void
    {
        $table = $this->type_repository->getTable();
 
        if ($this->access->checkAccess("write", "", $this->parent_gui->getObject()->getRefId())) {
            $link = $this->ui_factory->link()->standard(
                $this->lng->txt('prg_subtype_add'),
                $this->getUrl('add')
            );
            $this->toolbar->addComponent($link);
 
            $actions = [
                'edit' => $this->ui_factory->table()->action()->single(
                    $this->lng->txt('edit'),
                    $this->url_builder->withParameter($this->action_token, "edit"),
                    $this->id_token
                ),
                'delete' => $this->ui_factory->table()->action()->single(
                    $this->lng->txt('delete'),
                    $this->url_builder->withParameter($this->action_token, "delete"),
                    $this->id_token
                )
            ];
            $table = $table->withActions($actions);
        }
 
        $this->tpl->setContent(
            $this->renderer->render($table->withRequest($this->request))
        );
    }

References ILIAS\Repository\access(), ILIAS\Repository\lng(), renderer(), and ILIAS\Repository\toolbar().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setParentGUI()

ilStudyProgrammeTypeGUI::setParentGUI ( $parent_gui )

Definition at line 184 of file class.ilStudyProgrammeTypeGUI.php.

                                             : void
    {
        $this->parent_gui = $parent_gui;
    }

References $parent_gui.

◆ setSubTabsEdit()

ilStudyProgrammeTypeGUI::setSubTabsEdit ( string $active_tab_id )

protected

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

                                                            : void
    {
        $type_id = $this->getTypeIdFromQueryToken();
        $this->tabs->addSubTab(
            'general',
            $this->lng->txt('meta_general'),
            $this->getUrl('edit', $type_id)
        );
 
        if ($this->ilias->getSetting('custom_icons')) {
            $this->tabs->addSubTab(
                'custom_icons',
                $this->lng->txt('icon_settings'),
                $this->getUrl('editCustomIcons', $type_id)
            );
        }
 
        if (count($this->type_repository->getAllAMDRecordIds()) > 0) {
            $this->tabs->addSubTab(
                'amd',
                $this->lng->txt('md_advanced'),
                $this->getUrl('editAMD', $type_id)
            );
        }
 
        $this->tabs->activateSubTab($active_tab_id);
    }

References getTypeIdFromQueryToken(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilStudyProgrammeTypeGUI::update ( )

protected

Definition at line 426 of file class.ilStudyProgrammeTypeGUI.php.

                               : void
    {
        $type_id = $this->getTypeIdFromQueryToken();
        $form = $this->buildForm(
            $this->getUrl('update', $type_id),
            $this->lng->txt('prg_type_edit')
        )->withRequest($this->request);
 
        $result = $form->getData();
        if (!is_null($result)) {
            $type = $this->type_repository->getType($type_id);
            $this->updateTypeFromFormResult($type, $result);
            $this->tpl->setOnScreenMessage("success", $this->lng->txt('msg_obj_modified'), true);
            $this->ctrl->redirect($this, 'view');
        } else {
            $this->tpl->setOnScreenMessage("failure", $this->lng->txt("msg_fill_required"), true);
            $this->tpl->setContent($this->renderer->render($form));
        }
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateAMD()

ilStudyProgrammeTypeGUI::updateAMD ( )

protected

Definition at line 313 of file class.ilStudyProgrammeTypeGUI.php.

                                  : void
    {
        $type_id = $this->getTypeIdFromQueryToken();
        $type = $this->type_repository->getType($type_id);
        $form = new ilStudyProgrammeTypeAdvancedMetaDataFormGUI(
            $this->getUrl('updateAMD', $type_id),
            $this->type_repository,
            $this->tpl,
            $this->lng
        );
 
        if ($form->saveObject($type)) {
            $this->tpl->setOnScreenMessage("success", $this->lng->txt('msg_obj_modified'), true);
            $this->ctrl->redirectToURL($this->getUrl('editAMD', $type_id));
        } else {
            $this->tpl->setContent($form->getHTML());
        }
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCustomIcons()

ilStudyProgrammeTypeGUI::updateCustomIcons ( )

protected

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

                                          : void
    {
        $type_id = $this->getTypeIdFromQueryToken();
        $type = $this->type_repository->getType($type_id);
 
        $data = $this->getIconForm()
            ->withRequest($this->request)
            ->getData();
 
        if($data) {
            $type = $type->withIconIdentifier(current($data));
            $this->tpl->setOnScreenMessage("success", $this->lng->txt('msg_obj_modified'), true);
        } else {
            if($identifier = $type->getIconIdentifier()) {
                $this->type_repository->removeIconFromIrss($identifier);
            }
            $type = $type->withIconIdentifier(null);
            $this->tpl->setOnScreenMessage("success", $this->lng->txt('icon_removed'), true);
        }
        $this->type_repository->updateType($type);
        $type->updateAssignedStudyProgrammesIcons();
        $this->ctrl->redirectToURL($this->getUrl('editCustomIcons', $type_id));
    }