Inheritance diagram for ilOrgUnitPositionFormGUI:

Collaboration diagram for ilOrgUnitPositionFormGUI:

Public Member Functions
	__construct (protected ?BaseCommands $parent_gui, protected \ilOrgUnitPosition $object)

	fillForm ()

	saveObject ()

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

Data Fields
const	F_AUTHORITIES = "authorities"

const	F_TITLE = 'title'

const	F_DESCRIPTION = 'description'

Protected Member Functions
	initFormElements ()

Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()

	getFileHash ()

	hideRequired (string $a_type)

	appendOnloadCode (string $html)

	rebuildUploadedFiles ()

	checkForRequiredField ()

Protected Attributes
ilOrgUnitPositionDBRepository	$positionRepo

ILIAS DI Container	$DIC

ilLanguage	$lng

ilCtrl	$ctrl

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

Private Member Functions
	initButtons ()

	txt (string $key)

	infoTxt (string $key)

Detailed Description

Class ilOrgUnitPositionFormGUI.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitPositionFormGUI::__construct	(	protected ?BaseCommands	$parent_gui,
		protected \ilOrgUnitPosition	$object
	)

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

References $dic, $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ilOrgUnitLocalDIC\dic(), ilOrgUnitPosition\getId(), initButtons(), initFormElements(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), and ilFormGUI\setTarget().

       {
         global $DIC;
 
         $dic = ilOrgUnitLocalDIC::dic();
         $this->positionRepo = $dic["repo.Positions"];
 
         $this->parent_gui = $parent_gui;
         $this->object = $object;
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
 
         $action_cmd = $object->getId() > 0 ? BaseCommands::CMD_UPDATE : BaseCommands::CMD_CREATE;
         $form_action = $parent_gui->getSinglePosLinkTarget($action_cmd, $object->getId());
         $this->setFormAction($form_action);
 
         $this->initFormElements();
         $this->initButtons();
         $this->setTarget('_top');
 
         parent::__construct();
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillForm()

ilOrgUnitPositionFormGUI::fillForm ( )

Definition at line 116 of file class.ilOrgUnitPositionFormGUI.php.

References ilFormGUI\$id, ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), null, ILIAS\Repository\object(), and ilPropertyFormGUI\setValuesByArray().

                               : void
     {
         $array = [
             self::F_TITLE => $this->object->getTitle(),
             self::F_DESCRIPTION => $this->object->getDescription(),
             self::F_AUTHORITIES => $this->object->getAuthoritiesAsArray()
         ];
         $this->setValuesByArray($array);
     }

Here is the call graph for this function:

◆ infoTxt()

ilOrgUnitPositionFormGUI::infoTxt ( string $key )

private

Definition at line 178 of file class.ilOrgUnitPositionFormGUI.php.

References ILIAS\Repository\lng().

                                          : string
     {
         return $this->lng->txt($key . '_info');
     }

Here is the call graph for this function:

◆ initButtons()

ilOrgUnitPositionFormGUI::initButtons ( )

private

Definition at line 103 of file class.ilOrgUnitPositionFormGUI.php.

References ilPropertyFormGUI\addCommandButton(), ILIAS\Repository\object(), ilPropertyFormGUI\setTitle(), and txt().

