ilRepositoryGUI Class Reference

Class ilRepositoryGUI. More...

Collaboration diagram for ilRepositoryGUI:

Public Member Functions
	__construct ()
	Constructor public. More...
	executeCommand ()
	execute command More...
	show ()
	frameset ()
	output tree frameset More...
	showTree ()
	display tree view More...
	showRepTree ()
	Show tree. More...

Data Fields
	$lng
	$tpl
	$tree
	$rbacsystem
	$cur_ref_id
	$cmd
	$mode
	$ctrl

Protected Attributes
	$objDefinition
	$log
	$user
	$settings
	$help
	$error
	$access
	$tool_context

Private Attributes
	$http

Detailed Description

Class ilRepositoryGUI.

Author

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

Version

$Id$

ilRepositoryGUI: ilObjGroupGUI, ilObjFolderGUI, ilObjFileGUI, ilObjCourseGUI, ilCourseObjectivesGUI ilRepositoryGUI: ilObjSAHSLearningModuleGUI, ilObjChatroomGUI, ilObjForumGUI ilRepositoryGUI: ilObjLearningModuleGUI, ilObjGlossaryGUI ilRepositoryGUI: ilObjQuestionPoolGUI, ilObjSurveyQuestionPoolGUI, ilObjTestGUI ilRepositoryGUI: ilObjSurveyGUI, ilObjExerciseGUI, ilObjMediaPoolGUI, ilObjFileBasedLMGUI ilRepositoryGUI: ilObjCategoryGUI, ilObjRoleGUI, ilObjBlogGUI ilRepositoryGUI: ilObjLinkResourceGUI ilRepositoryGUI: ilObjRootFolderGUI, ilObjMediaCastGUI, ilObjRemoteCourseGUI, ilObjSessionGUI ilRepositoryGUI: ilObjCourseReferenceGUI, ilObjCategoryReferenceGUI, ilObjDataCollectionGUI, ilObjGroupReferenceGUI, ilObjStudyProgrammeReferenceGUI ilRepositoryGUI: ilObjPollGUI, ilObjRemoteCategoryGUI, ilObjRemoteWikiGUI, ilObjRemoteLearningModuleGUI ilRepositoryGUI: ilObjRemoteGlossaryGUI, ilObjRemoteFileGUI, ilObjRemoteGroupGUI ilRepositoryGUI: ilObjRemoteTestGUI, ilObjCloudGUI, ilObjPortfolioTemplateGUI ilRepositoryGUI: ilObjStudyProgrammeGUI ilRepositoryGUI: ilObjIndividualAssessmentGUI ilRepositoryGUI: ilObjLTIConsumerGUI ilRepositoryGUI: ilObjCmiXapiGUI

Definition at line 33 of file class.ilRepositoryGUI.php.

Constructor & Destructor Documentation

__construct()

ilRepositoryGUI::__construct

(

)

Constructor public.

Definition at line 88 of file class.ilRepositoryGUI.php.

