ilOrgUnitTypeFormGUI Class Reference

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

Inheritance diagram for ilOrgUnitTypeFormGUI:

Collaboration diagram for ilOrgUnitTypeFormGUI:

Public Member Functions
	__construct (ilOrgUnitTypeGUI $parent_gui, ilOrgUnitType $type)
	saveObject ()
	Save object (create or update) More...
Public Member Functions inherited from ilPropertyFormGUI
	__construct ()
	executeCommand ()
	setTableWidth (string $a_width)
	getTableWidth ()
	setMode (string $a_mode)
	getMode ()
	setTitle (string $a_title)
	getTitle ()
	setTitleIcon (string $a_titleicon)
	getTitleIcon ()
	setDescription (string $a_val)
	getDescription ()
	setTopAnchor (string $a_val)
	getTopAnchor ()
	setShowTopButtons (bool $a_val)
	getShowTopButtons ()
	setForceTopButtons (bool $a_val)
	getForceTopButtons ()
	addItem ($a_item)
	removeItemByPostVar (string $a_post_var, bool $a_remove_unused_headers=false)
	getItemByPostVar (string $a_post_var)
	setItems (array $a_items)
	getItems ()
	getInputItemsRecursive ()
	returns a flat array of all input items including the possibly existing subitems recursively More...
	setDisableStandardMessage (bool $a_val)
	getDisableStandardMessage ()
	getHideLabels ()
	setHideLabels (bool $a_value=true)
	setValuesByArray (array $a_values, bool $a_restrict_to_value_keys=false)
	setValuesByPost ()
	checkInput ()
	getInput (string $a_post_var, bool $ensureValidation=true)
	Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-POST variable, identified by the passed postvar. More...
	addCommandButton (string $a_cmd, string $a_text, string $a_id="")
	getCommandButtons ()
	clearCommandButtons ()
	getContent ()
	insertItem ( $item, bool $a_sub_item=false)
	addAsyncOnloadCode (string $code)
	getHTML ()
	getHTMLAsync ()
	getFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)
	Get file upload data. More...
	hasFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)
	moveFileUpload (string $a_target_directory, string $a_field, ?string $a_target_name=null, ?string $a_index=null, ?string $a_sub_index=null)
	Move upload to target directory. More...
Public Member Functions inherited from ilFormGUI
	setFormAction (string $a_formaction)
	getFormAction ()
	setTarget (string $a_target)
	getTarget ()
	setMultipart (bool $a_multipart)
	getMultipart ()
	setId (string $a_id)
	getId ()
	setName (string $a_name)
	getName ()
	setKeepOpen (bool $a_keepopen)
	getKeepOpen ()
	setOpenTag (bool $a_open)
	getOpenTag ()
	setCloseTag (bool $a_val)
	getCloseTag ()
	setPreventDoubleSubmission (bool $a_val)
	getPreventDoubleSubmission ()
	getHTML ()
	getContent ()

Protected Attributes
ilOrgUnitType	$type
ilOrgUnitTypeGUI	$parent_gui
Protected Attributes inherited from ilPropertyFormGUI
bool	$required_text = false
ilLanguage	$lng
ilCtrl	$ctrl
ilTemplate	$tpl
ilObjUser	$user = null
ilSetting	$settings = null
string	$mode = "std"
bool	$check_input_called = false
bool	$disable_standard_message = false
string	$top_anchor = "il_form_top"
string	$title = ''
string	$titleicon = ""
string	$description = ""
string	$tbl_width = ""
bool	$show_top_buttons = true
bool	$hide_labels = false
bool	$force_top_buttons = false
HTTP Services	$http
Refinery Factory	$refinery = null
ilGlobalTemplateInterface	$global_tpl = null
	$onload_code = []
Protected Attributes inherited from ilFormGUI
string	$formaction = ""
bool	$multipart = false
bool	$keepopen = false
bool	$opentag = true
string	$id = ''
string	$name = ''
string	$target = ''
bool	$prevent_double_submission = false

Private Member Functions
	initForm ()
	Add all fields to the form. More...
	fillObject ()
	Check validity of form and pass values from form to object. More...
	addTranslationInputs (string $a_lang_code)
	Add a text and textarea input per language. More...

Additional Inherited Members
Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()
	getFileHash ()
	hideRequired (string $a_type)
	appendOnloadCode (string $html)
	rebuildUploadedFiles ()

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 ilOrgUnitTypeFormGUI

Author

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

Definition at line 23 of file class.ilOrgUnitTypeFormGUI.php.

Constructor & Destructor Documentation

__construct()

