ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilOrgUnitTypeCustomIconsFormGUI Class Reference

Class ilOrgUnitTypeFormGUI. More...

+ Inheritance diagram for ilOrgUnitTypeCustomIconsFormGUI:
+ Collaboration diagram for ilOrgUnitTypeCustomIconsFormGUI:

Public Member Functions

 __construct ($parent_gui, ilOrgUnitType $type)
 
 saveObject ()
 Save object (create or update) 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...
 
 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...
 

Protected Member Functions

 initForm ()
 Add all fields to the form. More...
 
- Protected Member Functions inherited from ilPropertyFormGUI
 hideRequired ($a_type)
 
 rebuildUploadedFiles ()
 try to rebuild files More...
 

Protected Attributes

 $type
 
 $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
 
- Protected Attributes inherited from ilFormGUI
 $formaction
 
 $multipart = false
 
 $keepopen = false
 
 $opentag = true
 
 $id
 
 $name
 
 $prevent_double_submission = false
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitTypeCustomIconsFormGUI::__construct (   $parent_gui,
ilOrgUnitType  $type 
)
Parameters
$parent_gui
ilOrgUnitType$type

Definition at line 38 of file class.ilOrgUnitTypeCustomIconsFormGUI.php.

References $DIC, $ilCtrl, $lng, $parent_gui, $tpl, $type, and initForm().

39  {
40  global $DIC;
41  parent::__construct();
42  $tpl = $DIC['tpl'];
43  $ilCtrl = $DIC['ilCtrl'];
44  $lng = $DIC['lng'];
45  $this->parent_gui = $parent_gui;
46  $this->type = $type;
47  $this->tpl = $tpl;
48  $this->ctrl = $ilCtrl;
49  $this->lng = $lng;
50  $this->lng->loadLanguageModule('meta');
51  $this->initForm();
52  }
global $DIC
Definition: saml.php:7
global $ilCtrl
Definition: ilias.php:18
+ Here is the call graph for this function:

Member Function Documentation

◆ initForm()

ilOrgUnitTypeCustomIconsFormGUI::initForm ( )
protected

Add all fields to the form.

Definition at line 80 of file class.ilOrgUnitTypeCustomIconsFormGUI.php.

References ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), ilUtil\sendFailure(), ilFormGUI\setFormAction(), ilFileInputGUI\setSuffixes(), ilPropertyFormGUI\setTitle(), and ilPropertyFormGUI\setValuesByPost().

Referenced by __construct().

81  {
82  $this->setFormAction($this->ctrl->getFormAction($this->parent_gui));
83  $this->setTitle($this->lng->txt('orgu_type_custom_icon'));
84  $item = new ilImageFileInputGUI($this->lng->txt('icon') . ' 32x32 px', 'icon');
85  $item->setSuffixes(array( 'svg' ));
86  $item->setInfo($this->lng->txt('orgu_type_custom_icon_info'));
87  if (is_file($this->type->getIconPath(true))) {
88  $item->setImage($this->type->getIconPath(true));
89  }
90  $this->addItem($item);
91  $this->addCommandButton('updateCustomIcons', $this->lng->txt('save'));
92  }
setFormAction($a_formaction)
Set FormAction.
addItem($a_item)
Add Item (Property, SectionHeader).
setTitle($a_title)
Set Title.
addCommandButton($a_cmd, $a_text, $a_id="")
Add Command button.
This class represents an image file property in a property form.
setSuffixes($a_suffixes)
Set Accepted Suffixes.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ saveObject()

ilOrgUnitTypeCustomIconsFormGUI::saveObject ( )

Save object (create or update)

Returns
bool

Definition at line 60 of file class.ilOrgUnitTypeCustomIconsFormGUI.php.

References ilUtil\sendFailure().

61  {
62  if (!$this->fillObject()) {
63  return false;
64  }
65  try {
66  $this->type->save();
67 
68  return true;
69  } catch (ilException $e) {
70  ilUtil::sendFailure($e->getMessage());
71 
72  return false;
73  }
74  }
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
+ Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilOrgUnitTypeCustomIconsFormGUI::$ctrl
protected

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

◆ $lng

ilOrgUnitTypeCustomIconsFormGUI::$lng
protected

Definition at line 23 of file class.ilOrgUnitTypeCustomIconsFormGUI.php.

Referenced by __construct().

◆ $parent_gui

ilOrgUnitTypeCustomIconsFormGUI::$parent_gui
protected

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

Referenced by __construct().

◆ $tpl

ilOrgUnitTypeCustomIconsFormGUI::$tpl
protected

Definition at line 19 of file class.ilOrgUnitTypeCustomIconsFormGUI.php.

Referenced by __construct().

◆ $type

ilOrgUnitTypeCustomIconsFormGUI::$type
protected

Definition at line 15 of file class.ilOrgUnitTypeCustomIconsFormGUI.php.

Referenced by __construct().


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