Inheritance diagram for ilObjAdvancedEditingGUI:

Collaboration diagram for ilObjAdvancedEditingGUI:

Public Member Functions
	executeCommand ()

	saveObject ()

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	addSubtabs ()

	addPageEditorSettingsSubtabs ()

	settingsObject ()

	getTinyForm ()

	saveSettingsObject ()

	assessmentObject ()

	saveAssessmentSettingsObject ()

	surveyObject ()

	saveSurveySettingsObject ()

	frmPostObject ()

	saveFrmPostSettingsObject ()

	excAssObject ()

	saveExcAssSettingsObject ()

	showPageEditorSettingsObject ()

	initPageEditorForm ()

	savePageEditorSettingsObject ()

	showGeneralPageEditorSettingsObject ()

	initGeneralPageSettingsForm ()

	saveGeneralPageSettingsObject ()

	initCharSelectorSettingsForm (ilCharSelectorGUI $char_selector)

	showCharSelectorSettingsObject ()
	Show the settings for the selector of unicode characters. More...

	saveCharSelectorSettingsObject ()
	Save the settings for the selector of unicode characters. More...

Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)

	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	setCreationMode (bool $mode=true)
	if true, a creation screen is displayed the current [ref_id] don't belong to the current class! The mode is determined in ilRepositoryGUI More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelDeleteObject ()
	cancel deletion of object More...

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()

	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...

	setColumnSettings (ilColumnGUI $column_gui)

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Protected Member Functions
	getTabs ()
	@abstract overwrite in derived GUI class of your object type More...

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

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

	getPageObjectKeysWithOptionalHTML ()
	This limits the possibility to allow html for these page objects that supported the feature in the past. More...

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator (bool $omit=true)

	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	initCreationForms (string $new_type)
	Init creation forms. More...

	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...

	initCreateForm (string $new_type)

	initDidacticTemplate (ilPropertyFormGUI $form)

	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...

	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...

	initEditForm ()

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	initImportForm (string $new_type)

	importFileObject (int $parent_id=null)

	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	@abstract overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	fillCloneTemplate (?string $tpl_name, string $type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	showCustomIconsEditing ( $input_colspan=1, ilPropertyFormGUI $form=null, $as_section=true)
	show edit section of custom icons for container More...

Protected Attributes
ilPropertyFormGUI	$form

string	$cgrp = ""

StandardGUIRequest	$std_request

ilComponentRepository	$component_repository

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Factory	$refinery

ilFavouritesManager	$favourites

ilObjectCustomIconFactory	$custom_icon_factory

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION

const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Detailed Description

Class ilObjAdvancedEditingGUI.

Author: Helmut Schottmüller hscho.nosp@m.ttm@.nosp@m.gmx.d.nosp@m.e @ilCtrl_Calls ilObjAdvancedEditingGUI: ilPermissionGUI

Definition at line 24 of file class.ilObjAdvancedEditingGUI.php.

Member Function Documentation

◆ addPageEditorSettingsSubtabs()

ilObjAdvancedEditingGUI::addPageEditorSettingsSubtabs ( )

Definition at line 144 of file class.ilObjAdvancedEditingGUI.php.

                                                  : void
    {
        $this->tabs_gui->addSubTabTarget(
            "adve_pe_general",
            $this->ctrl->getLinkTarget($this, "showGeneralPageEditorSettings"),
            array("showGeneralPageEditorSettings", "", "view")
        );
 
        $grps = ilPageEditorSettings::getGroups();
 
        foreach ($grps as $g => $types) {
            $this->ctrl->setParameter($this, "grp", $g);
            $this->tabs_gui->addSubTabTarget(
                "adve_grp_" . $g,
                $this->ctrl->getLinkTarget($this, "showPageEditorSettings"),
                array("showPageEditorSettings")
            );
        }
        $this->ctrl->setParameter($this, "grp", $this->std_request->getGroup());
    }

References ILIAS\Repository\ctrl(), and ilPageEditorSettings\getGroups().

Here is the call graph for this function:

◆ addSubtabs()

ilObjAdvancedEditingGUI::addSubtabs ( )

Definition at line 96 of file class.ilObjAdvancedEditingGUI.php.

                                : void
    {
        if ($this->ctrl->getNextClass() !== "ilpermissiongui" &&
            !in_array($this->ctrl->getCmd(), array(
                "showPageEditorSettings",
                "showGeneralPageEditorSettings",
                "showCharSelectorSettings",
                "",
                "view"
            ), true)) {
            $this->tabs_gui->addSubTabTarget(
                "adve_general_settings",
                $this->ctrl->getLinkTarget($this, "settings"),
                array("settings", "saveSettings"),
                "",
                ""
            );
            $this->tabs_gui->addSubTabTarget(
                "adve_assessment_settings",
                $this->ctrl->getLinkTarget($this, "assessment"),
                array("assessment", "saveAssessmentSettings"),
                "",
                ""
            );
            $this->tabs_gui->addSubTabTarget(
                "adve_survey_settings",
                $this->ctrl->getLinkTarget($this, "survey"),
                array("survey", "saveSurveySettings"),
                "",
                ""
            );
            $this->tabs_gui->addSubTabTarget(
                "adve_frm_post_settings",
                $this->ctrl->getLinkTarget($this, "frmPost"),
                array("frmPost", "saveFrmPostSettings"),
                "",
                ""
            );
            $this->tabs_gui->addSubTabTarget(
                "adve_excass_settings",
                $this->ctrl->getLinkTarget($this, "excass"),
                array("excass", "saveExcAssSettings"),
                "",
                ""
            );
        }
    }

References ILIAS\Repository\ctrl().

Referenced by getTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assessmentObject()

ilObjAdvancedEditingGUI::assessmentObject ( )

Definition at line 242 of file class.ilObjAdvancedEditingGUI.php.

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

References $form, ilPropertyFormGUI\getHTML(), and initTagsForm().

Here is the call graph for this function:

◆ excAssObject()

ilObjAdvancedEditingGUI::excAssObject ( )

Definition at line 314 of file class.ilObjAdvancedEditingGUI.php.

                                  : void
    {
        $form = $this->initTagsForm(
            "exc_ass",
            "saveExcAssSettings",
            "advanced_editing_excass_settings"
        );
 
        $this->tpl->setContent($form->getHTML());
    }

References $form, ilPropertyFormGUI\getHTML(), and initTagsForm().

Here is the call graph for this function:

◆ executeCommand()

ilObjAdvancedEditingGUI::executeCommand ( )

Reimplemented from ilObjectGUI.

Definition at line 51 of file class.ilObjAdvancedEditingGUI.php.

                                    : void
    {
        if (!$this->rbac_system->checkAccess('read', $this->object->getRefId())) {
            $mess = str_replace("%s", $this->object->getTitle(), $this->lng->txt("msg_no_perm_read_item"));
            $this->ilias->raiseError($mess, $this->ilias->error_obj->WARNING);
        }
 
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
        $this->prepareOutput();
 
        switch ($next_class) {
 
            case 'ilpermissiongui':
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
 
            default:
                if ($cmd === null || $cmd === "" || $cmd === "view") {
                    $cmd = "showGeneralPageEditorSettings";
                }
                $cmd .= "Object";
                $this->$cmd();
 
                break;
        }
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\object(), and ilObjectGUI\prepareOutput().

Here is the call graph for this function:

◆ frmPostObject()

ilObjAdvancedEditingGUI::frmPostObject ( )

Definition at line 290 of file class.ilObjAdvancedEditingGUI.php.

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

References $form, ilPropertyFormGUI\getHTML(), and initTagsForm().

Here is the call graph for this function:

◆ getAdminTabs()

ilObjAdvancedEditingGUI::getAdminTabs ( )

administration tabs show only permissions and trash folder

Reimplemented from ilObjectGUI.

Definition at line 91 of file class.ilObjAdvancedEditingGUI.php.

                                  : void
    {
        $this->getTabs();
    }

References getTabs().

Here is the call graph for this function:

◆ getPageObjectKeysWithOptionalHTML()

ilObjAdvancedEditingGUI::getPageObjectKeysWithOptionalHTML ( )

protected

This limits the possibility to allow html for these page objects that supported the feature in the past.

PLEASE do not add additional keys here. The whole feature might be abandonded in the future.

Definition at line 564 of file class.ilObjAdvancedEditingGUI.php.

                                                          : array
    {
        return ["lobj","copa","mep","blp","prtf","prtt","gdf","lm","qht","qpl","qfbg","qfbs","sahs","stys","cont","cstr","auth"];
    }

◆ getTabs()

ilObjAdvancedEditingGUI::getTabs ( )

protected

@abstract overwrite in derived GUI class of your object type

Reimplemented from ilObjectGUI.

Definition at line 165 of file class.ilObjAdvancedEditingGUI.php.

                                : void
    {
        if ($this->rbac_system->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "adve_page_editor_settings",
                $this->ctrl->getLinkTarget($this, "showGeneralPageEditorSettings"),
                array("showPageEditorSettings", "","view")
            );
 
            $this->tabs_gui->addTarget(
                "adve_rte_settings",
                $this->ctrl->getLinkTarget($this, "settings"),
                array("settings","assessment", "survey", "frmPost", "excass"),
                "",
                ""
            );
 
            $this->tabs_gui->addTarget(
                "adve_char_selector_settings",
                $this->ctrl->getLinkTarget($this, "showCharSelectorSettings"),
                array("showCharSelectorSettings", "","view")
            );
        }
 
        if ($this->rbac_system->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "perm_settings",
                $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"),
                array("perm","info","owner"),
                'ilpermissiongui'
            );
        }
        $this->addSubtabs();
    }

