ilPageEditorGUI Class Reference

Page Editor GUI class. More...

Collaboration diagram for ilPageEditorGUI:

Public Member Functions
	__construct (&$a_page_object, &$a_page_object_gui)
	Constructor. More...
	setHeader ($a_header)
	set header title More...
	getHeader ()
	get header title More...
	setLocator (&$a_locator)
	set locator object More...
	returnToContext ()
	redirect to parent context More...
	setIntLinkReturn ($a_return)
	setPageBackTitle ($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 ()
	Cancel deletion. More...
	confirmedDeleteSelected ()
	Delete selected items. More...
	copy ()
	Copy selected items. More...
	cut ()
	Cut selected items. More...
	paste ($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 ($a_target, $a_types)
	Init map creation/update form. More...
	assignCharacteristic ()
	Assign characteristic. More...
	pasteFromClipboard ($a_hier_id)
	paste from clipboard (redirects to clipboard) More...
	insertFromClipboard ()
	insert object from clipboard More...
	displayPage ()
	Default for POST reloads and missing. More...
	displayLocator ()
	display locator More...
	showSnippetInfo ()
	Show snippet info. More...

Static Public Member Functions
static	_doJSEditing ()
	checks if current user has activated js editing and if browser is js capable More...
static	_isBrowserJSEditCapable ()
	checks wether browser is javascript editing capable More...

Data Fields
	$tpl
	$lng
	$ctrl
	$objDefinition
	$page
	$target_script
	$return_location
	$header
	$tabs
	$cont_obj
	$enable_keywords
	$enable_anchors

Protected Attributes
	$tabs_gui
	$help
	$user
	$access
	$log
	$ui
	$request
	$tool_context

Detailed Description

Page Editor GUI class.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

ilPageEditorGUI: ilPCParagraphGUI, ilPCTableGUI, ilPCTableDataGUI ilPageEditorGUI: ilPCMediaObjectGUI, ilPCListGUI, ilPCListItemGUI ilPageEditorGUI: ilPCFileListGUI, ilPCFileItemGUI, ilObjMediaObjectGUI ilPageEditorGUI: ilPCSourceCodeGUI, ilInternalLinkGUI, ilPCQuestionGUI ilPageEditorGUI: ilPCSectionGUI, ilPCDataTableGUI, ilPCResourcesGUI ilPageEditorGUI: ilPCMapGUI, ilPCPluggedGUI, ilPCTabsGUI, ilPCTabGUI, IlPCPlaceHolderGUI ilPageEditorGUI: ilPCContentIncludeGUI, ilPCLoginPageElementGUI ilPageEditorGUI: ilPCInteractiveImageGUI, ilPCProfileGUI, ilPCVerificationGUI ilPageEditorGUI: ilPCBlogGUI, ilPCQuestionOverviewGUI, ilPCSkillsGUI ilPageEditorGUI: ilPCConsultationHoursGUI, ilPCMyCoursesGUI, ilPCAMDPageListGUI ilPageEditorGUI: ilPCGridGUI, ilPCGridCellGUI, ilPageEditorServerAdapterGUI

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

Constructor & Destructor Documentation

__construct()

ilPageEditorGUI::__construct	(	&	$a_page_object,
		&	$a_page_object_gui
	)

Constructor.

Parameters

object

$a_page_object

page object public

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

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

    {
        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->http()->request();

        $this->log = ilLoggerFactory::getLogger('copg');

        $this->tool_context = $DIC->globalScreen()->tool()->context();

        // initiate variables
        $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"));
    }

Here is the call graph for this function:

Member Function Documentation

_doJSEditing()

static ilPageEditorGUI::_doJSEditing ( )

static

checks if current user has activated js editing and if browser is js capable

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

References $DIC, $ilUser, and _isBrowserJSEditCapable().

Referenced by ILIAS\COPage\Editor\Components\Page\PageQueryActionHandler\getActionsDropDown(), ilPCPlaceHolderGUI\insertPCText(), and ilPageObjectGUI\showPage().

    {
        global $DIC;

        $ilUser = $DIC->user();

        if ($ilUser->getPref("ilPageEditor_JavaScript") != "disable"
            && ilPageEditorGUI::_isBrowserJSEditCapable()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_isBrowserJSEditCapable()

static ilPageEditorGUI::_isBrowserJSEditCapable ( )

static

checks wether browser is javascript editing capable

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

Referenced by _doJSEditing().

    {
        return true;
    }

Here is the caller graph for this function:

activate()

ilPageEditorGUI::activate

(

)

(de-)activate selected items

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

References $_POST, and $_SESSION.

    {
        if (is_array($_POST["ids"])) {
            $updated = $this->page->switchEnableMultiple(
                $_POST["ids"],
                true,
                $this->page_gui->getPageConfig()->getEnableSelfAssessment()
            );
            if ($updated !== true) {
                $_SESSION["il_pg_error"] = $updated;
            } else {
                unset($_SESSION["il_pg_error"]);
            }
        }
        $this->ctrl->returnToParent($this);
    }

activatePage()

ilPageEditorGUI::activatePage

(

)

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

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

addChangeComment()

ilPageEditorGUI::addChangeComment

(

)

add change comment to history

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

References $_POST, ilHistory\_createEntry(), and ilUtil\stripSlashes().

    {
        include_once("./Services/History/classes/class.ilHistory.php");
        ilHistory::_createEntry(
            $this->page->getId(),
            "update",
            "",
            $this->page->getParentType() . ":pg",
            ilUtil::stripSlashes($_POST["change_comment"]),
            true
        );
        ilUtil::sendSuccess($this->lng->txt("cont_added_comment"), true);
        $this->ctrl->returnToParent($this);
    }

Here is the call graph for this function:

assignCharacteristic()

ilPageEditorGUI::assignCharacteristic

(

)

Assign characteristic.

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

References $_POST, $_SESSION, and ilUtil\stripSlashes().

    {
        $char_par = ilUtil::stripSlashes($_POST["char_par"]);
        $char_sec = ilUtil::stripSlashes($_POST["char_sec"]);

        $updated = $this->page->assignCharacteristic($_POST["target"], $char_par, $char_sec);
        if ($updated !== true) {
            $_SESSION["il_pg_error"] = $updated;
        } else {
            unset($_SESSION["il_pg_error"]);
        }
        $this->ctrl->returnToParent($this);
    }

Here is the call graph for this function:

cancelDeleteSelected()

ilPageEditorGUI::cancelDeleteSelected

(

)

Cancel deletion.

Parameters

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

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

characteristic()

ilPageEditorGUI::characteristic

(

)

Assign characeristic to text blocks/sections.

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

References $_POST, $cont_obj, $lng, $tpl, initCharacteristicForm(), and ilUtil\sendFailure().

    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        
        if (is_array($_POST["ids"])) {
            $types = array();
            
            // check what content element types have been selected
            foreach ($_POST["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) {
                ilUtil::sendFailure($lng->txt("cont_select_par_or_section"), true);
                $this->ctrl->returnToParent($this);
            } else {
                $this->initCharacteristicForm($_POST["ids"], $types);
                $tpl->setContent($this->form->getHTML());
            }
        } else {
            $this->ctrl->returnToParent($this);
        }
    }

Here is the call graph for this function:

confirmedDeleteSelected()

ilPageEditorGUI::confirmedDeleteSelected

(

)

Delete selected items.

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

References $_POST, and $_SESSION.

    {
        $targets = $_POST["ids"];
        if (count($targets) > 0) {
            $updated = $this->page->deleteContents(
                $targets,
                true,
                $this->page_gui->getPageConfig()->getEnableSelfAssessment()
            );
            if ($updated !== true) {
                $_SESSION["il_pg_error"] = $updated;
            } else {
                unset($_SESSION["il_pg_error"]);
            }
        }
        $this->ctrl->returnToParent($this);
    }

copy()

ilPageEditorGUI::copy

(

)

Copy selected items.

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

References $_POST, and $lng.

    {
        $lng = $this->lng;
        
        if (is_array($_POST["ids"])) {
            $this->page->copyContents($_POST["ids"]);
            ilUtil::sendSuccess($lng->txt("cont_sel_el_copied_use_paste"), true);
        }
        $this->ctrl->returnToParent($this);
    }

copyLinkedMediaToClipboard()

ilPageEditorGUI::copyLinkedMediaToClipboard

(

)

copy linked media object to clipboard

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

References $_POST, $ilUser, $user, and ilObject\_lookupTitle().

    {
        $ilUser = $this->user;
        
        ilUtil::sendSuccess($this->lng->txt("copied_to_clipboard"), true);
        $ilUser->addObjectToClipboard($_POST["mob_id"], "mob", ilObject::_lookupTitle($_POST["mob_id"]));
        $this->ctrl->returnToParent($this);
    }

Here is the call graph for this function:

copyLinkedMediaToMediaPool()

ilPageEditorGUI::copyLinkedMediaToMediaPool

(

)

copy linked media object to media pool

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

References $_POST, $ilUser, and $user.

    {
        $ilUser = $this->user;
        
        $this->ctrl->setParameterByClass("ilmediapooltargetselector", "mob_id", $_POST["mob_id"]);
        $this->ctrl->redirectByClass("ilmediapooltargetselector", "listPools");
    }

cut()

ilPageEditorGUI::cut

(

)

Cut selected items.

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

References $_POST, $_SESSION, and $lng.

    {
        $lng = $this->lng;
        
        if (is_array($_POST["ids"])) {
            $updated = $this->page->cutContents($_POST["ids"]);
            if ($updated !== true) {
                $_SESSION["il_pg_error"] = $updated;
            } else {
                unset($_SESSION["il_pg_error"]);
            }
            ilUtil::sendSuccess($lng->txt("cont_sel_el_cut_use_paste"), true);
        }
        $this->ctrl->returnToParent($this);
    }

deactivatePage()

ilPageEditorGUI::deactivatePage

(

)

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

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

delete()

ilPageEditorGUI::delete

(

)

Confirm.

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

References $_POST, $ctrl, $lng, $tpl, and ilUtil\sendInfo().

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

        $targets = $_POST["ids"];

        if (count($targets) == 0) {
            ilUtil::sendInfo($lng->txt("no_checkbox"), true);
            $this->ctrl->returnToParent($this);
        } else {
            include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
            $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());
        }
    }

Here is the call graph for this function:

displayLocator()

ilPageEditorGUI::displayLocator

(

)

display locator

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

Referenced by executeCommand().

    {
        /*if(is_object($this->locator))
        {
            $this->locator->display();
        }*/
    }

Here is the caller graph for this function:

displayPage()

ilPageEditorGUI::displayPage

(

)

Default for POST reloads and missing.

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

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

executeCommand()

ilPageEditorGUI::executeCommand

(

)

execute command

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

References $_GET, $_POST, $cont_obj, $ctrl, $help, $ret, ilObject\_lookupTitle(), displayLocator(), exit, getHeader(), ilCOPagePCDef\getPCDefinitionByGUIClassName(), ilCOPagePCDef\getPCDefinitionByName(), ilCOPagePCDef\getPCDefinitionByType(), ilCOPagePCDef\isPCGUIClassName(), paste(), pasteFromClipboard(), ilCOPagePCDef\requirePCGUIClassByName(), ilInternalLinkGUI\setFilterWhiteList(), and ui().

    {
        $ilCtrl = $this->ctrl;
        $ilHelp = $this->help;
        $this->log->debug("begin =========================");

        if (!true) {
            var_dump($_GET);
            echo "<br><br>";
            var_dump($_POST);
            exit;
        }

        // 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 = $_GET["hier_id"];
        $pc_id = $_GET["pc_id"];
        if (isset($_POST["new_hier_id"])) {
            $hier_id = $_POST["new_hier_id"];
        }

        $new_type = (isset($_GET["new_type"]))
            ? $_GET["new_type"]
            : $_POST["new_type"];

        $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(":", key($_POST["cmd"]));
            $pc_id = $pca[1];
            $cmd = explode("_", $pca[0]);
            unset($cmd[0]);
            $hier_id = implode("_", $cmd);
            $cmd = $_POST["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)
        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 == "" && $_GET["pl_pc_id"] != "") {
            $hid = $this->page->getHierIdsForPCIds(array($_GET["pl_pc_id"]));
            $hier_id = $hid[$_GET["pl_pc_id"]];
        }
        $this->log->debug("step PH: next class: " . $next_class);

        if ($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 = $_POST["pluginName"];
            if ($ctype == "mob") {
                $ctype = "media";
            }

            $this->log->debug("step CM: cmd: " . $cmd . ", ctype: " . $ctype . ", add_type: " . $add_type);
        } else {
            // Step LM (setting cmd and cmdclass for editing of linked media)
            if ($cmd == "editLinkedMedia") {
                $this->ctrl->setCmd("edit");
                $cmd = "edit";
                $_GET["pgEdMediaMode"] = "editLinkedMedia";
                $_GET["mob_id"] = $_POST["mob_id"];
            }
            if ($_GET["pgEdMediaMode"] == "editLinkedMedia") {
                $this->ctrl->setParameter($this, "pgEdMediaMode", "editLinkedMedia");
                $this->ctrl->setParameter($this, "mob_id", $_GET["mob_id"]);
                if ($cmdClass != "ilinternallinkgui" && $cmdClass != "ilmdeditorgui"
                    && $cmdClass != "ilimagemapeditorgui" && $cmdClass != "ilfilesystemgui") {
                    $this->ctrl->setCmdClass("ilobjmediaobjectgui");
                    $cmdClass = "ilobjmediaobjectgui";
                }
            }
            $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 ($_REQUEST["ctype"] == "" && $_REQUEST["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" || $_POST["editImagemapForward_x"] != "" || $_POST["imagemap_x"] != "") &&
                ($cmd != "displayPage" || $_POST["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"))) {
                if ($_GET["pgEdMediaMode"] != "editLinkedMedia") {
                    $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();
                }
            }
            $this->log->debug("step PR: ctype: $ctype");
        }

        // Step NC (handle empty next class)
        if ($_REQUEST["ctype"] != "" || $_REQUEST["cname"] != "") {
            $ctype = $_REQUEST["ctype"];
            if ($_REQUEST["cname"] != "") {
                $pc_def = ilCOPagePCDef::getPCDefinitionByName($_REQUEST["cname"]);
                $ctype = $pc_def["pc_type"];
            }
            $pc_id = $_REQUEST["pcid"];
            $hier_id = $_REQUEST["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->displayLocator();
        }

        $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 == "") {
            include_once("./Services/COPage/classes/class.ilCOPagePCDef.php");
            $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" && $_POST["editImagemapForward_x"] == "" && $_POST["imagemap_x"] == "") {
            $next_class = "";
        }
        $this->log->debug("step IM: next_class: $next_class");
        // Step FC (forward command)
        $this->log->debug("before FC: next_class:" . $next_class . ", pc_id:" . $pc_id .
                ", hier_id:" . $hier_id . ", ctype:" . $ctype . ", cmd:" . $cmd . ", _GET[cmd]: " . $_GET["cmd"]);


        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":
                include_once("./Services/COPage/classes/class.ilPCMediaObjectGUI.php");

                $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"),
                    $ilCtrl->getParentReturn($this)
                );
                $mob_gui = new ilObjMediaObjectGUI("", $_GET["mob_id"], false, false);
                $mob_gui->getTabs();
                $mob_gui->setEnabledMapAreas($this->page_gui->getPageConfig()->getEnableInternalLinks());
                $this->tpl->setTitle($this->lng->txt("mob") . ": " .
                    ilObject::_lookupTitle($_GET["mob_id"]));
                $ret = $this->ctrl->forwardCommand($mob_gui);
                break;

            // Question
            case "ilpcquestiongui":
                include_once("./Services/COPage/classes/class.ilPCQuestionGUI.php");
                $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"),
                        $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();
                include_once("./Services/COPage/classes/class.ilPCPluggedGUI.php");
                $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->request
                );
                $this->ctrl->forwardCommand($adapter);
                break;

            default:
                
                // generic calls to gui classes
                include_once("./Services/COPage/classes/class.ilCOPagePCDef.php");
                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);
                    } elseif ($cmd == "paste") {
                        $ret = $this->paste($hier_id);
                    } else {
                        $ret = $this->$cmd();
                    }
                }
                break;

        }

        $this->log->debug("end --------------------");

        return $ret;
    }

