ilRTESettings Class Reference

Collaboration diagram for ilRTESettings:

Public Member Functions
	__construct (private readonly Language $lng, private readonly ?ilObjUser $current_user=null)
	getRichTextEditor ()
	setRichTextEditor (string $js_editor)
	setUsedHTMLTags (array $html_tags, string $module)
	getAllAvailableHTMLTags ()
	setRichTextEditorUserState (int $state)
	getRichTextEditorUserState ()

Static Public Member Functions
static	_getUsedHTMLTags (string $module='')
static	_getUsedHTMLTagsAsString (string $module='')

Private Attributes
const	ALL_AVAILABLE_TAGS
const	DEFAULT_TAGS
const	DEFAULT_FORUM_AND_EXERCISE_TAGS
ilSetting	$advanced_editing

Detailed Description

Definition at line 23 of file ilRTESettings.php.

Constructor & Destructor Documentation

__construct()

ilRTESettings::__construct	(	private readonly Language	$lng,
		private readonly ?ilObjUser	$current_user = null
	)

Definition at line 119 of file ilRTESettings.php.

      {
        $this->advanced_editing = new ilSetting('advanced_editing');
    }

Member Function Documentation

_getUsedHTMLTags()

static ilRTESettings::_getUsedHTMLTags ( string  $module = '' )

static

Definition at line 126 of file ilRTESettings.php.

                                                                : array
    {
        $tags = (new ilSetting('advanced_editing'))->get('advanced_editing_used_html_tags_' . $module, '');
 
        if ($tags === '') {
            if ($module === 'frm_post' || $module === 'exc_ass') {
                return self::DEFAULT_FORUM_AND_EXERCISE_TAGS;
            }
            return self::DEFAULT_TAGS;
        }
 
        $usedtags = unserialize($tags, ['allowed_classes' => false]);
        if ($module !== 'frm_post') {
            return $usedtags;
        }
 
        if (!in_array('div', $usedtags, true)) {
            $usedtags[] = 'div';
        }
 
        if (!in_array('blockquote', $usedtags, true)) {
            $usedtags[] = 'blockquote';
        }
 
        return $usedtags;
    }

References DEFAULT_FORUM_AND_EXERCISE_TAGS, and DEFAULT_TAGS.

Referenced by ILIAS\LegalDocuments\HTMLPurifier\__construct(), ilAccessibilityDocumentHtmlPurifier\__construct(), ilWebDAVMountInstructionsDocumentPurifier\__construct(), assQuestionGUI\addBasicQuestionFormProperties(), ilAssQuestionFeedback\buildFeedbackContentFormProperty(), ilAssHtmlPurifier\getElementsUsedForAdvancedEditing(), ilHtmlForumPostPurifier\getPurifierConfigInstance(), ilUserImportParser\importEndTag(), assClozeTestGUI\populateQuestionSpecificFormPart(), and assLongMenuGUI\populateQuestionSpecificFormPart().

Here is the caller graph for this function:

_getUsedHTMLTagsAsString()

static ilRTESettings::_getUsedHTMLTagsAsString ( string  $module = '' )

static

Definition at line 153 of file ilRTESettings.php.

                                                                        : string
    {
        return array_reduce(
            self::_getUsedHTMLTags(),
            static fn(string $c, string $v): string => $c . '<$v>',
            ''
        );
    }

References $c.

Referenced by assQuestionGUI\cleanupAnswerText(), ilKprimChoiceWizardInputGUI\cleanupAnswerText(), ilObjSurvey\cloneTextblocks(), ilSurveyEditorGUI\saveHeadingObject(), and ILIAS\Test\Scoring\Manual\ConsecutiveScoring\store().

Here is the caller graph for this function:

getAllAvailableHTMLTags()

ilRTESettings::getAllAvailableHTMLTags

(

)

Definition at line 206 of file ilRTESettings.php.

                                             : array
    {
        return self::ALL_AVAILABLE_TAGS;
    }

getRichTextEditor()

ilRTESettings::getRichTextEditor

(

)

Definition at line 162 of file ilRTESettings.php.

                                       : string
    {
        return $this->advanced_editing->get('advanced_editing_javascript_editor', '0');
    }

getRichTextEditorUserState()

ilRTESettings::getRichTextEditorUserState

(

)

Definition at line 216 of file ilRTESettings.php.

                                                : int
    {
 
        if ($this->current_user->getPref('show_rte') !== '') {
            return (int) $this->current_user->getPref('show_rte');
        }
        return 1;
    }

setRichTextEditor()

ilRTESettings::setRichTextEditor

(

string

$js_editor

)

Definition at line 167 of file ilRTESettings.php.

                                                        : void
    {
        $this->advanced_editing->set('advanced_editing_javascript_editor', $js_editor);
    }

setRichTextEditorUserState()

ilRTESettings::setRichTextEditorUserState

(

int

$state

)

Definition at line 211 of file ilRTESettings.php.

                                                          : void
    {
        $this->current_user->writePref('show_rte', (string) $state);
    }

Referenced by ilTinyMCE\addRTESupport().

Here is the caller graph for this function:

setUsedHTMLTags()

ilRTESettings::setUsedHTMLTags	(	array	$html_tags,
		string	$module
	)

Definition at line 172 of file ilRTESettings.php.

     : void {
        if ($module === '') {
            return;
        }
 
        $auto_added_tags = [];
        if ($module === 'frm_post') {
            if (!in_array('div', $html_tags, true)) {
                $auto_added_tags[] = 'div';
            }
 
            if (!in_array('blockquote', $html_tags, true)) {
                $auto_added_tags[] = 'blockquote';
            }
        }
 
        $this->advanced_editing->set(
            'advanced_editing_used_html_tags_' . $module,
            serialize(array_merge($html_tags, $auto_added_tags))
        );
 
        if ($auto_added_tags !== []) {
            throw new ilAdvancedEditingRequiredTagsException(
                sprintf(
                    $this->lng->txt('advanced_editing_required_tags'),
                    implode(', ', $auto_added_tags)
                )
            );
        }
    }

Field Documentation

$advanced_editing

ilSetting ilRTESettings::$advanced_editing

private

Definition at line 117 of file ilRTESettings.php.

ALL_AVAILABLE_TAGS

const ilRTESettings::ALL_AVAILABLE_TAGS

private

Definition at line 25 of file ilRTESettings.php.

DEFAULT_FORUM_AND_EXERCISE_TAGS

const ilRTESettings::DEFAULT_FORUM_AND_EXERCISE_TAGS

private

Initial value:

= [
        'a',
        'blockquote',
        'br',
        'code',
        'div',
        'em',
        'img',
        'li',
        'ol',
        'p',
        'strong',
        'u',
        'ul',
        'span'
    ]

Definition at line 100 of file ilRTESettings.php.

Referenced by _getUsedHTMLTags().

DEFAULT_TAGS

const ilRTESettings::DEFAULT_TAGS

private

Definition at line 68 of file ilRTESettings.php.

Referenced by _getUsedHTMLTags().

---

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

• components/ILIAS/RTE/classes/ilRTESettings.php