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

Inheritance diagram for ilTextAreaInputGUI:

Collaboration diagram for ilTextAreaInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	setValue (string $a_value)

	getValue ()

	setCols (int $a_cols)

	getCols ()

	setRows (int $a_rows)

	getRows ()

	setMaxNumOfChars (int $a_number)

	getMaxNumOfChars ()

	setMinNumOfChars (int $a_number)

	getMinNumOfChars ()

	setUseRte (bool $a_usert, string $version='')

	getUseRte ()

	addPlugin (string $a_plugin)

	removePlugin (string $a_plugin)

	addButton (string $a_button)

	removeButton (string $a_button)

	setRTESupport (int $obj_id, string $obj_type, string $module, ?string $cfg_template=null, bool $hide_switch=false, ?string $version=null)
	Set RTE support for a special module. More...

	removeRTESupport ()

	setRteTags (array $a_rtetags)

	getRteTags ()

	setRteTagSet (string $a_set_name)

	getRteTagSet ($a_set_name)

	getRteTagString ()

	setUseTagsForRteOnly (bool $a_val)
	Set use tags for RTE only (default is true) More...

	getUseTagsForRteOnly ()

	setValueByArray (array $a_values)

	checkInput ()

	getInput ()

	insert (ilTemplate $a_tpl)

	usePurifier (?bool $a_flag=null)
	Setter/Getter for the html purifier usage. More...

	setPurifier (ilHtmlPurifierInterface $Purifier)
	Setter for the html purifier. More...

	getPurifier ()

	setRTERootBlockElement (?string $a_root_block_element)

	getRTERootBlockElement ()

	disableButtons ($a_button)
	Sets buttons which should be disabled in TinyMCE. More...

	getDisabledButtons (bool $as_array=true)

	getInitialRteWidth ()

	setInitialRteWidth (int $initial_rte_width)

	isCharLimited ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

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

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

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

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

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

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

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

	stripSlashesAddSpaceFallback (string $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...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Protected Attributes
array	$rteSupport = []

string	$value = ""

int	$cols = 30

int	$rows = 5

bool	$usert = false

array	$rtetags = []

array	$plugins = []

array	$removeplugins = []

array	$buttons = []

array	$rtesupport = []

bool	$use_tags_for_rte_only = true

int	$max_num_chars = 0

int	$min_num_chars = 0

int	$initial_rte_width = 795

array	$disabled_buttons = array()

bool	$usePurifier = false

ilHtmlPurifierInterface	$Purifier = null

string	$root_block_element = null

array	$rte_tag_set

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

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

Protected Member Functions inherited from ilFormPropertyGUI
	symbol ()

	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Detailed Description

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

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 26 of file class.ilTextAreaInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTextAreaInputGUI::__construct	(	string	$a_title = `""`,
		string	$a_postvar = `""`
	)

Definition at line 77 of file class.ilTextAreaInputGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), setRteTagSet(), and ilFormPropertyGUI\setType().

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         parent::__construct($a_title, $a_postvar);
         $this->setType("textarea");
         $this->setRteTagSet("standard");
         $this->plugins = array();
         $this->removeplugins = array();
         $this->buttons = array();
         $this->rteSupport = array();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addButton()

ilTextAreaInputGUI::addButton ( string $a_button )

Definition at line 170 of file class.ilTextAreaInputGUI.php.

                                                : void
     {
         $this->buttons[$a_button] = $a_button;
     }

◆ addPlugin()

ilTextAreaInputGUI::addPlugin ( string $a_plugin )

Definition at line 159 of file class.ilTextAreaInputGUI.php.

                                                : void
     {
         $this->plugins[$a_plugin] = $a_plugin;
     }

◆ checkInput()

ilTextAreaInputGUI::checkInput ( )

Definition at line 261 of file class.ilTextAreaInputGUI.php.

