Page Editor GUI class. More...

Collaboration diagram for ilPageEditorGUI:

Public Member Functions
	__construct (ilPageObject $a_page_object, ilPageObjectGUI $a_page_object_gui)

	setHeader (string $a_header)
	set header title More...

	getHeader ()

	returnToContext ()

	setIntLinkReturn (string $a_return)

	setPageBackTitle (string $a_title)

	executeCommand ()
	execute command More...

	activatePage ()

	deactivatePage ()

	setMediaMode ()
	set media and editing mode More...

	copyLinkedMediaToClipboard ()
	copy linked media object to clipboard More...

	copyLinkedMediaToMediaPool ()
	copy linked media object to media pool More...

	addChangeComment ()
	add change comment to history More...

	delete ()
	Confirm. More...

	cancelDeleteSelected ()

	confirmedDeleteSelected ()

	copy ()
	Copy selected items. More...

	cut ()
	Cut selected items. More...

	paste (string $a_hier_id)
	paste from clipboard (redirects to clipboard) More...

	activate ()
	(de-)activate selected items More...

	characteristic ()
	Assign characeristic to text blocks/sections. More...

	initCharacteristicForm (array $a_target, array $a_types)
	Init map creation/update form. More...

	assignCharacteristic ()

	pasteFromClipboard (string $a_hier_id)
	paste from clipboard (redirects to clipboard) More...

	insertFromClipboard ()
	insert object from clipboard More...

	displayPage ()
	Default for POST reloads and missing. More...

	showSnippetInfo ()
	Show snippet info. More...

Data Fields
ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilCtrl	$ctrl

ilObjectDefinition	$objDefinition

ilPageObject	$page

string	$target_script = ""

string	$return_location = ""

string	$header = ""

ilPageContent	$cont_obj = null

bool	$enable_keywords = false

bool	$enable_anchors = false

Protected Attributes
ServerRequestInterface	$http_request

EditGUIRequest	$request

EditSessionRepository	$edit_repo

ilPageContent	$content_obj

ilPropertyFormGUI	$form

string	$page_back_title = ""

ilPageObjectGUI	$page_gui

string	$int_link_return = ""

ilTabsGUI	$tabs_gui

ilHelpGUI	$help

ilObjUser	$user

ilAccessHandler	$access

ilLogger	$log

ILIAS DI UIServices	$ui

ILIAS GlobalScreen ScreenContext ContextServices	$tool_context

string	$requested_hier_id

string	$requested_pc_id

string	$requested_pcid

string	$requested_pl_pc_id

string	$requested_ctype

string	$requested_cname

int	$requested_mob_id

Detailed Description

Page Editor GUI class.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilPageEditorGUI: ilPCParagraphGUI, ilPCTableGUI, ilPCTableDataGUI @ilCtrl_Calls ilPageEditorGUI: ilPCMediaObjectGUI, ilPCListGUI, ilPCListItemGUI @ilCtrl_Calls ilPageEditorGUI: ilPCFileListGUI, ilPCFileItemGUI, ilObjMediaObjectGUI @ilCtrl_Calls ilPageEditorGUI: ilPCSourceCodeGUI, ilInternalLinkGUI, ilPCQuestionGUI @ilCtrl_Calls ilPageEditorGUI: ilPCSectionGUI, ilPCDataTableGUI, ilPCResourcesGUI @ilCtrl_Calls ilPageEditorGUI: ilPCMapGUI, ilPCPluggedGUI, ilPCTabsGUI, ilPCTabGUI, IlPCPlaceHolderGUI @ilCtrl_Calls ilPageEditorGUI: ilPCContentIncludeGUI, ilPCLoginPageElementGUI @ilCtrl_Calls ilPageEditorGUI: ilPCInteractiveImageGUI, ilPCProfileGUI, ilPCVerificationGUI @ilCtrl_Calls ilPageEditorGUI: ilPCBlogGUI, ilPCQuestionOverviewGUI, ilPCSkillsGUI @ilCtrl_Calls ilPageEditorGUI: ilPCConsultationHoursGUI, ilPCMyCoursesGUI, ilPCAMDPageListGUI @ilCtrl_Calls ilPageEditorGUI: ilPCGridGUI, ilPCGridCellGUI, ilPageEditorServerAdapterGUI

Definition at line 38 of file class.ilPageEditorGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPageEditorGUI::__construct	(	ilPageObject	$a_page_object,
		ilPageObjectGUI	$a_page_object_gui
	)

Definition at line 74 of file class.ilPageEditorGUI.php.

      {
        global $DIC;
 
        $this->help = $DIC["ilHelp"];
        $this->user = $DIC->user();
        $this->access = $DIC->access();
        $tpl = $DIC["tpl"];
        $lng = $DIC->language();
        $objDefinition = $DIC["objDefinition"];
        $ilCtrl = $DIC->ctrl();
        $ilTabs = $DIC->tabs();
 
        $this->ui = $DIC->ui();
 
        $this->request = $DIC->copage()->internal()->gui()->page()->editRequest();
        $this->requested_hier_id = $this->request->getHierId();
        $this->requested_pc_id = $this->request->getPCId();
        $this->requested_pl_pc_id = $this->request->getPlaceholderPCId();
        $this->requested_ctype = $this->request->getCType();
        $this->requested_cname = $this->request->getCName();
        $this->requested_mob_id = $this->request->getMobId();
 
        $this->log = ilLoggerFactory::getLogger('copg');
 
        $this->tool_context = $DIC->globalScreen()->tool()->context();
 
        // initiate variables
        $this->http_request = $DIC->http()->request();
        $this->ctrl = $ilCtrl;
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->objDefinition = $objDefinition;
        $this->tabs_gui = $ilTabs;
        $this->page = $a_page_object;
        $this->page_gui = $a_page_object_gui;
 
        $this->ctrl->saveParameter($this, array("hier_id", "pc_id"));
 
        $this->edit_repo = $DIC
            ->copage()
            ->internal()
            ->repo()
            ->edit();
    }

