ILIAS  release_7 Revision v7.30-3-g800a261c036
ilStudyProgrammeTypeAdvancedMetaDataFormGUI Class Reference

Class ilStudyProgrammeTypeAdvancedMetaDataFormGUI. More...

+ Inheritance diagram for ilStudyProgrammeTypeAdvancedMetaDataFormGUI:
+ Collaboration diagram for ilStudyProgrammeTypeAdvancedMetaDataFormGUI:

Public Member Functions

 __construct ($parent_gui, ilStudyProgrammeTypeRepository $type_repository)
 
 saveObject (ilStudyProgrammeType $type)
 Save object (create or update) More...
 
 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 ()
 Get HTML. More...
 
 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

 fillObject (ilStudyProgrammeType $type)
 Check validity of form and pass values from form to object. More...
 
- Protected Member Functions inherited from ilPropertyFormGUI
 hideRequired ($a_type)
 
 rebuildUploadedFiles ()
 try to rebuild files More...
 

Protected Attributes

 $type_repository
 
 $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
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeTypeAdvancedMetaDataFormGUI::__construct (   $parent_gui,
ilStudyProgrammeTypeRepository  $type_repository 
)

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

41 {
42 global $DIC;
43 $tpl = $DIC['tpl'];
44 $ilCtrl = $DIC['ilCtrl'];
45 $lng = $DIC['lng'];
46 $this->parent_gui = $parent_gui;
47 $this->type_repository = $type_repository;
48 $this->tpl = $tpl;
49 $this->ctrl = $ilCtrl;
50 $this->lng = $lng;
51 $this->lng->loadLanguageModule('meta');
52 $this->initForm();
53 }
global $DIC
Definition: goto.php:24

References $DIC, $lng, $parent_gui, $tpl, and $type_repository.

Member Function Documentation

◆ fillForm()

ilStudyProgrammeTypeAdvancedMetaDataFormGUI::fillForm ( ilStudyProgrammeType  $type)

Add all fields to the form.

Definition at line 94 of file class.ilStudyProgrammeTypeAdvancedMetaDataFormGUI.php.

95 {
96 $records_selected = $this->type_repository->getAssignedAMDRecordIdsByType($type->getId());
97 $item = $this->getItemByPostVar('amd_records');
98 $item->setValue($records_selected);
99 }
getItemByPostVar($a_post_var)
Get Item by POST variable.
$type

References $type, and ilPropertyFormGUI\getItemByPostVar().

+ Here is the call graph for this function:

◆ fillObject()

ilStudyProgrammeTypeAdvancedMetaDataFormGUI::fillObject ( ilStudyProgrammeType  $type)
protected

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

Returns
bool

Definition at line 106 of file class.ilStudyProgrammeTypeAdvancedMetaDataFormGUI.php.

107 {
108 $this->setValuesByPost();
109 if (!$this->checkInput()) {
110 return null;
111 }
112 try {
113 // Assign and deassign amd records. A plugin could prevent those actions.
114 $record_ids_selected = (array) $this->getInput('amd_records');
115 $record_ids = $this->type_repository->getAssignedAMDRecordIdsByType($type->getId(), true);
116 $record_ids_removed = array_diff($record_ids, $record_ids_selected);
117 $record_ids_added = array_diff($record_ids_selected, $record_ids);
118 foreach ($record_ids_added as $record_id) {
119 $type->assignAdvancedMDRecord($record_id);
120 }
121 foreach ($record_ids_removed as $record_id) {
122 $type->deassignAdvancedMdRecord($record_id);
123 }
124 } catch (ilException $e) {
125 ilUtil::sendFailure($e->getMessage());
126 return null;
127 }
128 return $type;
129 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
getInput($a_post_var, $ensureValidation=true)
Returns the value of a HTTP-POST variable, identified by the passed id.
checkInput()
Check Post Input.
setValuesByPost()
Set form values from POST values.
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.

References Vendor\Package\$e, $type, ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), ilUtil\sendFailure(), and ilPropertyFormGUI\setValuesByPost().

Referenced by saveObject().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ saveObject()

ilStudyProgrammeTypeAdvancedMetaDataFormGUI::saveObject ( ilStudyProgrammeType  $type)

Save object (create or update)

Returns
bool

Definition at line 61 of file class.ilStudyProgrammeTypeAdvancedMetaDataFormGUI.php.

62 {
63 $type = $this->fillObject($type);
64 if (!$type) {
65 return false;
66 }
67 $this->type_repository->updateType($type);
68 return true;
69 }
fillObject(ilStudyProgrammeType $type)
Check validity of form and pass values from form to object.

References $type, and fillObject().

+ Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilStudyProgrammeTypeAdvancedMetaDataFormGUI::$ctrl
protected

◆ $lng

ilStudyProgrammeTypeAdvancedMetaDataFormGUI::$lng
protected

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

Referenced by __construct().

◆ $parent_gui

ilStudyProgrammeTypeAdvancedMetaDataFormGUI::$parent_gui
protected

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

Referenced by __construct().

◆ $tpl

ilStudyProgrammeTypeAdvancedMetaDataFormGUI::$tpl
protected

Definition at line 22 of file class.ilStudyProgrammeTypeAdvancedMetaDataFormGUI.php.

Referenced by __construct().

◆ $type_repository

ilStudyProgrammeTypeAdvancedMetaDataFormGUI::$type_repository
protected

Definition at line 17 of file class.ilStudyProgrammeTypeAdvancedMetaDataFormGUI.php.

Referenced by __construct().


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