Class ilStudyProgrammeTypeFormGUI. More...

Inheritance diagram for ilStudyProgrammeTypeCustomIconsFormGUI:

Collaboration diagram for ilStudyProgrammeTypeCustomIconsFormGUI:

Public Member Functions
	__construct ($parent_gui, ilStudyProgrammeTypeRepository $type_repo)

	saveObject (ilStudyProgrammeType $type)
	Save object (create or update) More...

	initForm ()

	fillForm (ilStudyProgrammeType $type)
	Add all fields to the form. 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...

	setForceTopButtons ($a_val)
	Set force top buttons. More...

	getForceTopButtons ()
	Get force 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 Attributes
	$type_repo

	$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

	$force_top_buttons = false

Protected Attributes inherited from ilFormGUI
	$formaction

	$multipart = false

	$keepopen = false

	$opentag = true

	$id

	$name

	$prevent_double_submission = false

Additional Inherited Members
Protected Member Functions inherited from ilPropertyFormGUI
	hideRequired ($a_type)

	rebuildUploadedFiles ()
	try to rebuild files More...

Detailed Description

Class ilStudyProgrammeTypeFormGUI.

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

Definition at line 11 of file class.ilStudyProgrammeTypeCustomIconsFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeTypeCustomIconsFormGUI::__construct	(		$parent_gui,
		ilStudyProgrammeTypeRepository	$type_repo
	)

Parameters

	$parent_gui
ilStudyProgrammeType	$type

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

References $DIC, $lng, $parent_gui, $tpl, $type_repo, initForm(), and user().

     {
         global $DIC;
         $tpl = $DIC['tpl'];
         $ilCtrl = $DIC['ilCtrl'];
         $lng = $DIC['lng'];
         $this->webdir = $DIC->filesystem()->web();
         $this->parent_gui = $parent_gui;
         $this->user = $DIC['ilUser'];
         $this->type_repo = $type_repo;
         $this->tpl = $tpl;
         $this->ctrl = $ilCtrl;
         $this->lng = $lng;
 
         $this->lng->loadLanguageModule('meta');
         $this->initForm();
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillForm()

ilStudyProgrammeTypeCustomIconsFormGUI::fillForm ( ilStudyProgrammeType $type )

Add all fields to the form.

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

References Vendor\Package\$e, $type, ilPropertyFormGUI\checkInput(), ilStudyProgrammeType\getIcon(), ilStudyProgrammeType\getIconPath(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), ilUtil\getWebspaceDir(), ilStudyProgrammeType\processAndStoreIconFile(), ilStudyProgrammeType\removeIconFile(), ilUtil\sendFailure(), ilStudyProgrammeType\setIcon(), and ilPropertyFormGUI\setValuesByPost().

     {
         $item = $this->getItemByPostVar('icon');
         if ($type->getIcon() != '' && $this->webdir->has($type->getIconPath(true))) {
             // TODO: that´s horrible, try to avoid ilUtil in future
             $item->setImage(ilUtil::getWebspaceDir() . '/' . $type->getIconPath(true));
         }
     }

Here is the call graph for this function:

◆ initForm()

ilStudyProgrammeTypeCustomIconsFormGUI::initForm ( )

Definition at line 81 of file class.ilStudyProgrammeTypeCustomIconsFormGUI.php.

References ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilFormGUI\setFormAction(), ilFileInputGUI\setSuffixes(), and ilPropertyFormGUI\setTitle().

Referenced by __construct().

     {
         $this->setFormAction($this->ctrl->getFormAction($this->parent_gui));
         $this->setTitle($this->lng->txt('prg_type_custom_icon'));
         $item = new ilImageFileInputGUI($this->lng->txt('icon'), 'icon');
         $item->setSuffixes(array( 'svg' ));
         $item->setInfo($this->lng->txt('prg_type_custom_icon_info'));
         $this->addItem($item);
         $this->addCommandButton('updateCustomIcons', $this->lng->txt('save'));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveObject()

ilStudyProgrammeTypeCustomIconsFormGUI::saveObject ( ilStudyProgrammeType $type )

Save object (create or update)

Returns: bool

Definition at line 64 of file class.ilStudyProgrammeTypeCustomIconsFormGUI.php.

References Vendor\Package\$e, ilUtil\sendFailure(), and ilStudyProgrammeType\updateAssignedStudyProgrammesIcons().

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