Class ilStudyProgrammeTypeFormGUI. More...

Inheritance diagram for ilStudyProgrammeTypeCustomIconsFormGUI:

Collaboration diagram for ilStudyProgrammeTypeCustomIconsFormGUI:

Public Member Functions
	__construct ( $parent_gui, ilStudyProgrammeTypeRepository $type_repo, ilCtrl $ctrl, ilGlobalTemplateInterface $tpl, ilLanguage $lng, ilObjUser $user, Filesystem $web_dir)

	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 ()

	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
ilStudyProgrammeTypeGUI	$parent_gui

ilStudyProgrammeTypeRepository	$type_repo

Filesystem	$webdir

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

Additional Inherited Members
Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()

	getFileHash ()

	hideRequired (string $a_type)

	appendOnloadCode (string $html)

	rebuildUploadedFiles ()

	checkForRequiredField ()

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 30 of file class.ilStudyProgrammeTypeCustomIconsFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeTypeCustomIconsFormGUI::__construct	(		$parent_gui,
		ilStudyProgrammeTypeRepository	$type_repo,
		ilCtrl	$ctrl,
		ilGlobalTemplateInterface	$tpl,
		ilLanguage	$lng,
		ilObjUser	$user,
		Filesystem	$web_dir
	)

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

References ilPropertyFormGUI\$ctrl, ilPropertyFormGUI\$lng, $parent_gui, ilPropertyFormGUI\$tpl, $type_repo, ilPropertyFormGUI\$user, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), initForm(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

       {
         parent::__construct();
 
         $this->parent_gui = $parent_gui;
         $this->type_repo = $type_repo;
         $this->ctrl = $ctrl;
         $this->global_tpl = $tpl;
         $this->lng = $lng;
         $this->user = $user;
         $this->webdir = $web_dir;
 
         $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 93 of file class.ilStudyProgrammeTypeCustomIconsFormGUI.php.

References Vendor\Package\$e, ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), ilFileUtils\getWebspaceDir(), ILIAS\Repository\lng(), null, and ilPropertyFormGUI\setValuesByPost().

                                                         : void
     {
         $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(ilFileUtils::getWebspaceDir() . '/' . $type->getIconPath(true));
         }
     }

Here is the call graph for this function:

◆ initForm()

ilStudyProgrammeTypeCustomIconsFormGUI::initForm ( )

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

References ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), ilFileInputGUI\setSuffixes(), and ilPropertyFormGUI\setTitle().

Referenced by __construct().

                               : void
     {
         $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)

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

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

                                                           : bool
     {
         $type = $this->fillObject($type);
         if (!$type) {
             return false;
         }
         try {
             $this->type_repo->updateType($type);
             $type->updateAssignedStudyProgrammesIcons();
             return true;
         } catch (ilException $e) {
             $this->global_tpl->setOnScreenMessage("failure", $e->getMessage());
 
             return false;
         }
     }