References addSubtabs(), and ILIAS\Repository\ctrl().

Referenced by getAdminTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTinyForm()

ilObjAdvancedEditingGUI::getTinyForm ( )

Definition at line 207 of file class.ilObjAdvancedEditingGUI.php.

                                 : ilPropertyFormGUI
    {
        $editor = ilObjAdvancedEditing::_getRichTextEditor();
        $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 ($editor === "tinymce") {
            $cb->setChecked(true);
        }
        $form->addItem($cb);
        if ($this->checkPermissionBool("write")) {
            $form->addCommandButton("saveSettings", $this->lng->txt("save"));
        }
 
        return $form;
    }

References $form, ilObjAdvancedEditing\_getRichTextEditor(), ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Referenced by saveSettingsObject(), and settingsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCharSelectorSettingsForm()

ilObjAdvancedEditingGUI::initCharSelectorSettingsForm ( ilCharSelectorGUI $char_selector )

Definition at line 605 of file class.ilObjAdvancedEditingGUI.php.

                                                                                  : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setTitle($this->lng->txt('settings'));
        $form->setFormAction($this->ctrl->getFormAction($this));
        if ($this->checkPermissionBool("write")) {
            $form->addCommandButton("saveCharSelectorSettings", $this->lng->txt("save"));
        }
        $char_selector->addFormProperties($form);
 
        return $form;
    }

