ilRTESettingsGUI Class Reference

Class ilObjAdvancedEditingGUI. More...

Collaboration diagram for ilRTESettingsGUI:

Public Member Functions
	__construct (private readonly int $ref_id, private readonly ilGlobalTemplateInterface $tpl, private readonly ilCtrlInterface $ctrl, private readonly Language $lng, private readonly ilAccessHandler $access, ilObjUser $current_user, ilTabsGUI $tabs_gui)
	settings ()
	getTinyForm ()
	saveSettings ()
	assessment ()
	saveAssessmentSettings ()
	frmPost ()
	saveFrmPostSettings ()

Protected Member Functions
	initTagsForm (string $a_id, string $a_cmd, string $a_title)
	saveTags (string $a_id, string $a_cmd, ilPropertyFormGUI $form)

Private Member Functions
	addSubtabs (ilTabsGUI $tabs_gui)

Private Attributes
ilRTESettings	$settings

Detailed Description

Class ilObjAdvancedEditingGUI.

Author

Helmut Schottmüller hscho.nosp@m.ttm@.nosp@m.gmx.d.nosp@m.e

Definition at line 28 of file class.ilRTESettingsGUI.php.

Constructor & Destructor Documentation

__construct()

ilRTESettingsGUI::__construct	(	private readonly int	$ref_id,
		private readonly ilGlobalTemplateInterface	$tpl,
		private readonly ilCtrlInterface	$ctrl,
		private readonly Language	$lng,
		private readonly ilAccessHandler	$access,
		ilObjUser	$current_user,
		ilTabsGUI	$tabs_gui
	)

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

References ILIAS\Repository\lng(), and settings().

      {
        $this->settings = new ilRTESettings($this->lng, $current_user);
        $this->addSubTabs($tabs_gui);
    }

Here is the call graph for this function:

Member Function Documentation

addSubtabs()

ilRTESettingsGUI::addSubtabs ( ilTabsGUI  $tabs_gui )

private

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

References ilTabsGUI\addSubTabTarget(), and ILIAS\Repository\ctrl().

                                                    : void
    {
        $tabs_gui->addSubTabTarget(
            'adve_general_settings',
            $this->ctrl->getLinkTargetByClass([ilObjAdvancedEditingGUI::class, self::class], 'settings'),
            ['settings', 'saveSettings'],
            '',
            ''
        );
        $tabs_gui->addSubTabTarget(
            'adve_assessment_settings',
            $this->ctrl->getLinkTargetByClass([ilObjAdvancedEditingGUI::class, self::class], 'assessment'),
            ['assessment', 'saveAssessmentSettings'],
            '',
            ''
        );
        $tabs_gui->addSubTabTarget(
            'adve_frm_post_settings',
            $this->ctrl->getLinkTargetByClass([ilObjAdvancedEditingGUI::class, self::class], 'frmPost'),
            ['frmPost', 'saveFrmPostSettings'],
            '',
            ''
        );
    }

Here is the call graph for this function:

assessment()

ilRTESettingsGUI::assessment

(

)

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

