ilRTE Class Reference

Rich Text Editor base class This class provides access methods to a Rich Text Editor (RTE) integrated in ILIAS. More...

Inheritance diagram for ilRTE:

Collaboration diagram for ilRTE:

Public Member Functions
	__construct ()
	addPlugin (string $a_plugin_name)
	addButton (string $a_button_name)
	removePlugin (string $a_plugin_name)
	removeAllPlugins ()
	removeButton (string $a_button_name)
	addRTESupport (Language $lng, ilObjUser $user, int $obj_id, string $obj_type, string $a_module='', bool $allowFormElements=false, ?string $cfg_template=null)
	addUserTextEditor (string $editor_selector)
	addCustomRTESupport (int $obj_id, string $obj_type, array $tags)
	Adds custom support for an RTE in an ILIAS form. More...
	setRTERootBlockElement (?string $a_root_block_element)
	getRTERootBlockElement ()
	disableButtons ($a_button)
	Sets buttons which should be disabled in the RTE. More...
	getDisabledButtons (bool $as_list=true)
	Returns the disabled RTE buttons. More...
	getInitialWidth ()
	setInitialWidth (?int $initialWidth)

Static Public Member Functions
static	_getRTEClassname ()
static	_cleanupMediaObjectUsage (string $a_text, string $a_usage_type, int $a_usage_id)
	Synchronises appearances of media objects in $a_text with media object usage table. More...
static	replaceLatexSpan (string $text)
	Replace the latex delimiters used by the rich text editor Unfortunately these can't be processed by MathJax: "Note that the delimiters can’t look like HTML tags (i.e., can’t include the less-than sign), as these would be turned into tags by the browser before MathJax has the chance to run. More...
static	_replaceMediaObjectImageSrc (string $a_text, int $a_direction=0, string $nic='')
	Replaces image source from mob image urls with the mob id or replaces mob id with the correct image source. More...
static	_getMediaObjects (string $a_text, int $a_direction=0)
	Returns all media objects found in the passed string. More...

Protected Attributes
ilGlobalTemplateInterface	$tpl
ilCtrlInterface	$ctrl
ilObjUser	$user
ilLanguage	$lng
AgentDetermination	$browser
ilIniFile	$client_init
int	$initialWidth = null
string	$root_block_element = null
array	$plugins = []
array	$buttons = []
array	$disabled_buttons = []

Detailed Description

Rich Text Editor base class This class provides access methods to a Rich Text Editor (RTE) integrated in ILIAS.

Author

Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

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

Constructor & Destructor Documentation

__construct()

ilRTE::__construct

(

)

Reimplemented in ilTinyMCE.