References ilPropertyFormGUI\addCommandButton(), ilCharSelectorGUI\addFormProperties(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Here is the call graph for this function:

◆ initGeneralPageSettingsForm()

ilObjAdvancedEditingGUI::initGeneralPageSettingsForm ( )

Definition at line 501 of file class.ilObjAdvancedEditingGUI.php.

                                                 : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
 
        $aset = new ilSetting("adve");
 
        // use physical character styles
        $cb = new ilCheckboxInputGUI($this->lng->txt("adve_use_physical"), "use_physical");
        $cb->setInfo($this->lng->txt("adve_use_physical_info"));
        $cb->setChecked((bool) $aset->get("use_physical"));
        $form->addItem($cb);
 
        // blocking mode
        $cb = new ilCheckboxInputGUI($this->lng->txt("adve_blocking_mode"), "block_mode_act");
        $cb->setChecked((bool) $aset->get("block_mode_minutes") > 0);
        $form->addItem($cb);
 
        // number of minutes
        $ni = new ilNumberInputGUI($this->lng->txt("adve_minutes"), "block_mode_minutes");
        $ni->setMinValue(2);
        $ni->setMaxLength(5);
        $ni->setSize(5);
        $ni->setRequired(true);
        $ni->setInfo($this->lng->txt("adve_minutes_info"));
        $ni->setValue($aset->get("block_mode_minutes"));
        $cb->addSubItem($ni);
 
        // autosave
        $as = new ilNumberInputGUI($this->lng->txt("adve_autosave"), "autosave");
        $as->setSuffix($this->lng->txt("seconds"));
        $as->setMaxLength(5);
        $as->setSize(5);
        $as->setInfo($this->lng->txt("adve_autosave_info"));
        $as->setValue($aset->get("autosave"));
        $form->addItem($as);
 
        // auto url linking
        $cb = new ilCheckboxInputGUI($this->lng->txt("adve_auto_url_linking"), "auto_url_linking");
        $cb->setChecked((bool) $aset->get("auto_url_linking"));
        $cb->setInfo($this->lng->txt("adve_auto_url_linking_info"));
        $form->addItem($cb);
 
        if ($this->checkPermissionBool("write")) {
            $form->addCommandButton("saveGeneralPageSettings", $this->lng->txt("save"));
        }
 
        // workaround for glossaries to force rewriting of short texts
        ilGlossaryDefinition::setShortTextsDirtyGlobally();
 
 
        $form->setTitle($this->lng->txt("adve_pe_general"));
        $form->setFormAction($this->ctrl->getFormAction($this));
 
        return $form;
    }

References ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), ilGlossaryDefinition\setShortTextsDirtyGlobally(), and ilPropertyFormGUI\setTitle().

Here is the call graph for this function:

◆ initPageEditorForm()

ilObjAdvancedEditingGUI::initPageEditorForm ( )

Definition at line 409 of file class.ilObjAdvancedEditingGUI.php.

                                        : void
    {
        $this->lng->loadLanguageModule("content");
 
        $this->form = new ilPropertyFormGUI();
 
        if ($this->cgrp === "test") {
            $this->form->setTitle($this->lng->txt("adve_activation"));
            $cb = new ilCheckboxInputGUI($this->lng->txt("advanced_editing_tst_editing"), "tst_page_edit");
            $cb->setInfo($this->lng->txt("advanced_editing_tst_editing_desc"));
            if ($this->settings->get("enable_tst_page_edit", ilObjAssessmentFolder::ADDITIONAL_QUESTION_CONTENT_EDITING_MODE_PAGE_OBJECT_DISABLED)) {
                $cb->setChecked(true);
            }
            $this->form->addItem($cb);
 
            $sh = new ilFormSectionHeaderGUI();
            $sh->setTitle($this->lng->txt("adve_text_content_features"));
            $this->form->addItem($sh);
        } elseif ($this->cgrp === "rep") {
            $this->form->setTitle($this->lng->txt("adve_activation"));
            $cb = new ilCheckboxInputGUI($this->lng->txt("advanced_editing_rep_page_editing"), "cat_page_edit");
            $cb->setInfo($this->lng->txt("advanced_editing_rep_page_editing_desc"));
            if ($this->settings->get("enable_cat_page_edit")) {
                $cb->setChecked(true);
            }
            $this->form->addItem($cb);
 
            $sh = new ilFormSectionHeaderGUI();
            $sh->setTitle($this->lng->txt("adve_text_content_features"));
            $this->form->addItem($sh);
        } else {
            $this->form->setTitle($this->lng->txt("adve_text_content_features"));
        }
 
 
        $buttons = ilPageContentGUI::_getCommonBBButtons();
        foreach ($buttons as $b => $t) {
            // command button activation
            $cb = new ilCheckboxInputGUI(str_replace(":", "", $this->lng->txt("cont_text_" . $b)), "active_" . $b);
            $cb->setChecked((bool) ilPageEditorSettings::lookupSetting($this->cgrp, "active_" . $b, true));
            $this->form->addItem($cb);
        }
 
        // save and cancel commands
        if ($this->checkPermissionBool("write")) {
            $this->form->addCommandButton("savePageEditorSettings", $this->lng->txt("save"));
        }
 
        $this->form->setFormAction($this->ctrl->getFormAction($this));
    }

