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

Inheritance diagram for ilTextAreaInputGUI:

Collaboration diagram for ilTextAreaInputGUI:

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

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

	getValue ()
	Get Value. More...

	setCols ($a_cols)
	Set Cols. More...

	getCols ()
	Get Cols. More...

	setRows ($a_rows)
	Set Rows. More...

	getRows ()
	Get Rows. More...

	setUseRte ($a_usert, $version='')
	Set Use Rich Text Editing. More...

	getUseRte ()
	Get Use Rich Text Editing. More...

	addPlugin ($a_plugin)
	Add RTE plugin. More...

	removePlugin ($a_plugin)
	Remove RTE plugin. More...

	addButton ($a_button)
	Add RTE button. More...

	removeButton ($a_button)
	Remove RTE button. More...

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

	removeRTESupport ()
	Remove RTE support for a special module. More...

	setRteTags ($a_rtetags)
	Set Valid RTE Tags. More...

	getRteTags ()
	Get Valid RTE Tags. More...

	setRteTagSet ($a_set_name)
	Set Set of Valid RTE Tags. More...

	getRteTagSet ($a_set_name)
	Get Set of Valid RTE Tags. More...

	getRteTagString ()
	RTE Tag string. More...

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

	getUseTagsForRteOnly ()
	Get use tags for RTE only (default is true) More...

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

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

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

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

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

	getPurifier ()
	Getter for the html purifier. More...

	setRTERootBlockElement ($a_root_block_element)
	Setter for the TinyMCE root block element. More...

	getRTERootBlockElement ()
	Getter for the TinyMCE root block element. More...

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

	getDisabledButtons ($as_array=true)
	Returns the disabled TinyMCE buttons. More...

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

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 = ""

	$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 area property in a property form.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