ilOrgUnitTypeFormGUI::__construct	(	ilOrgUnitTypeGUI	$parent_gui,
		ilOrgUnitType	$type
	)

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

References $DIC, $parent_gui, $type, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), initForm(), and ILIAS\Repository\lng().

    {
        global $DIC;
        $this->parent_gui = $parent_gui;
        $this->type = $type;
        //$this->tpl =  $DIC->ui()->mainTemplate();
        $this->global_tpl =  $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('meta');
        $this->initForm();
        $this->http = $DIC->http();
    }

Here is the call graph for this function:

Member Function Documentation

addTranslationInputs()

ilOrgUnitTypeFormGUI::addTranslationInputs ( string  $a_lang_code )

private

Add a text and textarea input per language.

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

References ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), and ilTextAreaInputGUI\setValue().

Referenced by initForm().

                                                              : void
    {
        $a_lang_code = $a_lang_code ?? '';
        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt("meta_l_{$a_lang_code}"));
        $this->addItem($section);
        $item = new ilTextInputGUI($this->lng->txt('title'), "title_{$a_lang_code}");
        $item->setValue($this->type->getTitle($a_lang_code));
        $this->addItem($item);
        $item = new ilTextAreaInputGUI($this->lng->txt('description'), "description_{$a_lang_code}");
        $desc = $this->type->getDescription($a_lang_code) ?? '';
        $item->setValue($desc);
        $this->addItem($item);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillObject()

ilOrgUnitTypeFormGUI::fillObject ( )

private

Check validity of form and pass values from form to object.

Definition at line 95 of file class.ilOrgUnitTypeFormGUI.php.

References ilPropertyFormGUI\$description, Vendor\Package\$e, ilPropertyFormGUI\$title, ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), ILIAS\Repository\lng(), and ilPropertyFormGUI\setValuesByPost().

Referenced by saveObject().

                                 : bool
    {
        $this->setValuesByPost();
        if (!$this->checkInput()) {
            return false;
        }

        $success = true;
        try {
            $this->type->setDefaultLang($this->getInput('default_lang'));
            foreach ($this->lng->getInstalledLanguages() as $lang_code) {
                $title = $this->getInput("title_{$lang_code}");
                $description = $this->getInput("description_{$lang_code}");
                $this->type->setTitle($title, $lang_code);
                $this->type->setDescription($description, $lang_code);
            }
        } catch (ilOrgUnitTypePluginException $e) {
            $this->global_tpl->setOnScreenMessage('failure', $e->getMessage());
            $success = false;
        }

        return $success;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilOrgUnitTypeFormGUI::initForm ( )

private

Add all fields to the form.

Definition at line 65 of file class.ilOrgUnitTypeFormGUI.php.

References ilPropertyFormGUI\$title, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), addTranslationInputs(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Referenced by __construct().

                               : void
    {
        $this->setFormAction($this->ctrl->getFormAction($this->parent_gui));
        $title = $this->type->getId() ? $this->lng->txt('orgu_type_edit') : $this->lng->txt('orgu_type_add');
        $this->setTitle($title);
        $item = new ilSelectInputGUI($this->lng->txt('default_language'), 'default_lang');
        $item->setValue($this->type->getDefaultLang());
        $languages = $this->lng->getInstalledLanguages();
        $options = array();
        foreach ($languages as $lang_code) {
            $options[$lang_code] = $this->lng->txt("meta_l_{$lang_code}");
        }
        $item->setOptions($options);
        $item->setRequired(true);
        $this->addItem($item);

        foreach ($languages as $lang_code) {
            $this->addTranslationInputs($lang_code);
        }

        if ($this->type->getId()) {
            $this->addCommandButton('update', $this->lng->txt('save'));
        } else {
            $this->addCommandButton('create', $this->lng->txt('create'));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveObject()

ilOrgUnitTypeFormGUI::saveObject

(

)

Save object (create or update)

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

References Vendor\Package\$e, and fillObject().

                                : bool
    {
        if (!$this->fillObject()) {
            return false;
        }
        try {
            $this->type->save();

            return true;
        } catch (ilException $e) {
            $this->global_tpl->setOnScreenMessage('failure', $e->getMessage());

            return false;
        }
    }

Here is the call graph for this function:

Field Documentation

$parent_gui

ilOrgUnitTypeGUI ilOrgUnitTypeFormGUI::$parent_gui

protected

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

Referenced by __construct().

$type

ilOrgUnitType ilOrgUnitTypeFormGUI::$type

protected

Definition at line 25 of file class.ilOrgUnitTypeFormGUI.php.

Referenced by __construct().

---

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

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