References Vendor\Package\$b, ilPageContentGUI\_getCommonBBButtons(), ilObjAssessmentFolder\ADDITIONAL_QUESTION_CONTENT_EDITING_MODE_PAGE_OBJECT_DISABLED, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ILIAS\Repository\lng(), ilPageEditorSettings\lookupSetting(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ initTagsForm()

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

protected

Definition at line 339 of file class.ilObjAdvancedEditingGUI.php.

     : ilPropertyFormGUI {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, $a_cmd));
        $form->setTitle($this->lng->txt($a_title));
 
        $alltags = $this->object->getHTMLTags();
        $alltags = array_combine($alltags, $alltags);
 
        $tags = new ilMultiSelectInputGUI($this->lng->txt("advanced_editing_allow_html_tags"), "html_tags");
        $tags->setHeight(400);
        $tags->enableSelectAll(true);
        $tags->enableSelectedFirst(true);
        $tags->setOptions($alltags);
        $tags->setValue(ilObjAdvancedEditing::_getUsedHTMLTags($a_id));
        $form->addItem($tags);
 
        if ($this->access->checkAccess("write", "", $this->object->getRefId())) {
            $form->addCommandButton($a_cmd, $this->lng->txt("save"));
        }
 
        return $form;
    }

Referenced by assessmentObject(), excAssObject(), frmPostObject(), saveAssessmentSettingsObject(), saveExcAssSettingsObject(), saveFrmPostSettingsObject(), saveSurveySettingsObject(), and surveyObject().

Here is the caller graph for this function:

◆ saveAssessmentSettingsObject()

ilObjAdvancedEditingGUI::saveAssessmentSettingsObject ( )

Definition at line 253 of file class.ilObjAdvancedEditingGUI.php.

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

References $form, ilPropertyFormGUI\getHTML(), initTagsForm(), saveTags(), and ilPropertyFormGUI\setValuesByPost().

Here is the call graph for this function:

◆ saveCharSelectorSettingsObject()

ilObjAdvancedEditingGUI::saveCharSelectorSettingsObject ( )

Save the settings for the selector of unicode characters.

Definition at line 638 of file class.ilObjAdvancedEditingGUI.php.

                                                    : void
    {
        $this->checkPermission("write");
 
        $char_selector = new ilCharSelectorGUI(ilCharSelectorConfig::CONTEXT_ADMIN);
        $form = $this->initCharSelectorSettingsForm($char_selector);
        if ($form->checkInput()) {
            $char_selector->getFormValues($form);
 
            $this->settings->set('char_selector_availability', $char_selector->getConfig()->getAvailability());
            $this->settings->set('char_selector_definition', $char_selector->getConfig()->getDefinition());
 
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
            $this->ctrl->redirect($this, "showCharSelectorSettings");
        }
        $form->setValuesByPost();
        $this->tpl->setContent($form->getHTML());
    }