References setRteTagSet(), and ilFormPropertyGUI\setType().

         {
                 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 ( $a_button )

Add RTE button.

Parameters

string $a_button Button name

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

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

◆ addPlugin()

ilTextAreaInputGUI::addPlugin ( $a_plugin )

Add RTE plugin.

Parameters

string $a_plugin Plugin name

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

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

◆ checkInput()

ilTextAreaInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Definition at line 376 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().

         {
                 global $lng;
                 include_once("./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php");
                 
                 if($this->usePurifier() && $this->getPurifier())
                 {
                         $_POST[$this->getPostVar()] = ilUtil::stripOnlySlashes($_POST[$this->getPostVar()]);
                         $_POST[$this->getPostVar()] = $this->getPurifier()->purify($_POST[$this->getPostVar()]);
                 }
                 else
                 {
                         $allowed = $this->getRteTagString();
                         if ($this->plugins["latex"] == "latex" && !is_int(strpos($allowed, "<span>")))
                         {
                                 $allowed.= "<span>";
                         }
                         $_POST[$this->getPostVar()] = ($this->getUseRte() || !$this->getUseTagsForRteOnly())
                                 ? ilUtil::stripSlashes($_POST[$this->getPostVar()], true, $allowed)
                                 : ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                 }
 
                 if ($this->getRequired() && trim($_POST[$this->getPostVar()]) == "")
                 {
                         $this->setAlert($lng->txt("msg_input_is_required"));
 
                         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

mixed $a_button Either a button string or an array of button strings

Returns: ilTextAreaInputGUI Instance of ilTextAreaInputGUI public

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

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

Get Cols.

Returns: int Cols

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

References $cols.

Referenced by insert().

         {
                 return $this->cols;
         }

Here is the caller graph for this function:

◆ getDisabledButtons()

ilTextAreaInputGUI::getDisabledButtons ( $as_array = true )

Returns the disabled TinyMCE buttons.

Parameters

boolean $as_array Should the disabled buttons be returned as a string or as an array

Returns: Array Array of disabled buttons public

Definition at line 631 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:

◆ getPurifier()

ilTextAreaInputGUI::getPurifier ( )

Getter for the html purifier.

Returns: ilHtmlPurifierInterface Instance of ilHtmlPurifierInterface public

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

References $Purifier.

Referenced by checkInput().

         {
                 return $this->Purifier;
         }

Here is the caller graph for this function:

◆ getRows()

ilTextAreaInputGUI::getRows ( )

Get Rows.

Returns: int Rows

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

References $rows.

Referenced by insert().

         {
                 return $this->rows;
         }

Here is the caller graph for this function:

◆ getRTERootBlockElement()

ilTextAreaInputGUI::getRTERootBlockElement ( )

Getter for the TinyMCE root block element.

Returns: string Root block element of TinyMCE public

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

References $root_block_element.

Referenced by insert().

         {
                 return $this->root_block_element;
         }

Here is the caller graph for this function:

◆ getRteTags()

ilTextAreaInputGUI::getRteTags ( )

Get Valid RTE Tags.

Returns: array Valid RTE Tags

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

References $rtetags.

Referenced by getRteTagString(), and insert().

         {
                 return $this->rtetags;
         }

Here is the caller graph for this function:

◆ getRteTagSet()

ilTextAreaInputGUI::getRteTagSet ( $a_set_name )

Get Set of Valid RTE Tags.

Returns: array Set name "standard", "extended", "extended_img", "extended_table", "extended_table_img", "full"

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

Referenced by insert().

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

Here is the caller graph for this function:

◆ getRteTagString()

ilTextAreaInputGUI::getRteTagString ( )

RTE Tag string.

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

References $result, and getRteTags().

Referenced by checkInput().

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

Get Use Rich Text Editing.

Returns: int Use Rich Text Editing

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

References $usert.

Referenced by checkInput(), and insert().

         {
                 return $this->usert;
         }

Here is the caller graph for this function:

◆ getUseTagsForRteOnly()

ilTextAreaInputGUI::getUseTagsForRteOnly ( )

Get use tags for RTE only (default is true)

Returns: boolean use tags for RTE only

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

References $use_tags_for_rte_only.

Referenced by checkInput().

         {
                 return $this->use_tags_for_rte_only;
         }

Here is the caller graph for this function:

◆ getValue()

ilTextAreaInputGUI::getValue ( )

Get Value.

Returns: string Value

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

References $value.

Referenced by insert().

         {
                 return $this->value;
         }

Here is the caller graph for this function:

◆ insert()

ilTextAreaInputGUI::insert ( & $a_tpl )

Insert property html.

Returns: int Size

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

References ilRTE\_getRTEClassname(), getCols(), ilFormPropertyGUI\getDisabled(), getDisabledButtons(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getHiddenTag(), ilFormPropertyGUI\getPostVar(), getRows(), getRTERootBlockElement(), getRteTags(), getRteTagSet(), getUseRte(), getValue(), and ilUtil\prepareFormOutput().

         {
                 $ttpl = new ilTemplate("tpl.prop_textarea.html", true, true, "Services/Form");
                 
                 // disabled rte
                 if ($this->getUseRte() && $this->getDisabled())
                 {
                         $ttpl->setCurrentBlock("disabled_rte");
                         $ttpl->setVariable("DR_VAL", $this->getValue());
                         $ttpl->parseCurrentBlock();
                 }
                 else
                 {
                         if ($this->getUseRte())
                         {
                                 $rtestring = ilRTE::_getRTEClassname();
                                 include_once "./Services/RTE/classes/class.$rtestring.php";
                                 $rte = new $rtestring($this->rteSupport['version']);
                                 
                                 // @todo: Check this.
                                 $rte->addPlugin("emotions");
                                 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'], $this->rteSupport['hide_switch']);
                                 }
                                 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"); 
                                                 
                                                 // #11980 - p-tag is mandatory but we do not want the icons it comes with
                                                 $rte->disableButtons(array("anchor", "justifyleft", "justifycenter", 
                                                         "justifyright", "justifyfull", "formatselect", "removeformat",
                                                         "cut", "copy", "paste", "pastetext")); // JF, 2013-12-09
                                         }
                                         
                                         $rte->addCustomRTESupport(0, "", $this->getRteTags());                                  
                                 }                       
                                 
                                 $ttpl->touchBlock("prop_ta_w");
                                 $ttpl->setCurrentBlock("prop_textarea");
                                 $ttpl->setVariable("ROWS", $this->getRows());
                         }
                         else
                         {
                                 $ttpl->touchBlock("no_rteditor");
         
                                 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());
                         }
                         if (!$this->getDisabled())
                         {
                                 $ttpl->setVariable("POST_VAR",
                                         $this->getPostVar());
                         }
                         $ttpl->setVariable("ID", $this->getFieldId());
                         if ($this->getDisabled())
                         {
                                 $ttpl->setVariable('DISABLED','disabled="disabled" ');
                         }
                         $ttpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($this->getValue()));
                         $ttpl->parseCurrentBlock();
                 }
                 
                 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:

