ilObjAdvancedEditingGUI Class Reference

Class ilObjAdvancedEditingGUI. More...

Inheritance diagram for ilObjAdvancedEditingGUI:

Collaboration diagram for ilObjAdvancedEditingGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference)
	Constructor. More...
	executeCommand ()
	saveObject ()
	save object public More...
	getAdminTabs ()
	addSubtabs ()
	Add rte subtabs. More...
	addPageEditorSettingsSubtabs ()
	Show page editor settings subtabs. More...
	getTabs ()
	get tabs public More...
	settingsObject ()
	Display assessment folder settings form. More...
	saveSettingsObject ()
	Save Assessment settings. More...
	assessmentObject ()
	Display settings for test and assessment. More...
	saveAssessmentSettingsObject ()
	surveyObject ()
	Display settings for surveys. More...
	saveSurveySettingsObject ()
	frmPostObject ()
	Display settings for forums. More...
	saveFrmPostSettingsObject ()
	excAssObject ()
	Display settings for exercise assignments. More...
	saveExcAssSettingsObject ()
	showPageEditorSettingsObject ()
	Show page editor settings. More...
	initPageEditorForm ($a_mode="edit")
	Init page editor form. More...
	savePageEditorSettingsObject ()
	Save page editor settings form. More...
	showGeneralPageEditorSettingsObject ()
	Show general page editor settings. More...
	initGeneralPageSettingsForm ()
	Init general page editor settings form. More...
	saveGeneralPageSettingsObject ()
	Save general page settings. More...
	initCharSelectorSettingsForm (ilCharSelectorGUI $char_selector)
	Init the settings form for the selector of unicode characters. More...
	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
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	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 public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Data Fields
	$conditions
Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
const	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Protected Member Functions
	initTagsForm ($a_id, $a_cmd, $a_title)
	saveTags ($a_id, $a_cmd, $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 ()
	Get object service. More...
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	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 public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_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 $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_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...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$rbacsystem
	$rbacadmin
	$tabs
	$access
	$settings
Protected Attributes inherited from ilObjectGUI
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
	$ilErr
	$locator
	$user
	$access
	$rbacsystem
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service
	$favourites
	$request

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Detailed Description

Class ilObjAdvancedEditingGUI.

Author

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

Version

$Id$

ilObjAdvancedEditingGUI: ilPermissionGUI

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

Constructor & Destructor Documentation

__construct()

ilObjAdvancedEditingGUI::__construct	(		$a_data,
			$a_id,
			$a_call_by_reference
	)

Constructor.

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

References $DIC, $rbacsystem, ILIAS\GlobalScreen\Provider\__construct(), and settings().

    {
        global $DIC;

        $this->rbacsystem = $DIC->rbac()->system();
        $this->rbacadmin = $DIC->rbac()->admin();
        $this->ctrl = $DIC->ctrl();
        $this->tabs = $DIC->tabs();
        $this->tpl = $DIC["tpl"];
        $this->lng = $DIC->language();
        $this->access = $DIC->access();
        $this->settings = $DIC->settings();
        $rbacsystem = $DIC->rbac()->system();

        $this->type = "adve";
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);
        $this->lng->loadLanguageModule('adve');
        $this->lng->loadLanguageModule('meta');
    }

Here is the call graph for this function:

Member Function Documentation

addPageEditorSettingsSubtabs()

ilObjAdvancedEditingGUI::addPageEditorSettingsSubtabs

(

)

Show page editor settings subtabs.

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

References $_GET, ilObjectGUI\$ctrl, $tabs, and ilPageEditorSettings\getGroups().

    {
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;

        $ilTabs->addSubTabTarget(
            "adve_pe_general",
            $ilCtrl->getLinkTarget($this, "showGeneralPageEditorSettings"),
            array("showGeneralPageEditorSettings", "", "view")
        );

        include_once("./Services/COPage/classes/class.ilPageEditorSettings.php");
        $grps = ilPageEditorSettings::getGroups();
        
        foreach ($grps as $g => $types) {
            $ilCtrl->setParameter($this, "grp", $g);
            $ilTabs->addSubTabTarget(
                "adve_grp_" . $g,
                $ilCtrl->getLinkTarget($this, "showPageEditorSettings"),
                array("showPageEditorSettings")
            );
        }
        $ilCtrl->setParameter($this, "grp", $_GET["grp"]);
    }

Here is the call graph for this function:

addSubtabs()

ilObjAdvancedEditingGUI::addSubtabs

(

)

Add rte subtabs.

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

References ilObjectGUI\$ctrl.