References $DIC, $lng, $objDefinition, $tpl, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilLoggerFactory\getLogger(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ activate()

ilPageEditorGUI::activate ( )

(de-)activate selected items

Definition at line 636 of file class.ilPageEditorGUI.php.

                              : void
    {
        $ids = $this->request->getIds();
        if (count($ids) > 0) {
            $updated = $this->page->switchEnableMultiple(
                $ids,
                true,
                $this->page_gui->getPageConfig()->getEnableSelfAssessment()
            );
            if ($updated !== true) {
                $this->edit_repo->setPageError($updated);
            } else {
                $this->edit_repo->clearPageError();
            }
        }
        $this->ctrl->returnToParent($this);
    }

References ILIAS\LTI\ToolProvider\$updated, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ activatePage()

ilPageEditorGUI::activatePage ( )

Definition at line 453 of file class.ilPageEditorGUI.php.

                                  : void
    {
        $this->page_gui->activatePage();
    }

◆ addChangeComment()

ilPageEditorGUI::addChangeComment ( )

add change comment to history

Definition at line 523 of file class.ilPageEditorGUI.php.

                                      : void
    {
        ilHistory::_createEntry(
            $this->page->getId(),
            "update",
            [],
            $this->page->getParentType() . ":pg",
            $this->request->getString("change_comment"),
            true
        );
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("cont_added_comment"), true);
        $this->ctrl->returnToParent($this);
    }

