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 (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	_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 29 of file class.ilRTE.php.

Constructor & Destructor Documentation

__construct()

ilRTE::__construct

(

)

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

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

    {
        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'];
    }

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 141 of file class.ilRTE.php.

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

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

                                                                                                          : 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();
        }
    }

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 216 of file class.ilRTE.php.

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

Referenced by ilObjForumGUI\createThread(), ilObjForumGUI\deleteMobsOfDraft(), ilForumAutoSaveAsyncDraftAction\executeAndGetResponseObject(), ilForumUtil\moveMediaObjects(), ilForumUtil\saveMediaObjects(), ilObjForumGUI\savePostObject(), and ilExSubmissionTextGUI\updateAssignmentTextObject().

                                                                                 : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getRTEClassname()

static ilRTE::_getRTEClassname ( )

static

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

References ilObjAdvancedEditing\_getRichTextEditor().

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

                                             : string
    {
        $editor = ilObjAdvancedEditing::_getRichTextEditor();
        if (strtolower($editor) === 'tinymce') {
            return ilTinyMCE::class;
        }

        return self::class;
    }

Here is the call graph for this function:

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 174 of file class.ilRTE.php.

References ilObject\_lookupType(), and IL_INST_ID.

Referenced by SurveyQuestion\addMaterialTag(), ilObjSurvey\addMaterialTag(), assQuestionExport\addQTIMaterial(), ilExerciseManagementGUI\collectFeedbackDataFromPeer(), ilObjForumGUI\createThread(), ilObjForumGUI\doHistoryCheck(), ilExSubmissionTextGUI\editAssignmentTextObject(), ilObjForumGUI\editThreadDraftObject(), ilForumAutoSaveAsyncDraftAction\executeAndGetResponseObject(), ilAssSelfAssessmentQuestionFormatter\format(), assErrorTextImport\fromXML(), assFileUploadImport\fromXML(), assFormulaQuestionImport\fromXML(), assImagemapQuestionImport\fromXML(), assMultipleChoiceImport\fromXML(), assNumericImport\fromXML(), assOrderingHorizontalImport\fromXML(), assSingleChoiceImport\fromXML(), assTextSubsetImport\fromXML(), assKprimChoiceImport\fromXML(), assOrderingQuestionImport\fromXML(), assTextQuestionImport\fromXML(), assLongMenuImport\fromXML(), assMatchingQuestionImport\fromXML(), assClozeTestImport\fromXML(), ilAssMultiOptionQuestionFeedback\getAllSpecificAnswerFeedbackContents(), ilObjTest\getCompleteManualFeedback(), ilAssQuestionFeedback\getGenericFeedbackContent(), ilForum\getOneThread(), ilObjTest\getSingleManualFeedback(), ilAssMultiOptionQuestionFeedback\getSpecificAnswerFeedbackContent(), ilExPeerReviewGUI\getSubmissionContent(), ilObjTest\insertManualFeedback(), assKprimChoice\loadAnswerData(), SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), assNumeric\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), assTextSubset\loadFromDb(), assSingleChoice\loadFromDb(), SurveyMetricQuestion\loadFromDb(), assOrderingHorizontal\loadFromDb(), assMultipleChoice\loadFromDb(), assTextQuestion\loadFromDb(), assOrderingQuestion\loadFromDb(), assFileUpload\loadFromDb(), assClozeTest\loadFromDb(), assErrorText\loadFromDb(), assKprimChoice\loadFromDb(), assImagemapQuestion\loadFromDb(), SurveyMatrixQuestion\loadFromDb(), assMatchingQuestion\loadFromDb(), assLongMenu\loadFromDb(), assFormulaQuestion\loadFromDb(), ilObjSurvey\loadFromDb(), ilExAssignmentListTextTableGUI\parse(), assQuestionImport\processNonAbstractedImageReferences(), ilObjForumGUI\publishDraftObject(), ilObjForumGUI\renderDraftContent(), ilObjForumGUI\renderPostContent(), ilForumExportGUI\renderPostHtml(), ilObjForumGUI\renderPostingForm(), ilObjTest\retrieveMobsFromLegacyImports(), assClozeTest\saveAdditionalQuestionDataToDb(), assSingleChoice\saveAdditionalQuestionDataToDb(), assMultipleChoice\saveAnswerSpecificDataToDb(), ilObjForumGUI\saveAsDraftObject(), ilAssQuestionFeedback\saveGenericFeedbackContent(), ilObjForumGUI\savePostObject(), assQuestion\saveQuestionDataToDb(), ilAssMultiOptionQuestionFeedback\saveSpecificAnswerFeedbackContent(), ilObjForumGUI\saveThreadAsDraftObject(), SurveyQuestion\saveToDb(), ilObjSurvey\saveToDb(), ilExSubmissionTextGUI\showAssignmentTextObject(), ilForumXMLWriter\start(), assErrorText\toJSON(), assErrorText\toLog(), ilObjTest\toXML(), ilExSubmissionTextGUI\updateAssignmentTextObject(), ilObjForumGUI\updateDraftObject(), and ilObjForumGUI\updateThreadDraftObject().

     : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addButton()

