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 ($a_version='')
	ilRTE constructor. More...
	addPlugin ($a_plugin_name)
	Adds a plugin to the plugin list. More...
	addButton ($a_button_name)
	Adds a button to the button list. More...
	removePlugin ($a_plugin_name)
	Removes a plugin from the plugin list. More...
	removeAllPlugins ()
	Removes all plugins from instance. More...
	removeButton ($a_button_name)
	Removes a button from the button list. More...
	addRTESupport ($obj_id, $obj_type, $a_module="", $allowFormElements=false, $cfg_template=null, $hide_switch=false)
	Adds support for an RTE in an ILIAS form. More...
	addUserTextEditor ($editor_selector)
	Adds support for an user text editor. More...
	addCustomRTESupport ($obj_id, $obj_type, array $tags)
	Adds custom support for an RTE in an ILIAS form. More...
	setRTERootBlockElement ($a_root_block_element)
	Setter for the RTE root block element. More...
	getRTERootBlockElement ()
	Getter for the RTE root block element. More...
	disableButtons ($a_button)
	Sets buttons which should be disabled in the RTE. More...
	getDisabledButtons ($as_array=true)
	Returns the disabled RTE buttons. More...
	getInitialWidth ()
	setInitialWidth ($initialWidth)

Static Public Member Functions
static	_getRTEClassname ()
static	_cleanupMediaObjectUsage ($a_text, $a_usage_type, $a_usage_id)
	Synchronises appearances of media objects in $a_text with media object usage table. More...
static	_replaceMediaObjectImageSrc ($a_text, $a_direction=0, $nic=IL_INST_ID)
	Replaces image source from mob image urls with the mob id or replaces mob id with the correct image source. More...
static	_getMediaObjects ($a_text, $a_direction=0)
	Returns all media objects found in the passed string. More...

Data Fields
const	ILIAS_IMG_MANAGER_PLUGIN = 'ilias_image_manager_plugin'

Protected Attributes
	$plugins = array()
	$buttons = array()
	$tpl
	$ctrl
	$user
	$lng
	$browser
	$client_init
	$initialWidth = null
	$root_block_element = null
	$disabled_buttons = array()

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

Version

$Id$ class.ilRTE.php

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

Constructor & Destructor Documentation

__construct()

ilRTE::__construct

(

$a_version = ''

)

ilRTE constructor.

Parameters

string

$a_version

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

