ilStudyProgrammeTypeGUI Class Reference

Collaboration diagram for ilStudyProgrammeTypeGUI:

Public Member Functions
	__construct (ilGlobalTemplateInterface $tpl, ilCtrl $ilCtrl, ilAccess $ilAccess, ilToolbarGUI $ilToolbar, ilLanguage $lng, ILIAS $ilias, ilTabsGUI $ilTabs, ilObjUser $user, ilStudyProgrammeTypeRepository $type_repository, Input\Factory $input_factory, Renderer $renderer, Psr\Http\Message\ServerRequestInterface $request, Refinery\Factory $refinery_factory, Filesystem $web_dir, RequestWrapper $request_wrapper)
	executeCommand ()
	setParentGUI ($parent_gui)

Data Fields
ilGlobalTemplateInterface	$tpl
ilCtrl	$ctrl

Protected Member Functions
	checkAccess ()
	setSubTabsEdit (string $active_tab_id)
	editCustomIcons ()
	updateCustomIcons ()
	editAMD ()
	updateAMD ()
	listTypes ()
	add ()
	edit ()
	create ()
	update ()
	delete ()
	buildForm (string $submit_action, string $type_action, ilStudyProgrammeType $type=null)
	buildModalHeading (string $title, string $default_lng)
	buildLanguagesForms (ilStudyProgrammeType $type=null)
	getInstalledLanguages ()

Protected Attributes
ilAccess	$access
ilToolbarGUI	$toolbar
ilLanguage	$lng
ILIAS	$ilias
ilTabsGUI	$tabs
ilObjUser	$user
ilStudyProgrammeTypeRepository	$type_repository
Input Factory	$input_factory
Renderer	$renderer
Psr Http Message ServerRequestInterface	$request
Refinery Factory	$refinery_factory
	$parent_gui
array	$installed_languages = null
Filesystem	$web_dir
RequestWrapper	$request_wrapper

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 35 of file class.ilStudyProgrammeTypeGUI.php.

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeTypeGUI::__construct	(	ilGlobalTemplateInterface	$tpl,
		ilCtrl	$ilCtrl,
		ilAccess	$ilAccess,
		ilToolbarGUI	$ilToolbar,
		ilLanguage	$lng,
		ILIAS	$ilias,
		ilTabsGUI	$ilTabs,
		ilObjUser	$user,
		ilStudyProgrammeTypeRepository	$type_repository,
		Input\Factory	$input_factory,
		Renderer	$renderer,
		Psr\Http\Message\ServerRequestInterface	$request,
		Refinery\Factory	$refinery_factory,
		Filesystem	$web_dir,
		RequestWrapper	$request_wrapper
	)

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

References $ilias, $input_factory, $lng, $refinery_factory, $renderer, $request, $request_wrapper, $tpl, $type_repository, $user, $web_dir, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

      {
        $this->tpl = $tpl;
        $this->ctrl = $ilCtrl;
        $this->access = $ilAccess;
        $this->toolbar = $ilToolbar;
        $this->tabs = $ilTabs;
        $this->user = $user;
        $this->lng = $lng;
        $this->ilias = $ilias;
        $this->type_repository = $type_repository;
        $this->input_factory = $input_factory;
        $this->renderer = $renderer;
        $this->request = $request;
        $this->refinery_factory = $refinery_factory;
        $this->web_dir = $web_dir;
        $this->request_wrapper = $request_wrapper;

        $this->lng->loadLanguageModule('prg');
        $this->ctrl->saveParameter($this, 'type_id');
        $this->lng->loadLanguageModule('meta');
    }

Here is the call graph for this function:

Member Function Documentation

add()

ilStudyProgrammeTypeGUI::add ( )

protected

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

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

Referenced by executeCommand().

                            : void
    {
        $form = $this->buildForm(
            $this->ctrl->getFormActionByClass(
                __CLASS__,
                'create'
            ),
            $this->lng->txt('prg_type_add')
        );

        $this->tpl->setContent($this->renderer->render($form));
    }

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, ilStudyProgrammeType  $type = null  )

protected

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

References buildLanguagesForms(), buildModalHeading(), and ilStudyProgrammeType\getDefaultLang().