◆ removeButton()

ilTextAreaInputGUI::removeButton ( $a_button )

Remove RTE button.

Parameters

string $a_button Button name

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

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

◆ removePlugin()

ilTextAreaInputGUI::removePlugin ( $a_plugin )

Remove RTE plugin.

Parameters

string $a_plugin Plugin name

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

Referenced by ilCertificateGUI\certificateEditor().

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

Here is the caller graph for this function:

◆ removeRTESupport()

ilTextAreaInputGUI::removeRTESupport ( )

Remove RTE support for a special module.

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

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

◆ setCols()

ilTextAreaInputGUI::setCols ( $a_cols )

Set Cols.

Parameters

int $a_cols Cols

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

Referenced by ilObjTestSettingsGeneralGUI\buildForm(), ilObjStyleSheetGUI\createObject(), ilObjForumGUI\getModifiedReOnSubject(), ilObjExerciseGUI\initAssignmentTextForm(), ilRatingCategoryGUI\initCategoryForm(), ilObjectPluginGUI\initCreateForm(), ilObjGlossaryGUI\initCreateForm(), ilObjCloudGUI\initCreateForm(), ilObjectGUI\initCreateForm(), ilObjSAHSLearningModuleGUI\initCreationForm(), ilObjectPluginGUI\initEditForm(), ilObjectGUI\initEditForm(), ilObjTaggingSettingsGUI\initForbiddenTagsForm(), ilBookingObjectGUI\initForm(), ilObjMediaObjectGUI\initForm(), ilMailingListsGUI\initForm(), ilCASSettingsGUI\initFormSettings(), ilObjForumGUI\initForumCreateForm(), ilBasicSkillGUI\initLevelForm(), ilSkillProfileGUI\initProfileForm(), ilObjSurveyGUI\initPropertiesForm(), ilPermissionGUI\initRoleForm(), ilObjFileBasedLMGUI\initSettingsForm(), ilObjWikiGUI\initSettingsForm(), ilSCORM2004ScoGUI\showProperties(), and ilObjPaymentSettingsGUI\StatutoryRegulationsObject().

         {
                 $this->cols = $a_cols;
         }

Here is the caller graph for this function:

◆ setPurifier()

ilTextAreaInputGUI::setPurifier ( ilHtmlPurifierInterface $Purifier )

Setter for the html purifier.

Parameters

ilHtmlPurifierInterface Instance of ilHtmlPurifierInterface

Returns: ilTextAreaInputGUI Instance of ilTextAreaInputGUI public

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

References $Purifier.

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

◆ setRows()

ilTextAreaInputGUI::setRows ( $a_rows )

Set Rows.

Parameters

int $a_rows Rows

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

