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

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...
 
- 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)
 Set multi values. More...
 
 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...
 
 removeProhibitedCharacters ($a_text)
 Remove prohibited characters see #19159. More...
 
 stripSlashesAddSpaceFallback ($a_str)
 Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...
 
 getTableFilterHTML ()
 Get input item HTML to be inserted into table filters. More...
 
 getToolbarHTML ()
 Get input item HTML to be inserted into ilToolbarGUI. More...
 

Protected Attributes

 $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
 $type
 
 $title
 
 $postvar
 
 $info
 
 $alert
 
 $required = false
 
 $parentgui
 
 $parentform
 
 $hidden_title = ""
 
 $multi = false
 
 $multi_sortable = false
 
 $multi_addremove = true
 
 $multi_values
 

Additional Inherited Members

- 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_titleTitle
string$a_postvarPost Variable

Reimplemented from ilTextInputGUI.

Reimplemented in ilSelectBuilderInputGUI.

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

43 {
44 parent::__construct($a_title, $a_postvar);
45 $this->validationRegexp = "";
46 }

Member Function Documentation

◆ checkInput()

ilTextWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns
boolean Input ok, true/false

Reimplemented from ilTextInputGUI.

Reimplemented in ilSelectBuilderInputGUI.

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

104 {
105 global $lng;
106
107 $foundvalues = $_POST[$this->getPostVar()];
108 if (is_array($foundvalues))
109 {
110 foreach ($foundvalues as $idx => $value)
111 {
112 $_POST[$this->getPostVar()][$idx] = ilUtil::stripSlashes($value);
113 if ($this->getRequired() && trim($value) == "")
114 {
115 $this->setAlert($lng->txt("msg_input_is_required"));
116
117 return false;
118 }
119 else if (strlen($this->getValidationRegexp()))
120 {
121 if (!preg_match($this->getValidationRegexp(), $value))
122 {
123 $this->setAlert($lng->txt("msg_wrong_format"));
124 return FALSE;
125 }
126 }
127 }
128 }
129 else if($this->getRequired())
130 {
131 $this->setAlert($lng->txt("msg_input_is_required"));
132 return FALSE;
133 }
134
135 return $this->checkSubItemsInput();
136 }
getPostVar()
Get Post Variable.
setAlert($a_alert)
Set Alert Text.
getValidationRegexp()
Get validation regexp.
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
$_POST['username']
Definition: cron.php:12
global $lng
Definition: privfeed.php:40

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

+ Here is the call graph for this function:

◆ getAllowMove()

ilTextWizardInputGUI::getAllowMove ( )

Get allow move.

Returns
boolean Allow move

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

References $allowMove.

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

+ Here is the caller graph for this function:

◆ getValues()

ilTextWizardInputGUI::getValues ( )

Get Values.

Returns
array Values

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

References $values.

◆ insert()

ilTextWizardInputGUI::insert ( $a_tpl)

Insert property html.

Returns
int Size

Reimplemented from ilTextInputGUI.

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

144 {
145 $tpl = new ilTemplate("tpl.prop_textwizardinput.html", true, true, "Services/Form");
146 $i = 0;
147 foreach ($this->values as $value)
148 {
149 if (strlen($value))
150 {
151 $tpl->setCurrentBlock("prop_text_propval");
152 $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value));
153 $tpl->parseCurrentBlock();
154 }
155 if ($this->getAllowMove())
156 {
157 $tpl->setCurrentBlock("move");
158 $tpl->setVariable("CMD_UP", "cmd[up" . $this->getFieldId() . "][$i]");
159 $tpl->setVariable("CMD_DOWN", "cmd[down" . $this->getFieldId() . "][$i]");
160 $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
161 include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
162 $tpl->setVariable("UP_BUTTON", ilGlyphGUI::get(ilGlyphGUI::UP));
163 $tpl->setVariable("DOWN_BUTTON", ilGlyphGUI::get(ilGlyphGUI::DOWN));
164 $tpl->parseCurrentBlock();
165 }
166 $tpl->setCurrentBlock("row");
167 $tpl->setVariable("POST_VAR", $this->getPostVar() . "[$i]");
168 $tpl->setVariable("ID", $this->getFieldId() . "[$i]");
169 $tpl->setVariable("SIZE", $this->getSize());
170 $tpl->setVariable("MAXLENGTH", $this->getMaxLength());
171
172 if ($this->getDisabled())
173 {
174 $tpl->setVariable("DISABLED",
175 " disabled=\"disabled\"");
176 }
177 else
178 {
179 $tpl->setVariable("CMD_ADD", "cmd[add" . $this->getFieldId() . "][$i]");
180 $tpl->setVariable("CMD_REMOVE", "cmd[remove" . $this->getFieldId() . "][$i]");
181 include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
182 $tpl->setVariable("ADD_BUTTON", ilGlyphGUI::get(ilGlyphGUI::ADD));
183 $tpl->setVariable("REMOVE_BUTTON", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
184 }
185
186 $tpl->parseCurrentBlock();
187 $i++;
188 }
189 $tpl->setVariable("ELEMENT_ID", $this->getFieldId());
190
191 $a_tpl->setCurrentBlock("prop_generic");
192 $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
193 $a_tpl->parseCurrentBlock();
194
195 if (!$this->getDisabled())
196 {
197 global $tpl;
198 $tpl->addJavascript("./Services/Form/js/ServiceFormWizardInput.js");
199 $tpl->addJavascript("./Services/Form/templates/default/textwizard.js");
200 }
201 }
global $tpl
Definition: ilias.php:8
getFieldId()
Get Post Variable.
static get($a_glyph, $a_text="")
Get glyph html.
special template class to simplify handling of ITX/PEAR
getMaxLength()
Get Max Length.
static prepareFormOutput($a_str, $a_strip=false)
prepares string output for html forms @access public

References $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.

+ Here is the call graph for this function:

◆ setAllowMove()

ilTextWizardInputGUI::setAllowMove (   $a_allow_move)

Set allow move.

Parameters
boolean$a_allow_moveAllow move

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

84 {
85 $this->allowMove = $a_allow_move;
86 }

◆ setValue()

ilTextWizardInputGUI::setValue (   $a_value)

Set Value.

Parameters
array$a_valueValue

Reimplemented from ilTextInputGUI.

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

64 {
65 $this->values = $a_value;
66 }

◆ setValues()

ilTextWizardInputGUI::setValues (   $a_values)

Set Values.

Parameters
array$a_valueValue

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

54 {
55 $this->values = $a_values;
56 }

Field Documentation

◆ $allowMove

ilTextWizardInputGUI::$allowMove = false
protected

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

Referenced by getAllowMove().

◆ $values

ilTextWizardInputGUI::$values = array()
protected

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

Referenced by getValues().


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