Definition at line 58 of file class.ilRTE.php.

    {
        global $DIC;
 
        $this->tpl = $DIC['tpl'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->lng = $DIC['lng'];
        $this->browser = $DIC->http()->agent();
        $this->client_init = $DIC['ilClientIniFile'];
        $this->user = $DIC['ilUser'];
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

_cleanupMediaObjectUsage()

static ilRTE::_cleanupMediaObjectUsage ( string  $a_text, string  $a_usage_type, int  $a_usage_id  )

static

Synchronises appearances of media objects in $a_text with media object usage table.

Parameters

string	$a_text	text, including media object tags
string	$a_usage_type	type of context of usage, e.g. cat:html
int	$a_usage_id	if of context of usage, e.g. category id

Definition at line 145 of file class.ilRTE.php.

                                                                                                          : void
    {
        $mobs = ilObjMediaObject::_getMobsOfObject($a_usage_type, $a_usage_id);
        while (preg_match('/src=".*" data-id="([0-9]+)"/', $a_text, $found)) {
            $a_text = str_replace($found[0], '', $a_text);
            $found_mob_id = (int) $found[1];
 
            if (!in_array($found_mob_id, $mobs, true) && ilObjMediaObject::_exists($found_mob_id)) {
                // save usage if missing
                ilObjMediaObject::_saveUsage($found_mob_id, $a_usage_type, $a_usage_id);
            } else {
                // if already saved everything ok -> take mob out of mobs array
                unset($mobs[$found_mob_id]);
            }
        }
        // remaining usages are not in text anymore -> delete them
        // and media objects (note: delete method of ilObjMediaObject
        // checks whether object is used in another context; if yes,
        // the object is not deleted!)
        foreach ($mobs as $mob) {
            ilObjMediaObject::_removeUsage($mob, $a_usage_type, $a_usage_id);
            $mob_obj = new ilObjMediaObject($mob);
            $mob_obj->delete();
        }
    }

References ilObjMediaObject\_exists(), ilObjMediaObject\_getMobsOfObject(), ilObjMediaObject\_removeUsage(), ilObjMediaObject\_saveUsage(), and ILIAS\Repository\int().

Referenced by assQuestion\cleanupMediaObjectUsage(), and SurveyQuestion\saveToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

_getMediaObjects()

static ilRTE::_getMediaObjects ( string  $a_text, int  $a_direction = 0  )

static

Returns all media objects found in the passed string.

Parameters

string	$a_text	text, including media object tags
integer	$a_direction	0 to find image src, 1 to find mob id

Returns

int[] Array of media object ids

Definition at line 270 of file class.ilRTE.php.

                                                                                 : array
    {
        if ($a_text === '') {
            return [];
        }
 
        $mediaObjects = [];
        if ($a_direction === 0) {
            $is_matching = preg_match_all('/src=".*" data-id="([0-9]+)"/', $a_text, $matches);
        } else {
            $is_matching = preg_match_all('/src="il_[0-9]+_mob_([0-9]+)"/', $a_text, $matches);
        }
 
        if ($is_matching) {
            foreach ($matches[1] as $mob) {
                $mob = (int) $mob;
 
                if (ilObjMediaObject::_exists($mob) && !in_array($mob, $mediaObjects, true)) {
                    $mediaObjects[] = $mob;
                }
            }
        }
 
        return $mediaObjects;
    }

References ilObjMediaObject\_exists(), and ILIAS\Repository\int().

Referenced by ilObjForumGUI\createThread(), ilObjForumGUI\deleteMobsOfDraft(), ilForumAutoSaveAsyncDraftAction\executeAndGetResponseObject(), and ilObjForumGUI\savePostObject().

Here is the call graph for this function:

Here is the caller graph for this function:

_getRTEClassname()

static ilRTE::_getRTEClassname ( )

static

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

                                             : string
    {
        global $DIC;
        $editor = (new ilRTESettings($DIC['lng'], $DIC['ilUser']))->getRichTextEditor();
        if (strtolower($editor) === 'tinymce') {
            return ilTinyMCE::class;
        }
 
        return self::class;
    }

References $DIC.

Referenced by ilTextAreaInputGUI\insert(), and assTextQuestionGUI\magicAfterTestOutput().

Here is the caller graph for this function:

_replaceMediaObjectImageSrc()

static ilRTE::_replaceMediaObjectImageSrc ( string  $a_text, int  $a_direction = 0, string  $nic = ''  )

static

Replaces image source from mob image urls with the mob id or replaces mob id with the correct image source.

Parameters

string	$a_text	text, including media object tags
integer	$a_direction	0 to replace image src => mob id, 1 to replace mob id => image src
string	$nic

Returns

string The text containing the replaced media object src

Definition at line 228 of file class.ilRTE.php.

     : string {
        if ($a_text === '') {
            return '';
        }
 
        if ($nic === '' && defined('IL_INST_ID')) {
            $nic = (string) IL_INST_ID;
        }
 
        if ($a_direction === 0) {
            $a_text = preg_replace(
                '/src=".*" data-id="([0-9]+)"/',
                'src="il_' . $nic . '_mob_\\1"',
                $a_text
            );
        } else {
            $resulttext = $a_text;
            if (preg_match_all('/src="(il_[0-9]+_mob_([0-9]+))"/', $a_text, $matches)) {
                foreach ($matches[2] as $idx => $mob) {
                    if (ilObject::_lookupType((int) $mob) === 'mob') {
                        $mob_obj = new ilObjMediaObject((int) $mob);
                        $path_to_file = $mob_obj->getStandardSrc();
                        $resulttext = str_replace("src=\"{$matches[1][$idx]}\"", "src=\"{$path_to_file}\" data-id=\"{$matches[2][$idx]}\"", $resulttext);
                    }
                }
            }
            $a_text = $resulttext;
        }
 
        return $a_text;
    }

Referenced by assQuestionExport\addQTIMaterial(), ilObjForumGUI\createThread(), ilObjForumGUI\doHistoryCheck(), ilObjForumGUI\editThreadDraftObject(), ilForumAutoSaveAsyncDraftAction\executeAndGetResponseObject(), ilAssSelfAssessmentQuestionFormatter\format(), ilAssMultiOptionQuestionFeedback\getAllSpecificAnswerFeedbackContents(), ilObjTest\getCompleteManualFeedback(), ilObjTest\getFinalStatement(), ilAssQuestionFeedback\getGenericFeedbackContent(), ilObjTest\getIntroduction(), ilObjTest\getSingleManualFeedback(), ilAssMultiOptionQuestionFeedback\getSpecificAnswerFeedbackContent(), assKprimChoice\loadAnswerData(), assErrorText\loadFromDb(), assLongMenu\loadFromDb(), assMatchingQuestion\loadFromDb(), assOrderingHorizontal\loadFromDb(), assOrderingQuestion\loadFromDb(), assKprimChoice\loadFromDb(), ilObjSurvey\loadFromDb(), SurveyMatrixQuestion\loadFromDb(), SurveyMetricQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), SurveyTextQuestion\loadFromDb(), assClozeTest\loadFromDb(), assFileUpload\loadFromDb(), assFormulaQuestion\loadFromDb(), assImagemapQuestion\loadFromDb(), assMultipleChoice\loadFromDb(), assNumeric\loadFromDb(), assSingleChoice\loadFromDb(), assTextQuestion\loadFromDb(), assTextSubset\loadFromDb(), ilExAssignmentListTextTableGUI\parse(), assQuestionImport\processNonAbstractedImageReferences(), ilObjForumGUI\publishDraftObject(), ilForumExportGUI\renderPostHtml(), ilObjForumGUI\renderPostingForm(), ilObjTest\retrieveMobsFromLegacyImports(), assClozeTest\saveAdditionalQuestionDataToDb(), assMultipleChoice\saveAnswerSpecificDataToDb(), ilObjForumGUI\saveAsDraftObject(), ilAssQuestionFeedback\saveGenericFeedbackContent(), ilObjForumGUI\savePostObject(), assQuestion\saveQuestionDataToDb(), ilAssMultiOptionQuestionFeedback\saveSpecificAnswerFeedbackContent(), ilObjForumGUI\saveThreadAsDraftObject(), ilObjSurvey\saveToDb(), SurveyQuestion\saveToDb(), ilExSubmissionTextGUI\showAssignmentTextObject(), ILIAS\Test\Settings\MainSettings\SettingsMainGUI\showOldConcludingRemarks(), ILIAS\Test\Settings\MainSettings\SettingsMainGUI\showOldIntroduction(), ilForumXMLWriter\start(), assErrorText\toJSON(), assErrorText\toLog(), ilObjTest\toXML(), ilObjForumGUI\updateDraftObject(), and ilObjForumGUI\updateThreadDraftObject().

Here is the caller graph for this function:

addButton()

ilRTE::addButton

(

string

$a_button_name

)

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

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

addCustomRTESupport()

ilRTE::addCustomRTESupport	(	int	$obj_id,
		string	$obj_type,
		array	$tags
	)

Adds custom support for an RTE in an ILIAS form.

Parameters

int	$obj_id
string	$obj_type
string[]	$tags

Reimplemented in ilTinyMCE.

Definition at line 124 of file class.ilRTE.php.

                                                                                   : void
    {
    }

addPlugin()

ilRTE::addPlugin

(

string

$a_plugin_name

)

Definition at line 70 of file class.ilRTE.php.

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

addRTESupport()

ilRTE::addRTESupport	(	Language	$lng,
		ilObjUser	$user,
		int	$obj_id,
		string	$obj_type,
		string	$a_module = '',
		bool	$allowFormElements = false,
		?string	$cfg_template = null
	)

Reimplemented in ilTinyMCE.

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

     : void {
    }

addUserTextEditor()

ilRTE::addUserTextEditor

(

string

$editor_selector

)

Reimplemented in ilTinyMCE.

Definition at line 114 of file class.ilRTE.php.

                                                              : void
    {
    }

disableButtons()

ilRTE::disableButtons

(

$a_button

)

Sets buttons which should be disabled in the RTE.

Parameters

string[] | string

$a_button

Either a button string or an array of button strings

Returns

self

Definition at line 312 of file class.ilRTE.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, [$a_button]));
        }
 
        return $this;
    }