Here is the call graph for this function:

getHeader()

ilPageEditorGUI::getHeader

(

)

get header title

Returns

string header title

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

References $header.

Referenced by executeCommand().

    {
        return $this->header;
    }

Here is the caller graph for this function:

initCharacteristicForm()

ilPageEditorGUI::initCharacteristicForm	(		$a_target,
			$a_types
	)

Init map creation/update form.

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

References $ctrl, $lng, ilPCParagraphGUI\_getCharacteristics(), and ilPCSectionGUI\_getCharacteristics().

Referenced by characteristic().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        
        // edit form
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $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"
            );
            include_once("./Services/COPage/classes/class.ilPCParagraphGUI.php");
            $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"
            );
            include_once("./Services/COPage/classes/class.ilPCSectionGUI.php");
            $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"));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertFromClipboard()

ilPageEditorGUI::insertFromClipboard

(

)

insert object from clipboard

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

References $_GET, $type, and ilEditClipboardGUI\_getSelectedIDs().

    {
        include_once("./Services/Clipboard/classes/class.ilEditClipboardGUI.php");
        $ids = ilEditClipboardGUI::_getSelectedIDs();
        include_once("./Services/COPage/classes/class.ilPCMediaObject.php");

        $hier_id = $this->page->getHierIDForPCId($_GET["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->updated = $this->page->update();
                }
                if ($type == "incl") {
                    include_once("./Services/COPage/classes/class.ilPCContentInclude.php");
                    $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->updated = $this->page->update();
                }
            }
        }
        $this->ctrl->returnToParent($this);
    }

