Class ilStudyProgrammeTypeFormGUI. More...

Inheritance diagram for ilStudyProgrammeTypeFormGUI:

Collaboration diagram for ilStudyProgrammeTypeFormGUI:

Public Member Functions
	__construct ($parent_gui, ilStudyProgrammeType $type)

	saveObject ()
	Save object (create or update) More...

Public Member Functions inherited from ilPropertyFormGUI
	__construct ()
	Constructor. More...

	executeCommand ()
	Execute command. More...

	setTableWidth ($a_width)
	Set table width. More...

	getTableWidth ()
	get table width More...

	setMode ($a_mode)
	Set Mode ('std', 'subform'). More...

	getMode ()
	Get Mode ('std', 'subform'). More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setTitleIcon ($a_titleicon)
	Set TitleIcon. More...

	getTitleIcon ()
	Get TitleIcon. More...

	setDescription ($a_val)
	Set description. More...

	getDescription ()
	Get description. More...

	setTopAnchor ($a_val)
	Set top anchor. More...

	getTopAnchor ()
	Get top anchor. More...

	setShowTopButtons ($a_val)
	Get show top buttons. More...

	getShowTopButtons ()
	Set show top buttons. More...

	addItem ($a_item)
	Add Item (Property, SectionHeader). More...

	removeItemByPostVar ($a_post_var, $a_remove_unused_headers=false)
	Remove Item. More...

	getItemByPostVar ($a_post_var)
	Get Item by POST variable. More...

	setItems ($a_items)
	Set Items. More...

	getItems ()
	Get Items. More...

	getInputItemsRecursive ()
	returns a flat array of all input items including the possibly existing subitems recursively More...

	setDisableStandardMessage ($a_val)
	Set disable standard message. More...

	getDisableStandardMessage ()
	Get disable standard message. More...

	getHideLabels ()
	Get a value indicating whether the labels should be hidden or not. More...

	setHideLabels ($a_value=true)
	Set a value indicating whether the labels should be hidden or not. More...

	setValuesByArray ($a_values, $a_restrict_to_value_keys=false)
	Set form values from an array. More...

	setValuesByPost ()
	Set form values from POST values. More...

	checkInput ()
	Check Post Input. More...

	getInput ($a_post_var, $ensureValidation=true)
	Returns the value of a HTTP-POST variable, identified by the passed id. More...

	addCustomProperty ( $a_title, $a_html, $a_info="", $a_alert="", $a_required=false)
	Add a custom property. More...

	addCommandButton ($a_cmd, $a_text, $a_id="")
	Add Command button. More...

	getCommandButtons ()
	Return all Command buttons. More...

	clearCommandButtons ()
	Remove all command buttons. More...

	getContent ()
	Get Content. More...

	insertItem ($item, $a_sub_item=false)

	getHTML ()

	getFileUpload ($a_field, $a_index=null, $a_sub_index=null)
	Get file upload data. More...

	hasFileUpload ($a_field, $a_index=null, $a_sub_index=null)
	Was any file uploaded? More...

	moveFileUpload ($a_target_directory, $a_field, $a_target_name=null, $a_index=null, $a_sub_index=null)
	Move upload to target directory. More...

Public Member Functions inherited from ilFormGUI
	setFormAction ($a_formaction)
	Set FormAction. More...

	getFormAction ()
	Get FormAction. More...

	setTarget ($a_target)
	Set Target. More...

	getTarget ()
	Get Target. More...

	setMultipart ($a_multipart)
	Set Enctype Multipart/Formdata true/false. More...

	getMultipart ()
	Get Enctype Multipart/Formdata true/false. More...

	setId ($a_id)
	Set Id. More...

	getId ()
	Get Id. More...

	setName ($a_name)
	Set Name. More...

	getName ()
	Get Name. More...

	setKeepOpen ($a_keepopen)
	Set Keep Form Tag Open. More...

	getKeepOpen ()
	Get Keep Form Tag Open. More...

	setOpenTag ($a_open)
	Enable/Disable Open Form Tag. More...

	getOpenTag ()
	Get Open Form Tag Enabled. More...

	setCloseTag ($a_val)
	Set close tag. More...

	getCloseTag ()
	Get close tag. More...

	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...

	getPreventDoubleSubmission ()
	Get prevent double submission. More...

	getHTML ()
	Get HTML. More...

	getContent ()
	Get Content. More...

Protected Member Functions
	initForm ()
	Add all fields to the form. More...

	fillObject ()
	Check validity of form and pass values from form to object. More...

	addTranslationInputs ($a_lang_code)
	Add a text and textarea input per language. More...

