| ILIAS
    Release_4_1_x_branch Revision 61804
    | 
This class represents a text area property in a property form. More...
 Inheritance diagram for ilTextAreaInputGUI:
 Inheritance diagram for ilTextAreaInputGUI: Collaboration diagram for ilTextAreaInputGUI:
 Collaboration diagram for ilTextAreaInputGUI:| Public Member Functions | |
| __construct ($a_title="", $a_postvar="") | |
| Constructor. | |
| setValue ($a_value) | |
| Set Value. | |
| getValue () | |
| Get Value. | |
| setCols ($a_cols) | |
| Set Cols. | |
| getCols () | |
| Get Cols. | |
| setRows ($a_rows) | |
| Set Rows. | |
| getRows () | |
| Get Rows. | |
| setUseRte ($a_usert) | |
| Set Use Rich Text Editing. | |
| getUseRte () | |
| Get Use Rich Text Editing. | |
| addPlugin ($a_plugin) | |
| Add RTE plugin. | |
| removePlugin ($a_plugin) | |
| Remove RTE plugin. | |
| addButton ($a_button) | |
| Add RTE button. | |
| removeButton ($a_button) | |
| Remove RTE button. | |
| setRTESupport ($obj_id, $obj_type, $module, $cfg_template=null, $hide_switch=false, $version=null) | |
| Set RTE support for a special module. | |
| removeRTESupport () | |
| Remove RTE support for a special module. | |
| setRteTags ($a_rtetags) | |
| Set Valid RTE Tags. | |
| getRteTags () | |
| Get Valid RTE Tags. | |
| setRteTagSet ($a_set_name) | |
| Set Set of Valid RTE Tags. | |
| getRteTagSet ($a_set_name) | |
| Get Set of Valid RTE Tags. | |
| getRteTagString () | |
| RTE Tag string. | |
| setUseTagsForRteOnly ($a_val) | |
| Set use tags for RTE only (default is true) | |
| getUseTagsForRteOnly () | |
| Get use tags for RTE only (default is true) | |
| setValueByArray ($a_values) | |
| Set value by array. | |
| checkInput () | |
| Check input, strip slashes etc. | |
| insert (&$a_tpl) | |
| Insert property html. | |
| usePurifier ($a_flag=null) | |
| Setter/Getter for the html purifier usage. | |
| setPurifier (ilHtmlPurifierInterface $Purifier) | |
| Setter for the html purifier. | |
| getPurifier () | |
| Getter for the html purifier. | |
| setRTERootBlockElement ($a_root_block_element) | |
| Setter for the TinyMCE root block element. | |
| getRTERootBlockElement () | |
| Getter for the TinyMCE root block element. | |
| disableButtons ($a_button) | |
| Sets buttons which should be disabled in TinyMCE. | |
| getDisabledButtons ($as_array=true) | |
| Returns the disabled TinyMCE buttons. | |
|  Public Member Functions inherited from ilSubEnabledFormPropertyGUI | |
| addSubItem ($a_item) | |
| Add Subitem. | |
| getSubItems () | |
| Get Subitems. | |
| checkSubItemsInput () | |
| Check SubItems. | |
| getSubForm () | |
| Get sub form html. | |
| getItemByPostVar ($a_post_var) | |
| Get item by post var. | |
|  Public Member Functions inherited from ilFormPropertyGUI | |
| & | executeCommand () | 
| Execute command. | |
| getType () | |
| Get Type. | |
| setTitle ($a_title) | |
| Set Title. | |
| getTitle () | |
| Get Title. | |
| setPostVar ($a_postvar) | |
| Set Post Variable. | |
| getPostVar () | |
| Get Post Variable. | |
| getFieldId () | |
| Get Post Variable. | |
| setInfo ($a_info) | |
| Set Information Text. | |
| getInfo () | |
| Get Information Text. | |
| setAlert ($a_alert) | |
| Set Alert Text. | |
| getAlert () | |
| Get Alert Text. | |
| setRequired ($a_required) | |
| Set Required. | |
| getRequired () | |
| Get Required. | |
| setDisabled ($a_disabled) | |
| Set Disabled. | |
| getDisabled () | |
| Get Disabled. | |
| setParentForm ($a_parentform) | |
| Set Parent Form. | |
| getParentForm () | |
| Get Parent Form. | |
| setParent ($a_val) | |
| Set Parent GUI object. | |
| getParent () | |
| Get Parent GUI object. | |
| hideSubForm () | |
| Sub form hidden on init? | |
| setHiddenTitle ($a_val) | |
| Set hidden title (for screenreaders) | |
| getHiddenTitle () | |
| Get hidden title. | |
| serializeData () | |
| serialize data | |
| unserializeData ($a_data) | |
| unserialize data | |
| writeToSession () | |
| Write to session. | |
| clearFromSession () | |
| Clear session value. | |
| readFromSession () | |
| Read from session. | |
| getHiddenTag ($a_post_var, $a_value) | |
| Get hidden tag (used for disabled properties) | |
| Protected Attributes | |
| $value | |
| $cols | |
| $rows | |
| $usert | |
| $rtetags | |
| $plugins | |
| $removeplugins | |
| $buttons | |
| $rtesupport | |
| $use_tags_for_rte_only = true | |
| $disabled_buttons = array() | |
| $usePurifier = false | |
| $Purifier = null | |
| $root_block_element = null | |
| $rte_tag_set | |
|  Protected Attributes inherited from ilSubEnabledFormPropertyGUI | |
| $sub_items = array() | |
|  Protected Attributes inherited from ilFormPropertyGUI | |
| $type | |
| $title | |
| $postvar | |
| $info | |
| $alert | |
| $required = false | |
| $parentgui | |
| $parentform | |
| $hidden_title = "" | |
| Additional Inherited Members | |
|  Protected Member Functions inherited from ilFormPropertyGUI | |
| setType ($a_type) | |
| Set Type. | |
This class represents a text area property in a property form.
Definition at line 33 of file class.ilTextAreaInputGUI.php.
| ilTextAreaInputGUI::__construct | ( | $a_title = "", | |
| $a_postvar = "" | |||
| ) | 
Constructor.
| string | $a_title | Title | 
| string | $a_postvar | Post Variable | 
Reimplemented from ilFormPropertyGUI.
Definition at line 121 of file class.ilTextAreaInputGUI.php.
References setRteTagSet(), and ilFormPropertyGUI\setType().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilTextAreaInputGUI::addButton | ( | $a_button | ) | 
Add RTE button.
| string | $a_button | Button name | 
Definition at line 237 of file class.ilTextAreaInputGUI.php.
| ilTextAreaInputGUI::addPlugin | ( | $a_plugin | ) | 
Add RTE plugin.
| string | $a_plugin | Plugin name | 
Definition at line 217 of file class.ilTextAreaInputGUI.php.
| ilTextAreaInputGUI::checkInput | ( | ) | 
Check input, strip slashes etc.
set alert, if input is not ok.
Reimplemented from ilFormPropertyGUI.
Definition at line 363 of file class.ilTextAreaInputGUI.php.
References $_POST, $lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), getPurifier(), ilFormPropertyGUI\getRequired(), getRteTagString(), getUseRte(), getUseTagsForRteOnly(), ilFormPropertyGUI\setAlert(), ilUtil\stripOnlySlashes(), ilUtil\stripSlashes(), and usePurifier().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilTextAreaInputGUI::disableButtons | ( | $a_button | ) | 
Sets buttons which should be disabled in TinyMCE.
| mixed | $a_button | Either a button string or an array of button strings | 
Definition at line 583 of file class.ilTextAreaInputGUI.php.
| ilTextAreaInputGUI::getCols | ( | ) | 
Get Cols.
Definition at line 167 of file class.ilTextAreaInputGUI.php.
References $cols.
Referenced by insert().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::getDisabledButtons | ( | $as_array = true | ) | 
Returns the disabled TinyMCE buttons.
| boolean | $as_array | Should the disabled buttons be returned as a string or as an array | 
Definition at line 605 of file class.ilTextAreaInputGUI.php.
References $disabled_buttons.
Referenced by insert().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::getPurifier | ( | ) | 
Getter for the html purifier.
Definition at line 546 of file class.ilTextAreaInputGUI.php.
References $Purifier.
Referenced by checkInput().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::getRows | ( | ) | 
Get Rows.
Definition at line 187 of file class.ilTextAreaInputGUI.php.
References $rows.
Referenced by insert().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::getRTERootBlockElement | ( | ) | 
Getter for the TinyMCE root block element.
Definition at line 570 of file class.ilTextAreaInputGUI.php.
References $root_block_element.
Referenced by insert().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::getRteTags | ( | ) | 
Get Valid RTE Tags.
Definition at line 287 of file class.ilTextAreaInputGUI.php.
References $rtetags.
Referenced by getRteTagString(), and insert().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::getRteTagSet | ( | $a_set_name | ) | 
Get Set of Valid RTE Tags.
Definition at line 309 of file class.ilTextAreaInputGUI.php.
| ilTextAreaInputGUI::getRteTagString | ( | ) | 
RTE Tag string.
Definition at line 318 of file class.ilTextAreaInputGUI.php.
References $result, and getRteTags().
Referenced by checkInput().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::getUseRte | ( | ) | 
Get Use Rich Text Editing.
Definition at line 207 of file class.ilTextAreaInputGUI.php.
References $usert.
Referenced by checkInput(), and insert().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::getUseTagsForRteOnly | ( | ) | 
Get use tags for RTE only (default is true)
Definition at line 343 of file class.ilTextAreaInputGUI.php.
References $use_tags_for_rte_only.
Referenced by checkInput().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::getValue | ( | ) | 
Get Value.
Definition at line 147 of file class.ilTextAreaInputGUI.php.
References $value.
Referenced by insert().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::insert | ( | & | $a_tpl | ) | 
Insert property html.
Definition at line 399 of file class.ilTextAreaInputGUI.php.
References ilRTE\_getRTEClassname(), getCols(), ilFormPropertyGUI\getDisabled(), getDisabledButtons(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getHiddenTag(), ilFormPropertyGUI\getPostVar(), getRows(), getRTERootBlockElement(), getRteTags(), getUseRte(), getValue(), and ilUtil\prepareFormOutput().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilTextAreaInputGUI::removeButton | ( | $a_button | ) | 
Remove RTE button.
| string | $a_button | Button name | 
Definition at line 247 of file class.ilTextAreaInputGUI.php.
| ilTextAreaInputGUI::removePlugin | ( | $a_plugin | ) | 
Remove RTE plugin.
| string | $a_plugin | Plugin name | 
Definition at line 227 of file class.ilTextAreaInputGUI.php.
| ilTextAreaInputGUI::removeRTESupport | ( | ) | 
Remove RTE support for a special module.
Definition at line 267 of file class.ilTextAreaInputGUI.php.
| ilTextAreaInputGUI::setCols | ( | $a_cols | ) | 
Set Cols.
| int | $a_cols | Cols | 
Definition at line 157 of file class.ilTextAreaInputGUI.php.
Referenced by ilObjSAHSLearningModuleGUI\initCreationForm(), ilObjectPluginGUI\initEditForm(), ilObjFileBasedLMGUI\initEditForm(), ilObjMediaPoolGUI\initEditForm(), ilObject2GUI\initEditForm(), ilObjTaggingSettingsGUI\initForbiddenTagsForm(), ilObjBookingPoolGUI\initForm(), ilObjMediaObjectGUI\initForm(), ilMailingListsGUI\initForm(), ilObjForumGUI\initForumCreateForm(), ilNoteGUI\initNoteForm(), ilPermission2GUI\initRoleForm(), ilObjWikiGUI\initSettingsForm(), and ilObjForumGUI\initTopicCreateForm().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::setPurifier | ( | ilHtmlPurifierInterface | $Purifier | ) | 
Setter for the html purifier.
| ilHtmlPurifierInterface | Instance of ilHtmlPurifierInterface | 
Definition at line 534 of file class.ilTextAreaInputGUI.php.
References $Purifier.
| ilTextAreaInputGUI::setRows | ( | $a_rows | ) | 
Set Rows.
| int | $a_rows | Rows | 
Definition at line 177 of file class.ilTextAreaInputGUI.php.
Referenced by ilObjPaymentSettingsGUI\generalSettingsObject(), ilObjExerciseGUI\initAssignmentForm(), ilObjMediaObjectGUI\initForm(), ilObjUserGUI\initForm(), ilObjLinkResourceGUI\initFormLink(), ilConsultationHoursGUI\initFormSequence(), ilObjAuthSettingsGUI\initLoginForm(), ilMailOptionsGUI\initMailOptionsForm(), ilPersonalProfileGUI\initMailOptionsForm(), and ilObjFileGUI\initPropertiesForm().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::setRTERootBlockElement | ( | $a_root_block_element | ) | 
Setter for the TinyMCE root block element.
| string | $a_root_block_element | root block element | 
Definition at line 558 of file class.ilTextAreaInputGUI.php.
| ilTextAreaInputGUI::setRTESupport | ( | $obj_id, | |
| $obj_type, | |||
| $module, | |||
| $cfg_template = null, | |||
| $hide_switch = false, | |||
| $version = null | |||
| ) | 
Set RTE support for a special module.
Definition at line 259 of file class.ilTextAreaInputGUI.php.
| ilTextAreaInputGUI::setRteTags | ( | $a_rtetags | ) | 
Set Valid RTE Tags.
| array | $a_rtetags | Valid RTE Tags | 
Definition at line 277 of file class.ilTextAreaInputGUI.php.
Referenced by setRteTagSet().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::setRteTagSet | ( | $a_set_name | ) | 
Set Set of Valid RTE Tags.
Definition at line 298 of file class.ilTextAreaInputGUI.php.
References setRteTags().
Referenced by __construct().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::setUseRte | ( | $a_usert | ) | 
Set Use Rich Text Editing.
| int | $a_usert | Use Rich Text Editing | 
Definition at line 197 of file class.ilTextAreaInputGUI.php.
Referenced by ilObjChatServerGUI\initSmiliesEditForm().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::setUseTagsForRteOnly | ( | $a_val | ) | 
Set use tags for RTE only (default is true)
| boolean | $a_val | use tags for RTE only | 
Definition at line 333 of file class.ilTextAreaInputGUI.php.
| ilTextAreaInputGUI::setValue | ( | $a_value | ) | 
Set Value.
| string | $a_value | Value | 
Definition at line 137 of file class.ilTextAreaInputGUI.php.
Referenced by assQuestionGUI\addBasicQuestionFormProperties(), ilPaymentCouponGUI\addCoupon(), ilObjSurveyGUI\addHeadingObject(), ilUserProfile\addStandardFieldsToForm(), ilCertificateGUI\certificateEditor(), ilObjStyleSettingsGUI\createPgGUIObject(), ilObjFileAccessSettingsGUI\editDownloadingSettings(), ilObjForumGUI\editObject(), SurveyTextQuestionGUI\editQuestion(), SurveyMetricQuestionGUI\editQuestion(), assTextQuestionGUI\editQuestion(), assOrderingHorizontalGUI\editQuestion(), SurveySingleChoiceQuestionGUI\editQuestion(), SurveyMultipleChoiceQuestionGUI\editQuestion(), assErrorTextGUI\editQuestion(), SurveyMatrixQuestionGUI\editQuestion(), assSingleChoiceGUI\feedback(), assMultipleChoiceGUI\feedback(), assImagemapQuestionGUI\feedback(), assQuestionGUI\feedback(), ilGroupRegistrationGUI\fillRegistrationType(), ilCourseRegistrationGUI\fillRegistrationType(), ilObjSurveyGUI\importExternalMailRecipientsObject(), ilObjMDSettingsGUI\initCopyrightEditForm(), ilObjRemoteCourseGUI\initEditTable(), ilAdvancedMDSettingsGUI\initFieldForm(), ilCalendarAppointmentGUI\initForm(), ilAdvancedMDSettingsGUI\initForm(), ilObjCourseGUI\initForm(), ilObjSessionGUI\initForm(), ilObjGroupGUI\initForm(), ilObjLinkResourceGUI\initFormSettings(), ilCourseObjectivesGUI\initFormTitle(), ilObjCourseGUI\initInfoEditor(), ilObjMediaCastGUI\initSettingsForm(), ilPageLayoutGUI\properties(), ilObjSurveyGUI\propertiesObject(), ilObjTestGUI\propertiesObject(), setValueByArray(), ilMailFormGUI\showForm(), and assQuestionGUI\suggestedsolution().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilTextAreaInputGUI::setValueByArray | ( | $a_values | ) | 
Set value by array.
| array | $a_values | value array | 
Definition at line 353 of file class.ilTextAreaInputGUI.php.
References ilFormPropertyGUI\getPostVar(), and setValue().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilTextAreaInputGUI::usePurifier | ( | $a_flag = null | ) | 
Setter/Getter for the html purifier usage.
| boolean | $a_flag | Use purifier or not | 
Definition at line 516 of file class.ilTextAreaInputGUI.php.
References $usePurifier.
Referenced by checkInput().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | protected | 
Definition at line 42 of file class.ilTextAreaInputGUI.php.
| 
 | protected | 
Definition at line 36 of file class.ilTextAreaInputGUI.php.
Referenced by getCols().
| 
 | protected | 
Definition at line 54 of file class.ilTextAreaInputGUI.php.
Referenced by getDisabledButtons().
| 
 | protected | 
Definition at line 40 of file class.ilTextAreaInputGUI.php.
| 
 | protected | 
Definition at line 74 of file class.ilTextAreaInputGUI.php.
Referenced by getPurifier(), and setPurifier().
| 
 | protected | 
Definition at line 41 of file class.ilTextAreaInputGUI.php.
| 
 | protected | 
Definition at line 83 of file class.ilTextAreaInputGUI.php.
Referenced by getRTERootBlockElement().
| 
 | protected | 
Definition at line 37 of file class.ilTextAreaInputGUI.php.
Referenced by getRows().
| 
 | protected | 
Definition at line 85 of file class.ilTextAreaInputGUI.php.
| 
 | protected | 
Definition at line 43 of file class.ilTextAreaInputGUI.php.
| 
 | protected | 
Definition at line 39 of file class.ilTextAreaInputGUI.php.
Referenced by getRteTags().
| 
 | protected | 
Definition at line 44 of file class.ilTextAreaInputGUI.php.
Referenced by getUseTagsForRteOnly().
| 
 | protected | 
Definition at line 64 of file class.ilTextAreaInputGUI.php.
Referenced by usePurifier().
| 
 | protected | 
Definition at line 38 of file class.ilTextAreaInputGUI.php.
Referenced by getUseRte().
| 
 | protected | 
Definition at line 35 of file class.ilTextAreaInputGUI.php.
Referenced by getValue().