Referenced by getTabs().

    {
        $ilCtrl = $this->ctrl;

        if ($ilCtrl->getNextClass() != "ilpermissiongui" &&
            !in_array($ilCtrl->getCmd(), array("showPageEditorSettings",
                "showGeneralPageEditorSettings", "showCharSelectorSettings", "", "view"))) {
            $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"),
                "",
                ""
            );
        }
    }

Here is the caller graph for this function:

assessmentObject()

ilObjAdvancedEditingGUI::assessmentObject

(

)

Display settings for test and assessment.

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

References initTagsForm().

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

Here is the call graph for this function:

excAssObject()

ilObjAdvancedEditingGUI::excAssObject

(

)

Display settings for exercise assignments.

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

References initTagsForm().

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

Here is the call graph for this function:

executeCommand()

ilObjAdvancedEditingGUI::executeCommand

(

)

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

References $ret, and ilObjectGUI\prepareOutput().

    {
        if (!$this->rbacsystem->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':
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $ret = &$this->ctrl->forwardCommand($perm_gui);
                break;

            default:
                if ($cmd == "" || $cmd == "view") {
                    $cmd = "showGeneralPageEditorSettings";
                }
                $cmd .= "Object";
                $this->$cmd();

                break;
        }
        return true;
    }

Here is the call graph for this function:

frmPostObject()

ilObjAdvancedEditingGUI::frmPostObject

(

)

Display settings for forums.

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

References initTagsForm().

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

Here is the call graph for this function:

getAdminTabs()

ilObjAdvancedEditingGUI::getAdminTabs

(

)

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

References getTabs().

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

Returns

array

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

Referenced by initGeneralPageSettingsForm(), and saveGeneralPageSettingsObject().

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

Here is the caller graph for this function:

getTabs()

ilObjAdvancedEditingGUI::getTabs

(

)

get tabs public

Parameters

object

tabs gui object

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

References $rbacsystem, and addSubtabs().