Here is the call graph for this function:

paste()

ilPageEditorGUI::paste

(

$a_hier_id

)

paste from clipboard (redirects to clipboard)

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

References $ctrl.

Referenced by executeCommand().

    {
        $ilCtrl = $this->ctrl;
        $this->page->pasteContents($a_hier_id, $this->page_gui->getPageConfig()->getEnableSelfAssessment());
        include_once("./Modules/LearningModule/classes/class.ilEditClipboard.php");
        //ilEditClipboard::setAction("");
        $this->ctrl->returnToParent($this);
    }

Here is the caller graph for this function:

pasteFromClipboard()

ilPageEditorGUI::pasteFromClipboard

(

$a_hier_id

)

paste from clipboard (redirects to clipboard)

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

References $ctrl.

Referenced by executeCommand().

    {
        $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");
    }

Here is the caller graph for this function:

returnToContext()

ilPageEditorGUI::returnToContext

(

)

redirect to parent context

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

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

setHeader()

ilPageEditorGUI::setHeader

(

$a_header

)

set header title

Parameters

string

$a_header

header title

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

    {
        $this->header = $a_header;
    }

setIntLinkReturn()

ilPageEditorGUI::setIntLinkReturn

(

$a_return

)

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

    {
        $this->int_link_return = $a_return;
    }

