This class represents a text wizard property in a property form. More...

Inheritance diagram for ilTextWizardInputGUI:

Collaboration diagram for ilTextWizardInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setValues ($a_values)
	Set Values. More...

	setValue ($a_value)
	Set Value. More...

	getValues ()
	Get Values. More...

	setAllowMove ($a_allow_move)
	Set allow move. More...

	getAllowMove ()
	Get allow move. More...

	checkInput ()
	Check input, strip slashes etc. More...

	insert ($a_tpl)
	Insert property html. More...

	render ($a_mode="")

Public Member Functions inherited from ilTextInputGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setValue ($a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

	setValidationFailureMessage ($a_msg)
	Set message string for validation failure. More...

	getValidationFailureMessage ()

	setValidationRegexp ($a_value)
	Set validation regexp. More...

	getValidationRegexp ()
	Get validation regexp. More...

	setMaxLength ($a_maxlength)
	Set Max Length. More...

	getMaxLength ()
	Get Max Length. More...

	setSize ($a_size)
	Set Size. More...

	setInlineStyle ($a_style)
	Set inline style. More...

	getInlineStyle ()
	Get inline style. More...

	setCssClass ($a_class)

	getCssClass ()

	setValueByArray ($a_values)
	Set value by array. More...

	getSize ()
	Get Size. More...

	setSuffix ($a_value)
	Set suffix. More...

	getSuffix ()
	Get suffix. More...

	setInputType ($a_type)
	set input type More...

	getInputType ()
	get input type More...

	setSubmitFormOnEnter ($a_val)
	Set submit form on enter. More...

	getSubmitFormOnEnter ()
	Get submit form on enter. More...

	checkInput ()
	Check input, strip slashes etc. More...

	getDataSource ()
	get datasource link for js autocomplete More...

	setDataSource ($href, $a_delimiter=null)
	set datasource link for js autocomplete More...

	setDataSourceSubmitOnSelection ($a_stat)

	getDataSourceSubmitOnSelection ()

	setDataSourceSubmitUrl ($a_url)

	getDataSourceSubmitUrl ()

	setMultiValues (array $a_values)

	insert ($a_tpl)
	Insert property html. More...

	getTableFilterHTML ()
	Get HTML for table filter. More...

	getToolbarHTML ()
	Get HTML for toolbar. More...

	setDisableHtmlAutoComplete ($autocomplete)

	isHtmlAutoCompleteDisabled ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...

	getSubItems ()
	Get Subitems. More...

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()
	Get sub form html. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setPostVar ($a_postvar)
	Set Post Variable. More...

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

	setInfo ($a_info)
	Set Information Text. More...

	getInfo ()
	Get Information Text. More...

	setAlert ($a_alert)
	Set Alert Text. More...

	getAlert ()
	Get Alert Text. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required. More...

	setDisabled ($a_disabled)
	Set Disabled. More...

	getDisabled ()
	Get Disabled. More...

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm ($a_parentform)
	Set Parent Form. More...

	getParentForm ()
	Get Parent Form. More...

	setParent ($a_val)
	Set Parent GUI object. More...

	getParent ()
	Get Parent GUI object. More...

	getSubForm ()
	Get sub form html. More...

	hideSubForm ()
	Sub form hidden on init? More...

	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...

	getHiddenTitle ()
	Get hidden title. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...

	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...

	getMulti ()
	Get Multi. More...

	setMultiValues (array $a_values)
	Set multi values. More...

	getMultiValues ()
	Get multi values. More...

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

Public Member Functions inherited from ilTableFilterItem
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Protected Attributes
	$tpl

	$values = array()

	$allowMove = false

Protected Attributes inherited from ilTextInputGUI
	$value

	$maxlength = 200

	$size = 40

	$validationRegexp

	$validationFailureMessage = ''

	$suffix

	$style_css

	$css_class

	$ajax_datasource

	$ajax_datasource_delimiter

	$ajax_datasource_commit = false

	$ajax_datasource_commit_url

	$submit_form_on_enter = false

	$autocomplete_disabled = false

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
	$ctrl

	$lng

	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Detailed Description

This class represents a text wizard property in a property form.

Author: Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilTextWizardInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Definition at line 47 of file class.ilTextWizardInputGUI.php.

References $DIC.

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->tpl = $DIC["tpl"];
         parent::__construct($a_title, $a_postvar);
         $this->validationRegexp = "";
     }

Member Function Documentation

◆ checkInput()

ilTextWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

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