References ilFormPropertyGUI\$lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), getInput(), getMaxNumOfChars(), getMinNumOfChars(), ilFormPropertyGUI\getRequired(), isCharLimited(), ilFormPropertyGUI\setAlert(), and ilLanguage\txt().

                                 : bool
     {
         $lng = $this->lng;
 
         $value = $this->getInput();
         if ($this->getRequired() && trim($value) == "") {
             $this->setAlert($lng->txt("msg_input_is_required"));
             return false;
         }
 
         if ($this->isCharLimited()) {
             //avoid whitespace surprises. #20630, #20674
             $ascii_whitespaces = chr(194) . chr(160);
             $ascii_breaklines = chr(13) . chr(10);
 
             $to_replace = array($ascii_whitespaces, $ascii_breaklines, "&lt;", "&gt;", "&amp;");
             $replace_to = array(' ', '', "_", "_", "_");
 
             #20630 mbstring extension is mandatory for 5.4
             $chars_entered = mb_strlen(strip_tags(str_replace($to_replace, $replace_to, $value)));
 
             if ($this->getMaxNumOfChars() && ($chars_entered > $this->getMaxNumOfChars())) {
                 $this->setAlert($lng->txt("msg_input_char_limit_max"));
                 return false;
             } elseif ($this->getMinNumOfChars() && ($chars_entered < $this->getMinNumOfChars())) {
                 $this->setAlert($lng->txt("msg_input_char_limit_min"));
                 return false;
             }
         }
 
         return $this->checkSubItemsInput();
     }

Here is the call graph for this function:

◆ disableButtons()

ilTextAreaInputGUI::disableButtons ( $a_button )

Sets buttons which should be disabled in TinyMCE.

Parameters

string|string[] $a_button Either a button string or an array of button strings

Definition at line 480 of file class.ilTextAreaInputGUI.php.

                                              : self
     {
         if (is_array($a_button)) {
             $this->disabled_buttons = array_unique(array_merge($this->disabled_buttons, $a_button));
         } else {
             $this->disabled_buttons = array_unique(array_merge($this->disabled_buttons, array($a_button)));
         }
         return $this;
     }

◆ getCols()

ilTextAreaInputGUI::getCols ( )

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

References $cols.

Referenced by insert().

                              : int
     {
         return $this->cols;
     }

Here is the caller graph for this function:

◆ getDisabledButtons()

ilTextAreaInputGUI::getDisabledButtons ( bool $as_array = true )

Returns: string|array Array of disabled buttons

Definition at line 493 of file class.ilTextAreaInputGUI.php.

References $disabled_buttons.

Referenced by insert().

     {
         if (!$as_array) {
             return implode(',', $this->disabled_buttons);
         } else {
             return $this->disabled_buttons;
         }
     }

Here is the caller graph for this function:

◆ getInitialRteWidth()

ilTextAreaInputGUI::getInitialRteWidth ( )

Definition at line 502 of file class.ilTextAreaInputGUI.php.

References $initial_rte_width.

Referenced by insert().

                                         : int
     {
         return $this->initial_rte_width;
     }

Here is the caller graph for this function:

◆ getInput()

ilTextAreaInputGUI::getInput ( )

Definition at line 294 of file class.ilTextAreaInputGUI.php.

References $value, ilFormPropertyGUI\getPostVar(), getPurifier(), getRteTagString(), getUseRte(), getUseTagsForRteOnly(), ilFormPropertyGUI\raw(), ilFormPropertyGUI\str(), ilUtil\stripSlashes(), and usePurifier().