References $_GET, $_POST, $_SESSION, $cur_ref_id, $DIC, $ilCtrl, $ilLog, $ilSetting, $ilUser, $lng, $objDefinition, $rbacsystem, $tpl, $tree, $type, ilObject\_lookupType(), help(), ILIAS\FileDelivery\http(), ilUtil\isAPICall(), settings(), and user().

    {
        global $DIC;

        $this->log = $DIC["ilLog"];
        $this->user = $DIC->user();
        $this->settings = $DIC->settings();
        $this->help = $DIC["ilHelp"];
        $this->error = $DIC["ilErr"];
        $this->access = $DIC->access();
        $lng = $DIC->language();
        $tpl = $DIC["tpl"];
        $tree = $DIC->repositoryTree();
        $rbacsystem = $DIC->rbac()->system();
        $objDefinition = $DIC["objDefinition"];
        $ilCtrl = $DIC->ctrl();
        $ilLog = $DIC["ilLog"];
        $ilUser = $DIC->user();
        $ilSetting = $DIC->settings();
        $this->tool_context = $DIC->globalScreen()->tool()->context();
        $this->http = $DIC->http();

        $this->lng = $lng;
        $this->tpl = $tpl;
        $this->tree = $tree;
        $this->rbacsystem = $rbacsystem;
        $this->objDefinition = $objDefinition;

        $this->ctrl = $ilCtrl;
        
        $this->creation_mode = false;

        $this->ctrl->saveParameter($this, array("ref_id"));
        if (!ilUtil::isAPICall()) {
            $this->ctrl->setReturn($this, "");
        }

        // determine current ref id and mode
        if (!empty($_GET["ref_id"]) || $this->ctrl->getCmd() == "showTree") {
            $this->cur_ref_id = $_GET["ref_id"];
        } else {
            //echo "1-".$_SESSION["il_rep_ref_id"]."-";
            if (!empty($_SESSION["il_rep_ref_id"]) && !empty($_GET["getlast"])) {
                $this->cur_ref_id = $_SESSION["il_rep_ref_id"];
            //echo "2-".$this->cur_ref_id."-";
            } else {
                $this->cur_ref_id = $this->tree->getRootId();

                if ($_GET["cmd"] != "" && $_GET["cmd"] != "frameset") {
                    //echo "hhh";
                    $get_str = $post_str = "";
                    foreach ($_GET as $key => $value) {
                        $get_str .= "-$key:$value";
                    }
                    foreach ($_POST as $key => $value) {
                        $post_str .= "-$key:$value";
                    }
                    $ilLog->write("Repository: command called without ref_id." .
                        "GET:" . $get_str . "-POST:" . $post_str, $ilLog->WARNING);
                }
                // #10033
                $_GET = array("baseClass" => "ilRepositoryGUI");
                $_POST = array();
                $this->ctrl->setCmd("frameset");
            }
        }
        //echo "<br>+".$_GET["ref_id"]."+";
        if (!$tree->isInTree($this->cur_ref_id) && $this->ctrl->getCmd() != "showTree") {
            $this->cur_ref_id = $this->tree->getRootId();

            // check wether command has been called with
            // item that is not in tree
            if ($_GET["cmd"] != "" && $_GET["cmd"] != "frameset") {
                $get_str = $post_str = "";
                foreach ($_GET as $key => $value) {
                    $get_str .= "-$key:$value";
                }
                foreach ($_POST as $key => $value) {
                    $post_str .= "-$key:$value";
                }
                $ilLog->write("Repository: command called with ref_id that is not in tree." .
                    "GET:" . $get_str . "-POST:" . $post_str, $ilLog->WARNING);
            }
            $_GET = array();
            $_POST = array();
            $this->ctrl->setCmd("frameset");
        }

        // set current repository view mode
        if (!empty($_GET["set_mode"])) {
            $_SESSION["il_rep_mode"] = $_GET["set_mode"];
            if ($ilUser->getId() != ANONYMOUS_USER_ID) {
                $ilUser->writePref("il_rep_mode", $_GET["set_mode"]);
            }
        }

        // get user setting
        if ($_SESSION["il_rep_mode"] == "") {
            if ($ilUser->getId() != ANONYMOUS_USER_ID) {
                $_SESSION["il_rep_mode"] = $ilUser->getPref("il_rep_mode");
            }
        }

        // if nothing set, get default view
        if ($_SESSION["il_rep_mode"] == "") {
            $_SESSION["il_rep_mode"] = $ilSetting->get("default_repository_view");
        }

        $this->mode = ($_SESSION["il_rep_mode"] != "")
            ? $_SESSION["il_rep_mode"]
            : "flat";

        // store current ref id
        if ($this->ctrl->getCmd() != "showTree" &&
            $rbacsystem->checkAccess("read", $this->cur_ref_id)) {
            $type = ilObject::_lookupType($this->cur_ref_id, true);
            if ($type == "cat" || $type == "grp" || $type == "crs"
                || $type == "root") {
                $_SESSION["il_rep_ref_id"] = $this->cur_ref_id;
            }
        }
        
        $_GET["ref_id"] = $this->cur_ref_id;
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilRepositoryGUI::executeCommand

(

)

execute command

Definition at line 217 of file class.ilRepositoryGUI.php.

References $_GET, $_POST, $_SESSION, $cmd, $ctrl, $error, $help, $ilCtrl, $ilErr, $lng, $rbacsystem, ilObject\_lookupType(), frameset(), ilPublicSectionSettings\getInstance(), ilLoggerFactory\getLogger(), ILIAS\FileDelivery\http(), ilHelpGUI\ID_PART_SCREEN, ilObject2GUI\REPOSITORY_NODE_ID, show(), showTree(), and user().

    {
        $rbacsystem = $this->rbacsystem;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilHelp = $this->help;
        $ilErr = $this->error;

        if (
            ($this->user->isAnonymous() || !($this->user->getId() >= 1)) &&
            !ilPublicSectionSettings::getInstance()->isEnabledForDomain(
                $this->http->request()->getServerParams()['SERVER_NAME']
            )
        ) {
            $this->ctrl->redirectToURL('./login.php?cmd=force_login');
        }

        $this->tool_context->claim()->repository();
        $show_tree = ($_SESSION["il_rep_mode"] == "flat")
            ? true
            : false;

        // check creation mode
        // determined by "new_type" parameter
        $new_type = ($_POST["new_type"] != "" && $ilCtrl->getCmd() == "create")
            ? $_POST["new_type"]
            : $_GET["new_type"];

        if ($new_type != "" && $new_type != "sty") {
            $this->creation_mode = true;
            $ilHelp->setScreenIdComponent($new_type);
            $ilHelp->setDefaultScreenId(ilHelpGUI::ID_PART_SCREEN, "create");
        }

        // handle frameset command
        $cmd = $this->ctrl->getCmd();
        if (($cmd == "frameset" || $_GET["rep_frame"] == 1) && $_SESSION["il_rep_mode"] == "tree") {
            $next_class = "";
            $cmd = "frameset";
        } elseif ($cmd == "frameset" && $_SESSION["il_rep_mode"] != "tree") {
            $this->ctrl->setCmd("");
            $cmd = "";
        }


        // determine next class
        if ($cmd != "frameset") {
            if ($this->creation_mode) {
                $obj_type = $new_type;
                $class_name = $this->objDefinition->getClassName($obj_type);
                if (strtolower($class_name) != "user") {
                    $next_class = strtolower("ilObj" . $class_name . "GUI");
                } else {
                    $next_class = $this->ctrl->getNextClass();
                }
                // Only set the fixed cmdClass if the next class is different to
                // the GUI class of the new object.
                // An example:
                // Copy Category uses this call structure:
                // RespositoryGUI -> CategoryGUI -> ilObjectCopyGUI
                // Without this fix, the cmdClass ilObjectCopyGUI would never be reached
                
                ilLoggerFactory::getLogger('obj')->debug($this->ctrl->getNextClass() . ' <-> ' . $class_name);
                
                if ($this->ctrl->getNextClass() != strtolower('ilObj' . $class_name . 'GUI')) {
                    $this->ctrl->setCmdClass($next_class);
                }
            } elseif ((($next_class = $this->ctrl->getNextClass($this)) == "")
                || ($next_class == "ilrepositorygui" && $this->ctrl->getCmd() == "return")) {
                if ($cmd != "frameset" && $cmd != "showTree") {
                    // get GUI of current object
                    $obj_type = ilObject::_lookupType($this->cur_ref_id, true);
                    $class_name = $this->objDefinition->getClassName($obj_type);
                    $next_class = strtolower("ilObj" . $class_name . "GUI");

                    $this->ctrl->setCmdClass($next_class);
                    if ($this->ctrl->getCmd() == "return") {
                        $this->ctrl->setCmd("");
                    }
                }
            }
        }

        // commands that are always handled by repository gui
        // to do: move to container
        if ($cmd == "showRepTree") {
            $next_class = "";
        }

        switch ($next_class) {
            default:
                // forward all other classes to gui commands
                if ($next_class != "" && $next_class != "ilrepositorygui") {
                    $class_path = $this->ctrl->lookupClassPath($next_class);
                    // get gui class instance
                    require_once($class_path);
                    $class_name = $this->ctrl->getClassForClasspath($class_path);
                    if (!$this->creation_mode) {
                        if (is_subclass_of($class_name, "ilObject2GUI")) {
                            $this->gui_obj = new $class_name($this->cur_ref_id, ilObject2GUI::REPOSITORY_NODE_ID);
                        } else {
                            $this->gui_obj = new $class_name("", $this->cur_ref_id, true, false);
                        }
                    } else {
                        if (is_subclass_of($class_name, "ilObject2GUI")) {
                            $this->gui_obj = new $class_name(null, ilObject2GUI::REPOSITORY_NODE_ID, $this->cur_ref_id);
                        } else {
                            $this->gui_obj = new $class_name("", 0, true, false);
                        }
                    }
                    //$this->gui_obj = new $class_name("", $this->cur_ref_id, true, false);

    
                    $tabs_out = ($new_type == "")
                        ? true
                        : false;
                    $this->gui_obj->setCreationMode($this->creation_mode);
                    $this->ctrl->setReturn($this, "return");

                    $this->show();
                } else {        //
                    // process repository frameset
                    if ($cmd == "frameset") {
                        if ($_SESSION["il_rep_mode"] == "tree") {
                            $this->frameset();
                            return;
                        }
                        $cmd = "";
                        $this->ctrl->setCmd("");
                    }
                    
                    // process tree command
                    if ($cmd == "showTree") {
                        $this->showTree();
                        return;
                    }
                    
                    $cmd = $this->ctrl->getCmd("");
                    
                    // check read access for category
                    if ($this->cur_ref_id > 0 && !$rbacsystem->checkAccess("read", $this->cur_ref_id) && $cmd != "showRepTree") {
                        $_SESSION["il_rep_ref_id"] = "";
                        $ilErr->raiseError($lng->txt("permission_denied"), $ilErr->MESSAGE);
                        $this->tpl->printToStdout();
                    } else {
                        $this->cmd = $cmd;
                        $this->$cmd();
                    }
                }
                break;
        }
    }

Here is the call graph for this function:

frameset()

ilRepositoryGUI::frameset

(

)

output tree frameset

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

References $access, $ctrl, $ilCtrl, and $lng.

Referenced by executeCommand().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilAccess = $this->access;
        
        $ilCtrl->redirectByClass("ilrepositorygui", "");
    }