getDisabledButtons()

ilRTE::getDisabledButtons

(

bool

$as_list = true

)

Returns the disabled RTE buttons.

Parameters

bool

$as_list

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

Returns

string[]|string

Definition at line 328 of file class.ilRTE.php.

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

getInitialWidth()

ilRTE::getInitialWidth

(

)

Definition at line 337 of file class.ilRTE.php.

                                     : ?int
    {
        return $this->initialWidth;
    }

getRTERootBlockElement()

ilRTE::getRTERootBlockElement

(

)

Definition at line 302 of file class.ilRTE.php.

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

removeAllPlugins()

ilRTE::removeAllPlugins

(

)

Definition at line 88 of file class.ilRTE.php.

                                      : void
    {
        foreach ($this->plugins as $plugin) {
            $this->removePlugin($plugin);
        }
    }

References XapiProxy\$plugin, and removePlugin().

Here is the call graph for this function:

removeButton()

ilRTE::removeButton

(

string

$a_button_name

)

Definition at line 95 of file class.ilRTE.php.

                                                       : void
    {
        $key = array_search($a_button_name, $this->buttons, true);
        if ($key !== false) {
            unset($this->buttons[$key]);
        }
    }

removePlugin()

ilRTE::removePlugin

(

string

$a_plugin_name

)