Referenced by __construct().

                                   : void
     {
         if (!$this->object->getId()) {
             $this->setTitle($this->txt('create'));
             $this->addCommandButton(BaseCommands::CMD_CREATE, $this->txt(BaseCommands::CMD_CREATE));
             $this->addCommandButton(BaseCommands::CMD_CANCEL, $this->txt(BaseCommands::CMD_CANCEL));
         } else {
             $this->setTitle($this->txt('update'));
             $this->addCommandButton(BaseCommands::CMD_UPDATE, $this->txt(BaseCommands::CMD_UPDATE));
             $this->addCommandButton(BaseCommands::CMD_CANCEL, $this->txt(BaseCommands::CMD_CANCEL));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFormElements()

ilOrgUnitPositionFormGUI::initFormElements ( )

protected

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

References $DIC, ilFormGUI\$id, $scope, $scopes, $txt, ilPropertyFormGUI\addItem(), ilOrgUnitAuthority\getScopes(), ilOrgUnitGenericMultiInputGUI\MULTI_FIELD_ID, ilOrgUnitGenericMultiInputGUI\MULTI_FIELD_OVER, ilOrgUnitGenericMultiInputGUI\MULTI_FIELD_SCOPE, ilOrgUnitAuthority\OVER_EVERYONE, ilSelectInputGUI\setOptions(), and ilOrgUnitGenericMultiInputGUI\setShowLabel().

Referenced by __construct().

                                          : void
     {
         global $DIC;
         $lng = $DIC->language();
 
         $te = new ilTextInputGUI($lng->txt(self::F_TITLE), self::F_TITLE);
         $te->setRequired(true);
         $this->addItem($te);
 
         $te = new ilTextAreaInputGUI($lng->txt(self::F_DESCRIPTION), self::F_DESCRIPTION);
         $this->addItem($te);
 
         $m = new ilOrgUnitGenericMultiInputGUI($lng->txt(self::F_AUTHORITIES), self::F_AUTHORITIES);
         $m->setShowLabel(true);
         $m->setRenderOneForEmptyValue(false);
         $m->setMulti(true);
 
         $id = new ilHiddenInputGUI(ilOrgUnitGenericMultiInputGUI::MULTI_FIELD_ID);
         $m->addInput($id);
 
         $over = new ilSelectInputGUI($lng->txt('over'), ilOrgUnitGenericMultiInputGUI::MULTI_FIELD_OVER);
         $over_options = [];
         $over_options[ilOrgUnitAuthority::OVER_EVERYONE] = $lng->txt('over_'
             . ilOrgUnitAuthority::OVER_EVERYONE);
         $over_options += $this->positionRepo->getArray('id', 'title');
         $over->setOptions($over_options);
         $m->addInput($over);
 
         $available_scopes = [];
         foreach (ilOrgUnitAuthority::getScopes() as $scope) {
             $txt = $lng->txt('scope_' . $scope);
             $available_scopes[$scope] = $txt;
         }
 
         $scopes = new ilSelectInputGUI($lng->txt('scope'), ilOrgUnitGenericMultiInputGUI::MULTI_FIELD_SCOPE);
         $scopes->setOptions($available_scopes);
         $m->addInput($scopes);
 
         $this->addItem($m);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveObject()

ilOrgUnitPositionFormGUI::saveObject ( )

Definition at line 163 of file class.ilOrgUnitPositionFormGUI.php.

                                 : bool
     {
         if ($this->fillObject() === false) {
             return false;
         }
 
         $this->object = $this->positionRepo->store($this->object);
         return true;
     }

◆ txt()

ilOrgUnitPositionFormGUI::txt ( string $key )

private

Definition at line 173 of file class.ilOrgUnitPositionFormGUI.php.

References ILIAS\Repository\lng().

Referenced by initButtons().

                                      : string
     {
         return $this->lng->txt($key);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilCtrl ilOrgUnitPositionFormGUI::$ctrl

protected

Definition at line 35 of file class.ilOrgUnitPositionFormGUI.php.

◆ $DIC

ILIAS DI Container ilOrgUnitPositionFormGUI::$DIC

protected

Definition at line 33 of file class.ilOrgUnitPositionFormGUI.php.

Referenced by __construct(), and initFormElements().

◆ $lng

ilLanguage ilOrgUnitPositionFormGUI::$lng

protected

Definition at line 34 of file class.ilOrgUnitPositionFormGUI.php.

◆ $positionRepo

ilOrgUnitPositionDBRepository ilOrgUnitPositionFormGUI::$positionRepo

protected

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

◆ F_AUTHORITIES

const ilOrgUnitPositionFormGUI::F_AUTHORITIES = "authorities"

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

◆ F_DESCRIPTION

const ilOrgUnitPositionFormGUI::F_DESCRIPTION = 'description'

Definition at line 30 of file class.ilOrgUnitPositionFormGUI.php.

◆ F_TITLE

const ilOrgUnitPositionFormGUI::F_TITLE = 'title'

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

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

components/ILIAS/OrgUnit/classes/Positions/class.ilOrgUnitPositionFormGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fillForm()

◆ infoTxt()

◆ initButtons()

◆ initFormElements()

◆ saveObject()

◆ txt()

Field Documentation

◆ $ctrl

◆ $DIC

◆ $lng

◆ $positionRepo

◆ F_AUTHORITIES

◆ F_DESCRIPTION

◆ F_TITLE