Referenced by ilObjPaymentSettingsGUI\__editPricesTable(), ilPaymentObjectGUI\__initPaymentObject(), ilPaymentObjectGUI\editPayMethod(), ilObjPaymentSettingsGUI\editPriceObject(), ilObjPaymentSettingsGUI\getSubTabs(), ilObjExerciseGUI\initAssignmentForm(), ilObjCategoryGUI\initEditForm(), ilObjMediaObjectGUI\initForm(), ilObjUserGUI\initForm(), ilCalendarAppointmentGUI\initFormConfirmBooking(), ilObjLinkResourceGUI\initFormLink(), ilConsultationHoursGUI\initFormSequence(), ilSurveyEditorGUI\initHeadingForm(), ilAuthLoginPageEditorGUI\initLoginForm(), ilMailOptionsGUI\initMailOptionsForm(), ilPersonalSettingsGUI\initMailOptionsForm(), ilObjFileGUI\initPropertiesForm(), and ilSCORM2004ScoGUI\showProperties().

         {
                 $this->rows = $a_rows;
         }

Here is the caller graph for this function:

◆ setRTERootBlockElement()

ilTextAreaInputGUI::setRTERootBlockElement ( $a_root_block_element )

Setter for the TinyMCE root block element.

Parameters

string $a_root_block_element root block element

Returns: ilTextAreaInputGUI Instance of ilTextAreaInputGUI public

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

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

◆ setRTESupport()

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

Set RTE support for a special module.

Parameters