Referenced by add(), create(), edit(), and update().

     : Input\Container\Form\Form {
        $default_lng = "";
        if (!is_null($type)) {
            $default_lng = $type->getDefaultLang();
        }

        return $this->input_factory->container()->form()->standard(
            $submit_action,
            [
                "default_lang" => $this->buildModalHeading($type_action, $default_lng),
                "info" => $this->buildLanguagesForms($type)
            ]
        )->withAdditionalTransformation(
            $this->refinery_factory->custom()->transformation(
                function ($values) {
                    return [
                        'default_lang' => $values['default_lang']['default_lang'],
                        'info' => $values['info']
                    ];
                }
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildLanguagesForms()

ilStudyProgrammeTypeGUI::buildLanguagesForms ( ilStudyProgrammeType  $type = null )

protected

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

References $lng, $refinery_factory, ilStudyProgrammeType\getDescription(), getInstalledLanguages(), and ilStudyProgrammeType\getTitle().

Referenced by buildForm().

                                                                             : 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_factory
            );
        }

        return $this->input_factory->field()->group($return);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildModalHeading()

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

protected

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

References getInstalledLanguages(), ILIAS\Repository\lng(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by buildForm().

                                                                            : 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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkAccess()

ilStudyProgrammeTypeGUI::checkAccess ( )

protected

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

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

Referenced by executeCommand().

                                    : 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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

create()

ilStudyProgrammeTypeGUI::create ( )

protected

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

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

Referenced by executeCommand().

                               : void
    {
        $form = $this->buildForm(
            $this->ctrl->getFormActionByClass(
                __CLASS__,
                '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));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilStudyProgrammeTypeGUI::delete ( )

protected

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

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

                               : void
    {
        $type_id = $this->request_wrapper->retrieve("type_id", $this->refinery_factory->kindlyTo()->int());
        $type = $this->type_repository->getType($type_id);
        try {
            $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);
        }
    }

Here is the call graph for this function:

edit()

ilStudyProgrammeTypeGUI::edit ( )

protected

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

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

Referenced by executeCommand().

                             : void
    {
        $type_id = $this->request_wrapper->retrieve("type_id", $this->refinery_factory->kindlyTo()->int());
        $type = $this->type_repository->getType($type_id);

        $form = $this->buildForm(
            $this->ctrl->getFormActionByClass(
                __CLASS__,
                'update'
            ),
            $this->lng->txt('prg_type_edit'),
            $type
        );

        $this->tpl->setContent($this->renderer->render($form));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editAMD()

ilStudyProgrammeTypeGUI::editAMD ( )

protected

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

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

Referenced by executeCommand().

                                : void
    {
        $form = new ilStudyProgrammeTypeAdvancedMetaDataFormGUI(
            $this,
            $this->type_repository,
            $this->ctrl,
            $this->tpl,
            $this->lng
        );
        $type_id = $this->request_wrapper->retrieve("type_id", $this->refinery_factory->kindlyTo()->int());
        $form->fillForm($this->type_repository->getType($type_id));
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editCustomIcons()

ilStudyProgrammeTypeGUI::editCustomIcons ( )

protected

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

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

Referenced by executeCommand().

                                        : void
    {
        $form = new ilStudyProgrammeTypeCustomIconsFormGUI(
            $this,
            $this->type_repository,
            $this->ctrl,
            $this->tpl,
            $this->lng,
            $this->user,
            $this->web_dir
        );
        $form->fillForm($this->type_repository->getType(
            $this->request_wrapper->retrieve("type_id", $this->refinery_factory->kindlyTo()->int())
        ));
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilStudyProgrammeTypeGUI::executeCommand

(

)

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

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

                                    : void
    {
        $this->checkAccess();
        $cmd = $this->ctrl->getCmd();
        switch ($cmd) {
            case '':
            case 'view':
            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;
            case 'cancel':
                $this->ctrl->redirect($this->parent_gui);
                break;
            default:
                throw new LogicException("Unknown command: $cmd");
        }
    }

Here is the call graph for this function:

getInstalledLanguages()

ilStudyProgrammeTypeGUI::getInstalledLanguages ( )

protected

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

References $installed_languages, and ILIAS\Repository\lng().

Referenced by buildLanguagesForms(), and buildModalHeading().

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

        return $this->installed_languages;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listTypes()

ilStudyProgrammeTypeGUI::listTypes ( )

protected

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

References $access, $ctrl, $lng, $tabs, $type_repository, $web_dir, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), and ILIAS\Repository\toolbar().

Referenced by executeCommand().

                                  : void
    {
        if ($this->access->checkAccess("write", "", $this->parent_gui->getObject()->getRefId())) {
            $button = ilLinkButton::getInstance();
            $button->setCaption('prg_subtype_add');
            $button->setUrl($this->ctrl->getLinkTarget($this, 'add'));
            $this->toolbar->addButtonInstance($button);
        }
        $table = new ilStudyProgrammeTypeTableGUI(
            $this,
            'listTypes',
            $this->parent_gui->getObject()->getRefId(),
            $this->type_repository,
            $this->ctrl,
            $this->tabs,
            $this->access,
            $this->lng,
            $this->web_dir
        );
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setParentGUI()

ilStudyProgrammeTypeGUI::setParentGUI

(

$parent_gui

)

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

References $parent_gui.

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

setSubTabsEdit()

ilStudyProgrammeTypeGUI::setSubTabsEdit ( string  $active_tab_id )

protected

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

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

Referenced by executeCommand().

                                                            : void
    {
        $this->tabs->addSubTab(
            'general',
            $this->lng->txt('meta_general'),
            $this->ctrl->getLinkTarget($this, 'edit')
        );

        if ($this->ilias->getSetting('custom_icons')) {
            $this->tabs->addSubTab(
                'custom_icons',
                $this->lng->txt('icon_settings'),
                $this->ctrl->getLinkTarget($this, 'editCustomIcons')
            );
        }

        if (count($this->type_repository->getAllAMDRecordIds()) > 0) {
            $this->tabs->addSubTab(
                'amd',
                $this->lng->txt('md_advanced'),
                $this->ctrl->getLinkTarget($this, 'editAMD')
            );
        }

        $this->tabs->activateSubTab($active_tab_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilStudyProgrammeTypeGUI::update ( )

protected

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

References $type, buildForm(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilStudyProgrammeType\setDefaultLang(), ilStudyProgrammeType\setDescription(), and ilStudyProgrammeType\setTitle().

Referenced by executeCommand().

                               : void
    {
        $type_id = $this->request_wrapper->retrieve("type_id", $this->refinery_factory->kindlyTo()->int());
        $type = $this->type_repository->getType($type_id);
        $form = $this->buildForm(
            $this->ctrl->getFormActionByClass(
                __CLASS__,
                'update'
            ),
            $this->lng->txt('prg_type_edit'),
            $type
        )->withRequest($this->request);

        $result = $form->getData();
        if (!is_null($result)) {
            $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));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateAMD()

ilStudyProgrammeTypeGUI::updateAMD ( )

protected

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

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

Referenced by executeCommand().

                                  : void
    {
        $form = new ilStudyProgrammeTypeAdvancedMetaDataFormGUI(
            $this,
            $this->type_repository,
            $this->ctrl,
            $this->tpl,
            $this->lng
        );
        $type_id = $this->request_wrapper->retrieve("type_id", $this->refinery_factory->kindlyTo()->int());
        if ($form->saveObject($this->type_repository->getType($type_id))) {
            $this->tpl->setOnScreenMessage("success", $this->lng->txt('msg_obj_modified'), true);
            $this->ctrl->redirect($this, 'editAMD');
        } else {
            $this->tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateCustomIcons()

ilStudyProgrammeTypeGUI::updateCustomIcons ( )

protected

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

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

Referenced by executeCommand().

                                          : void
    {
        $form = new ilStudyProgrammeTypeCustomIconsFormGUI(
            $this,
            $this->type_repository,
            $this->ctrl,
            $this->tpl,
            $this->lng,
            $this->user,
            $this->web_dir
        );
        $type_id = $this->request_wrapper->retrieve("type_id", $this->refinery_factory->kindlyTo()->int());
        if ($form->saveObject($this->type_repository->getType($type_id))) {
            $this->tpl->setOnScreenMessage("success", $this->lng->txt('msg_obj_modified'), true);
            $this->ctrl->redirect($this, 'editCustomIcons');
        } 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

ilAccess ilStudyProgrammeTypeGUI::$access

protected

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

Referenced by listTypes().

$ctrl

ilCtrl ilStudyProgrammeTypeGUI::$ctrl

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

Referenced by listTypes().

$ilias

ILIAS ilStudyProgrammeTypeGUI::$ilias

protected

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

Referenced by __construct().

$input_factory

Input Factory ilStudyProgrammeTypeGUI::$input_factory

protected

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

Referenced by __construct().

$installed_languages

array ilStudyProgrammeTypeGUI::$installed_languages = null

protected

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

Referenced by getInstalledLanguages().

$lng

ilLanguage ilStudyProgrammeTypeGUI::$lng

protected

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

Referenced by __construct(), buildLanguagesForms(), and listTypes().

$parent_gui

ilStudyProgrammeTypeGUI::$parent_gui

protected

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

Referenced by setParentGUI().

$refinery_factory

Refinery Factory ilStudyProgrammeTypeGUI::$refinery_factory

protected

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

Referenced by __construct(), and buildLanguagesForms().

$renderer

Renderer ilStudyProgrammeTypeGUI::$renderer

protected

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

Referenced by __construct().

$request

Psr Http Message ServerRequestInterface ilStudyProgrammeTypeGUI::$request

protected

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

Referenced by __construct().

$request_wrapper

RequestWrapper ilStudyProgrammeTypeGUI::$request_wrapper

protected

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

Referenced by __construct().

$tabs

ilTabsGUI ilStudyProgrammeTypeGUI::$tabs

protected

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

Referenced by listTypes().

$toolbar

ilToolbarGUI ilStudyProgrammeTypeGUI::$toolbar

protected

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

$tpl

ilGlobalTemplateInterface ilStudyProgrammeTypeGUI::$tpl

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

Referenced by __construct().

$type_repository

ilStudyProgrammeTypeRepository ilStudyProgrammeTypeGUI::$type_repository

protected

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

Referenced by __construct(), and listTypes().

$user

ilObjUser ilStudyProgrammeTypeGUI::$user

protected

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

Referenced by __construct().

$web_dir

Filesystem ilStudyProgrammeTypeGUI::$web_dir

protected

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

Referenced by __construct(), and listTypes().

---

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

• Modules/StudyProgramme/classes/types/class.ilStudyProgrammeTypeGUI.php