Definition at line 80 of file class.ilRTE.php.

                                                       : void
    {
        $key = array_search($a_plugin_name, $this->plugins, true);
        if ($key !== false) {
            unset($this->plugins[$key]);
        }
    }

Referenced by removeAllPlugins().

Here is the caller graph for this function:

replaceLatexSpan()

static ilRTE::replaceLatexSpan ( string  $text )

static

Replace the latex delimiters used by the rich text editor Unfortunately these can't be processed by MathJax: "Note that the delimiters can’t look like HTML tags (i.e., can’t include the less-than sign), as these would be turned into tags by the browser before MathJax has the chance to run.

You can only include text, not tags, as your math delimiters."

See also

https://docs.mathjax.org/en/latest/options/input/tex.html#option-descriptions

This function should called by components that display RTE content.

Definition at line 181 of file class.ilRTE.php.

                                                         : string
    {
        $start = '<span class="latex">';
        $end = '</span>';
        $start_len = ilStr::strLen($start);
        $end_len = ilStr::strLen($end);
 
        // current position to start the search for delimiters
        $cpos = 0;
 
        // find position of start delimiter
        while (is_int($spos = ilStr::strIPos($text, $start, $cpos))) {
 
            // find position of end delimiter
            $epos = ilStr::strIPos($text, $end, $spos + $start_len);
            if (!is_int($epos)) {
                break;
            }
 
            // extract the tex code inside the delimiters
            $tex = ilStr::subStr($text, $spos + $start_len, $epos - $spos - $start_len);
 
            // wrap the tex code in new delimiters
            $replace = '[tex]' . $tex . '[/tex]';
 
            // replace the span
            $text = ilStr::subStr($text, 0, $spos) . $replace . ilStr::subStr($text, $epos + $end_len);
 
            // continue search behind the replacement
            $cpos = $spos + ilStr::strLen($replace);
 
            if ($cpos >= ilStr::strlen($text)) {
                // current position at the end => stop search
                break;
            }
        }
 
        return $text;
    }

References ilStr\strIPos(), ilStr\strLen(), and ilStr\subStr().

Referenced by ilAssSelfAssessmentQuestionFormatter\format(), ilAssSelfAssessmentQuestionFormatter\migrateToLmContent(), ilForum\prepareText(), and ilLegacyFormElementsUtil\prepareTextareaOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

setInitialWidth()

ilRTE::setInitialWidth

(

?int

$initialWidth

)

Definition at line 342 of file class.ilRTE.php.

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

setRTERootBlockElement()

ilRTE::setRTERootBlockElement

(

?string

$a_root_block_element

)

Definition at line 296 of file class.ilRTE.php.

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

Field Documentation

$browser

AgentDetermination ilRTE::$browser

protected

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

$buttons

array ilRTE::$buttons = []

protected

Definition at line 50 of file class.ilRTE.php.

$client_init

ilIniFile ilRTE::$client_init

protected

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

$ctrl

ilCtrlInterface ilRTE::$ctrl

protected

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

$disabled_buttons

array ilRTE::$disabled_buttons = []

protected

Definition at line 56 of file class.ilRTE.php.

$initialWidth

int ilRTE::$initialWidth = null

protected

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

$lng

ilLanguage ilRTE::$lng

protected

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

$plugins

array ilRTE::$plugins = []

protected

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

Referenced by ilTinyMCE\getPlugins().

$root_block_element

string ilRTE::$root_block_element = null

protected

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

$tpl

ilGlobalTemplateInterface ilRTE::$tpl

protected

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

$user

ilObjUser ilRTE::$user

protected

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

---

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

• components/ILIAS/RTE/classes/class.ilRTE.php