Referenced by getAdminTabs().

    {
        $rbacsystem = $this->rbacsystem;

        if ($rbacsystem->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 ($rbacsystem->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($this->tabs_gui);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initCharSelectorSettingsForm()

ilObjAdvancedEditingGUI::initCharSelectorSettingsForm

(

ilCharSelectorGUI

$char_selector

)

Init the settings form for the selector of unicode characters.

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

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilCharSelectorGUI\addFormProperties(), and ilObjectGUI\checkPermissionBool().

Referenced by saveCharSelectorSettingsObject(), and showCharSelectorSettingsObject().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
    
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $form->setTitle($lng->txt('settings'));
        $form->setFormAction($ilCtrl->getFormAction($this));
        if ($this->checkPermissionBool("write")) {
            $form->addCommandButton("saveCharSelectorSettings", $lng->txt("save"));
        }
        $char_selector->addFormProperties($form);

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initGeneralPageSettingsForm()

ilObjAdvancedEditingGUI::initGeneralPageSettingsForm

(

)

Init general page editor settings form.

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

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\checkPermissionBool(), ilComponent\getAll(), getPageObjectKeysWithOptionalHTML(), ilCheckboxInputGUI\setChecked(), ilFormPropertyGUI\setInfo(), ilNumberInputGUI\setMinValue(), ilGlossaryDefinition\setShortTextsDirtyGlobally(), and ilNumberInputGUI\setSuffix().

Referenced by saveGeneralPageSettingsObject(), and showGeneralPageEditorSettingsObject().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
    
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $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($aset->get("use_physical"));
        $form->addItem($cb);

        // blocking mode
        $cb = new ilCheckboxInputGUI($this->lng->txt("adve_blocking_mode"), "block_mode_act");
        $cb->setChecked($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($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", $lng->txt("save"));
        }

        // enable html/js
        $this->lng->loadLanguageModule("copg");
        $sh = new ilFormSectionHeaderGUI();
        $sh->setTitle($lng->txt("copg_allow_html"));
        $sh->setInfo($lng->txt("copg_allow_html_info"));
        $form->addItem($sh);

        $comps = ilComponent::getAll();
        $comps_per_dir = array_column(array_map(function ($k, $v) {
            return [$v["type"] . "/" . $v["name"], $v];
        }, array_keys($comps), $comps), 1, 0);

        $cdef = new ilCOPageObjDef();
        foreach ($cdef->getDefinitions() as $key => $def) {
            if (in_array($key, $this->getPageObjectKeysWithOptionalHTML())) {
                $comp_id = $comps_per_dir[$def["component"]]["id"];
                $this->lng->loadLanguageModule($comp_id);
                $cb = new ilCheckboxInputGUI($def["component"] . ": " . $this->lng->txt($comp_id . "_page_type_" . $key), "act_html_" . $key);
                $cb->setChecked($aset->get("act_html_" . $key));
                $form->addItem($cb);
            }
        }

        // workaround for glossaries to force rewriting of shot texts
        ilGlossaryDefinition::setShortTextsDirtyGlobally();

                    
        $form->setTitle($lng->txt("adve_pe_general"));
        $form->setFormAction($ilCtrl->getFormAction($this));
     
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initPageEditorForm()

ilObjAdvancedEditingGUI::initPageEditorForm

(

$a_mode = "edit"

)

Init page editor form.

Parameters

int

$a_mode

Edit Mode

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

References Vendor\Package\$b, $ilSetting, ilObjectGUI\$lng, $settings, ilPageContentGUI\_getCommonBBButtons(), ilObjAssessmentFolder\ADDITIONAL_QUESTION_CONTENT_EDITING_MODE_PAGE_OBJECT_DISABLED, ilObjectGUI\checkPermissionBool(), ilPageEditorSettings\lookupSetting(), and ilFormPropertyGUI\setInfo().

Referenced by savePageEditorSettingsObject(), and showPageEditorSettingsObject().

    {
        $lng = $this->lng;
        $ilSetting = $this->settings;
        
        $lng->loadLanguageModule("content");
        
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $this->form = new ilPropertyFormGUI();
    
        if ($this->cgrp == "test") {
            require_once 'Modules/Test/classes/class.ilObjAssessmentFolder.php';
        
            $this->form->setTitle($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 ($ilSetting->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($lng->txt("adve_text_content_features"));
            $this->form->addItem($sh);
        } elseif ($this->cgrp == "rep") {
            $this->form->setTitle($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 ($ilSetting->get("enable_cat_page_edit")) {
                $cb->setChecked(true);
            }
            $this->form->addItem($cb);

            $sh = new ilFormSectionHeaderGUI();
            $sh->setTitle($lng->txt("adve_text_content_features"));
            $this->form->addItem($sh);
        } else {
            $this->form->setTitle($lng->txt("adve_text_content_features"));
        }

        
        include_once("./Services/COPage/classes/class.ilPageEditorSettings.php");
        
        include_once("./Services/COPage/classes/class.ilPageContentGUI.php");
        $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(ilPageEditorSettings::lookupSetting($this->cgrp, "active_" . $b, true));
            $this->form->addItem($cb);
        }
    
        // save and cancel commands
        if ($this->checkPermissionBool("write")) {
            $this->form->addCommandButton("savePageEditorSettings", $lng->txt("save"));
        }
        
        $this->form->setFormAction($this->ctrl->getFormAction($this));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTagsForm()

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

protected

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

References $access, ilObjAdvancedEditing\_getUsedHTMLTags(), and ilMultiSelectInputGUI\setHeight().

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

    {
        $ilAccess = $this->access;
        
        include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
        $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);
        
        include_once "Services/Form/classes/class.ilMultiSelectInputGUI.php";
        $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 ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
            $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:

saveAssessmentSettingsObject()

ilObjAdvancedEditingGUI::saveAssessmentSettingsObject

(

)

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

References initTagsForm(), and saveTags().

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

saveCharSelectorSettingsObject()

ilObjAdvancedEditingGUI::saveCharSelectorSettingsObject

(

)

Save the settings for the selector of unicode characters.

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

References ilObjectGUI\$ctrl, $ilSetting, ilObjectGUI\$lng, $settings, ilObjectGUI\$tpl, ilObjectGUI\checkPermission(), ilCharSelectorConfig\CONTEXT_ADMIN, and initCharSelectorSettingsForm().

    {
        $ilSetting = $this->settings;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;

        $this->checkPermission("write");
        
        require_once 'Services/UIComponent/CharSelector/classes/class.ilCharSelectorGUI.php';
        $char_selector = new ilCharSelectorGUI(ilCharSelectorConfig::CONTEXT_ADMIN);
        $form = $this->initCharSelectorSettingsForm($char_selector);
        if ($form->checkInput()) {
            $char_selector->getFormValues($form);

            $ilSetting->set('char_selector_availability', $char_selector->getConfig()->getAvailability());
            $ilSetting->set('char_selector_definition', $char_selector->getConfig()->getDefinition());
            
            ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
            $ilCtrl->redirect($this, "showCharSelectorSettings");
        }
        $form->setValuesByPost();
        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

saveExcAssSettingsObject()

ilObjAdvancedEditingGUI::saveExcAssSettingsObject

(

)

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

References initTagsForm(), and saveTags().

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

Here is the call graph for this function:

saveFrmPostSettingsObject()

ilObjAdvancedEditingGUI::saveFrmPostSettingsObject

(

)

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

References initTagsForm(), and saveTags().

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

saveGeneralPageSettingsObject()

ilObjAdvancedEditingGUI::saveGeneralPageSettingsObject

(

)

Save general page settings.

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

References $_POST, ilObjectGUI\$ctrl, ilObjectGUI\$lng, $ok, ilObjectGUI\$tpl, ilObjectGUI\checkPermission(), getPageObjectKeysWithOptionalHTML(), and initGeneralPageSettingsForm().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;

        $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", $_POST["use_physical"]);
                if ($_POST["block_mode_act"]) {
                    $aset->set("block_mode_minutes", (int) $_POST["block_mode_minutes"]);
                } else {
                    $aset->set("block_mode_minutes", 0);
                }
                $aset->set("auto_url_linking", $_POST["auto_url_linking"]);

                $aset->set("autosave", $form->getInput("autosave"));

                $def = new ilCOPageObjDef();
                foreach ($def->getDefinitions() as $key => $def) {
                    if (in_array($key, $this->getPageObjectKeysWithOptionalHTML())) {
                        $aset->set("act_html_" . $key, (int) $_POST["act_html_" . $key]);
                    }
                }

                ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
                $ilCtrl->redirect($this, "showGeneralPageEditorSettings");
            }
        }
        
        $form->setValuesByPost();
        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

saveObject()

ilObjAdvancedEditingGUI::saveObject

(

)

save object public

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

References ilObjectGUI\checkPermission().

    {
        $this->checkPermission("write");

        parent::saveObject();

        // always send a message
        ilUtil::sendSuccess($this->lng->txt("object_added"), true);
        $this->ctrl->redirect($this);
    }

Here is the call graph for this function:

savePageEditorSettingsObject()

ilObjAdvancedEditingGUI::savePageEditorSettingsObject

(

)

Save page editor settings form.

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

References $_GET, $_POST, Vendor\Package\$b, ilObjectGUI\$ctrl, $ilSetting, ilObjectGUI\$lng, $settings, ilPageContentGUI\_getCommonBBButtons(), ilObjectGUI\checkPermission(), initPageEditorForm(), ilUtil\sendInfo(), and ilPageEditorSettings\writeSetting().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;

        $this->checkPermission("write");
    
        $this->initPageEditorForm();
        if ($this->form->checkInput()) {
            include_once("./Services/COPage/classes/class.ilPageEditorSettings.php");
            include_once("./Services/COPage/classes/class.ilPageContentGUI.php");
            $buttons = ilPageContentGUI::_getCommonBBButtons();
            foreach ($buttons as $b => $t) {
                ilPageEditorSettings::writeSetting(
                    $_GET["grp"],
                    "active_" . $b,
                    $this->form->getInput("active_" . $b)
                );
            }
            
            if ($_GET["grp"] == "test") {
                $ilSetting->set("enable_tst_page_edit", (int) $_POST["tst_page_edit"]);
            } elseif ($_GET["grp"] == "rep") {
                $ilSetting->set("enable_cat_page_edit", (int) $_POST["cat_page_edit"]);
            }
            
            ilUtil::sendInfo($lng->txt("msg_obj_modified"), true);
        }
        
        $ilCtrl->setParameter($this, "grp", $_GET["grp"]);
        $ilCtrl->redirect($this, "showPageEditorSettings");
    }

Here is the call graph for this function:

saveSettingsObject()

ilObjAdvancedEditingGUI::saveSettingsObject

(

)

Save Assessment settings.

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

References $_POST, and ilObjectGUI\checkPermission().

    {
        $this->checkPermission("write");

        if ($_POST["use_tiny"]) {
            $this->object->setRichTextEditor("tinymce");
        } else {
            $this->object->setRichTextEditor("");
        }
        ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);

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

Here is the call graph for this function:

saveSurveySettingsObject()

ilObjAdvancedEditingGUI::saveSurveySettingsObject

(

)

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

References initTagsForm(), and saveTags().

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

Here is the call graph for this function:

saveTags()

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

protected

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

References $_POST, Vendor\Package\$e, ilObjectGUI\checkPermission(), and ilUtil\sendInfo().

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

    {
        $this->checkPermission("write");
        try {
            if ($form->checkInput()) {
                // get rid of select all
                if (is_array($_POST['html_tags']) && $_POST['html_tags'][0] == "") {
                    unset($_POST['html_tags'][0]);
                }

                $this->object->setUsedHTMLTags((array) $_POST['html_tags'], $a_id);
                ilUtil::sendSuccess($this->lng->txt('msg_obj_modified'), true);
            } else {
                return false;
            }
        } catch (ilAdvancedEditingRequiredTagsException $e) {
            ilUtil::sendInfo($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:

settingsObject()

ilObjAdvancedEditingGUI::settingsObject

(

)

Display assessment folder settings form.

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

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilObjectGUI\checkPermissionBool(), and ilCheckboxInputGUI\setChecked().

    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $editor = $this->object->_getRichTextEditor();
        
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($ilCtrl->getFormAction($this));
        $this->form->setTitle($lng->txt("adve_activation"));
        $cb = new ilCheckboxInputGUI($this->lng->txt("adve_use_tiny_mce"), "use_tiny");
        if ($editor == "tinymce") {
            $cb->setChecked(true);
        }
        $this->form->addItem($cb);
        if ($this->checkPermissionBool("write")) {
            $this->form->addCommandButton("saveSettings", $lng->txt("save"));
        }
        
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

showCharSelectorSettingsObject()

ilObjAdvancedEditingGUI::showCharSelectorSettingsObject

(

)

Show the settings for the selector of unicode characters.

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

References $ilSetting, $settings, $tabs, ilObjectGUI\$tpl, ilCharSelectorConfig\CONTEXT_ADMIN, and initCharSelectorSettingsForm().

    {
        $ilTabs = $this->tabs;
        $ilSetting = $this->settings;
        $tpl = $this->tpl;

        $ilTabs->activateTab("adve_char_selector_settings");
                
        require_once 'Services/UIComponent/CharSelector/classes/class.ilCharSelectorGUI.php';
        $char_selector = new ilCharSelectorGUI(ilCharSelectorConfig::CONTEXT_ADMIN);
        $char_selector->getConfig()->setAvailability($ilSetting->get('char_selector_availability'));
        $char_selector->getConfig()->setDefinition($ilSetting->get('char_selector_definition'));
        $form = $this->initCharSelectorSettingsForm($char_selector);
        $char_selector->setFormValues($form);
        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

showGeneralPageEditorSettingsObject()

ilObjAdvancedEditingGUI::showGeneralPageEditorSettingsObject

(

)

Show general page editor settings.

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

References $tabs, ilObjectGUI\$tpl, and initGeneralPageSettingsForm().

    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;

        $this->addPageEditorSettingsSubTabs();
        $ilTabs->activateTab("adve_page_editor_settings");
        
        $form = $this->initGeneralPageSettingsForm();
        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

showPageEditorSettingsObject()

ilObjAdvancedEditingGUI::showPageEditorSettingsObject

(

)

Show page editor settings.

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

References $_GET, ilObjectGUI\$ctrl, $tabs, ilObjectGUI\$tpl, ilPageEditorSettings\getGroups(), and initPageEditorForm().

    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        
        $this->addPageEditorSettingsSubTabs();
        
        include_once("./Services/COPage/classes/class.ilPageEditorSettings.php");
        $grps = ilPageEditorSettings::getGroups();
        
        $this->cgrp = $_GET["grp"];
        if ($this->cgrp == "") {
            $this->cgrp = key($grps);
        }

        $ilCtrl->setParameter($this, "grp", $this->cgrp);
        $ilTabs->setSubTabActive("adve_grp_" . $this->cgrp);
        
        $this->initPageEditorForm();
        $tpl->setContent($this->form->getHtml());
    }

Here is the call graph for this function:

surveyObject()

ilObjAdvancedEditingGUI::surveyObject

(

)

Display settings for surveys.

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

References initTagsForm().

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

Here is the call graph for this function:

Field Documentation

$access

ilObjAdvancedEditingGUI::$access

protected

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

Referenced by initTagsForm().

$conditions

ilObjAdvancedEditingGUI::$conditions

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

$rbacadmin

ilObjAdvancedEditingGUI::$rbacadmin

protected

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

$rbacsystem

ilObjAdvancedEditingGUI::$rbacsystem

protected

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

Referenced by __construct(), and getTabs().

$settings

ilObjAdvancedEditingGUI::$settings

protected

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

Referenced by initPageEditorForm(), saveCharSelectorSettingsObject(), savePageEditorSettingsObject(), and showCharSelectorSettingsObject().

$tabs

ilObjAdvancedEditingGUI::$tabs

protected

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

Referenced by addPageEditorSettingsSubtabs(), showCharSelectorSettingsObject(), showGeneralPageEditorSettingsObject(), and showPageEditorSettingsObject().

---

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

• Services/AdvancedEditing/classes/class.ilObjAdvancedEditingGUI.php