Inheritance diagram for ilAsyncPropertyFormGUI:

Collaboration diagram for ilAsyncPropertyFormGUI:

Public Member Functions
	__construct (RequestWrapper $request_wrapper, array $config=array(), bool $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...

	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 (string $a_formaction)
	Sets the form action If the form is set to async, the cmdMode=asynch is added to the url. More...

	getJsPath ()

	setJsPath (string $js_path)

	getDefaultFormName ()

	isAsync ()

	setAsync (bool $is_async)

	setName (string $a_name)

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

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

static	getErrorMessageTemplate ()
	Returns the error-message template for the client-side validation. More...

Static Protected Member Functions
static	addOnLoadCode (string $id, string $content)
	Adds onload code to the template. More...

Protected Attributes
bool	$has_errors = false

bool	$is_async = true

RequestWrapper	$request_wrapper

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

Static Protected Attributes
static string	$js_path = "./Modules/StudyProgramme/templates/js/"

static string	$default_from_name = "async_form"

static array	$js_on_load_added = array()

Additional Inherited Members
Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()

	getFileHash ()

	hideRequired (string $a_type)

	appendOnloadCode (string $html)

	rebuildUploadedFiles ()

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 29 of file class.ilAsyncPropertyFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilAsyncPropertyFormGUI::__construct	(	RequestWrapper	$request_wrapper,
		array	$config = `array()`,
		bool	$is_async = `true`
	)

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

References $config, ILIAS\LTI\ToolProvider\$key, $request_wrapper, ILIAS\GlobalScreen\Provider\__construct(), setAsync(), and setName().

     {
         parent::__construct();
 
         foreach ($config as $key => $value) {
             $setterMethod = "set" . ucfirst($key);
             if (method_exists($this, $setterMethod)) {
                 $setterMethod($value);
             }
         }
 
         $this->request_wrapper = $request_wrapper;
         $this->setAsync($is_async);
         $this->setName(self::$default_from_name);
     }

Here is the call graph for this function:

Member Function Documentation

◆ addJavaScript()

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

static

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

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

References $DIC, and ilPropertyFormGUI\$tpl.

Referenced by ilObjStudyProgrammeTreeGUI\initAsyncUIElements().

                                                                                                     : void
     {
         global $DIC;
         $tpl = $DIC['tpl'];
 
         $js_path = $js_base_path ?? self::$js_path;
 
         $tpl->addJavaScript($js_path . 'ilAsyncPropertyFormGUI.js');
 
         $global_config =
             "$.ilAsyncPropertyForm.global_config.error_message_template = '" .
             self::getErrorMessageTemplate() .
             "'; $.ilAsyncPropertyForm.global_config.async_form_name = '" .
             self::$default_from_name . "';"
         ;
 
         self::addOnLoadCode('global_config', $global_config);
 
         if ($add_form_loader) {
             self::addOnLoadCode('form_loader', '$("body").ilAsyncPropertyForm();');
         }
     }

Here is the caller graph for this function:

◆ addOnLoadCode()

static ilAsyncPropertyFormGUI::addOnLoadCode	(	string	$id,
		string	$content
	)

staticprotected

Adds onload code to the template.

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

References $DIC, ilFormGUI\$id, and ilPropertyFormGUI\$tpl.

                                                                         : void
     {
         global $DIC;
         $tpl = $DIC['tpl'];
 
         if (!isset(self::$js_on_load_added[$id])) {
             $tpl->addOnLoadCode($content);
             self::$js_on_load_added[$id] = $content;
         }
     }

◆ checkInput()

ilAsyncPropertyFormGUI::checkInput ( )

Saves the change input result into a property.

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

Referenced by getErrors().

                                 : bool
     {
         $result = parent::checkInput();
         $this->has_errors = $result;
 
         return $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.

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

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

                                                                : ilAsyncPropertyFormGUI
     {
         if (count($this->getItems()) > 0) {
             throw new ilException("You cannot clone into a already filled form!");
         }
 
         $reflect = new ReflectionClass($this);
         $properties = $reflect->getProperties(ReflectionProperty::IS_PUBLIC);
 
         foreach ($properties as $property) {
             $this->{$property->getName()} = $property->getValue($form_to_clone);
         }
 
         foreach ($form_to_clone->getItems() as $item) {
             $this->addItem($item);
         }
 
         foreach ($form_to_clone->getCommandButtons() as $button) {
             $this->addCommandButton($button['cmd'], $button['text']);
         }
 
         return $this;
     }

Here is the call graph for this function:

◆ getDefaultFormName()

ilAsyncPropertyFormGUI::getDefaultFormName ( )

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

                                         : string
     {
         return self::$default_from_name;
     }

◆ getErrorMessageTemplate()

static ilAsyncPropertyFormGUI::getErrorMessageTemplate ( )

static

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

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

References $DIC, ilPropertyFormGUI\$lng, ilPropertyFormGUI\$tpl, ilTemplate\get(), ilUtil\getImagePath(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilLanguage\txt().

                                                     : string
     {
         global $DIC;
         $lng = $DIC['lng'];
 
         $tpl = new ilTemplate("tpl.property_form.html", true, true, "Services/Form");
 
         $tpl->setCurrentBlock("alert");
         // TODO: DW -> refactor getImagePath
         $tpl->setVariable("IMG_ALERT", ilUtil::getImagePath("icon_alert.svg"));
         $tpl->setVariable("ALT_ALERT", $lng->txt("alert"));
         $tpl->setVariable("TXT_ALERT", "[TXT_ALERT]");
         $tpl->parseCurrentBlock();
         return trim($tpl->get("alert"));
     }

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 118 of file class.ilAsyncPropertyFormGUI.php.

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

                                : array
     {
         if (!$this->check_input_called) {
             $this->checkInput();
         }
 
         $errors = array();
         foreach ($this->getItems() as $item) {
             // We call method exists as there are items in the form (ilFormSectionHeaderGUI)
             // that do not have alerts. (#16956)
             if (method_exists($item, "getAlert") && $item->getAlert() !== "") {
                 $errors[] = array('key' => $item->getFieldId(), 'message' => $item->getAlert());
             }
         }
         return $errors;
     }

Here is the call graph for this function:

◆ getHTML()

ilAsyncPropertyFormGUI::getHTML ( )

Returns the rendered form content.

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

References isAsync().

                              : string
     {
         self::addJavaScript($this->isAsync());
 
         return parent::getHTML();
     }

Here is the call graph for this function:

◆ getJsPath()

ilAsyncPropertyFormGUI::getJsPath ( )

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

                                : ?string
     {
         return self::$js_path;
     }

◆ hasErrors()

ilAsyncPropertyFormGUI::hasErrors ( )

Return if there were errors on the last checkInput call.

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

References $has_errors.

                                : bool
     {
         return $this->has_errors;
     }

◆ isAsync()

ilAsyncPropertyFormGUI::isAsync ( )

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

References $is_async.

Referenced by getHTML(), and setFormAction().

                              : bool
     {
         return $this->is_async;
     }

Here is the caller graph for this function:

◆ isSubmitted()

ilAsyncPropertyFormGUI::isSubmitted ( )

Checks if the form was submitted.

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

                                  : bool
     {
         if ($this->request_wrapper->has("cmd")) {
             return true;
         }
         return false;
     }

◆ setAsync()

ilAsyncPropertyFormGUI::setAsync ( bool $is_async )

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

References $is_async.

Referenced by __construct().

                                             : void
     {
         $this->is_async = $is_async;
     }

Here is the caller graph for this function:

◆ setFormAction()

ilAsyncPropertyFormGUI::setFormAction ( string $a_formaction )

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

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

References isAsync().

                                                        : void
     {
         if ($this->isAsync()) {
             $a_formaction .= "&cmdMode=asynch";
         }
 
         $this->formaction = $a_formaction;
     }

Here is the call graph for this function:

◆ setJsPath()

ilAsyncPropertyFormGUI::setJsPath ( string $js_path )

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

References $js_path.

                                               : void
     {
         self::$js_path = $js_path;
     }

◆ setName()

ilAsyncPropertyFormGUI::setName ( string $a_name )

Parameters

string $a_name

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

Referenced by __construct().

                                            : void
     {
         self::$default_from_name = $a_name;
 
         parent::setName($a_name);
     }

Here is the caller graph for this function:

Field Documentation

◆ $default_from_name

string ilAsyncPropertyFormGUI::$default_from_name = "async_form"

staticprotected

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

◆ $has_errors

bool ilAsyncPropertyFormGUI::$has_errors = false

protected

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

Referenced by hasErrors().

◆ $is_async

bool ilAsyncPropertyFormGUI::$is_async = true

protected

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

Referenced by isAsync(), and setAsync().

◆ $js_on_load_added

array ilAsyncPropertyFormGUI::$js_on_load_added = array()

staticprotected

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

◆ $js_path

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

staticprotected

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

Referenced by setJsPath().

◆ $request_wrapper

RequestWrapper ilAsyncPropertyFormGUI::$request_wrapper

protected

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

Referenced by __construct().

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

Modules/StudyProgramme/classes/helpers/class.ilAsyncPropertyFormGUI.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addJavaScript()

◆ addOnLoadCode()

◆ checkInput()

◆ cloneForm()

◆ getDefaultFormName()

◆ getErrorMessageTemplate()

◆ getErrors()

◆ getHTML()

◆ getJsPath()

◆ hasErrors()

◆ isAsync()

◆ isSubmitted()

◆ setAsync()

◆ setFormAction()

◆ setJsPath()

◆ setName()

Field Documentation

◆ $default_from_name

◆ $has_errors

◆ $is_async

◆ $js_on_load_added

◆ $js_path

◆ $request_wrapper