ilRTE::addButton

(

string

$a_button_name

)

Definition at line 74 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

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

                                                                                   : void
    {
    }

addPlugin()

ilRTE::addPlugin

(

string

$a_plugin_name

)

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

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

addRTESupport()

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

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

     : void {
    }

addUserTextEditor()

ilRTE::addUserTextEditor

(

string

$editor_selector

)

Definition at line 111 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 258 of file class.ilRTE.php.

Referenced by ilTinyMCE\addCustomRTESupport().

                                             : 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;
    }

Here is the caller graph for this function:

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 274 of file class.ilRTE.php.

References $disabled_buttons.

Referenced by ilTinyMCE\_buildAdvancedButtonsFromHTMLTags(), ilTinyMCE\_buildAdvancedTableButtonsFromHTMLTags(), and ilTinyMCE\_buildButtonsFromHTMLTags().

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

        return $this->disabled_buttons;
    }

Here is the caller graph for this function:

getInitialWidth()

ilRTE::getInitialWidth

(

)

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

References $initialWidth.

Referenced by ilTinyMCE\addRTESupport().

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

Here is the caller graph for this function:

getRTERootBlockElement()

ilRTE::getRTERootBlockElement

(

)

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

References $root_block_element.

Referenced by ilTinyMCE\addCustomRTESupport(), and ilTinyMCE\addRTESupport().

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

Here is the caller graph for this function:

removeAllPlugins()

ilRTE::removeAllPlugins

(

)

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

References XapiProxy\$plugin, and removePlugin().

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

Here is the call graph for this function:

removeButton()

ilRTE::removeButton

(

string

$a_button_name

)

Definition at line 94 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 79 of file class.ilRTE.php.

Referenced by removeAllPlugins().

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

Here is the caller graph for this function:

setInitialWidth()

ilRTE::setInitialWidth

(

?int

$initialWidth

)

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

References $initialWidth.

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

setRTERootBlockElement()

ilRTE::setRTERootBlockElement

(

?string

$a_root_block_element

)

Definition at line 242 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 35 of file class.ilRTE.php.

$buttons

array ilRTE::$buttons = []

protected

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

$client_init

ilIniFile ilRTE::$client_init

protected

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

$ctrl

ilCtrlInterface ilRTE::$ctrl

protected

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

$disabled_buttons

array ilRTE::$disabled_buttons = []

protected

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

Referenced by getDisabledButtons().

$initialWidth

int ilRTE::$initialWidth = null

protected

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

Referenced by getInitialWidth(), and setInitialWidth().

$lng

ilLanguage ilRTE::$lng

protected

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

$plugins

array ilRTE::$plugins = []

protected

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

Referenced by ilTinyMCE\getPlugins().

$root_block_element

string ilRTE::$root_block_element = null

protected

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

Referenced by getRTERootBlockElement().

$tpl

ilGlobalTemplateInterface ilRTE::$tpl

protected

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

Referenced by ilTinyMCE\addCustomRTESupport(), and ilTinyMCE\addRTESupport().

$user

ilObjUser ilRTE::$user

protected

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

---

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

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