int	$obj_id	Object ID
string	$obj_type	Object Type
string	$module	ILIAS module

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

         {
                 $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 ( $a_rtetags )

Set Valid RTE Tags.

Parameters

array $a_rtetags Valid RTE Tags

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

Referenced by setRteTagSet().

         {
                 $this->rtetags = $a_rtetags;
         }

Here is the caller graph for this function:

◆ setRteTagSet()

ilTextAreaInputGUI::setRteTagSet ( $a_set_name )

Set Set of Valid RTE Tags.

Returns: array Set name "standard", "extended", "extended_img", "extended_table", "extended_table_img", "full"

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

References setRteTags().

Referenced by __construct().

         {
                 $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	(	$a_usert,
		$version = `''`
	)

Set Use Rich Text Editing.

Parameters

int	$a_usert	Use Rich Text Editing
string	$version

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

Referenced by ilDataCollectionTableEditGUI\initForm().

         {
                 $this->usert = $a_usert;
 
                 if(strlen($version))
                 {
                         $this->rteSupport['version'] = $version;
                 }
         }

Here is the caller graph for this function:

◆ setUseTagsForRteOnly()

ilTextAreaInputGUI::setUseTagsForRteOnly ( $a_val )

Set use tags for RTE only (default is true)

Parameters

boolean $a_val use tags for RTE only

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

         {
                 $this->use_tags_for_rte_only = $a_val;
         }

◆ setValue()

ilTextAreaInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

Referenced by assClozeTestGUI\addBasicQuestionFormProperties(), assQuestionGUI\addBasicQuestionFormProperties(), ilPaymentCouponGUI\addCoupon(), ilUserProfile\addStandardFieldsToForm(), ilObjPaymentSettingsGUI\BillingMailObject(), ilObjTestSettingsGeneralGUI\buildForm(), ilTestScoringGUI\buildManScoringParticipantForm(), ilObjFileAccessSettingsGUI\editDownloadingSettings(), ilGroupRegistrationGUI\fillRegistrationType(), ilCourseRegistrationGUI\fillRegistrationType(), ilSurveyParticipantsGUI\importExternalMailRecipientsFromTextFormObject(), ilObjStyleSettingsGUI\initAddPageLayoutForm(), ilObjMDSettingsGUI\initCopyrightEditForm(), ilRemoteObjectBaseGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilDidacticTemplateSettingsGUI\initEditTemplate(), ilAdvancedMDSettingsGUI\initFieldForm(), ilPageLayoutGUI\initForm(), ilCalendarAppointmentGUI\initForm(), ilAdvancedMDSettingsGUI\initForm(), ilObjSessionGUI\initForm(), ilObjGroupGUI\initForm(), ilObjRoleTemplateGUI\initFormRoleTemplate(), ilObjLinkResourceGUI\initFormSettings(), ilCourseObjectivesGUI\initFormTitle(), ilObjCourseGUI\initInfoEditor(), ilObjUserFolderGUI\initNewAccountMailForm(), ilObjSurveyGUI\initPropertiesForm(), ilObjTaxonomyGUI\initSettingsForm(), ilObjMediaCastGUI\initSettingsForm(), ilChatroomSmileyTask\initSmiliesEditForm(), ilObjPaymentSettingsGUI\InvoiceNumberObject(), assErrorTextGUI\populateQuestionSpecificFormPart(), assOrderingHorizontalGUI\populateQuestionSpecificFormPart(), setValueByArray(), ilMailFormGUI\showForm(), and assQuestionGUI\suggestedsolution().

         {
                 $this->value = $a_value;
         }

Here is the caller graph for this function:

◆ setValueByArray()

ilTextAreaInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

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

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

         {
                 $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 ( $a_flag = null )

Setter/Getter for the html purifier usage.

Parameters

boolean $a_flag Use purifier or not

Returns: mixed Returns instance of ilTextAreaInputGUI or boolean public

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

References $usePurifier.

Referenced by checkInput().

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

Here is the caller graph for this function:

Field Documentation

◆ $buttons

ilTextAreaInputGUI::$buttons

protected

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

◆ $cols

ilTextAreaInputGUI::$cols

protected

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

Referenced by getCols().

◆ $disabled_buttons

ilTextAreaInputGUI::$disabled_buttons = array()

protected

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

Referenced by getDisabledButtons().

◆ $plugins

ilTextAreaInputGUI::$plugins

protected

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

◆ $Purifier

ilTextAreaInputGUI::$Purifier = null

protected

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

Referenced by getPurifier(), and setPurifier().

◆ $removeplugins

ilTextAreaInputGUI::$removeplugins

protected

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

◆ $root_block_element

ilTextAreaInputGUI::$root_block_element = null

protected

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

Referenced by getRTERootBlockElement().

◆ $rows

ilTextAreaInputGUI::$rows

protected

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

Referenced by getRows().

◆ $rte_tag_set

ilTextAreaInputGUI::$rte_tag_set

protected

Initial value:

= array(
                "mini" => array("strong", "em", "u", "ol", "li", "ul", "blockquote", "a", "p", "span"), 
                "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 86 of file class.ilTextAreaInputGUI.php.

◆ $rtesupport

ilTextAreaInputGUI::$rtesupport

protected

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

◆ $rtetags

ilTextAreaInputGUI::$rtetags

protected

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

Referenced by getRteTags().

◆ $use_tags_for_rte_only

ilTextAreaInputGUI::$use_tags_for_rte_only = true

protected

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

Referenced by getUseTagsForRteOnly().

◆ $usePurifier

ilTextAreaInputGUI::$usePurifier = false

protected

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

Referenced by usePurifier().

◆ $usert

ilTextAreaInputGUI::$usert

protected

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

Referenced by getUseRte().

◆ $value

ilTextAreaInputGUI::$value

protected

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

Referenced by getValue().

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

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

◆ getPurifier()

◆ getRows()

◆ getRTERootBlockElement()

◆ getRteTags()

◆ getRteTagSet()

◆ getRteTagString()

◆ getUseRte()

◆ getUseTagsForRteOnly()

◆ getValue()

◆ insert()

◆ removeButton()

◆ removePlugin()

◆ removeRTESupport()

◆ setCols()

◆ setPurifier()

◆ setRows()

◆ setRTERootBlockElement()

◆ setRTESupport()

◆ setRteTags()

◆ setRteTagSet()

◆ setUseRte()

◆ setUseTagsForRteOnly()

◆ setValue()

◆ setValueByArray()

◆ usePurifier()

Field Documentation

◆ $buttons

◆ $cols

◆ $disabled_buttons

◆ $plugins

◆ $Purifier

◆ $removeplugins

◆ $root_block_element

◆ $rows

◆ $rte_tag_set

◆ $rtesupport

◆ $rtetags

◆ $use_tags_for_rte_only

◆ $usePurifier

◆ $usert

◆ $value