ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilOrgUnitAuthorityFormGUI Class Reference

Class ilOrgUnitAuthorityFormGUI. More...

+ Inheritance diagram for ilOrgUnitAuthorityFormGUI:
+ Collaboration diagram for ilOrgUnitAuthorityFormGUI:

Public Member Functions

 fillForm ()
 
 fillObject ()
 returns whether checkinput was successful or not. More...
 
- Public Member Functions inherited from ILIAS\Modules\OrgUnit\ARHelper\BaseForm
 __construct (BaseCommands $parent_gui, \ActiveRecord $object)
 BaseForm constructor. More...
 
 fillForm ()
 
 saveObject ()
 
- 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...
 
 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...
 

Data Fields

const F_TITLE = 'title'
 
const F_DESCRIPTION = 'description'
 

Protected Member Functions

 initFormElements ()
 
- Protected Member Functions inherited from ILIAS\Modules\OrgUnit\ARHelper\BaseForm
 initFormElements ()
 
 fillObject ()
 
 initButtons ()
 
 txt ($key)
 
 infoTxt ($key)
 
 dic ()
 
- Protected Member Functions inherited from ilPropertyFormGUI
 hideRequired ($a_type)
 
 rebuildUploadedFiles ()
 try to rebuild files More...
 

Protected Attributes

 $object
 
- Protected Attributes inherited from ILIAS\Modules\OrgUnit\ARHelper\BaseForm
 $parent_gui
 
 $DIC
 
 $object
 
- 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
 
- Protected Attributes inherited from ilFormGUI
 $formaction
 
 $multipart = false
 
 $keepopen = false
 
 $opentag = true
 
 $id
 
 $name
 
 $prevent_double_submission = false
 

Detailed Description

Member Function Documentation

◆ fillForm()

ilOrgUnitAuthorityFormGUI::fillForm ( )

Definition at line 43 of file class.ilOrgUnitAuthorityFormGUI.php.

References array, object, and ilPropertyFormGUI\setValuesByArray().

44  {
45  $array = array(
46  self::F_TITLE => $this->object->getTitle(),
47  self::F_DESCRIPTION => $this->object->getDescription(),
48  );
49 
50  $this->setValuesByArray($array);
51  }
Create styles array
The data for the language used.
Create new PHPExcel object
obj_idprivate
setValuesByArray($a_values, $a_restrict_to_value_keys=false)
Set form values from an array.
+ Here is the call graph for this function:

◆ fillObject()

ilOrgUnitAuthorityFormGUI::fillObject ( )

returns whether checkinput was successful or not.

Returns
bool

Definition at line 59 of file class.ilOrgUnitAuthorityFormGUI.php.

References ilPropertyFormGUI\checkInput(), and ilPropertyFormGUI\getInput().

60  {
61  if (!$this->checkInput()) {
62  return false;
63  }
64 
65  $this->object->setTitle($this->getInput(self::F_TITLE));
66  $this->object->setDescription($this->getInput(self::F_DESCRIPTION));
67 
68  return true;
69  }
checkInput()
Check Post Input.
getInput($a_post_var, $ensureValidation=true)
Returns the value of a HTTP-POST variable, identified by the passed id.
+ Here is the call graph for this function:

◆ initFormElements()

ilOrgUnitAuthorityFormGUI::initFormElements ( )
protected

Definition at line 21 of file class.ilOrgUnitAuthorityFormGUI.php.

References $r, ilPropertyFormGUI\addItem(), and ILIAS\Modules\OrgUnit\ARHelper\BaseForm\txt().

22  {
23  $te = new ilTextInputGUI($this->txt(self::F_TITLE), self::F_TITLE);
24  $te->setRequired(true);
25  $this->addItem($te);
26 
27  $te = new ilTextAreaInputGUI($this->txt(self::F_DESCRIPTION), self::F_DESCRIPTION);
28  $this->addItem($te);
29 
30  $c = new ilCustomInputGUI($this->txt('authorities'));
31  $f = $this->parent_gui->dic()->ui()->factory();
32  $r = $this->parent_gui->dic()->ui()->renderer();
33  $modal = $f->modal()->roundtrip("Modal", $f->legacy(''))->withCloseWithKeyboard(false);
34  $button = $f->button()
35  ->shy($this->txt("open_authorities_modal"), '#')
36  ->withOnClick($modal->getShowSignal());
37 
38  $c->setHtml($r->render([ $button, $modal ]));
39  $this->addItem($c);
40  }
addItem($a_item)
Add Item (Property, SectionHeader).
$r
Definition: example_031.php:79
This class represents a text property in a property form.
This class represents a custom property in a property form.
This class represents a text area property in a property form.
+ Here is the call graph for this function:

Field Documentation

◆ $object

ilOrgUnitAuthorityFormGUI::$object
protected

Definition at line 16 of file class.ilOrgUnitAuthorityFormGUI.php.

◆ F_DESCRIPTION

const ilOrgUnitAuthorityFormGUI::F_DESCRIPTION = 'description'

Definition at line 18 of file class.ilOrgUnitAuthorityFormGUI.php.

◆ F_TITLE

const ilOrgUnitAuthorityFormGUI::F_TITLE = 'title'

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


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