ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilAsyncPropertyFormGUI Class Reference

Class ilAsyncPropertyFormGUI. More...

+ Inheritance diagram for ilAsyncPropertyFormGUI:
+ Collaboration diagram for ilAsyncPropertyFormGUI:

Public Member Functions

 __construct (array $config=array(), $is_async=true)
 
 checkInput ()
 Saves the change input result into a property. More...
 
 getErrors ()
 Return errors of the form as array. More...
 
 hasErrors ()
 Return if there were errors on the last checkInput call. More...
 
 getErrorMessageTemplate ()
 Returns the error-message template for the client-side validation. More...
 
 cloneForm (ilPropertyFormGUI $form_to_clone)
 Copies form items, buttons and properties from another form. More...
 
 getHTML ()
 Returns the rendered form content. More...
 
 isSubmitted ()
 Checks if the form was submitted. More...
 
 setFormAction ($a_formaction)
 Sets the form action If the form is set to async, the cmdMode=asynch is added to the url. More...
 
 getJsPath ()
 
 setJsPath ($js_path)
 
 getDefaultFormName ()
 
 isAsync ()
 
 setAsync ($is_async)
 
 setName ($a_name)
 
- Public Member Functions inherited from ilPropertyFormGUI
 ilPropertyFormGUI ()
 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)
 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)
 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
 ilFormGUI ()
 Constructor. More...
 
 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...
 

Static Public Member Functions

static addJavaScript ($add_form_loader=false, $js_base_path=null)
 Adds all needed js By default is called by ilAsyncPropertyFormGUI::getHTML() More...
 

Protected Member Functions

 addOnLoadCode ($id, $content)
 Adds onload code to the template. More...
 
- Protected Member Functions inherited from ilPropertyFormGUI
 hideRequired ($a_type)
 
 keepFileUpload ($a_hash, $a_field, $a_tmp_name, $a_name, $a_type, $a_index=null, $a_sub_index=null)
 Import upload into temp directory. More...
 
 rebuildUploadedFiles ()
 try to rebuild files More...
 

Protected Attributes

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

Static Protected Attributes

static $js_path = "./Modules/StudyProgramme/templates/js/"
 
static $default_from_name = "async_form"
 
static $js_on_load_added = array()
 

Detailed Description

Class ilAsyncPropertyFormGUI.

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

Definition at line 10 of file class.ilAsyncPropertyFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilAsyncPropertyFormGUI::__construct ( array  $config = array(),
  $is_async = true 
)

Definition at line 36 of file class.ilAsyncPropertyFormGUI.php.

References $is_async, setAsync(), and setName().

36  {
37  parent::__construct();
38 
39  foreach($config as $key=>$value) {
40  $setterMethod = "set".ucfirst($key);
41  if(method_exists($this, $setterMethod)) {
42  $setterMethod($value);
43  }
44  }
45 
46  $this->setAsync($is_async);
47  $this->setName(self::$default_from_name);
48  }
+ Here is the call graph for this function:

Member Function Documentation

◆ addJavaScript()

static ilAsyncPropertyFormGUI::addJavaScript (   $add_form_loader = false,
  $js_base_path = null 
)
static

Adds all needed js By default is called by ilAsyncPropertyFormGUI::getHTML()

Parameters
bool$add_form_loader
null$js_base_path

Definition at line 58 of file class.ilAsyncPropertyFormGUI.php.

References $js_path, and $tpl.

Referenced by ilObjStudyProgrammeTreeGUI\initAsyncUIElements().

58  {
59  global $tpl;
60 
61  $js_path = (isset($js_base_path))? $js_base_path : self::$js_path;
62 
63  $tpl->addJavaScript($js_path.'ilAsyncPropertyFormGUI.js');
64 
65  $global_config = "$.ilAsyncPropertyForm.global_config.error_message_template = '".self::getErrorMessageTemplate()."'; $.ilAsyncPropertyForm.global_config.async_form_name = '".self::$default_from_name."';";
66  self::addOnLoadCode('global_config', $global_config);
67 
68  if($add_form_loader) {
69  self::addOnLoadCode('form_loader', '$("body").ilAsyncPropertyForm();');
70  }
71  }
global $tpl
Definition: ilias.php:8
+ Here is the caller graph for this function:

◆ addOnLoadCode()