Referenced by checkInput().

                               : string
     {
         if ($this->usePurifier() && $this->getPurifier()) {
             $value = $this->getPurifier()->purify($this->raw($this->getPostVar()));
         } else {
             $allowed = $this->getRteTagString();
             if (isset($this->plugins["latex"]) && $this->plugins["latex"] == "latex" && !is_int(strpos($allowed, "<span>"))) {
                 $allowed .= "<span>";
             }
             $value = ($this->getUseRte() || !$this->getUseTagsForRteOnly())
                 ? ilUtil::stripSlashes($this->raw($this->getPostVar()), true, $allowed)
                 : $this->str($this->getPostVar());
         }
 
         $value = self::removeProhibitedCharacters($value);
         return $value;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxNumOfChars()

ilTextAreaInputGUI::getMaxNumOfChars ( )

Definition at line 133 of file class.ilTextAreaInputGUI.php.

References $max_num_chars.

Referenced by checkInput(), insert(), and isCharLimited().

                                       : int
     {
         return $this->max_num_chars;
     }

Here is the caller graph for this function:

◆ getMinNumOfChars()

ilTextAreaInputGUI::getMinNumOfChars ( )

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

References $min_num_chars.

Referenced by checkInput(), insert(), and isCharLimited().

                                       : int
     {
         return $this->min_num_chars;
     }

Here is the caller graph for this function:

◆ getPurifier()

ilTextAreaInputGUI::getPurifier ( )

Definition at line 459 of file class.ilTextAreaInputGUI.php.

References $Purifier.

Referenced by getInput().

                                  : ilHtmlPurifierInterface
     {
         return $this->Purifier;
     }

Here is the caller graph for this function:

◆ getRows()

ilTextAreaInputGUI::getRows ( )

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

References $rows.

Referenced by insert().

                              : int
     {
         return $this->rows;
     }

Here is the caller graph for this function:

◆ getRTERootBlockElement()

ilTextAreaInputGUI::getRTERootBlockElement ( )

Definition at line 470 of file class.ilTextAreaInputGUI.php.

References $root_block_element.

Referenced by insert().

                                             : ?string
     {
         return $this->root_block_element;
     }

Here is the caller graph for this function:

◆ getRteTags()

ilTextAreaInputGUI::getRteTags ( )

Definition at line 211 of file class.ilTextAreaInputGUI.php.

References $rtetags.

Referenced by getRteTagString(), and insert().

                                 : array
     {
         return $this->rtetags;
     }

Here is the caller graph for this function:

◆ getRteTagSet()

ilTextAreaInputGUI::getRteTagSet ( $a_set_name )

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

Referenced by insert().

                                              : array
     {
         return $this->rte_tag_set[$a_set_name];
     }

Here is the caller graph for this function:

◆ getRteTagString()

ilTextAreaInputGUI::getRteTagString ( )

Definition at line 230 of file class.ilTextAreaInputGUI.php.

References getRteTags().

Referenced by getInput().

                                      : string
     {
         $result = "";
         foreach ($this->getRteTags() as $tag) {
             $result .= "<$tag>";
         }
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUseRte()

ilTextAreaInputGUI::getUseRte ( )

Definition at line 154 of file class.ilTextAreaInputGUI.php.

References $usert.

Referenced by getInput(), and insert().

                                : bool
     {
         return $this->usert;
     }

Here is the caller graph for this function:

◆ getUseTagsForRteOnly()

ilTextAreaInputGUI::getUseTagsForRteOnly ( )

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

References $use_tags_for_rte_only.

Referenced by getInput().

                                           : bool
     {
         return $this->use_tags_for_rte_only;
     }

Here is the caller graph for this function:

◆ getValue()

ilTextAreaInputGUI::getValue ( )

Definition at line 98 of file class.ilTextAreaInputGUI.php.

References $value.

Referenced by insert().

                               : string
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ insert()

ilTextAreaInputGUI::insert ( ilTemplate $a_tpl )

Definition at line 312 of file class.ilTextAreaInputGUI.php.

References ilFormPropertyGUI\$lng, XapiProxy\$plugin, ilRTE\_getRTEClassname(), getCols(), ilFormPropertyGUI\getDisabled(), getDisabledButtons(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getHiddenTag(), ilFormPropertyGUI\getInfo(), getInitialRteWidth(), getMaxNumOfChars(), getMinNumOfChars(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getRows(), getRTERootBlockElement(), getRteTags(), getRteTagSet(), getUseRte(), getValue(), isCharLimited(), null, ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), ilLanguage\toJS(), and ilLanguage\txt().

                                              : void
     {
         $lng = $this->lng;
 
         $ttpl = new ilTemplate("tpl.prop_textarea.html", true, true, "components/ILIAS/Form");
 
         if ($this->getInfo() !== '') {
             $ttpl->setCurrentBlock('described_by_description');
             $ttpl->setVariable('DESCRIBED_BY_DESCRIPTION_FIELD_ID', $this->getFieldId());
             $ttpl->parseCurrentBlock();
         }
 
         // disabled rte
         if ($this->getUseRte() && $this->getDisabled()) {
             $ttpl->setCurrentBlock("disabled_rte");
             $ttpl->setVariable("DR_VAL", $this->getValue());
         } else {
             if ($this->getUseRte()) {
                 $ttpl->touchBlock("rteditor");
                 $rtestring = ilRTE::_getRTEClassname();
                 $rte = new $rtestring((string) $this->rteSupport['version']);
                 $rte->setInitialWidth($this->getInitialRteWidth());
 
                 // @todo: Check this.
                 $rte->addPlugin("emoticons");
                 foreach ($this->plugins as $plugin) {
                     if (strlen($plugin)) {
                         $rte->addPlugin($plugin);
                     }
                 }
                 foreach ($this->removeplugins as $plugin) {
                     if (strlen($plugin)) {
                         $rte->removePlugin($plugin);
                     }
                 }
 
                 foreach ($this->buttons as $button) {
                     if (strlen($button)) {
                         $rte->addButton($button);
                     }
                 }
 
                 $rte->disableButtons($this->getDisabledButtons());
 
                 if ($this->getRTERootBlockElement() !== null) {
                     $rte->setRTERootBlockElement($this->getRTERootBlockElement());
                 }
 
                 if (count($this->rteSupport) >= 3) {
                     $rte->addRTESupport($this->rteSupport["obj_id"], $this->rteSupport["obj_type"], $this->rteSupport["module"], false, $this->rteSupport['cfg_template']);
                 } else {
                     // disable all plugins for mini-tagset
                     if (!array_diff($this->getRteTags(), $this->getRteTagSet("mini"))) {
                         $rte->removeAllPlugins();
 
                         // #13603 - "paste from word" is essential
                         $rte->addPlugin("paste");
                         //Add plugins 'lists', 'code' and 'link': in tinymce 3 it wasnt necessary to configure these plugins
                         $rte->addPlugin("lists");
                         $rte->addPlugin("link");
                         $rte->addPlugin("code");
 
                         if (method_exists($rte, 'removeAllContextMenuItems')) {
                             $rte->removeAllContextMenuItems(); //https://github.com/ILIAS-eLearning/ILIAS/pull/3088#issuecomment-805830050
                         }
 
                         // #11980 - p-tag is mandatory but we do not want the icons it comes with
                         $rte->disableButtons(array("anchor", "alignleft", "aligncenter",
                             "alignright", "alignjustify", "formatselect", "removeformat",
                             "cut", "copy", "paste", "pastetext")); // JF, 2013-12-09
                     }
                     $rte->addCustomRTESupport(0, "", $this->getRteTags());
                 }
 
                 $ttpl->touchBlock("prop_ta_w");
             } else {
                 if ($this->getCols() > 5) {
                     $ttpl->setCurrentBlock("prop_ta_c");
                     $ttpl->setVariable("COLS", $this->getCols());
                     $ttpl->parseCurrentBlock();
                 } else {
                     $ttpl->touchBlock("prop_ta_w");
                 }
             }
             $ttpl->setCurrentBlock("prop_textarea");
             $ttpl->setVariable("ROWS", $this->getRows());
             $ttpl->setVariable("POST_VAR", $this->getPostVar());
             $ttpl->setVariable("ID", $this->getFieldId());
             if ($this->getDisabled()) {
                 $ttpl->setVariable('DISABLED', 'disabled="disabled" ');
             }
             $ttpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($this->getValue()));
 
             if ($this->getRequired()) {
                 $ttpl->setVariable("REQUIRED", "required=\"required\"");
             }
 
             if ($this->isCharLimited()) {
                 $ttpl->setVariable("MAXCHARS", $this->getMaxNumOfChars());
                 $ttpl->setVariable("MINCHARS", $this->getMinNumOfChars());
 
                 $lng->toJS("form_chars_remaining");
             }
         }
         $ttpl->parseCurrentBlock();
 
         if ($this->isCharLimited()) {
             $ttpl->setVariable("FEEDBACK_MAX_LIMIT", $this->getMaxNumOfChars());
             $ttpl->setVariable("FEEDBACK_ID", $this->getFieldId());
             $ttpl->setVariable("CHARS_REMAINING", $lng->txt("form_chars_remaining"));
         }
 
         if ($this->getDisabled()) {
             $ttpl->setVariable(
                 "HIDDEN_INPUT",
                 $this->getHiddenTag($this->getPostVar(), $this->getValue())
             );
         }
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $ttpl->get());
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ isCharLimited()

ilTextAreaInputGUI::isCharLimited ( )

Definition at line 512 of file class.ilTextAreaInputGUI.php.

References getMaxNumOfChars(), and getMinNumOfChars().

Referenced by checkInput(), and insert().

                                    : bool
     {
         if ($this->getMaxNumOfChars() || $this->getMinNumOfChars()) {
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeButton()

ilTextAreaInputGUI::removeButton ( string $a_button )

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

                                                   : void
     {
         unset($this->buttons[$a_button]);
     }

◆ removePlugin()

ilTextAreaInputGUI::removePlugin ( string $a_plugin )

Definition at line 164 of file class.ilTextAreaInputGUI.php.

                                                   : void
     {
         $this->removeplugins[$a_plugin] = $a_plugin;
     }

◆ removeRTESupport()

ilTextAreaInputGUI::removeRTESupport ( )

Definition at line 201 of file class.ilTextAreaInputGUI.php.

                                       : void
     {
         $this->rteSupport = array();
     }

◆ setCols()

ilTextAreaInputGUI::setCols ( int $a_cols )

Deprecated:

Definition at line 106 of file class.ilTextAreaInputGUI.php.

Referenced by ilObjStyleSheetGUI\getCreateForm(), ilRatingCategoryGUI\initCategoryForm(), ilObjEmployeeTalkSeriesGUI\initCreateForm(), ilObjBibliographicGUI\initCreateForm(), ilObjGlossaryGUI\initCreateForm(), ilObjFolderGUI\initEditForm(), ilObjectPluginGUI\initEditForm(), ilObjectGUI\initEditForm(), ilObjTaggingSettingsGUI\initForbiddenTagsForm(), ilLOTestAssignmentForm\initForm(), ilObjMediaObjectGUI\initForm(), ilBookingObjectGUI\initForm(), ilMailingListsGUI\initForm(), ilCASSettingsGUI\initFormSettings(), ilObjSCORMLearningModuleGUI\initPropertiesForm(), ilObjSCORM2004LearningModuleGUI\initPropertiesForm(), ilPermissionGUI\initRoleForm(), ilObjFileBasedLMGUI\initSettingsForm(), and ilObjEmployeeTalkGUI\sendUpdateNotification().

                                         : void
     {
         // obsolete because of bootstrap
         $this->cols = $a_cols;
     }

Here is the caller graph for this function:

◆ setInitialRteWidth()

ilTextAreaInputGUI::setInitialRteWidth ( int $initial_rte_width )

Definition at line 507 of file class.ilTextAreaInputGUI.php.

References $initial_rte_width.

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

◆ setMaxNumOfChars()

ilTextAreaInputGUI::setMaxNumOfChars ( int $a_number )

Definition at line 128 of file class.ilTextAreaInputGUI.php.

Referenced by ilBadgeManagementGUI\initBadgeForm().

                                                    : void
     {
         $this->max_num_chars = $a_number;
     }

Here is the caller graph for this function:

◆ setMinNumOfChars()

ilTextAreaInputGUI::setMinNumOfChars ( int $a_number )

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

                                                    : void
     {
         $this->min_num_chars = $a_number;
     }

◆ setPurifier()

ilTextAreaInputGUI::setPurifier ( ilHtmlPurifierInterface $Purifier )

Setter for the html purifier.

Definition at line 453 of file class.ilTextAreaInputGUI.php.

References $Purifier.

                                                                   : self
     {
         $this->Purifier = $Purifier;
         return $this;
     }

◆ setRows()

ilTextAreaInputGUI::setRows ( int $a_rows )

Definition at line 117 of file class.ilTextAreaInputGUI.php.

Referenced by ilObjMailGUI\buildSignaturePlaceholderInputs(), ilPCMediaObjectEditorGUI\getEditorElements(), ilMailOptionsFormGUI\init(), ilPageLayoutAdministrationGUI\initAddPageLayoutForm(), ilExAssignmentEditorGUI\initAssignmentForm(), ilContainerGUI\initEditForm(), ilLTIConsumerSettingsFormGUI\initForm(), ilLTIConsumeProviderFormGUI\initForm(), ilBasicSkillTemplateGUI\initForm(), ilSkillTemplateCategoryGUI\initForm(), ilSkillCategoryGUI\initForm(), ilBasicSkillGUI\initForm(), ilObjMediaObjectGUI\initForm(), ilSkillTreeNodeGUI\initForm(), ilObjUserGUI\initForm(), ilObjLinkResourceGUI\initFormLink(), ilConsultationHoursGUI\initFormSequence(), ilSurveyEditorGUI\initHeadingForm(), and ilLTIConsumeProviderFormGUI\initToolConfigForm().

                                         : void
     {
         $this->rows = $a_rows;
     }

Here is the caller graph for this function:

◆ setRTERootBlockElement()

ilTextAreaInputGUI::setRTERootBlockElement ( ?string $a_root_block_element )

Definition at line 464 of file class.ilTextAreaInputGUI.php.

                                                                          : self
     {
         $this->root_block_element = $a_root_block_element;
         return $this;
     }

◆ setRTESupport()

ilTextAreaInputGUI::setRTESupport	(	int	$obj_id,
		string	$obj_type,
		string	$module,
		?string	$cfg_template = `null`,
		bool	$hide_switch = `false`,
		?string	$version = `null`
	)

Set RTE support for a special module.

Definition at line 183 of file class.ilTextAreaInputGUI.php.

References $version.

      : void {
         $this->rteSupport = array(
             "obj_id" => $obj_id,
             "obj_type" => $obj_type,
             "module" => $module,
             'cfg_template' => $cfg_template,
             'hide_switch' => $hide_switch,
             'version' => $version
         );
     }

◆ setRteTags()

ilTextAreaInputGUI::setRteTags ( array $a_rtetags )

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

Referenced by setRteTagSet().

                                                 : void
     {
         $this->rtetags = $a_rtetags;
     }

Here is the caller graph for this function:

◆ setRteTagSet()

ilTextAreaInputGUI::setRteTagSet ( string $a_set_name )

Parameters

string $a_set_name Set name "standard", "extended", "extended_img", "extended_table", "extended_table_img", "full"

Definition at line 220 of file class.ilTextAreaInputGUI.php.

References setRteTags().

Referenced by __construct().

                                                     : void
     {
         $this->setRteTags($this->rte_tag_set[$a_set_name]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUseRte()

ilTextAreaInputGUI::setUseRte	(	bool	$a_usert,
		string	$version = `''`
	)

Definition at line 148 of file class.ilTextAreaInputGUI.php.

References $version.

                                                                   : void
     {
         $this->usert = $a_usert;
         $this->rteSupport['version'] = $version;
     }

◆ setUseTagsForRteOnly()

ilTextAreaInputGUI::setUseTagsForRteOnly ( bool $a_val )

Set use tags for RTE only (default is true)

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

                                                      : void
     {
         $this->use_tags_for_rte_only = $a_val;
     }

◆ setValue()

ilTextAreaInputGUI::setValue ( string $a_value )

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

Referenced by assQuestionGUI\addBasicQuestionFormProperties(), ilAdvancedMDFieldDefinition\addToFieldDefinitionForm(), ilUserProfile\getTextareaInput(), ilSurveyParticipantsGUI\importExternalMailRecipientsFromTextFormObject(), ilRemoteObjectBaseGUI\initEditForm(), ilDidacticTemplateSettingsGUI\initEditTemplate(), ilLTIConsumeProviderFormGUI\initForm(), ilPageLayoutGUI\initForm(), ilCalendarAppointmentGUI\initForm(), ilObjSessionGUI\initForm(), ilAdvancedMDSettingsGUI\initForm(), ilCourseObjectivesGUI\initFormTitle(), ilObjCourseGUI\initInfoEditor(), ilObjUserFolderGUI\initNewAccountMailForm(), ilObjTaxonomyGUI\initSettingsForm(), ilLTIConsumeProviderFormGUI\initToolConfigForm(), ilAdvancedMDRecordTranslations\modifyTranslationInfoForDescription(), ilAdvancedMDFieldTranslations\modifyTranslationInfoForDescription(), assErrorTextGUI\populateQuestionSpecificFormPart(), assOrderingHorizontalGUI\populateQuestionSpecificFormPart(), ilObjOrgUnitSettingsFormGUI\saveObject(), setValueByArray(), and ilMailFormGUI\showForm().

                                              : void
     {
         $this->value = $a_value;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilTextAreaInputGUI::setValueByArray ( array $a_values )

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

References ilFormPropertyGUI\getPostVar(), ilSubEnabledFormPropertyGUI\getSubItems(), and setValue().

                                                     : void
     {
         $this->setValue($a_values[$this->getPostVar()] ?? "");
 
         foreach ($this->getSubItems() as $item) {
             $item->setValueByArray($a_values);
         }
     }

Here is the call graph for this function:

◆ usePurifier()

ilTextAreaInputGUI::usePurifier ( ?bool $a_flag = null )

Setter/Getter for the html purifier usage.

Parameters

bool $a_flag Use purifier or not

Returns: self|bool

Definition at line 440 of file class.ilTextAreaInputGUI.php.

References $usePurifier, and null.

Referenced by getInput().

     {
         if (null === $a_flag) {
             return $this->usePurifier;
         }
 
         $this->usePurifier = $a_flag;
         return $this;
     }

Here is the caller graph for this function:

Field Documentation

◆ $buttons

array ilTextAreaInputGUI::$buttons = []

protected

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

◆ $cols

int ilTextAreaInputGUI::$cols = 30

protected

Definition at line 30 of file class.ilTextAreaInputGUI.php.

Referenced by getCols().

◆ $disabled_buttons

array ilTextAreaInputGUI::$disabled_buttons = array()

protected

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

Referenced by getDisabledButtons().

◆ $initial_rte_width

int ilTextAreaInputGUI::$initial_rte_width = 795

protected

Definition at line 41 of file class.ilTextAreaInputGUI.php.

Referenced by getInitialRteWidth(), and setInitialRteWidth().

◆ $max_num_chars

int ilTextAreaInputGUI::$max_num_chars = 0

protected

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

Referenced by getMaxNumOfChars().

◆ $min_num_chars

int ilTextAreaInputGUI::$min_num_chars = 0

protected

Definition at line 40 of file class.ilTextAreaInputGUI.php.

Referenced by getMinNumOfChars().

◆ $plugins

array ilTextAreaInputGUI::$plugins = []

protected

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

◆ $Purifier

ilHtmlPurifierInterface ilTextAreaInputGUI::$Purifier = null

protected

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

Referenced by getPurifier(), and setPurifier().

◆ $removeplugins

array ilTextAreaInputGUI::$removeplugins = []

protected

Definition at line 35 of file class.ilTextAreaInputGUI.php.

◆ $root_block_element

string ilTextAreaInputGUI::$root_block_element = null

protected

Definition at line 45 of file class.ilTextAreaInputGUI.php.

Referenced by getRTERootBlockElement().

◆ $rows

int ilTextAreaInputGUI::$rows = 5

protected

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

Referenced by getRows().

◆ $rte_tag_set

array ilTextAreaInputGUI::$rte_tag_set

protected

Initial value:

= array(
        "mini" => array("strong", "em", "u", "ol", "li", "ul", "blockquote", "a", "p", "span", "br"), 
        "standard" => array("strong", "em", "u", "ol", "li", "ul", "p", "div",
            "i", "b", "code", "sup", "sub", "pre", "strike", "gap"),
        "extended" => array(
            "a","blockquote","br","cite","code","div","em","h1","h2","h3",
            "h4","h5","h6","hr","li","ol","p",
            "pre","span","strike","strong","sub","sup","u","ul",
            "i", "b", "gap"),
        "extended_img" => array(
            "a","blockquote","br","cite","code","div","em","h1","h2","h3",
            "h4","h5","h6","hr","img","li","ol","p",
            "pre","span","strike","strong","sub","sup","u","ul",
            "i", "b", "gap"),
        "extended_table" => array(
            "a","blockquote","br","cite","code","div","em","h1","h2","h3",
            "h4","h5","h6","hr","li","ol","p",
            "pre","span","strike","strong","sub","sup","table","td",
            "tr","u","ul", "i", "b", "gap"),
        "extended_table_img" => array(
            "a","blockquote","br","cite","code","div","em","h1","h2","h3",
            "h4","h5","h6","hr","img","li","ol","p",
            "pre","span","strike","strong","sub","sup","table","td",
            "tr","u","ul", "i", "b", "gap"),
        "full" => array(
            "a","blockquote","br","cite","code","div","em","h1","h2","h3",
            "h4","h5","h6","hr","img","li","ol","p",
            "pre","span","strike","strong","sub","sup","table","td",
            "tr","u","ul","ruby","rbc","rtc","rb","rt","rp", "i", "b", "gap"))

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

◆ $rteSupport

array ilTextAreaInputGUI::$rteSupport = []

protected

Definition at line 28 of file class.ilTextAreaInputGUI.php.

◆ $rtesupport

array ilTextAreaInputGUI::$rtesupport = []

protected

Definition at line 37 of file class.ilTextAreaInputGUI.php.

◆ $rtetags

array ilTextAreaInputGUI::$rtetags = []

protected

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

Referenced by getRteTags().

◆ $use_tags_for_rte_only

bool ilTextAreaInputGUI::$use_tags_for_rte_only = true

protected

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

Referenced by getUseTagsForRteOnly().

◆ $usePurifier

bool ilTextAreaInputGUI::$usePurifier = false

protected

Definition at line 43 of file class.ilTextAreaInputGUI.php.

Referenced by usePurifier().

◆ $usert

bool ilTextAreaInputGUI::$usert = false

protected

Definition at line 32 of file class.ilTextAreaInputGUI.php.

Referenced by getUseRte().

◆ $value

string ilTextAreaInputGUI::$value = ""

protected

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

Referenced by getInput(), and getValue().

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

components/ILIAS/Form/classes/class.ilTextAreaInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addButton()

◆ addPlugin()

◆ checkInput()

◆ disableButtons()

◆ getCols()

◆ getDisabledButtons()

◆ getInitialRteWidth()

◆ getInput()

◆ getMaxNumOfChars()

◆ getMinNumOfChars()

◆ getPurifier()

◆ getRows()

◆ getRTERootBlockElement()

◆ getRteTags()

◆ getRteTagSet()

◆ getRteTagString()

◆ getUseRte()

◆ getUseTagsForRteOnly()

◆ getValue()

◆ insert()

◆ isCharLimited()

◆ removeButton()

◆ removePlugin()

◆ removeRTESupport()

◆ setCols()

◆ setInitialRteWidth()

◆ setMaxNumOfChars()

◆ setMinNumOfChars()

◆ setPurifier()

◆ setRows()

◆ setRTERootBlockElement()

◆ setRTESupport()

◆ setRteTags()

◆ setRteTagSet()

◆ setUseRte()

◆ setUseTagsForRteOnly()

◆ setValue()

◆ setValueByArray()

◆ usePurifier()

Field Documentation

◆ $buttons

◆ $cols

◆ $disabled_buttons

◆ $initial_rte_width

◆ $max_num_chars

◆ $min_num_chars

◆ $plugins

◆ $Purifier

◆ $removeplugins

◆ $root_block_element

◆ $rows

◆ $rte_tag_set

◆ $rteSupport

◆ $rtesupport

◆ $rtetags

◆ $use_tags_for_rte_only

◆ $usePurifier

◆ $usert

◆ $value