ilRTE Class Reference

Rich Text Editor base class. More...

Inheritance diagram for ilRTE:

Collaboration diagram for ilRTE:

Public Member Functions
	ilRTE ($a_version="")
	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 ()
	removeButton ($a_button_name)
	Removes a button from the button list. More...
	addRTESupport ()
	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, $tags)
	Adds custom support for an RTE in an ILIAS form. More...
	_cleanupMediaObjectUsage ($a_text, $a_usage_type, $a_usage_id)
	synchronises appearances of media objects in $a_text with media object usage table More...
	setRTERootBlockElement ()
	getRTERootBlockElement ()
	disableButtons ()
	getDisabledButtons ()
	getInitialWidth ()
	setInitialWidth ($initialWidth)

Static Public Member Functions
static	_getRTEClassname ()
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'
	$plugins
	$buttons
	$tpl
	$ctrl
	$lng

Protected Attributes
	$initialWidth = null

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

Member Function Documentation

_cleanupMediaObjectUsage()

ilRTE::_cleanupMediaObjectUsage	(		$a_text,
			$a_usage_type,
			$a_usage_id
	)

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

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

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

        {
                // get current stored mobs
                include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                $mobs = ilObjMediaObject::_getMobsOfObject($a_usage_type,
                        $a_usage_id);
                while (eregi("data\/".CLIENT_ID."\/mobs\/mm_([0-9]+)", $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 272 of file class.ilRTE.php.

References ilObjMediaObject\_exists().

Referenced by ilObjForumGUI\getReplyEditForm(), ilObjPaymentSettingsGUI\saveStatutoryRegulationsObject(), ilObjForumGUI\setTopicCreateDefaultValues(), and ilObjExerciseGUI\updateAssignmentTextObject().

        {
                if (!strlen($a_text)) return array();
                include_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

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

References ilObjAdvancedEditing\_getRichTextEditor().

Referenced by ilObjForumGUI\cancelPostObject(), ilContainerGUI\editPageContentObject(), ilTextAreaInputGUI\insert(), and assTextQuestionGUI\outQuestionForTest().

        {
                include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
                $editor = ilObjAdvancedEditing::_getRichTextEditor();
                switch ($editor)
                {
                        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 236 of file class.ilRTE.php.

References ilObjMediaObject\_exists().

Referenced by ilPurchaseBaseGUI\__sendBill(), SurveyQuestion\addMaterialTag(), ilObjSurvey\addMaterialTag(), assQuestion\addQTIMaterial(), ilObjTest\addQTIMaterial(), assMultipleChoice\calculateReachedPoints(), assQuestion\copySuggestedSolutionFiles(), ilObjExerciseGUI\editAssignmentTextObject(), ilForumExportGUI\executeCommand(), ilAssSelfAssessmentQuestionFormatter\format(), assKprimChoiceImport\fromXML(), assErrorTextImport\fromXML(), assFileUploadImport\fromXML(), assFlashQuestionImport\fromXML(), assOrderingQuestionImport\fromXML(), assImagemapQuestionImport\fromXML(), assJavaAppletImport\fromXML(), assMultipleChoiceImport\fromXML(), assNumericImport\fromXML(), assOrderingHorizontalImport\fromXML(), assTextQuestionImport\fromXML(), assTextSubsetImport\fromXML(), assSingleChoiceImport\fromXML(), assClozeTestImport\fromXML(), assFormulaQuestionImport\fromXML(), assMatchingQuestionImport\fromXML(), ilObjTest\fromXML(), ilForum\generatePost(), ilAssMultiOptionQuestionFeedback\getAllSpecificAnswerFeedbackContents(), ilAssQuestionFeedback\getGenericFeedbackContent(), ilObjTest\getManualFeedback(), ilObjForumGUI\getReplyEditForm(), ilAssMultiOptionQuestionFeedback\getSpecificAnswerFeedbackContent(), ilObjSurvey\importObject(), ilSurveyImporter\importXmlRepresentation(), assKprimChoice\loadAnswerData(), assOrderingHorizontal\loadFromDb(), SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), assFileUpload\loadFromDb(), assFlashQuestion\loadFromDb(), assTextQuestion\loadFromDb(), assTextSubset\loadFromDb(), assOrderingQuestion\loadFromDb(), assErrorText\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), assClozeTest\loadFromDb(), assKprimChoice\loadFromDb(), assSingleChoice\loadFromDb(), assMultipleChoice\loadFromDb(), SurveyMetricQuestion\loadFromDb(), assMatchingQuestion\loadFromDb(), assJavaApplet\loadFromDb(), assImagemapQuestion\loadFromDb(), SurveyMatrixQuestion\loadFromDb(), assFormulaQuestion\loadFromDb(), ilObjSurvey\loadFromDb(), ilObjTest\loadFromDb(), assQuestion\loadFromDb(), ilExAssignmentListTextTableGUI\parse(), assQuestionImport\processNonAbstractedImageReferences(), ilObjForumGUI\quotePostObject(), assClozeTest\saveAdditionalQuestionDataToDb(), ilAssQuestionFeedback\saveGenericFeedbackContent(), assSingleChoice\savePreviewData(), assQuestion\saveQuestionDataToDb(), ilAssMultiOptionQuestionFeedback\saveSpecificAnswerFeedbackContent(), ilObjPaymentSettingsGUI\saveStatutoryRegulationsObject(), assNumeric\saveToDb(), ilObjSurvey\saveToDb(), SurveyQuestion\saveToDb(), ilObjTest\saveToDb(), ilObjForumGUI\setTopicCreateDefaultValues(), ilObjForumGUI\setTreeStateAsynchObject(), ilObjExerciseGUI\showAssignmentTextObject(), ilShopShoppingCartGUI\showItems(), ilForumXMLWriter\start(), ilObjPaymentSettingsGUI\StatutoryRegulationsObject(), assErrorText\toJSON(), and ilObjExerciseGUI\updateAssignmentTextObject().

        {
                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:
                                include_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 (ilObjMediaObject::_exists($mob))
                                                {
                                                        $mob_obj =& new ilObjMediaObject($mob);
                                                        $replace = "il_" . $matches[1][$idx] . "_mob_" . $mob;
                                                        $resulttext = str_replace("src=\"$replace\"", "src=\"" . ILIAS_HTTP_PATH . "/data/" . CLIENT_ID . "/mobs/mm_" . $mob . "/" . $mob_obj->getTitle() . "\"", $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.

Adds a button to the button list

Parameters

string

$a_button_name

The name of the button public

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

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

addCustomRTESupport()

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

Adds custom support for an RTE in an ILIAS form.

Adds custom support for an RTE in an ILIAS form

public

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

        {
                // must be overwritten in parent classes
        }

addPlugin()

ilRTE::addPlugin

(

$a_plugin_name

)

Adds a plugin to the plugin list.

Adds a plugin to the plugin list

Parameters

string

$a_plugin_name

The name of the plugin public

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

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

addRTESupport()

ilRTE::addRTESupport

(

)

Adds support for an RTE in an ILIAS form.

Adds support for an RTE in an ILIAS form

public

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

        {
                // must be overwritten in parent classes
        }

addUserTextEditor()

ilRTE::addUserTextEditor

(

$editor_selector

)

Adds support for an user text editor.

public

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

        {
                // must be overwritten in parent classes
        }

disableButtons()

ilRTE::disableButtons

(

)

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

Referenced by ilTinyMCE\addCustomRTESupport(), ilTinyMCE\handleIliasImageManagerAdded(), ilTinyMCE\handleImagePluginsBeforeRendering(), and ilTinyMCE\ilTinyMCE().

        {
                // must be overwritten in sub classes
        }

Here is the caller graph for this function:

getDisabledButtons()

ilRTE::getDisabledButtons

(

)

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

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

        {
                // must be overwritten in sub classes
        }

Here is the caller graph for this function:

getInitialWidth()

ilRTE::getInitialWidth

(

)

Returns

integer

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

(

)

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

        {
                // must be overwritten in sub classes
        }

ilRTE()

ilRTE::ilRTE

(

$a_version = ""

)

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

References $ilCtrl, $lng, and $tpl.

        {
                global $tpl, $ilCtrl, $lng;
                $this->tpl =& $tpl;
                $this->ctrl =& $ilCtrl;
                $this->lng =& $lng;
                $this->plugins = array();
                $this->buttons = array();
        }

removeAllPlugins()

ilRTE::removeAllPlugins

(

)

Definition at line 110 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.

Removes a button from the button list

Parameters

string

$a_button_name

The name of the button public

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

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

Removes a plugin from the plugin list

Parameters

string

$a_plugin_name

The name of the plugin public

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

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

References $initialWidth.

        {
                $this->initialWidth = $initialWidth;
        }

setRTERootBlockElement()

ilRTE::setRTERootBlockElement

(

)

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

        {
                // must be overwritten in sub classes
        }

Field Documentation

$buttons

ilRTE::$buttons

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

$ctrl

ilRTE::$ctrl

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

$initialWidth

ilRTE::$initialWidth = null

protected

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

Referenced by getInitialWidth(), and setInitialWidth().

$lng

ilRTE::$lng

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

Referenced by ilRTE().

$plugins

ilRTE::$plugins

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

$tpl

ilRTE::$tpl

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

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

ILIAS_IMG_MANAGER_PLUGIN

const ilRTE::ILIAS_IMG_MANAGER_PLUGIN = 'ilias_image_manager_plugin'

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

Referenced by ilSurveyEditorGUI\initHeadingForm(), and ilObjPaymentSettingsGUI\StatutoryRegulationsObject().

---

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

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