ilAsyncPropertyFormGUI::addOnLoadCode (   $id,
  $content 
)
protected

Adds onload code to the template.

Parameters
$id
$content

Definition at line 175 of file class.ilAsyncPropertyFormGUI.php.

References ilFormGUI\$id, and $tpl.

175  {
176  global $tpl;
177 
178  if(!isset(self::$js_on_load_added[$id])) {
179  $tpl->addOnLoadCode($content);
180  self::$js_on_load_added[$id] = $content;
181  }
182  }
global $tpl
Definition: ilias.php:8

◆ checkInput()

ilAsyncPropertyFormGUI::checkInput ( )

Saves the change input result into a property.

Returns
bool

Definition at line 79 of file class.ilAsyncPropertyFormGUI.php.

References $result.

Referenced by getErrors().

79  {
80  $result = parent::checkInput();
81  $this->has_errors = $result;
82 
83  return $result;
84  }
$result
+ Here is the caller graph for this function:

◆ cloneForm()

ilAsyncPropertyFormGUI::cloneForm ( ilPropertyFormGUI  $form_to_clone)

Copies form items, buttons and properties from another form.

Parameters
ilPropertyFormGUI$form_to_clone
Returns
$this
Exceptions
ilException

Definition at line 145 of file class.ilAsyncPropertyFormGUI.php.

References ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilPropertyFormGUI\getCommandButtons(), and ilPropertyFormGUI\getItems().

145  {
146  if(count($this->getItems()) > 0) {
147  throw new ilException("You cannot clone into a already filled form!");
148  }
149 
150  $reflect = new ReflectionClass($this);
151  $properties = $reflect->getProperties(ReflectionProperty::IS_PUBLIC);
152 
153  foreach($properties as $property) {
154  $this->{$property->getName()} = $property->getValue($form_to_clone);
155  }
156 
157  foreach($form_to_clone->getItems() as $item) {
158  $this->addItem($item);
159  }
160 
161  foreach($form_to_clone->getCommandButtons() as $button) {
162  $this->addCommandButton($button['cmd'], $button['text']);
163  }
164 
165  return $this;
166  }
Base class for ILIAS Exception handling.
addItem($a_item)
Add Item (Property, SectionHeader).
getCommandButtons()
Return all Command buttons.
addCommandButton($a_cmd, $a_text)
Add Command button.
+ Here is the call graph for this function:

◆ getDefaultFormName()

ilAsyncPropertyFormGUI::getDefaultFormName ( )
Returns
mixed

Definition at line 239 of file class.ilAsyncPropertyFormGUI.php.

239  {
240  return self::$default_from_name;
241  }

◆ getErrorMessageTemplate()

ilAsyncPropertyFormGUI::getErrorMessageTemplate ( )

Returns the error-message template for the client-side validation.

Returns
string

Definition at line 122 of file class.ilAsyncPropertyFormGUI.php.

References $lng, $tpl, and ilUtil\getImagePath().

122  {
123  global $lng;
124 
125  $tpl = new ilTemplate("tpl.property_form.html", true, true, "Services/Form");
126 
127  $tpl->setCurrentBlock("alert");
128  $tpl->setVariable("IMG_ALERT", ilUtil::getImagePath("icon_alert.svg"));
129  $tpl->setVariable("ALT_ALERT", $lng->txt("alert"));
130  $tpl->setVariable("TXT_ALERT", "[TXT_ALERT]");
131  $tpl->parseCurrentBlock();
132  $content = trim($tpl->get("alert"));
133 
134  return $content;
135  }
global $tpl
Definition: ilias.php:8
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
special template class to simplify handling of ITX/PEAR
global $lng
Definition: privfeed.php:40
+ Here is the call graph for this function:

◆ getErrors()

ilAsyncPropertyFormGUI::getErrors ( )

Return errors of the form as array.

Returns
array Array with field id and error message: array([]=>array('key'=>fieldId, 'message'=>error-message))

Definition at line 91 of file class.ilAsyncPropertyFormGUI.php.

References $errors, checkInput(), and ilPropertyFormGUI\getItems().