References $_POST, ilFormPropertyGUI\$lng, ilTextInputGUI\$value, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilTextInputGUI\getValidationRegexp(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

     {
         $lng = $this->lng;
         
         $foundvalues = $_POST[$this->getPostVar()];
         if (is_array($foundvalues)) {
             foreach ($foundvalues as $idx => $value) {
                 $_POST[$this->getPostVar()][$idx] = ilUtil::stripSlashes($value);
                 if ($this->getRequired() && trim($value) == "") {
                     $this->setAlert($lng->txt("msg_input_is_required"));
 
                     return false;
                 } elseif (strlen($this->getValidationRegexp())) {
                     if (!preg_match($this->getValidationRegexp(), $value)) {
                         $this->setAlert($lng->txt("msg_wrong_format"));
                         return false;
                     }
                 }
             }
         } elseif ($this->getRequired()) {
             $this->setAlert($lng->txt("msg_input_is_required"));
             return false;
         }
         
         return $this->checkSubItemsInput();
     }

Here is the call graph for this function:

◆ getAllowMove()

ilTextWizardInputGUI::getAllowMove ( )

Get allow move.

Returns: boolean Allow move

Definition at line 102 of file class.ilTextWizardInputGUI.php.

References $allowMove.

Referenced by ilSelectBuilderInputGUI\insert(), and render().

     {
         return $this->allowMove;
     }

Here is the caller graph for this function:

◆ getValues()

ilTextWizardInputGUI::getValues ( )

Get Values.

Returns: array Values

Definition at line 82 of file class.ilTextWizardInputGUI.php.

References $values.

     {
         return $this->values;
     }

◆ insert()

ilTextWizardInputGUI::insert ( $a_tpl )

Insert property html.

Returns: int Size

Definition at line 144 of file class.ilTextWizardInputGUI.php.

References render().

     {
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $this->render());
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ render()

ilTextWizardInputGUI::render ( $a_mode = "" )

Definition at line 151 of file class.ilTextWizardInputGUI.php.

References $i, $tpl, ilTextInputGUI\$value, ilGlyphGUI\ADD, ilGlyphGUI\DOWN, ilGlyphGUI\get(), getAllowMove(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilTextInputGUI\getMaxLength(), ilFormPropertyGUI\getPostVar(), ilTextInputGUI\getSize(), ilUtil\prepareFormOutput(), ilGlyphGUI\REMOVE, and ilGlyphGUI\UP.

Referenced by insert().

     {
         $tpl = new ilTemplate("tpl.prop_textwizardinput.html", true, true, "Services/Form");
         $i = 0;
         foreach ($this->values as $value) {
             if (strlen($value)) {
                 $tpl->setCurrentBlock("prop_text_propval");
                 $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value));
                 $tpl->parseCurrentBlock();
             }
             if ($this->getAllowMove()) {
                 $tpl->setCurrentBlock("move");
                 $tpl->setVariable("CMD_UP", "cmd[up" . $this->getFieldId() . "][$i]");
                 $tpl->setVariable("CMD_DOWN", "cmd[down" . $this->getFieldId() . "][$i]");
                 $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
                 $tpl->setVariable("UP_BUTTON", ilGlyphGUI::get(ilGlyphGUI::UP));
                 $tpl->setVariable("DOWN_BUTTON", ilGlyphGUI::get(ilGlyphGUI::DOWN));
                 $tpl->parseCurrentBlock();
             }
             $tpl->setCurrentBlock("row");
             $tpl->setVariable("POST_VAR", $this->getPostVar() . "[$i]");
             $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
             $tpl->setVariable("SIZE", $this->getSize());
             $tpl->setVariable("MAXLENGTH", $this->getMaxLength());
             
             if ($this->getDisabled()) {
                 $tpl->setVariable(
                     "DISABLED",
                     " disabled=\"disabled\""
                 );
             } else {
                 $tpl->setVariable("CMD_ADD", "cmd[add" . $this->getFieldId() . "][$i]");
                 $tpl->setVariable("CMD_REMOVE", "cmd[remove" . $this->getFieldId() . "][$i]");
                 $tpl->setVariable("ADD_BUTTON", ilGlyphGUI::get(ilGlyphGUI::ADD));
                 $tpl->setVariable("REMOVE_BUTTON", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
             }
             
             $tpl->parseCurrentBlock();
             $i++;
         }
 
         $tpl->setVariable("ELEMENT_ID", $this->getFieldId());
         
         if (!$this->getDisabled()) {
             $this->tpl->addJavascript("./Services/Form/js/ServiceFormWizardInput.js");
             $this->tpl->addJavascript("./Services/Form/templates/default/textwizard.js");
         }
         
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAllowMove()

ilTextWizardInputGUI::setAllowMove ( $a_allow_move )

Set allow move.

Parameters

boolean $a_allow_move Allow move

Definition at line 92 of file class.ilTextWizardInputGUI.php.

Referenced by ilObjectCustomUserFieldsGUI\initFieldForm().

     {
         $this->allowMove = $a_allow_move;
     }

Here is the caller graph for this function:

◆ setValue()

ilTextWizardInputGUI::setValue ( $a_value )

Set Value.

Parameters

array $a_value Value

Definition at line 72 of file class.ilTextWizardInputGUI.php.

     {
         $this->values = $a_value;
     }

◆ setValues()

ilTextWizardInputGUI::setValues ( $a_values )

Set Values.

Parameters

array $a_value Value

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

     {
         $this->values = $a_values;
     }

Field Documentation

◆ $allowMove

ilTextWizardInputGUI::$allowMove = false

protected

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

Referenced by getAllowMove().

◆ $tpl

ilTextWizardInputGUI::$tpl

protected

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

Referenced by render().

◆ $values

ilTextWizardInputGUI::$values = array()

protected

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

Referenced by getValues().

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

Services/Form/classes/class.ilTextWizardInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getAllowMove()

◆ getValues()

◆ insert()

◆ render()

◆ setAllowMove()

◆ setValue()

◆ setValues()

Field Documentation

◆ $allowMove

◆ $tpl

◆ $values