References ilPropertyFormGUI\checkInput(), ilCharSelectorConfig\CONTEXT_ADMIN, ILIAS\Repository\ctrl(), ilPropertyFormGUI\getHTML(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ilPropertyFormGUI\setValuesByPost().

Here is the call graph for this function:

◆ saveExcAssSettingsObject()

ilObjAdvancedEditingGUI::saveExcAssSettingsObject ( )

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

                                              : void
    {
        $form = $this->initTagsForm(
            "exc_ass",
            "saveExcAssSettings",
            "advanced_editing_excass_settings"
        );
        if (!$this->saveTags("exc_ass", "excAss", $form)) {
            $form->setValuesByPost();
            $this->tpl->setContent($form->getHTML());
        }
    }

References $form, ilPropertyFormGUI\getHTML(), initTagsForm(), saveTags(), and ilPropertyFormGUI\setValuesByPost().

Here is the call graph for this function:

◆ saveFrmPostSettingsObject()

ilObjAdvancedEditingGUI::saveFrmPostSettingsObject ( )

Definition at line 301 of file class.ilObjAdvancedEditingGUI.php.

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

References $form, ilPropertyFormGUI\getHTML(), initTagsForm(), saveTags(), and ilPropertyFormGUI\setValuesByPost().

Here is the call graph for this function:

◆ saveGeneralPageSettingsObject()

ilObjAdvancedEditingGUI::saveGeneralPageSettingsObject ( )

Definition at line 569 of file class.ilObjAdvancedEditingGUI.php.

                                                   : void
    {
        $this->checkPermission("write");
 
        $form = $this->initGeneralPageSettingsForm();
        if ($form->checkInput()) {
            $autosave = (int) $form->getInput("autosave");
            $ok = true;
 
            // autosave must be greater 10, if activated
            if ($autosave > 0 && $autosave < 10) {
                $form->getItemByPostVar("autosave")->setAlert($this->lng->txt("adve_autosave_info_min_10"));
                $ok = false;
            }
 
            if ($ok) {
                $aset = new ilSetting("adve");
                $aset->set("use_physical", $form->getInput("use_physical"));
                if ($form->getInput("block_mode_act")) {
                    $aset->set("block_mode_minutes", (string) (int) $form->getInput("block_mode_minutes"));
                } else {
                    $aset->set("block_mode_minutes", 0);
                }
                $aset->set("auto_url_linking", $form->getInput("auto_url_linking"));
 
                $aset->set("autosave", $form->getInput("autosave"));
 
                $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
                $this->ctrl->redirect($this, "showGeneralPageEditorSettings");
            }
        }
 
        $form->setValuesByPost();
        $this->tpl->setContent($form->getHTML());
    }

References ilPropertyFormGUI\checkInput(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getHTML(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and ilPropertyFormGUI\setValuesByPost().

Here is the call graph for this function:

◆ saveObject()

ilObjAdvancedEditingGUI::saveObject ( )

Reimplemented from ilObjectGUI.

Definition at line 80 of file class.ilObjAdvancedEditingGUI.php.

                                : void
    {
        $this->checkPermission("write");
 
        parent::saveObject();
 
        // always send a message
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_added"), true);
        $this->ctrl->redirect($this);
    }

References ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ savePageEditorSettingsObject()

ilObjAdvancedEditingGUI::savePageEditorSettingsObject ( )

Definition at line 460 of file class.ilObjAdvancedEditingGUI.php.

                                                  : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;
 
        $this->checkPermission("write");
 
        $this->initPageEditorForm();
        if ($this->form->checkInput()) {
            $buttons = ilPageContentGUI::_getCommonBBButtons();
            foreach ($buttons as $b => $t) {
                ilPageEditorSettings::writeSetting(
                    $this->std_request->getGroup(),
                    "active_" . $b,
                    $this->form->getInput("active_" . $b)
                );
            }
 
            if ($this->std_request->getGroup() === "test") {
                $ilSetting->set("enable_tst_page_edit", (string) $this->form->getInput("tst_page_edit"));
            } elseif ($this->std_request->getGroup() === "rep") {
                $ilSetting->set("enable_cat_page_edit", (string) $this->form->getInput("cat_page_edit"));
            }
 
            $this->tpl->setOnScreenMessage('info', $lng->txt("msg_obj_modified"), true);
        }
 
        $ilCtrl->setParameter($this, "grp", $this->std_request->getGroup());
        $ilCtrl->redirect($this, "showPageEditorSettings");
    }

References Vendor\Package\$b, $ilSetting, $lng, ILIAS\LTI\ToolProvider\$settings, ilPageContentGUI\_getCommonBBButtons(), ILIAS\Repository\form(), and ilPageEditorSettings\writeSetting().

Here is the call graph for this function:

◆ saveSettingsObject()

ilObjAdvancedEditingGUI::saveSettingsObject ( )

Definition at line 225 of file class.ilObjAdvancedEditingGUI.php.

                                        : void
    {
        $this->checkPermission("write");
 
        $form = $this->getTinyForm();
        $form->checkInput();
 
        if ($form->getInput("use_tiny")) {
            $this->object->setRichTextEditor("tinymce");
        } else {
            $this->object->setRichTextEditor("");
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
 
        $this->ctrl->redirect($this, 'settings');
    }

References $form, ilPropertyFormGUI\checkInput(), ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getInput(), getTinyForm(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ saveSurveySettingsObject()

ilObjAdvancedEditingGUI::saveSurveySettingsObject ( )

Definition at line 277 of file class.ilObjAdvancedEditingGUI.php.

                                              : void
    {
        $form = $this->initTagsForm(
            "survey",
            "saveSurveySettings",
            "advanced_editing_survey_settings"
        );
        if (!$this->saveTags("survey", "survey", $form)) {
            $form->setValuesByPost();
            $this->tpl->setContent($form->getHTML());
        }
    }

References $form, ilPropertyFormGUI\getHTML(), initTagsForm(), saveTags(), and ilPropertyFormGUI\setValuesByPost().

Here is the call graph for this function:

◆ saveTags()

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

protected

Definition at line 366 of file class.ilObjAdvancedEditingGUI.php.

     : bool {
        $this->checkPermission("write");
        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->object->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;
    }

References ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), and ILIAS\Repository\lng().

Referenced by saveAssessmentSettingsObject(), saveExcAssSettingsObject(), saveFrmPostSettingsObject(), and saveSurveySettingsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ settingsObject()

ilObjAdvancedEditingGUI::settingsObject ( )

Definition at line 200 of file class.ilObjAdvancedEditingGUI.php.

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

References $form, ilObjectGUI\$tpl, ilPropertyFormGUI\getHTML(), getTinyForm(), and ilGlobalTemplateInterface\setContent().

Here is the call graph for this function:

◆ showCharSelectorSettingsObject()

ilObjAdvancedEditingGUI::showCharSelectorSettingsObject ( )

Show the settings for the selector of unicode characters.

Definition at line 622 of file class.ilObjAdvancedEditingGUI.php.

                                                    : void
    {
        $this->tabs_gui->activateTab("adve_char_selector_settings");
 
        $char_selector = new ilCharSelectorGUI(ilCharSelectorConfig::CONTEXT_ADMIN);
        $char_selector->getConfig()->setAvailability((int) $this->settings->get('char_selector_availability'));
        $char_selector->getConfig()->setDefinition((string) $this->settings->get('char_selector_definition'));
        $form = $this->initCharSelectorSettingsForm($char_selector);
        $char_selector->setFormValues($form);
        $this->tpl->setContent($form->getHTML());
    }

References ilCharSelectorConfig\CONTEXT_ADMIN, ilPropertyFormGUI\getHTML(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ showGeneralPageEditorSettingsObject()

ilObjAdvancedEditingGUI::showGeneralPageEditorSettingsObject ( )

Definition at line 492 of file class.ilObjAdvancedEditingGUI.php.

                                                         : void
    {
        $this->addPageEditorSettingsSubtabs();
        $this->tabs_gui->activateTab("adve_page_editor_settings");
 
        $form = $this->initGeneralPageSettingsForm();
        $this->tpl->setContent($form->getHTML());
    }

References ilPropertyFormGUI\getHTML().

Here is the call graph for this function:

◆ showPageEditorSettingsObject()

ilObjAdvancedEditingGUI::showPageEditorSettingsObject ( )

Definition at line 391 of file class.ilObjAdvancedEditingGUI.php.

                                                  : void
    {
        $this->addPageEditorSettingsSubtabs();
 
        $grps = ilPageEditorSettings::getGroups();
 
        $this->cgrp = $this->std_request->getGroup();
        if ($this->cgrp === "") {
            $this->cgrp = (string) key($grps);
        }
 
        $this->ctrl->setParameter($this, "grp", $this->cgrp);
        $this->tabs_gui->setSubTabActive("adve_grp_" . $this->cgrp);
 
        $this->initPageEditorForm();
        $this->tpl->setContent($this->form->getHTML());
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\form(), and ilPageEditorSettings\getGroups().

Here is the call graph for this function:

◆ surveyObject()

ilObjAdvancedEditingGUI::surveyObject ( )

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

                                  : void
    {
        $form = $this->initTagsForm(
            "survey",
            "saveSurveySettings",
            "advanced_editing_survey_settings"
        );
 
        $this->tpl->setContent($form->getHTML());
    }

References $form, ilPropertyFormGUI\getHTML(), and initTagsForm().

Here is the call graph for this function:

Field Documentation

◆ $cgrp

string ilObjAdvancedEditingGUI::$cgrp = ""

protected

Definition at line 27 of file class.ilObjAdvancedEditingGUI.php.

◆ $component_repository

ilComponentRepository ilObjAdvancedEditingGUI::$component_repository

protected

Definition at line 29 of file class.ilObjAdvancedEditingGUI.php.

◆ $form

ilPropertyFormGUI ilObjAdvancedEditingGUI::$form

protected

Definition at line 26 of file class.ilObjAdvancedEditingGUI.php.

Referenced by assessmentObject(), excAssObject(), frmPostObject(), getTinyForm(), saveAssessmentSettingsObject(), saveExcAssSettingsObject(), saveFrmPostSettingsObject(), saveSettingsObject(), saveSurveySettingsObject(), settingsObject(), and surveyObject().

◆ $std_request

StandardGUIRequest ilObjAdvancedEditingGUI::$std_request

protected

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

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

Services/AdvancedEditing/classes/class.ilObjAdvancedEditingGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addPageEditorSettingsSubtabs()

◆ addSubtabs()

◆ assessmentObject()

◆ excAssObject()

◆ executeCommand()

◆ frmPostObject()

◆ getAdminTabs()

◆ getPageObjectKeysWithOptionalHTML()

◆ getTabs()

◆ getTinyForm()

◆ initCharSelectorSettingsForm()

◆ initGeneralPageSettingsForm()

◆ initPageEditorForm()

◆ initTagsForm()

◆ saveAssessmentSettingsObject()

◆ saveCharSelectorSettingsObject()

◆ saveExcAssSettingsObject()

◆ saveFrmPostSettingsObject()

◆ saveGeneralPageSettingsObject()

◆ saveObject()

◆ savePageEditorSettingsObject()

◆ saveSettingsObject()

◆ saveSurveySettingsObject()

◆ saveTags()

◆ settingsObject()

◆ showCharSelectorSettingsObject()

◆ showGeneralPageEditorSettingsObject()

◆ showPageEditorSettingsObject()

◆ surveyObject()

Field Documentation

◆ $cgrp

◆ $component_repository

◆ $form

◆ $std_request