91  {
92  if(!$this->check_input_called) {
93  $this->checkInput();
94  }
95 
96  $errors = array();
97  foreach($this->getItems() as $item) {
98  // We call method exists as there are items in the form (ilFormSectionHeaderGUI)
99  // that do not have alerts. (#16956)
100  if(method_exists($item, "getAlert") && $item->getAlert() != "") {
101  $errors[] = array('key'=>$item->getFieldId(), 'message'=>$item->getAlert());
102  }
103  }
104  return $errors;
105  }
checkInput()
Saves the change input result into a property.
$errors
+ Here is the call graph for this function:

◆ getHTML()

ilAsyncPropertyFormGUI::getHTML ( )

Returns the rendered form content.

Returns
string

Definition at line 189 of file class.ilAsyncPropertyFormGUI.php.

References isAsync().

189  {
190  self::addJavaScript($this->isAsync());
191 
192  return parent::getHTML();
193  }
+ Here is the call graph for this function:

◆ getJsPath()

ilAsyncPropertyFormGUI::getJsPath ( )
Returns
mixed

Definition at line 225 of file class.ilAsyncPropertyFormGUI.php.

References $js_path.

225  {
226  return $this->js_path;
227  }

◆ hasErrors()

ilAsyncPropertyFormGUI::hasErrors ( )

Return if there were errors on the last checkInput call.

Returns
boolean

Definition at line 112 of file class.ilAsyncPropertyFormGUI.php.

References $has_errors.

◆ isAsync()

ilAsyncPropertyFormGUI::isAsync ( )
Returns
boolean

Definition at line 246 of file class.ilAsyncPropertyFormGUI.php.

References $is_async.

Referenced by getHTML(), and setFormAction().

+ Here is the caller graph for this function:

◆ isSubmitted()

ilAsyncPropertyFormGUI::isSubmitted ( )

Checks if the form was submitted.

Returns
bool

Definition at line 200 of file class.ilAsyncPropertyFormGUI.php.

References $_POST.

200  {
201  if(isset($_POST['cmd'])) {
202  return true;
203  }
204  return false;
205  }
$_POST['username']
Definition: cron.php:12

◆ setAsync()

ilAsyncPropertyFormGUI::setAsync (   $is_async)
Parameters
boolean$is_async

Definition at line 254 of file class.ilAsyncPropertyFormGUI.php.

References $is_async.

Referenced by __construct().

254  {
255  $this->is_async = $is_async;
256  }
+ Here is the caller graph for this function:

◆ setFormAction()

ilAsyncPropertyFormGUI::setFormAction (   $a_formaction)

Sets the form action If the form is set to async, the cmdMode=asynch is added to the url.

Parameters
string$a_formaction

Definition at line 214 of file class.ilAsyncPropertyFormGUI.php.

References isAsync().

214  {
215  if($this->isAsync()) {
216  $a_formaction .= "&cmdMode=asynch";
217  }
218 
219  $this->formaction = $a_formaction;
220  }
+ Here is the call graph for this function:

◆ setJsPath()

ilAsyncPropertyFormGUI::setJsPath (   $js_path)
Parameters
mixed$js_path

Definition at line 232 of file class.ilAsyncPropertyFormGUI.php.

References $js_path.

232  {
233  $this->js_path = $js_path;
234  }

◆ setName()

ilAsyncPropertyFormGUI::setName (   $a_name)
Parameters
string$a_name

Definition at line 262 of file class.ilAsyncPropertyFormGUI.php.

Referenced by __construct().

262  {
263  self::$default_from_name = $a_name;
264 
265  parent::setName($a_name);
266  }
+ Here is the caller graph for this function:

Field Documentation

◆ $default_from_name

ilAsyncPropertyFormGUI::$default_from_name = "async_form"
staticprotected

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

◆ $has_errors

ilAsyncPropertyFormGUI::$has_errors = false
protected

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

Referenced by hasErrors().

◆ $is_async

ilAsyncPropertyFormGUI::$is_async = true
protected

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

Referenced by __construct(), isAsync(), and setAsync().

◆ $js_on_load_added

ilAsyncPropertyFormGUI::$js_on_load_added = array()
staticprotected

Definition at line 24 of file class.ilAsyncPropertyFormGUI.php.

◆ $js_path

ilAsyncPropertyFormGUI::$js_path = "./Modules/StudyProgramme/templates/js/"
staticprotected

Definition at line 14 of file class.ilAsyncPropertyFormGUI.php.

Referenced by addJavaScript(), getJsPath(), and setJsPath().


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