GUI class for personal workspace. More...

Collaboration diagram for ilPersonalWorkspaceGUI:

Public Member Functions
	__construct ()
	constructor More...

	executeCommand ()
	execute command More...

Protected Member Functions
	initTree ()
	Init personal tree. More...

	renderBack ()

	renderLocator ()
	Build locator for current node. More...

Protected Attributes
	$ctrl

	$lng

	$help

	$obj_definition

	$tpl

	$main_menu

	$user

	$tabs

	$locator

	$tree

	$node_id

	$tool_context

Detailed Description

GUI class for personal workspace.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

@ilCtrl_Calls ilPersonalWorkspaceGUI: ilObjWorkspaceRootFolderGUI, ilObjWorkspaceFolderGUI @ilCtrl_Calls ilPersonalWorkspaceGUI: ilObjectCopyGUI, ilObjFileGUI, ilObjBlogGUI @ilCtrl_Calls ilPersonalWorkspaceGUI: ilObjTestVerificationGUI, ilObjExerciseVerificationGUI @ilCtrl_Calls ilPersonalWorkspaceGUI: ilObjLinkResourceGUI, ilObjCourseVerificationGUI @ilCtrl_Calls ilPersonalWorkspaceGUI: ilObjSCORMVerificationGUI @ilCtrl_Calls ilPersonalWorkspaceGUI: ilObjCmiXapiVerificationGUI @ilCtrl_Calls ilPersonalWorkspaceGUI: ilObjLTIConsumerVerificationGUI

Definition at line 18 of file class.ilPersonalWorkspaceGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPersonalWorkspaceGUI::__construct ( )

constructor

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

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->help = $DIC["ilHelp"];
        $this->obj_definition = $DIC["objDefinition"];
        $this->tpl = $DIC["tpl"];
        $this->main_menu = $DIC["ilMainMenu"];
        $this->user = $DIC->user();
        $this->tabs = $DIC->tabs();
        $this->locator = $DIC["ilLocator"];
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();
        $ilHelp = $DIC["ilHelp"];
        $this->settings = $DIC->settings();
 
        $lng->loadLanguageModule("wsp");
 
        $this->initTree();
 
        $ilCtrl->saveParameter($this, "wsp_id");
 
        $this->node_id = (int) $_REQUEST["wsp_id"];
        if (!$this->node_id || !$this->tree->isInTree($this->node_id)) {
            $this->node_id = $this->tree->getRootId();
        }
        $this->tool_context = $DIC->globalScreen()->tool()->context();
    }