Protected Member Functions inherited from ilPropertyFormGUI
	hideRequired ($a_type)

	rebuildUploadedFiles ()
	try to rebuild files More...

Protected Attributes
	$type

	$tpl

	$lng

	$ctrl

	$parent_gui

Protected Attributes inherited from ilPropertyFormGUI
	$lng

	$ctrl

	$tpl

	$user

	$settings

	$mode = "std"

	$check_input_called = false

	$disable_standard_message = false

	$top_anchor = "il_form_top"

	$titleicon = false

	$description = ""

	$tbl_width = false

	$show_top_buttons = true

	$hide_labels = false

Protected Attributes inherited from ilFormGUI
	$formaction

	$multipart = false

	$keepopen = false

	$opentag = true

	$id

	$name

	$prevent_double_submission = false

Detailed Description

Class ilStudyProgrammeTypeFormGUI.

Author: Stefan Wanzenried sw@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

Definition at line 10 of file class.ilStudyProgrammeTypeFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeTypeFormGUI::__construct	(		$parent_gui,
		ilStudyProgrammeType	$type
	)

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

References $DIC, $ilCtrl, $lng, $parent_gui, $tpl, $type, and initForm().

     {
         global $DIC;
         $tpl = $DIC['tpl'];
         $ilCtrl = $DIC['ilCtrl'];
         $lng = $DIC['lng'];
         $this->parent_gui = $parent_gui;
         $this->type = $type;
         $this->tpl = $tpl;
         $this->ctrl = $ilCtrl;
         $this->lng = $lng;
         $this->lng->loadLanguageModule('meta');
         $this->lng->loadLanguageModule('prg');
         
         $this->initForm();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addTranslationInputs()

ilStudyProgrammeTypeFormGUI::addTranslationInputs ( $a_lang_code )

protected

Add a text and textarea input per language.

Parameters

$a_lang_code

Definition at line 145 of file class.ilStudyProgrammeTypeFormGUI.php.

References $section, ilPropertyFormGUI\addItem(), ilTextInputGUI\setValue(), and ilTextAreaInputGUI\setValue().

Referenced by initForm().

     {
         $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}");
         $item->setValue($this->type->getDescription($a_lang_code));
         $this->addItem($item);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillObject()

ilStudyProgrammeTypeFormGUI::fillObject ( )

protected

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

Returns: bool

Definition at line 117 of file class.ilStudyProgrammeTypeFormGUI.php.

References ilPropertyFormGUI\$description, $success, $title, ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), ilUtil\sendFailure(), and ilPropertyFormGUI\setValuesByPost().

Referenced by saveObject().

     {
         $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 (ilStudyProgrammeTypePluginException $e) {
             ilUtil::sendFailure($e->getMessage());
             $success = false;
         }
         return $success;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initForm()

ilStudyProgrammeTypeFormGUI::initForm ( )

protected

Add all fields to the form.

Definition at line 79 of file class.ilStudyProgrammeTypeFormGUI.php.

References $languages, PHPMailer\PHPMailer\$options, $title, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), addTranslationInputs(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Referenced by __construct().

     {
         $this->setFormAction($this->ctrl->getFormAction($this->parent_gui));
         $title = $this->type->getId() ? $this->lng->txt('prg_type_edit') : $this->lng->txt('prg_type_add');
         $this->setTitle($title);
         $item = new ilSelectInputGUI($this->lng->txt('default_language'), 'default_lang');
         $languages = $this->lng->getInstalledLanguages();
         $options = array();
         foreach ($languages as $lang_code) {
             $options[$lang_code] = $this->lng->txt("meta_l_{$lang_code}");
         }
         $item->setOptions($options);
         $type_default = $this->type->getDefaultLang();
         if (in_array($type_default, $languages)) {
             $item->setValue($type_default);
         } else {
             $item->setValue($this->lng->getDefaultLanguage());
         }
         $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'));
         }
         $this->addCommandButton('cancel', $this->lng->txt('cancel'));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveObject()

ilStudyProgrammeTypeFormGUI::saveObject ( )

Save object (create or update)

Returns: bool

Definition at line 62 of file class.ilStudyProgrammeTypeFormGUI.php.

References fillObject(), and ilUtil\sendFailure().

     {
         if (!$this->fillObject()) {
             return false;
         }
         try {
             $this->type->save();
             return true;
         } catch (ilException $e) {
             ilUtil::sendFailure($e->getMessage());
             return false;
         }
     }