setLocator()

ilPageEditorGUI::setLocator

(

&

$a_locator

)

set locator object

Parameters

object

$a_locator

locator object

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

    {
        $this->locator = $a_locator;
    }

setMediaMode()

ilPageEditorGUI::setMediaMode

(

)

set media and editing mode

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

References $_POST, $ilUser, and $user.

    {
        $ilUser = $this->user;

        $ilUser->writePref("ilPageEditor_MediaMode", $_POST["media_mode"]);
        $ilUser->writePref("ilPageEditor_HTMLMode", $_POST["html_mode"]);
        if ($ilUser->getPref("ilPageEditor_JavaScript") != $_POST["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", $_POST["js_mode"]);
        
        // again not so nice...
        if ($this->page->getParentType() == "lm") {
            $this->ctrl->redirectByClass("illmpageobjectgui", "edit");
        } else {
            $this->ctrl->returnToParent($this);
        }
    }

setPageBackTitle()

ilPageEditorGUI::setPageBackTitle

(

$a_title

)

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

    {
        $this->page_back_title = $a_title;
    }

showSnippetInfo()

ilPageEditorGUI::showSnippetInfo

(

)

Show snippet info.

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

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

    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilAccess = $this->access;
        $ilCtrl = $this->ctrl;
        
        $stpl = new ilTemplate("tpl.snippet_info.html", true, true, "Services/COPage");
        
        include_once("./Modules/MediaPool/classes/class.ilMediaPoolItem.php");
        $mep_pools = ilMediaPoolItem::getPoolForItemId($_POST["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();
        }
        
        include_once("./Modules/MediaPool/classes/class.ilMediaPoolPage.php");
        $stpl->setVariable("TXT_TITLE", $lng->txt("title"));
        $stpl->setVariable("VAL_TITLE", ilMediaPoolPage::lookupTitle($_POST["ci_id"]));
        $stpl->setVariable("TXT_BACK", $lng->txt("back"));
        $stpl->setVariable(
            "HREF_BACK",
            $ilCtrl->getLinkTarget($this->page_gui, "edit")
        );
        $tpl->setContent($stpl->get());
    }

Here is the call graph for this function:

Field Documentation

$access

ilPageEditorGUI::$access

protected

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

Referenced by showSnippetInfo().

$cont_obj

ilPageEditorGUI::$cont_obj

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

Referenced by characteristic(), and executeCommand().

$ctrl

ilPageEditorGUI::$ctrl

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

Referenced by delete(), executeCommand(), initCharacteristicForm(), paste(), pasteFromClipboard(), and showSnippetInfo().

$enable_anchors

ilPageEditorGUI::$enable_anchors

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

$enable_keywords

ilPageEditorGUI::$enable_keywords

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

$header

ilPageEditorGUI::$header

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

Referenced by getHeader().

$help

ilPageEditorGUI::$help

protected

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

Referenced by executeCommand().

$lng

ilPageEditorGUI::$lng

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

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

$log

ilPageEditorGUI::$log

protected

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

$objDefinition

ilPageEditorGUI::$objDefinition

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

Referenced by __construct().

$page

ilPageEditorGUI::$page

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

$request

ilPageEditorGUI::$request

protected

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

$return_location

ilPageEditorGUI::$return_location

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

$tabs

ilPageEditorGUI::$tabs

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

$tabs_gui

ilPageEditorGUI::$tabs_gui

protected

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

$target_script

ilPageEditorGUI::$target_script

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

$tool_context

ilPageEditorGUI::$tool_context

protected

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

$tpl

ilPageEditorGUI::$tpl

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

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

$ui

ilPageEditorGUI::$ui

protected

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

$user

ilPageEditorGUI::$user

protected

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

Referenced by copyLinkedMediaToClipboard(), copyLinkedMediaToMediaPool(), and setMediaMode().

---

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

• Services/COPage/classes/class.ilPageEditorGUI.php