Here is the caller graph for this function:

show()

ilRepositoryGUI::show

(

)

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

References $ret.

Referenced by executeCommand().

    {
        // normal command processing
        $ret = $this->ctrl->forwardCommand($this->gui_obj);
        $this->tpl->setVariable("OBJECTS", $this->gui_obj->getHTML());
        $this->tpl->printToStdout();
    }

Here is the caller graph for this function:

showRepTree()

ilRepositoryGUI::showRepTree

(

)

Show tree.

Definition at line 520 of file class.ilRepositoryGUI.php.

References exit.

    {
        $exp = new ilRepositoryExplorerGUI($this, "showRepTree");
        // root node should be skipped, see #26787
        $exp->setSkipRootNode(true);
        $exp->handleCommand();
        exit;
    }

showTree()

ilRepositoryGUI::showTree

(

)

display tree view

Definition at line 395 of file class.ilRepositoryGUI.php.

References $_GET, $ctrl, $ilCtrl, $ilSetting, $lng, $n, $nd, $settings, $tree, ilObject\_lookupObjId(), ilObject\_lookupType(), exit, ilUtil\getStyleSheetLocation(), and iljQueryUtil\initjQuery().

Referenced by executeCommand().

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

        $ilCtrl->setParameter($this, "active_node", $_GET["active_node"]);

        $this->tpl = new ilGlobalTemplate("tpl.main.html", true, true);
        $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
        
        $this->tpl->addBlockFile("CONTENT", "content", "tpl.explorer.html");

        include_once("./Services/Repository/classes/class.ilRepositoryExplorer.php");

        $active_node = ($_GET["active_node"] > 1)
            ? $_GET["active_node"]
            : (($_GET["ref_id"] > 1)
                ? $_GET["ref_id"]
                : 0);
        $top_node = 0;
        if ($ilSetting->get("rep_tree_limit_grp_crs") && $active_node > 0) {
            $path = $tree->getPathId($active_node);
            foreach ($path as $n) {
                if ($top_node > 0) {
                    break;
                }
                if (in_array(
                    ilObject::_lookupType(ilObject::_lookupObjId($n)),
                    array("crs", "grp")
                )) {
                    $top_node = $n;
                }
            }
        }

        $exp = new ilRepositoryExplorer("ilias.php?baseClass=ilRepositoryGUI&cmd=goto", $top_node);
        $exp->setUseStandardFrame(false);
        $exp->setExpandTarget($ilCtrl->getLinkTarget($this, "showTree"));
        $exp->setFrameUpdater("tree", "updater");
        $exp->setTargetGet("ref_id");

        if ($_GET["repexpand"] == "") {
            $expanded = $this->tree->readRootId();
        } else {
            $expanded = $_GET["repexpand"];
        }

        $exp->setExpand($expanded);

        if ($active_node > 0) {
            $path = $tree->getPathId($active_node);
            if ($top_node > 0) {
                $exp->setForceOpenPath($path);
                $exp->setExpand($expanded);
            } else {
                $exp->setForceOpenPath($path + array($top_node));
            }
            $exp->highlightNode($active_node);
        }

        // build html-output
        if ($top_node > 0) {
            $head_tpl = new ilTemplate(
                "tpl.cont_tree_head.html",
                true,
                true,
                "Services/Repository"
            );
            $path = ilObject::_getIcon(ROOT_FOLDER_ID, "tiny", "root");
            $nd = $tree->getNodeData(ROOT_FOLDER_ID);
            $title = $nd["title"];
            if ($title == "ILIAS") {
                $title = $lng->txt("repository");
            }
            $head_tpl->setVariable("IMG_SRC", $path);
            $head_tpl->setVariable("ALT_IMG", $lng->txt("icon") . " " . $title);
            $head_tpl->setVariable("LINK_TXT", $title);
            $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", "1");
            $head_tpl->setVariable(
                "LINK_HREF",
                $ilCtrl->getLinkTargetByClass("ilrepositorygui", "frameset")
            );
            $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $_GET["ref_id"]);
            $exp->setTreeLead($head_tpl->get());

            $exp->initItemCounter(1);
            $exp->setOutput(
                $tree->getParentId($top_node),
                1,
                ilObject::_lookupObjId($tree->getParentId($top_node))
            );
        } else {
            $exp->setOutput(0);
        }
        $output = $exp->getOutput(false);

        //if ($GLOBALS["ilUser"]->getLogin() == "alex") echo "topnode:$top_node:activenode:$active_node:";
        

        // asynchronous output
        if ($ilCtrl->isAsynch()) {
            echo $output;
            exit;
        }

        $this->tpl->setCurrentBlock("content");
        $this->tpl->setVariable("TXT_EXPLORER_HEADER", $this->lng->txt("overview"));
        $this->tpl->setVariable("EXP_REFRESH", $this->lng->txt("refresh"));
        $this->tpl->setVariable("EXPLORER", $output);
        $ilCtrl->setParameter($this, "repexpand", $_GET["repexpand"]);
        $this->tpl->setVariable("ACTION", $ilCtrl->getLinkTarget($this, "showTree", "", false, false));
        $this->tpl->parseCurrentBlock();
        
        include_once("./Services/jQuery/classes/class.iljQueryUtil.php");
        iljQueryUtil::initjQuery($this->tpl);
        
        $this->tpl->printToStdout(false);
        exit;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilRepositoryGUI::$access