References initTagsForm().

                                : void
    {
        $form = $this->initTagsForm(
            "assessment",
            "saveAssessmentSettings",
            "advanced_editing_assessment_settings"
        );

        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

frmPost()

ilRTESettingsGUI::frmPost

(

)

Definition at line 138 of file class.ilRTESettingsGUI.php.

References initTagsForm().

                             : void
    {
        $form = $this->initTagsForm(
            "frm_post",
            "saveFrmPostSettings",
            "advanced_editing_frm_post_settings"
        );

        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

getTinyForm()

ilRTESettingsGUI::getTinyForm

(

)

Definition at line 77 of file class.ilRTESettingsGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and settings().

Referenced by saveSettings(), and settings().

                                 : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt("adve_activation"));
        $cb = new ilCheckboxInputGUI($this->lng->txt("adve_use_tiny_mce"), "use_tiny");
        if ($this->settings->getRichTextEditor() === "tinymce") {
            $cb->setChecked(true);
        }
        $form->addItem($cb);
        if ($this->access->checkAccess('write', '', $this->ref_id)) {
            $form->addCommandButton("saveSettings", $this->lng->txt("save"));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTagsForm()

ilRTESettingsGUI::initTagsForm ( string  $a_id, string  $a_cmd, string  $a_title  )

protected

Definition at line 162 of file class.ilRTESettingsGUI.php.

References ilRTESettings\_getUsedHTMLTags(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilMultiSelectInputGUI\setHeight(), and settings().

Referenced by assessment(), frmPost(), saveAssessmentSettings(), and saveFrmPostSettings().

     : ilPropertyFormGUI {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, $a_cmd));
        $form->setTitle($this->lng->txt($a_title));

        $tags = new ilMultiSelectInputGUI($this->lng->txt("advanced_editing_allow_html_tags"), "html_tags");
        $tags->setHeight(400);
        $tags->enableSelectAll(true);
        $tags->enableSelectedFirst(true);
        $tags->setOptions(
            array_combine($this->settings->getAllAvailableHTMLTags(), $this->settings->getAllAvailableHTMLTags())
        );
        $tags->setValue(ilRTESettings::_getUsedHTMLTags($a_id));
        $form->addItem($tags);

        if ($this->access->checkAccess('write', '', $this->ref_id)) {
            $form->addCommandButton($a_cmd, $this->lng->txt("save"));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveAssessmentSettings()

ilRTESettingsGUI::saveAssessmentSettings

(

)

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

References initTagsForm(), and saveTags().

                                            : void
    {
        $form = $this->initTagsForm(
            "assessment",
            "saveAssessmentSettings",
            "advanced_editing_assessment_settings"
        );
        if (!$this->saveTags("assessment", "assessment", $form)) {
            $form->setValuesByPost();
            $this->tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

saveFrmPostSettings()

ilRTESettingsGUI::saveFrmPostSettings

(

)

Definition at line 149 of file class.ilRTESettingsGUI.php.

References initTagsForm(), and saveTags().

                                         : void
    {
        $form = $this->initTagsForm(
            "frm_post",
            "saveFrmPostSettings",
            "advanced_editing_frm_post_settings"
        );
        if (!$this->saveTags("frm_post", "frmPost", $form)) {
            $form->setValuesByPost();
            $this->tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

saveSettings()

ilRTESettingsGUI::saveSettings

(

)

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

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), getTinyForm(), ILIAS\Repository\lng(), and settings().

                                  : void
    {
        if (!$this->access->checkAccess('write', '', $this->ref_id)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_perm_read'), true);
            return;
        }

        $form = $this->getTinyForm();
        $form->checkInput();

        if ($form->getInput('use_tiny')) {
            $this->settings->setRichTextEditor('tinymce');
        } else {
            $this->settings->setRichTextEditor('');
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);

        $this->ctrl->redirect($this, 'settings');
    }

Here is the call graph for this function:

saveTags()

ilRTESettingsGUI::saveTags ( string  $a_id, string  $a_cmd, ilPropertyFormGUI  $form  )

protected

Definition at line 188 of file class.ilRTESettingsGUI.php.

References Vendor\Package\$e, ILIAS\Repository\access(), ilPropertyFormGUI\checkInput(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getInput(), ILIAS\Repository\lng(), and settings().

Referenced by saveAssessmentSettings(), and saveFrmPostSettings().

     : bool {
        if (!$this->access->checkAccess('write', '', $this->ref_id)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_perm_read'), true);
            return false;
        }
        try {
            if ($form->checkInput()) {
                $html_tags = $form->getInput("html_tags");
                // get rid of select all
                if (array_key_exists(0, $html_tags) && (string) $html_tags[0] === '') {
                    unset($html_tags[0]);
                }
                $this->settings->setUsedHTMLTags((array) $html_tags, $a_id);
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
            } else {
                return false;
            }
        } catch (ilAdvancedEditingRequiredTagsException $e) {
            $this->tpl->setOnScreenMessage('info', $e->getMessage(), true);
        }
        $this->ctrl->redirect($this, $a_cmd);
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

settings()

ilRTESettingsGUI::settings

(

)

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

References getTinyForm().

Referenced by __construct(), getTinyForm(), initTagsForm(), saveSettings(), and saveTags().

                              : void
    {
        $tpl = $this->tpl;
        $form = $this->getTinyForm();
        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$settings

ilRTESettings ilRTESettingsGUI::$settings

private

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

---

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

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