References ilHistory\_createEntry(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ assignCharacteristic()

ilPageEditorGUI::assignCharacteristic ( )

Definition at line 735 of file class.ilPageEditorGUI.php.

                                          : void
    {
        $char_par = $this->request->getString("char_par");
        $char_sec = $this->request->getString("char_sec");
 
        $updated = $this->page->assignCharacteristic(
            $this->request->getStringArray("target"),
            $char_par,
            $char_sec,
            ""
        );
        if ($updated !== true) {
            $this->edit_repo->setPageError($updated);
        } else {
            $this->edit_repo->clearPageError();
        }
        $this->ctrl->returnToParent($this);
    }

References ILIAS\LTI\ToolProvider\$updated, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ cancelDeleteSelected()

ilPageEditorGUI::cancelDeleteSelected ( )

Definition at line 565 of file class.ilPageEditorGUI.php.

                                          : void
    {
        $this->ctrl->returnToParent($this);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ characteristic()

ilPageEditorGUI::characteristic ( )

Assign characeristic to text blocks/sections.

Definition at line 657 of file class.ilPageEditorGUI.php.

                                    : void
    {
        $tpl = $this->tpl;
        $lng = $this->lng;
 
        $ids = $this->request->getIds();
        if (count($ids) > 0) {
            $types = array();
 
            // check what content element types have been selected
            foreach ($ids as $t) {
                $tarr = explode(":", $t);
                $cont_obj = $this->page->getContentObject($tarr[0], $tarr[1]);
                if (is_object($cont_obj) && $cont_obj->getType() == "par") {
                    $types["par"] = "par";
                }
                if (is_object($cont_obj) && $cont_obj->getType() == "sec") {
                    $types["sec"] = "sec";
                }
            }
 
            if (count($types) == 0) {
                $this->tpl->setOnScreenMessage('failure', $lng->txt("cont_select_par_or_section"), true);
                $this->ctrl->returnToParent($this);
            } else {
                $this->initCharacteristicForm($ids, $types);
                $tpl->setContent($this->form->getHTML());
            }
        } else {
            $this->ctrl->returnToParent($this);
        }
    }

References $cont_obj, $lng, $tpl, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilPageContent\getType(), initCharacteristicForm(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

Here is the call graph for this function:

◆ confirmedDeleteSelected()

ilPageEditorGUI::confirmedDeleteSelected ( )

Definition at line 570 of file class.ilPageEditorGUI.php.

                                             : void
    {
        $targets = $this->request->getIds();
        if (count($targets) > 0) {
            $updated = $this->page->deleteContents(
                $targets,
                true,
                $this->page_gui->getPageConfig()->getEnableSelfAssessment()
            );
            if ($updated !== true) {
                $this->edit_repo->setPageError($updated);
            } else {
                $this->edit_repo->clearPageError();
            }
        }
        $this->ctrl->returnToParent($this);
    }

References ILIAS\LTI\ToolProvider\$updated, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ copy()

ilPageEditorGUI::copy ( )

Copy selected items.

Definition at line 591 of file class.ilPageEditorGUI.php.

                          : void
    {
        $lng = $this->lng;
 
        $ids = $this->request->getIds();
        if (count($ids) > 0) {
            $this->page->copyContents($ids);
            $this->tpl->setOnScreenMessage('success', $lng->txt("cont_sel_el_copied_use_paste"), true);
        }
        $this->ctrl->returnToParent($this);
    }

References $lng, ILIAS\Repository\ctrl(), and ilLanguage\txt().

Here is the call graph for this function:

◆ copyLinkedMediaToClipboard()

ilPageEditorGUI::copyLinkedMediaToClipboard ( )

copy linked media object to clipboard

Definition at line 498 of file class.ilPageEditorGUI.php.

                                                : void
    {
        $ilUser = $this->user;
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("copied_to_clipboard"), true);
        $ilUser->addObjectToClipboard(
            $this->requested_mob_id,
            "mob",
            ilObject::_lookupTitle($this->requested_mob_id)
        );
        $this->ctrl->returnToParent($this);
    }

References $ilUser, $user, ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ copyLinkedMediaToMediaPool()

ilPageEditorGUI::copyLinkedMediaToMediaPool ( )

copy linked media object to media pool

Definition at line 514 of file class.ilPageEditorGUI.php.

                                                : void
    {
        $this->ctrl->setParameterByClass("ilmediapooltargetselector", "mob_id", $this->requested_mob_id);
        $this->ctrl->redirectByClass("ilmediapooltargetselector", "listPools");
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ cut()

ilPageEditorGUI::cut ( )

Cut selected items.

Definition at line 606 of file class.ilPageEditorGUI.php.

                         : void
    {
        $lng = $this->lng;
 
        $ids = $this->request->getIds();
        if (count($ids)) {
            $updated = $this->page->cutContents($ids);
            if ($updated !== true) {
                $this->edit_repo->setPageError($updated);
            } else {
                $this->edit_repo->clearPageError();
            }
            $this->tpl->setOnScreenMessage('success', $lng->txt("cont_sel_el_cut_use_paste"), true);
        }
        $this->ctrl->returnToParent($this);
    }

References $lng, ILIAS\LTI\ToolProvider\$updated, ILIAS\Repository\ctrl(), and ilLanguage\txt().

Here is the call graph for this function:

◆ deactivatePage()

ilPageEditorGUI::deactivatePage ( )

Definition at line 458 of file class.ilPageEditorGUI.php.

                                    : void
    {
        $this->page_gui->deactivatePage();
    }

◆ delete()

ilPageEditorGUI::delete ( )

Confirm.

Definition at line 540 of file class.ilPageEditorGUI.php.

                            : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;
 
        $targets = $this->request->getIds();
 
        if (count($targets) == 0) {
            $this->tpl->setOnScreenMessage('info', $lng->txt("no_checkbox"), true);
            $this->ctrl->returnToParent($this);
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("copg_confirm_el_deletion"));
            $cgui->setCancel($lng->txt("cancel"), "cancelDeleteSelected");
            $cgui->setConfirm($lng->txt("confirm"), "confirmedDeleteSelected");
            foreach ($targets as $t) {
                $cgui->addHiddenItem("ids[]", $t);
            }
 
            $tpl->setContent($cgui->getHTML());
        }
    }

References $ctrl, $lng, $tpl, ILIAS\Repository\ctrl(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

Here is the call graph for this function:

◆ displayPage()

ilPageEditorGUI::displayPage ( )

Default for POST reloads and missing.

Definition at line 816 of file class.ilPageEditorGUI.php.

                                 : void
    {
        $this->ctrl->returnToParent($this);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ executeCommand()

ilPageEditorGUI::executeCommand ( )

execute command

Definition at line 153 of file class.ilPageEditorGUI.php.

                                    : string
    {
        $ilCtrl = $this->ctrl;
        $ilHelp = $this->help;
        $this->log->debug("begin =========================");
        $ctype = "";
        $cont_obj = null;
 
        $ret = "";
        $add_type = "";
 
        // Step BC (basic command determination)
        // determine cmd, cmdClass, hier_id and pc_id
        $cmd = $this->ctrl->getCmd("displayPage");
        $cmdClass = strtolower($this->ctrl->getCmdClass());
 
        $hier_id = $this->requested_hier_id;
        $pc_id = $this->requested_pc_id;
        $new_hier_id = $this->request->getString("new_hier_id");
        if ($new_hier_id != "") {
            $hier_id = $new_hier_id;
        }
 
        $this->log->debug("step BC: cmd:$cmd, cmdClass:$cmdClass, hier_id: $hier_id, pc_id: $pc_id");
 
        // Step EC (exec_ command handling)
        // handle special exec_ commands, modify pc, hier_id
        if (substr($cmd, 0, 5) == "exec_") {
            // check whether pc id is given
            $pca = explode(":", $this->ctrl->getCmd());
            $pc_id = $pca[1];
            $cmd = explode("_", $pca[0]);
            unset($cmd[0]);
            $hier_id = implode("_", $cmd);
            $cmd = $this->request->getString("command" . $hier_id);
        }
        $this->log->debug("step EC: cmd:$cmd, hier_id: $hier_id, pc_id: $pc_id");
 
        // Step CC (handle table container (and similar) commands
        // ... strip "c" "r" of table ids from hierarchical id
        $first_hier_character = substr($hier_id, 0, 1);
        if ($first_hier_character == "c" ||
            $first_hier_character == "r" ||
            $first_hier_character == "g" ||
            $first_hier_character == "i") {
            $hier_id = substr($hier_id, 1);
        }
        $this->log->debug("step CC: cmd:$cmd, hier_id: $hier_id, pc_id: $pc_id");
 
        // Step B (build dom, and ids in XML)
        $this->page->buildDom();
        $this->page->addHierIDs();
 
 
        // Step CS (strip base command)
        $com = null;
        if ($cmdClass != "ilfilesystemgui") {
            $com = explode("_", $cmd);
            $cmd = $com[0];
        }
        $this->log->debug("step CS: cmd:$cmd");
 
 
        // Step NC (determine next class)
        $next_class = $this->ctrl->getNextClass($this);
        $this->log->debug("step NC: next class: " . $next_class);
 
 
        // Step PH (placeholder handling, placeholders from preview mode come without hier_id)
        if ($next_class == "ilpcplaceholdergui" && $hier_id == "" && $this->requested_pl_pc_id != "") {
            $hid = $this->page->getHierIdsForPCIds(array($this->requested_pl_pc_id));
            $hier_id = $hid[$this->requested_pl_pc_id];
        }
        $this->log->debug("step PH: next class: " . $next_class);
 
        if (!is_null($com) && ($com[0] == "insert" || $com[0] == "create")) {
            // Step CM (creation mode handling)
            $cmd = $com[0];
            $ctype = $com[1] ?? "";                             // note ctype holds type if cmdclass is empty, but also subcommands if not (e.g. applyFilter in ilpcmediaobjectgui)
            $add_type = $this->request->getString("pluginName");
            if ($ctype == "mob") {
                $ctype = "media";
            }
 
            $this->log->debug("step CM: cmd: " . $cmd . ", ctype: " . $ctype . ", add_type: " . $add_type);
        } else {
            $this->log->debug("step LM: cmd: " . $cmd . ", cmdClass: " . $cmdClass);
 
            // Step PR (get content object and return to parent)
            $this->log->debug("before PR: cmdClass: $cmdClass, nextClass: $next_class" .
                ", hier_id: " . $hier_id . ", pc_id: " . $pc_id . ")");
            // note: ilinternallinkgui for page: no cont_obj is received
            // ilinternallinkgui for mob: cont_obj is received
            if ($this->requested_ctype == "" && $this->requested_cname == "" &&
                $cmd != "insertFromClipboard" && $cmd != "pasteFromClipboard" &&
                $cmd != "setMediaMode" && $cmd != "copyLinkedMediaToClipboard" &&
                $cmd != "activatePage" && $cmd != "deactivatePage" &&
                $cmd != "copyLinkedMediaToMediaPool" && $cmd != "showSnippetInfo" &&
                $cmd != "delete" && $cmd != "paste" &&
                $cmd != "cancelDeleteSelected" && $cmd != "confirmedDeleteSelected" &&
                $cmd != "copy" && $cmd != "cut" &&
                ($cmd != "displayPage" || $this->request->getString("editImagemapForward_x") != "") &&
                $cmd != "activate" && $cmd != "characteristic" &&
                $cmd != "assignCharacteristic" &&
                $cmdClass != "ilrepositoryselector2inputgui" &&
                $cmdClass != "ilpageeditorserveradaptergui" &&
                $cmd != "cancelCreate" && $cmd != "popup" &&
                $cmdClass != "ileditclipboardgui" && $cmd != "addChangeComment" &&
                ($cmdClass != "ilinternallinkgui" || ($next_class == "ilpcmediaobjectgui"))) {
                $cont_obj = $this->page->getContentObject($hier_id, $pc_id);
                if (!is_object($cont_obj)) {
                    $this->log->debug("returnToParent");
                    $ilCtrl->returnToParent($this);
                }
                $ctype = $cont_obj->getType();
            }
        }
 
        // Step NC (handle empty next class)
        if ($this->requested_ctype != "" || $this->requested_cname != "") {
            $ctype = $this->requested_ctype;
            if ($this->requested_cname != "") {
                $pc_def = ilCOPagePCDef::getPCDefinitionByName($this->requested_cname);
                $ctype = $pc_def["pc_type"];
            }
            $pc_id = $this->requested_pc_id;
            $hier_id = $this->requested_hier_id;
            if (!in_array($cmd, ["insert", "create"])) {
                $cont_obj = $this->page->getContentObject($hier_id, $pc_id);
            }
        }
        // this fixes e.g. #31214
        if ($pc_id != "" && $hier_id == "") {
            $hier_id = $this->page->getHierIdForPcId($pc_id);
        }
        if ($ctype != "media" || !is_object($cont_obj)) {
            if ($this->getHeader() != "") {
                $this->tpl->setTitle($this->getHeader());
            }
        }
 
        $this->cont_obj = $cont_obj;
 
 
        $this->ctrl->setParameter($this, "hier_id", $hier_id);
        $this->ctrl->setParameter($this, "pc_id", $pc_id);
        $this->ctrl->setCmd($cmd);
        if ($next_class == "") {
            $pc_def = ilCOPagePCDef::getPCDefinitionByType($ctype);
            if (is_array($pc_def)) {
                $this->ctrl->setCmdClass($pc_def["pc_gui_class"]);
            }
            $next_class = $this->ctrl->getNextClass($this);
        }
        $this->log->debug("step NC2: next_class: $next_class");
 
        // ... do not do this while imagemap editing is ongoing
        // Step IM (handle image map editing)
        if ($cmd == "displayPage" &&
            $this->request->getString("editImagemapForward_x") == ""
            && $this->request->getString("imagemap_x") == "") {
            $next_class = "";
        }
 
 
        switch ($next_class) {
            case "ilinternallinkgui":
                $link_gui = new ilInternalLinkGUI(
                    $this->page_gui->getPageConfig()->getIntLinkHelpDefaultType(),
                    $this->page_gui->getPageConfig()->getIntLinkHelpDefaultId(),
                    $this->page_gui->getPageConfig()->getIntLinkHelpDefaultIdIsRef()
                );
                $link_gui->setFilterWhiteList(
                    $this->page_gui->getPageConfig()->getIntLinkFilterWhiteList()
                );
                foreach ($this->page_gui->getPageConfig()->getIntLinkFilters() as $filter) {
                    $link_gui->filterLinkType($filter);
                }
                $link_gui->setReturn($this->int_link_return);
 
                $ret = $this->ctrl->forwardCommand($link_gui);
                break;
 
            // PC Media Object
            case "ilpcmediaobjectgui":
                $this->tabs_gui->clearTargets();
                $this->tabs_gui->setBackTarget(
                    $this->page_gui->page_back_title,
                    $ilCtrl->getLinkTarget($this->page_gui, "edit")
                );
                $pcmob_gui = new ilPCMediaObjectGUI($this->page, $cont_obj, $hier_id, $pc_id);
                $pcmob_gui->setStyleId($this->page_gui->getStyleId());
                $pcmob_gui->setSubCmd($ctype);
                $pcmob_gui->setEnabledMapAreas($this->page_gui->getPageConfig()->getEnableInternalLinks());
                $ret = $this->ctrl->forwardCommand($pcmob_gui);
                $ilHelp->setScreenIdComponent("copg_media");
                break;
 
            // only for "linked" media
            case "ilobjmediaobjectgui":
                $this->tabs_gui->clearTargets();
                $this->tabs_gui->setBackTarget(
                    $this->lng->txt("back"),
                    (string) $ilCtrl->getParentReturn($this)
                );
                $mob_gui = new ilObjMediaObjectGUI("", $this->requested_mob_id, false, false);
                $mob_gui->getTabs();
                $mob_gui->setEnabledMapAreas($this->page_gui->getPageConfig()->getEnableInternalLinks());
                $this->tpl->setTitle($this->lng->txt("mob") . ": " .
                    ilObject::_lookupTitle($this->requested_mob_id));
                $ret = $this->ctrl->forwardCommand($mob_gui);
                break;
 
            // Question
            case "ilpcquestiongui":
                $pc_question_gui = new ilPCQuestionGUI($this->page, $cont_obj, $hier_id, $pc_id);
                $pc_question_gui->setSelfAssessmentMode($this->page_gui->getPageConfig()->getEnableSelfAssessment());
                $pc_question_gui->setPageConfig($this->page_gui->getPageConfig());
 
                if ($this->page_gui->getPageConfig()->getEnableSelfAssessment()) {
                    $this->tabs_gui->clearTargets();
                    $ilHelp->setScreenIdComponent("copg_pcqst");
                    $this->tabs_gui->setBackTarget(
                        $this->lng->txt("back"),
                        (string) $ilCtrl->getParentReturn($this)
                    );
                    $ret = $this->ctrl->forwardCommand($pc_question_gui);
                } else {
                    $cmd = $this->ctrl->getCmd();
                    $pc_question_gui->$cmd();
                    $this->ctrl->redirectByClass(array("ilobjquestionpoolgui", get_class($cont_obj)), "editQuestion");
                }
                break;
 
            // Plugged Component
            case "ilpcpluggedgui":
                $this->tabs_gui->clearTargets();
                $plugged_gui = new ilPCPluggedGUI(
                    $this->page,
                    $cont_obj,
                    $hier_id,
                    $add_type,
                    $pc_id
                );
                $ret = $this->ctrl->forwardCommand($plugged_gui);
                break;
 
            case "ilpageeditorserveradaptergui":
                $adapter = new ilPageEditorServerAdapterGUI(
                    $this->page_gui,
                    $this->ctrl,
                    $this->ui,
                    $this->http_request
                );
                $this->ctrl->forwardCommand($adapter);
                break;
 
            default:
 
                // generic calls to gui classes
                if (ilCOPagePCDef::isPCGUIClassName($next_class, true)) {
                    $this->log->debug("Generic Call");
                    $pc_def = ilCOPagePCDef::getPCDefinitionByGUIClassName($next_class);
                    $this->tabs_gui->clearTargets();
                    $this->tabs_gui->setBackTarget(
                        $this->page_gui->page_back_title,
                        $ilCtrl->getLinkTarget($this->page_gui, "edit")
                    );
                    $ilHelp->setScreenIdComponent("copg_" . $pc_def["pc_type"]);
                    //ilCOPagePCDef::requirePCGUIClassByName($pc_def["name"]);
                    $gui_class_name = $pc_def["pc_gui_class"];
                    $pc_gui = new $gui_class_name($this->page, $cont_obj, $hier_id, $pc_id);
                    if ($pc_def["style_classes"]) {
                        $pc_gui->setStyleId($this->page_gui->getStyleId());
                    }
                    $pc_gui->setPageConfig($this->page_gui->getPageConfig());
                    $ret = $this->ctrl->forwardCommand($pc_gui);
                } else {
                    $this->log->debug("Call ilPageEditorGUI command.");
                    // cmd belongs to ilPageEditorGUI
 
                    if ($cmd == "pasteFromClipboard") {
                        //$ret = $this->pasteFromClipboard($hier_id);
                        $this->pasteFromClipboard($hier_id);
                    } elseif ($cmd == "paste") {
                        //$ret = $this->paste($hier_id);
                        $this->paste($hier_id);
                    } else {
                        $ret = $this->$cmd();
                    }
                }
                break;
 
        }
 
        $this->log->debug("end --------------------");
 
        return (string) $ret;
    }

References $cont_obj, $ctrl, $help, $requested_ctype, $requested_hier_id, $requested_pc_id, $requested_pl_pc_id, ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), getHeader(), ilCOPagePCDef\getPCDefinitionByGUIClassName(), ilCOPagePCDef\getPCDefinitionByName(), ilCOPagePCDef\getPCDefinitionByType(), ilPageContent\getType(), ilCOPagePCDef\isPCGUIClassName(), ILIAS\Repository\lng(), paste(), pasteFromClipboard(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ getHeader()

ilPageEditorGUI::getHeader ( )

Definition at line 130 of file class.ilPageEditorGUI.php.

                               : string
    {
        return $this->header;
    }

References $header.

Referenced by executeCommand().

Here is the caller graph for this function:

◆ initCharacteristicForm()

ilPageEditorGUI::initCharacteristicForm	(	array	$a_target,
		array	$a_types
	)

Init map creation/update form.

Definition at line 693 of file class.ilPageEditorGUI.php.

     : void {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
 
        // edit form
        $this->form = new ilPropertyFormGUI();
        $this->form->setTitle($this->lng->txt("cont_choose_characteristic"));
 
        if ($a_types["par"] == "par") {
            $select_prop = new ilSelectInputGUI(
                $this->lng->txt("cont_choose_characteristic_text"),
                "char_par"
            );
            $options = ilPCParagraphGUI::_getCharacteristics($this->page_gui->getStyleId());
            $select_prop->setOptions($options);
            $this->form->addItem($select_prop);
        }
        if ($a_types["sec"] == "sec") {
            $select_prop = new ilSelectInputGUI(
                $this->lng->txt("cont_choose_characteristic_section"),
                "char_sec"
            );
            $options = ilPCSectionGUI::_getCharacteristics($this->page_gui->getStyleId());
            $select_prop->setOptions($options);
            $this->form->addItem($select_prop);
        }
 
        foreach ($a_target as $t) {
            $hidden = new ilHiddenInputGUI("target[]");
            $hidden->setValue($t);
            $this->form->addItem($hidden);
        }
 
        $this->form->setFormAction($ilCtrl->getFormAction($this));
        $this->form->addCommandButton("assignCharacteristic", $lng->txt("save"));
        $this->form->addCommandButton("showPage", $lng->txt("cancel"));
    }

Referenced by characteristic().

Here is the caller graph for this function:

◆ insertFromClipboard()

ilPageEditorGUI::insertFromClipboard ( )

insert object from clipboard

Exceptions

ilDateTimeException

Definition at line 781 of file class.ilPageEditorGUI.php.

                                         : void
    {
        $ids = ilEditClipboardGUI::_getSelectedIDs();
 
        $hier_id = $this->page->getHierIdForPcId($this->requested_pc_id);
        if ($hier_id == "") {
            $hier_id = "pg";
        }
 
        if ($ids != "") {
            foreach ($ids as $id2) {
                $id = explode(":", $id2);
                $type = $id[0];
                $id = $id[1];
                if ($type == "mob") {
                    $this->content_obj = new ilPCMediaObject($this->page);
                    $this->content_obj->readMediaObject($id);
                    $this->content_obj->createAlias($this->page, $hier_id);
                    $this->page->update();
                }
                if ($type == "incl") {
                    $this->content_obj = new ilPCContentInclude($this->page);
                    $this->content_obj->create($this->page, $hier_id);
                    $this->content_obj->setContentType("mep");
                    $this->content_obj->setContentId($id);
                    $this->page->update();
                }
            }
        }
        $this->ctrl->returnToParent($this);
    }

References $id, $type, ilEditClipboardGUI\_getSelectedIDs(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ paste()

ilPageEditorGUI::paste ( string $a_hier_id )

paste from clipboard (redirects to clipboard)

Definition at line 626 of file class.ilPageEditorGUI.php.

                                            : void
    {
        $this->page->pasteContents($a_hier_id, $this->page_gui->getPageConfig()->getEnableSelfAssessment());
        //ilEditClipboard::setAction("");
        $this->ctrl->returnToParent($this);
    }

References ILIAS\Repository\ctrl().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pasteFromClipboard()

ilPageEditorGUI::pasteFromClipboard ( string $a_hier_id )

paste from clipboard (redirects to clipboard)

Definition at line 757 of file class.ilPageEditorGUI.php.

                                                         : void
    {
        $ilCtrl = $this->ctrl;
        //var_dump($a_hier_id);
        $ilCtrl->setParameter($this, "hier_id", $a_hier_id);
        $ilCtrl->setParameterByClass(
            "ilEditClipboardGUI",
            "returnCommand",
            rawurlencode($ilCtrl->getLinkTarget(
                $this,
                "insertFromClipboard",
                "",
                false,
                false
            ))
        );
        //echo ":".$ilCtrl->getLinkTarget($this, "insertFromClipboard").":";
        $ilCtrl->redirectByClass("ilEditClipboardGUI", "getObject");
    }

Referenced by executeCommand().

Here is the caller graph for this function:

◆ returnToContext()

ilPageEditorGUI::returnToContext ( )

Definition at line 135 of file class.ilPageEditorGUI.php.

                                     : void
    {
        $this->ctrl->returnToParent($this);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ setHeader()

ilPageEditorGUI::setHeader ( string $a_header )

set header title

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

                                               : void
    {
        $this->header = $a_header;
    }

◆ setIntLinkReturn()

ilPageEditorGUI::setIntLinkReturn ( string $a_return )

Definition at line 140 of file class.ilPageEditorGUI.php.

                                                      : void
    {
        $this->int_link_return = $a_return;
    }

◆ setMediaMode()

ilPageEditorGUI::setMediaMode ( )

set media and editing mode

Definition at line 466 of file class.ilPageEditorGUI.php.

                                  : void
    {
        $ilUser = $this->user;
 
        $ilUser->writePref(
            "ilPageEditor_MediaMode",
            $this->request->getString("media_mode")
        );
        $ilUser->writePref(
            "ilPageEditor_HTMLMode",
            $this->request->getString("html_mode")
        );
        $js_mode = $this->request->getString("js_mode");
        if ($ilUser->getPref("ilPageEditor_JavaScript") != $js_mode) {
            // not nice, should be solved differently in the future
            if ($this->page->getParentType() == "lm") {
                $this->ctrl->setParameterByClass("illmpageobjectgui", "reloadTree", "y");
            }
        }
        $ilUser->writePref("ilPageEditor_JavaScript", $js_mode);
 
        // again not so nice...
        if ($this->page->getParentType() == "lm") {
            $this->ctrl->redirectByClass("illmpageobjectgui", "edit");
        } else {
            $this->ctrl->returnToParent($this);
        }
    }

References $ilUser, $user, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ setPageBackTitle()

ilPageEditorGUI::setPageBackTitle ( string $a_title )

Definition at line 145 of file class.ilPageEditorGUI.php.

                                                     : void
    {
        $this->page_back_title = $a_title;
    }

◆ showSnippetInfo()

ilPageEditorGUI::showSnippetInfo ( )

Show snippet info.

Definition at line 824 of file class.ilPageEditorGUI.php.

                                     : void
    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilAccess = $this->access;
        $ilCtrl = $this->ctrl;
 
        $stpl = new ilTemplate("tpl.snippet_info.html", true, true, "Services/COPage");
 
        $mep_pools = ilMediaPoolItem::getPoolForItemId(
            $this->request->getString("ci_id")
        );
        foreach ($mep_pools as $mep_id) {
            $ref_ids = ilObject::_getAllReferences($mep_id);
            $edit_link = false;
            foreach ($ref_ids as $rid) {
                if (!$edit_link && $ilAccess->checkAccess("write", "", $rid)) {
                    $stpl->setCurrentBlock("edit_link");
                    $stpl->setVariable("TXT_EDIT", $lng->txt("edit"));
                    $stpl->setVariable(
                        "HREF_EDIT",
                        "./goto.php?target=mep_" . $rid
                    );
                    $stpl->parseCurrentBlock();
                }
            }
            $stpl->setCurrentBlock("pool");
            $stpl->setVariable("TXT_MEDIA_POOL", $lng->txt("obj_mep"));
            $stpl->setVariable("VAL_MEDIA_POOL", ilObject::_lookupTitle($mep_id));
            $stpl->parseCurrentBlock();
        }
 
        $stpl->setVariable("TXT_TITLE", $lng->txt("title"));
        $stpl->setVariable(
            "VAL_TITLE",
            ilMediaPoolPage::lookupTitle($this->request->getString("ci_id"))
        );
        $stpl->setVariable("TXT_BACK", $lng->txt("back"));
        $stpl->setVariable(
            "HREF_BACK",
            $ilCtrl->getLinkTarget($this->page_gui, "edit")
        );
        $tpl->setContent($stpl->get());
    }

References $lng, $tpl, ilObject\_getAllReferences(), ilObject\_lookupTitle(), ilMediaPoolItem\getPoolForItemId(), and ilMediaPoolPage\lookupTitle().

Here is the call graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilPageEditorGUI::$access

protected

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

◆ $cont_obj

ilPageContent ilPageEditorGUI::$cont_obj = null

Definition at line 60 of file class.ilPageEditorGUI.php.

Referenced by characteristic(), and executeCommand().

◆ $content_obj

ilPageContent ilPageEditorGUI::$content_obj

protected

Definition at line 43 of file class.ilPageEditorGUI.php.

◆ $ctrl

ilCtrl ilPageEditorGUI::$ctrl

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

Referenced by delete(), and executeCommand().

◆ $edit_repo

EditSessionRepository ilPageEditorGUI::$edit_repo

protected

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

◆ $enable_anchors

bool ilPageEditorGUI::$enable_anchors = false

Definition at line 62 of file class.ilPageEditorGUI.php.

◆ $enable_keywords

bool ilPageEditorGUI::$enable_keywords = false

Definition at line 61 of file class.ilPageEditorGUI.php.

◆ $form

ilPropertyFormGUI ilPageEditorGUI::$form

protected

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

◆ $header

string ilPageEditorGUI::$header = ""

Definition at line 59 of file class.ilPageEditorGUI.php.

Referenced by getHeader().

◆ $help

ilHelpGUI ilPageEditorGUI::$help

protected

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

Referenced by executeCommand().

◆ $http_request

ServerRequestInterface ilPageEditorGUI::$http_request

protected

Definition at line 40 of file class.ilPageEditorGUI.php.

◆ $int_link_return

string ilPageEditorGUI::$int_link_return = ""

protected

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

◆ $lng

ilLanguage ilPageEditorGUI::$lng

Definition at line 53 of file class.ilPageEditorGUI.php.

Referenced by __construct(), characteristic(), copy(), cut(), and delete().

◆ $log

ilLogger ilPageEditorGUI::$log

protected

Definition at line 63 of file class.ilPageEditorGUI.php.

◆ $objDefinition

ilObjectDefinition ilPageEditorGUI::$objDefinition

Definition at line 55 of file class.ilPageEditorGUI.php.

Referenced by __construct().

◆ $page

ilPageObject ilPageEditorGUI::$page

Definition at line 56 of file class.ilPageEditorGUI.php.

◆ $page_back_title

string ilPageEditorGUI::$page_back_title = ""

protected

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

◆ $page_gui

ilPageObjectGUI ilPageEditorGUI::$page_gui

protected

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

◆ $request

EditGUIRequest ilPageEditorGUI::$request

protected

Definition at line 41 of file class.ilPageEditorGUI.php.

◆ $requested_cname

string ilPageEditorGUI::$requested_cname

protected

Definition at line 71 of file class.ilPageEditorGUI.php.

◆ $requested_ctype

string ilPageEditorGUI::$requested_ctype

protected

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

Referenced by executeCommand().

◆ $requested_hier_id

string ilPageEditorGUI::$requested_hier_id

protected

Definition at line 66 of file class.ilPageEditorGUI.php.

Referenced by executeCommand().

◆ $requested_mob_id

int ilPageEditorGUI::$requested_mob_id

protected

Definition at line 72 of file class.ilPageEditorGUI.php.

◆ $requested_pc_id

string ilPageEditorGUI::$requested_pc_id

protected

Definition at line 67 of file class.ilPageEditorGUI.php.

Referenced by executeCommand().

◆ $requested_pcid

string ilPageEditorGUI::$requested_pcid

protected

Definition at line 68 of file class.ilPageEditorGUI.php.

◆ $requested_pl_pc_id

string ilPageEditorGUI::$requested_pl_pc_id

protected

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

Referenced by executeCommand().

◆ $return_location

string ilPageEditorGUI::$return_location = ""

Definition at line 58 of file class.ilPageEditorGUI.php.

◆ $tabs_gui

ilTabsGUI ilPageEditorGUI::$tabs_gui

protected

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

◆ $target_script

string ilPageEditorGUI::$target_script = ""

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

◆ $tool_context

ILIAS GlobalScreen ScreenContext ContextServices ilPageEditorGUI::$tool_context

protected

Definition at line 65 of file class.ilPageEditorGUI.php.

◆ $tpl

ilGlobalTemplateInterface ilPageEditorGUI::$tpl

Definition at line 52 of file class.ilPageEditorGUI.php.

Referenced by __construct(), characteristic(), and delete().

◆ $ui

ILIAS DI UIServices ilPageEditorGUI::$ui

protected

Definition at line 64 of file class.ilPageEditorGUI.php.

◆ $user

ilObjUser ilPageEditorGUI::$user

protected

Definition at line 50 of file class.ilPageEditorGUI.php.

Referenced by copyLinkedMediaToClipboard(), and setMediaMode().

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

Services/COPage/classes/class.ilPageEditorGUI.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activate()

◆ activatePage()

◆ addChangeComment()

◆ assignCharacteristic()

◆ cancelDeleteSelected()

◆ characteristic()

◆ confirmedDeleteSelected()

◆ copy()

◆ copyLinkedMediaToClipboard()

◆ copyLinkedMediaToMediaPool()

◆ cut()

◆ deactivatePage()

◆ delete()

◆ displayPage()

◆ executeCommand()

◆ getHeader()

◆ initCharacteristicForm()

◆ insertFromClipboard()

◆ paste()

◆ pasteFromClipboard()

◆ returnToContext()

◆ setHeader()

◆ setIntLinkReturn()

◆ setMediaMode()

◆ setPageBackTitle()

◆ showSnippetInfo()

Field Documentation

◆ $access

◆ $cont_obj

◆ $content_obj

◆ $ctrl

◆ $edit_repo

◆ $enable_anchors

◆ $enable_keywords

◆ $form

◆ $header

◆ $help

◆ $http_request

◆ $int_link_return

◆ $lng

◆ $log

◆ $objDefinition

◆ $page

◆ $page_back_title

◆ $page_gui

◆ $request

◆ $requested_cname

◆ $requested_ctype

◆ $requested_hier_id

◆ $requested_mob_id

◆ $requested_pc_id

◆ $requested_pcid

◆ $requested_pl_pc_id

◆ $return_location

◆ $tabs_gui

◆ $target_script

◆ $tool_context

◆ $tpl

◆ $ui

◆ $user