protected

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

Referenced by frameset().

$cmd

ilRepositoryGUI::$cmd

Definition at line 79 of file class.ilRepositoryGUI.php.

Referenced by executeCommand().

$ctrl

ilRepositoryGUI::$ctrl

Definition at line 81 of file class.ilRepositoryGUI.php.

Referenced by executeCommand(), frameset(), and showTree().

$cur_ref_id

ilRepositoryGUI::$cur_ref_id

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

Referenced by __construct().

$error

ilRepositoryGUI::$error

protected

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

Referenced by executeCommand().

$help

ilRepositoryGUI::$help

protected

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

Referenced by executeCommand().

$http

ilRepositoryGUI::$http

private

Definition at line 82 of file class.ilRepositoryGUI.php.

$lng

ilRepositoryGUI::$lng

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

Referenced by __construct(), executeCommand(), frameset(), and showTree().

$log

ilRepositoryGUI::$log

protected

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

$mode

ilRepositoryGUI::$mode

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

$objDefinition

ilRepositoryGUI::$objDefinition

protected

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

Referenced by __construct().

$rbacsystem

ilRepositoryGUI::$rbacsystem

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

Referenced by __construct(), and executeCommand().

$settings

ilRepositoryGUI::$settings

protected

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

Referenced by showTree().

$tool_context

ilRepositoryGUI::$tool_context

protected

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

$tpl

ilRepositoryGUI::$tpl

Definition at line 75 of file class.ilRepositoryGUI.php.

Referenced by __construct().

$tree

ilRepositoryGUI::$tree

Definition at line 76 of file class.ilRepositoryGUI.php.

Referenced by __construct(), and showTree().

$user

ilRepositoryGUI::$user

protected

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

---

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

• Services/Repository/classes/class.ilRepositoryGUI.php