References $DIC, and user().

    {
        global $DIC;

        $this->tpl = $DIC['tpl'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->lng = $DIC['lng'];
        $this->browser = $DIC['ilBrowser'];
        $this->client_init = $DIC['ilClientIniFile'];
        $this->user = $DIC['ilUser'];
    }

Here is the call graph for this function:

Member Function Documentation

_cleanupMediaObjectUsage()

static ilRTE::_cleanupMediaObjectUsage (   $a_text,   $a_usage_type,   $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 196 of file class.ilRTE.php.

References $mobs, ilObjMediaObject\_getMobsOfObject(), ilObjMediaObject\_removeUsage(), and ilObjMediaObject\_saveUsage().

Referenced by ilObjTest\cleanupMediaobjectUsage(), assQuestion\cleanupMediaObjectUsage(), ilContainerGUI\savePageContentObject(), and SurveyQuestion\saveToDb().

    {
        require_once 'Services/MediaObjects/classes/class.ilObjMediaObject.php';

        $mobs = ilObjMediaObject::_getMobsOfObject($a_usage_type, $a_usage_id);
        while (preg_match("/data\/" . CLIENT_ID . "\/mobs\/mm_([0-9]+)/i", $a_text, $found)) {
            $a_text = str_replace($found[0], "", $a_text);
            if (!in_array($found[1], $mobs)) {
                // save usage if missing
                ilObjMediaObject::_saveUsage($found[1], $a_usage_type, $a_usage_id);
            } else {
                // if already saved everything ok -> take mob out of mobs array
                unset($mobs[$found[1]]);
            }
        }
        // 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 (   $a_text,   $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

array array of media objects

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

References ilObjMediaObject\_exists().

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

    {
        if (!strlen($a_text)) {
            return array();
        }

        require_once 'Services/MediaObjects/classes/class.ilObjMediaObject.php';

        $mediaObjects = array();
        switch ($a_direction) {
            case 0:
                if (preg_match_all('/src="([^"]*?\/mobs\/mm_([0-9]+)\/.*?)\"/', $a_text, $matches)) {
                    foreach ($matches[2] as $idx => $mob) {
                        if (ilObjMediaObject::_exists($mob) && !in_array($mob, $mediaObjects)) {
                            $mediaObjects[] = $mob;
                        }
                    }
                }
                break;

            default:
                if (preg_match_all('/src="il_([0-9]+)_mob_([0-9]+)"/', $a_text, $matches)) {
                    foreach ($matches[2] as $idx => $mob) {
                        if (ilObjMediaObject::_exists($mob) && !in_array($mob, $mediaObjects)) {
                            $mediaObjects[] = $mob;
                        }
                    }
                }
                break;
        }

        return $mediaObjects;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getRTEClassname()

static ilRTE::_getRTEClassname ( )

static

Returns

string

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

References ilObjAdvancedEditing\_getRichTextEditor().

Referenced by ilContainerGUI\editPageContentObject(), ilObjForumGUI\getCensorshipFormHTML(), ilTextAreaInputGUI\insert(), and assTextQuestionGUI\magicAfterTestOutput().

    {
        require_once 'Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php';
        switch (ilObjAdvancedEditing::_getRichTextEditor()) {
            case 'tinymce':
                return 'ilTinyMCE';
                break;

            default:
                return 'ilRTE';
                break;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_replaceMediaObjectImageSrc()

static ilRTE::_replaceMediaObjectImageSrc (   $a_text,   $a_direction = 0,   $nic = IL_INST_ID  )

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

Returns

string The text containing the replaced media object src

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

References ilObject\_lookupType(), and ilWACSignedPath\signFile().

Referenced by SurveyQuestion\addMaterialTag(), ilObjSurvey\addMaterialTag(), assQuestion\addQTIMaterial(), ilObjTest\addQTIMaterial(), assQuestion\copySuggestedSolutionFiles(), ilObjForumGUI\createThread(), ilObjForumGUI\doCaptchaCheck(), ilObjForumGUI\doHistoryCheck(), ilExSubmissionTextGUI\editAssignmentTextObject(), ilObjForumGUI\editDraftObject(), ilObjForumGUI\editThreadDraftObject(), ilForumAutoSaveAsyncDraftAction\executeAndGetResponseObject(), ilAssSelfAssessmentQuestionFormatter\format(), assLongMenuImport\fromXML(), assKprimChoiceImport\fromXML(), assErrorTextImport\fromXML(), assFileUploadImport\fromXML(), assFlashQuestionImport\fromXML(), assClozeTestImport\fromXML(), assImagemapQuestionImport\fromXML(), assFormulaQuestionImport\fromXML(), assJavaAppletImport\fromXML(), assMultipleChoiceImport\fromXML(), assNumericImport\fromXML(), assOrderingHorizontalImport\fromXML(), assSingleChoiceImport\fromXML(), assTextQuestionImport\fromXML(), assTextSubsetImport\fromXML(), assOrderingQuestionImport\fromXML(), assMatchingQuestionImport\fromXML(), ilObjTest\fromXML(), ilForum\generatePost(), ilAssMultiOptionQuestionFeedback\getAllSpecificAnswerFeedbackContents(), ilAssQuestionFeedback\getGenericFeedbackContent(), ilObjTest\getManualFeedback(), ilAssMultiOptionQuestionFeedback\getSpecificAnswerFeedbackContent(), ilExPeerReviewGUI\getSubmissionContent(), ilObjSurvey\importObject(), ilSurveyImporter\importXmlRepresentation(), assMultipleChoice\isForcedEmptySolution(), ilExerciseManagementGUI\listTextAssignmentObject(), assKprimChoice\loadAnswerData(), assOrderingHorizontal\loadFromDb(), SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), assFileUpload\loadFromDb(), assTextQuestion\loadFromDb(), assTextSubset\loadFromDb(), assFlashQuestion\loadFromDb(), assOrderingQuestion\loadFromDb(), assErrorText\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), assClozeTest\loadFromDb(), assKprimChoice\loadFromDb(), assSingleChoice\loadFromDb(), SurveyMetricQuestion\loadFromDb(), assMultipleChoice\loadFromDb(), assMatchingQuestion\loadFromDb(), assJavaApplet\loadFromDb(), assImagemapQuestion\loadFromDb(), assLongMenu\loadFromDb(), SurveyMatrixQuestion\loadFromDb(), assFormulaQuestion\loadFromDb(), ilObjSurvey\loadFromDb(), ilObjTest\loadFromDb(), assQuestion\loadFromDb(), ilExAssignmentListTextTableGUI\parse(), assQuestionImport\processNonAbstractedImageReferences(), ilObjForumGUI\publishDraftObject(), ilObjForumGUI\quotePostObject(), ilObjForumGUI\renderDraftContent(), ilObjForumGUI\renderPostContent(), ilForumExportGUI\renderPostHtml(), assClozeTest\saveAdditionalQuestionDataToDb(), ilAssQuestionFeedback\saveGenericFeedbackContent(), assSingleChoice\savePreviewData(), assQuestion\saveQuestionDataToDb(), ilAssMultiOptionQuestionFeedback\saveSpecificAnswerFeedbackContent(), ilObjForumGUI\saveThreadAsDraftObject(), assNumeric\saveToDb(), ilObjSurvey\saveToDb(), SurveyQuestion\saveToDb(), ilObjTest\saveToDb(), ilExSubmissionTextGUI\showAssignmentTextObject(), ilForumXMLWriter\start(), assErrorText\toJSON(), ilExSubmissionTextGUI\updateAssignmentTextObject(), and ilObjForumGUI\updateThreadDraftObject().

    {
        if (!strlen($a_text)) {
            return '';
        }

        switch ($a_direction) {
            case 0:
                $a_text = preg_replace('/src="([^"]*?\/mobs\/mm_([0-9]+)\/.*?)\"/', 'src="il_' . IL_INST_ID . '_mob_\\2"', $a_text);
                break;

            default:
                require_once 'Services/MediaObjects/classes/class.ilObjMediaObject.php';
                $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($mob) == "mob") {
                            $mob_obj = new ilObjMediaObject($mob);
                            $replace = "il_" . $matches[1][$idx] . "_mob_" . $mob;
                            require_once('./Services/WebAccessChecker/classes/class.ilWACSignedPath.php');
                            $path_to_file = ilWACSignedPath::signFile(ILIAS_HTTP_PATH . "/data/" . CLIENT_ID . "/mobs/mm_" . $mob . "/" . $mob_obj->getTitle());
                            $resulttext = str_replace("src=\"$replace\"", "src=\"" . $path_to_file . "\"", $resulttext);
                        }
                    }
                }
                $a_text = $resulttext;
                break;
        }

        return $a_text;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addButton()

ilRTE::addButton

(

$a_button_name

)

Adds a button to the button list.

Parameters

string

$a_button_name

The name of the button

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

    {
        array_push($this->buttons, $a_button_name);
    }

addCustomRTESupport()

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

Adds custom support for an RTE in an ILIAS form.

Parameters

$obj_id	integer
$obj_type	string
$tags	array

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

    {
    }

addPlugin()

ilRTE::addPlugin

(

$a_plugin_name

)

Adds a plugin to the plugin list.

Parameters

string

$a_plugin_name

The name of the plugin

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

    {
        array_push($this->plugins, $a_plugin_name);
    }

addRTESupport()

ilRTE::addRTESupport	(		$obj_id,
			$obj_type,
			$a_module = "",
			$allowFormElements = false,
			$cfg_template = null,
			$hide_switch = false
	)

Adds support for an RTE in an ILIAS form.

Parameters

$obj_id	integer
$obj_type	string
$a_module	string
$allowFormElements	bool
$cfg_template	bool
$hide_switch	bool

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

    {
    }

addUserTextEditor()

ilRTE::addUserTextEditor

(

$editor_selector

)

Adds support for an user text editor.

Parameters

$editor_selector

string

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

    {
    }

disableButtons()

ilRTE::disableButtons

(

$a_button

)

Sets buttons which should be disabled in the RTE.

Parameters

array | string

$a_button

Either a button string or an array of button strings

Returns

self

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

Referenced by ilTinyMCE\addCustomRTESupport(), ilTinyMCE\addInternalTinyMCEImageManager(), ilTinyMCE\handleIliasImageManagerRemoved(), and ilTinyMCE\handleImagePluginsBeforeRendering().

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

Here is the caller graph for this function:

getDisabledButtons()

ilRTE::getDisabledButtons

(

$as_array = true

)

Returns the disabled RTE buttons.

Parameters

bool

$as_array

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

Returns

array|string

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

References $disabled_buttons.

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

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

Here is the caller graph for this function:

getInitialWidth()

ilRTE::getInitialWidth

(

)

Returns

integer

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

References $initialWidth.

Referenced by ilTinyMCE\addRTESupport().

    {
        return $this->initialWidth;
    }

Here is the caller graph for this function:

getRTERootBlockElement()

ilRTE::getRTERootBlockElement

(

)

Getter for the RTE root block element.

Returns

string Root block element of the RTE

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

References $root_block_element.

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

    {
        return $this->root_block_element;
    }

Here is the caller graph for this function:

removeAllPlugins()

ilRTE::removeAllPlugins

(

)

Removes all plugins from instance.

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

References removePlugin().

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

Here is the call graph for this function:

removeButton()

ilRTE::removeButton

(

$a_button_name

)

Removes a button from the button list.

Parameters

string

$a_button_name

The name of the button

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

References $key.

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

removePlugin()

ilRTE::removePlugin

(

$a_plugin_name

)

Removes a plugin from the plugin list.

Parameters

string

$a_plugin_name

The name of the plugin

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

References $key.

Referenced by removeAllPlugins().

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

Here is the caller graph for this function:

setInitialWidth()

ilRTE::setInitialWidth

(

$initialWidth

)

Parameters

integer

$initialWidth

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

References $initialWidth.

    {
        $this->initialWidth = $initialWidth;
    }

setRTERootBlockElement()

ilRTE::setRTERootBlockElement

(

$a_root_block_element

)

Setter for the RTE root block element.

Parameters

string

$a_root_block_element

Root block element

Returns

self

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

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

Field Documentation

$browser

ilRTE::$browser

protected

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

$buttons

ilRTE::$buttons = array()

protected

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

$client_init

ilRTE::$client_init

protected

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

$ctrl

ilRTE::$ctrl

protected

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

$disabled_buttons

ilRTE::$disabled_buttons = array()

protected

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

Referenced by getDisabledButtons().

$initialWidth

ilRTE::$initialWidth = null

protected

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

Referenced by getInitialWidth(), and setInitialWidth().

$lng

ilRTE::$lng

protected

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

$plugins

ilRTE::$plugins = array()

protected

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

$root_block_element

ilRTE::$root_block_element = null

protected

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

Referenced by getRTERootBlockElement().

$tpl

ilRTE::$tpl

protected

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

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

$user

ilRTE::$user

protected

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

ILIAS_IMG_MANAGER_PLUGIN

const ilRTE::ILIAS_IMG_MANAGER_PLUGIN = 'ilias_image_manager_plugin'

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

Referenced by ilSurveyEditorGUI\initHeadingForm(), and ilObjLearningSequenceSettingsGUI\initRTEInput().

---

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

• Services/RTE/classes/class.ilRTE.php