References $DIC, $lng, help(), initTree(), settings(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilPersonalWorkspaceGUI::executeCommand ( )

execute command

Definition at line 113 of file class.ilPersonalWorkspaceGUI.php.

    {
        $ilCtrl = $this->ctrl;
        $objDefinition = $this->obj_definition;
        $tpl = $this->tpl;
        $ilMainMenu = $this->main_menu;
 
        if ($this->settings->get("disable_personal_workspace")) {
            throw new ilException($this->lng->txt("no_permission"));
        }
 
        $ilCtrl->setReturn($this, "render");
        $cmd = $ilCtrl->getCmd();
 
        $this->tool_context->current()->addAdditionalData(ilWorkspaceGSToolProvider::SHOW_WS_TREE, true);
 
        // new type
        if ($_REQUEST["new_type"]) {
            $class_name = $objDefinition->getClassName($_REQUEST["new_type"]);
 
            // Only set the fixed cmdClass if the next class is different to
            // the GUI class of the new object.
            // An example:
            // ilObjLinkResourceGUI tries to forward to ilLinkInputGUI (adding an internal link
            // when creating a link resource)
            // Without this fix, the cmdClass ilObjectCopyGUI would never be reached
            if (strtolower($ilCtrl->getNextClass($this)) != strtolower("ilObj" . $class_name . "GUI")) {
                $ilCtrl->setCmdClass("ilObj" . $class_name . "GUI");
            }
        }
 
        // root node
        $next_class = $ilCtrl->getNextClass();
        if (!$next_class) {
            $node = $this->tree->getNodeData($this->node_id);
            $next_class = "ilObj" . $objDefinition->getClassName($node["type"]) . "GUI";
            $ilCtrl->setCmdClass($next_class);
        }
        
        //  if we do this here the object can still change the breadcrumb
        $this->renderLocator();
        
        // current node
        $class_path = $ilCtrl->lookupClassPath($next_class);
        include_once($class_path);
        $class_name = $ilCtrl->getClassForClasspath($class_path);
        if ($_REQUEST["new_type"]) {
            $gui = new $class_name(null, ilObject2GUI::WORKSPACE_NODE_ID, $this->node_id);
            $gui->setCreationMode();
        } else {
            $gui = new $class_name($this->node_id, ilObject2GUI::WORKSPACE_NODE_ID, false);
        }
        $ilCtrl->forwardCommand($gui);
        if ($ilMainMenu->getMode() == ilMainMenuGUI::MODE_FULL) {
            $this->renderBack();
        }
 
        $tpl->setLocator();
    }

References $ctrl, $main_menu, $obj_definition, $tpl, ilMainMenuGUI\MODE_FULL, renderBack(), renderLocator(), settings(), ilWorkspaceGSToolProvider\SHOW_WS_TREE, and ilObject2GUI\WORKSPACE_NODE_ID.

Here is the call graph for this function:

◆ initTree()

ilPersonalWorkspaceGUI::initTree ( )

protected

Init personal tree.

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

    {
        $ilUser = $this->user;
 
        $user_id = $ilUser->getId();
 
        include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
        $this->tree = new ilWorkspaceTree($user_id);
        if (!$this->tree->getRootId()) {
            $this->tree->createTreeForUser($user_id);
        }
    }

References $ilUser, and $user.

Referenced by __construct().

Here is the caller graph for this function:

◆ renderBack()

ilPersonalWorkspaceGUI::renderBack ( )

protected

Definition at line 189 of file class.ilPersonalWorkspaceGUI.php.

    {
        $lng = $this->lng;
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        $root = $this->tree->getNodeData($this->node_id);
        if ($root["type"] != "wfld" && $root["type"] != "wsrt") {
            // do not override existing back targets, e.g. public user profile gui
            if (!$ilTabs->back_target) {
                $owner = $this->tree->lookupOwner($this->node_id);
                // workspace
                if ($owner == $ilUser->getId()) {
                    $parent = $this->tree->getParentNodeData($this->node_id);
                    if ($parent["wsp_id"]) {
                        if ($parent["type"] == "wsrt") {
                            $class = "ilobjworkspacerootfoldergui";
                        } else {
                            $class = "ilobjworkspacefoldergui";
                        }
                        $ilCtrl->setParameterByClass($class, "wsp_id", $parent["wsp_id"]);
                        $ilTabs->setBackTarget(
                            $lng->txt("back"),
                            $ilCtrl->getLinkTargetByClass($class, "")
                        );
                    }
                }
                // "shared by others"
                else {
                    $ilCtrl->setParameterByClass("ilobjworkspacerootfoldergui", "wsp_id", "");
                    $ilCtrl->setParameterByClass("ilobjworkspacerootfoldergui", "user", $owner);
                    $ilTabs->setBackTarget(
                        $lng->txt("back"),
                        $ilCtrl->getLinkTargetByClass("ilobjworkspacerootfoldergui", "share")
                    );
                }
            }
        }
    }

References $ctrl, $ilUser, $lng, $tabs, and $user.

Referenced by executeCommand().

Here is the caller graph for this function:

◆ renderLocator()

ilPersonalWorkspaceGUI::renderLocator ( )

protected

Build locator for current node.

Definition at line 233 of file class.ilPersonalWorkspaceGUI.php.

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilLocator = $this->locator;
        $tpl = $this->tpl;
        $objDefinition = $this->obj_definition;
 
        $ilLocator->clearItems();
        
        // we have no path if shared item
        $path = $this->tree->getPathFull($this->node_id);
        if ($path) {
            foreach ($path as $node) {
                $obj_class = "ilObj" . $objDefinition->getClassName($node["type"]) . "GUI";
 
                $ilCtrl->setParameter($this, "wsp_id", $node["wsp_id"]);
 
                switch ($node["type"]) {
                    case "wsrt":
                        $ilLocator->addItem($lng->txt("mm_personal_and_shared_r"), $ilCtrl->getLinkTargetByClass($obj_class, "render"));
                        break;
 
                    case "blog":
                    case $objDefinition->isContainer($node["type"]):
                        $ilLocator->addItem($node["title"], $ilCtrl->getLinkTargetByClass($obj_class, "render"));
                        break;
 
                    default:
                        $ilLocator->addItem($node["title"], $ilCtrl->getLinkTargetByClass($obj_class, "edit"));
                        break;
                }
            }
        }
 
        $ilCtrl->setParameter($this, "wsp_id", $this->node_id);
    }