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

Inheritance diagram for ilStudyProgrammeTypeAdvancedMetaDataFormGUI:

Collaboration diagram for ilStudyProgrammeTypeAdvancedMetaDataFormGUI:

Public Member Functions
	__construct (ilStudyProgrammeTypeGUI $parent_gui, ilStudyProgrammeTypeRepository $type_repository, ilCtrl $ctrl, ilGlobalTemplateInterface $tpl, ilLanguage $lng)

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

	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 Member Functions
	fillObject (ilStudyProgrammeType $type)
	Check validity of form and pass values from form to object. More...

Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()

	getFileHash ()

	hideRequired (string $a_type)

	appendOnloadCode (string $html)

	rebuildUploadedFiles ()

Protected Attributes
ilStudyProgrammeTypeRepository	$type_repository

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

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 ilStudyProgrammeTypeAdvancedMetaDataFormGUI

Author: Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeTypeAdvancedMetaDataFormGUI::__construct	(	ilStudyProgrammeTypeGUI	$parent_gui,
		ilStudyProgrammeTypeRepository	$type_repository,
		ilCtrl	$ctrl,
		ilGlobalTemplateInterface	$tpl,
		ilLanguage	$lng
	)

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

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

       {
         parent::__construct();
 
         $this->parent_gui = $parent_gui;
         $this->type_repository = $type_repository;
         $this->global_tpl = $tpl;
         $this->ctrl = $ctrl;
         $this->lng = $lng;
         $this->lng->loadLanguageModule('meta');
         $this->initForm();
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillForm()

ilStudyProgrammeTypeAdvancedMetaDataFormGUI::fillForm ( ilStudyProgrammeType $type )

Add all fields to the form.

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

References ilStudyProgrammeType\getId(), and ilPropertyFormGUI\getItemByPostVar().

                                                         : void
     {
         $records_selected = $this->type_repository->getAssignedAMDRecordIdsByType($type->getId());
         $item = $this->getItemByPostVar('amd_records');
         $item->setValue($records_selected);
     }

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.

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

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

Referenced by saveObject().

                                                              : ?ilStudyProgrammeType
     {
         $this->setValuesByPost();
         if (!$this->checkInput()) {
             return null;
         }
         try {
             // Assign and deassign amd records. A plugin could prevent those actions.
             $record_ids_selected = (array) $this->getInput('amd_records');
             $record_ids = $this->type_repository->getAssignedAMDRecordIdsByType($type->getId(), true);
             $record_ids_removed = array_diff($record_ids, $record_ids_selected);
             $record_ids_added = array_diff($record_ids_selected, $record_ids);
             foreach ($record_ids_added as $record_id) {
                 $type->assignAdvancedMDRecord((int) $record_id);
             }
             foreach ($record_ids_removed as $record_id) {
                 $type->deassignAdvancedMdRecord((int) $record_id);
             }
         } catch (ilException $e) {
             $this->global_tpl->setOnScreenMessage("failure", $e->getMessage());
             return null;
         }
         return $type;
     }

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)

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

References ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), fillObject(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), ilMultiSelectInputGUI\setOptions(), and ilPropertyFormGUI\setTitle().

                                                           : bool
     {
         $type = $this->fillObject($type);
         if (!$type) {
             return false;
         }
         $this->type_repository->updateType($type);
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $parent_gui

ilStudyProgrammeTypeGUI ilStudyProgrammeTypeAdvancedMetaDataFormGUI::$parent_gui

protected

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

Referenced by __construct().

◆ $type_repository

ilStudyProgrammeTypeRepository ilStudyProgrammeTypeAdvancedMetaDataFormGUI::$type_repository

protected

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

Referenced by __construct().

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

Modules/StudyProgramme/classes/types/class.ilStudyProgrammeTypeAdvancedMetaDataFormGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fillForm()

◆ fillObject()

◆ saveObject()

Field Documentation

◆ $parent_gui

◆ $type_repository