GUI class for personal workspace. More...

Collaboration diagram for ilPersonalWorkspaceGUI:

Public Member Functions
	executeCommand ()

Protected Member Functions
	initTree ()

	renderBack ()

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

Protected Attributes
ilSetting	$settings

ilCtrl	$ctrl

ilLanguage	$lng

ilHelpGUI	$help

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilObjUser	$user

ilTabsGUI	$tabs

ilLocatorGUI	$locator

ilTree	$tree

int	$node_id

ContextServices	$tool_context

StandardGUIRequest	$std_request

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

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

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

Member Function Documentation

◆ executeCommand()

ilPersonalWorkspaceGUI::executeCommand ( )

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

References $ctrl, $obj_definition, $tpl, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), renderLocator(), ILIAS\UICore\GlobalTemplate\setLocator(), ILIAS\Repository\settings(), ilWorkspaceGSToolProvider\SHOW_WS_TREE, and ilObject2GUI\WORKSPACE_NODE_ID.

                                     : void
     {
         $ilCtrl = $this->ctrl;
         $objDefinition = $this->obj_definition;
         $tpl = $this->tpl;
 
         if ($this->settings->get("disable_personal_workspace")) {
             throw new ilException($this->lng->txt("no_permission"));
         }
 
         $ilCtrl->setReturn($this, "render");
 
         if (!in_array($ilCtrl->getCmd(), ["shareFilter"]) &&
             !in_array(strtolower($ilCtrl->getCmdClass()), ["ilobjectownershipmanagementgui"])
         ) {
             $this->tool_context->current()->addAdditionalData(ilWorkspaceGSToolProvider::SHOW_WS_TREE, true);
         }
 
         // new type
         if ($this->std_request->getNewType()) {
             $class_name = $objDefinition->getClassName(
                 $this->std_request->getNewType()
             );
 
             // 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")) {
                 $this->ctrl->setParameterByClass("ilObj" . $class_name . "GUI", "new_type", $this->std_request->getNewType());
                 $ilCtrl->redirectByClass("ilObj" . $class_name . "GUI", $ilCtrl->getCmd());
             }
         }
 
         // 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->redirectByClass($next_class, $ilCtrl->getCmd());
         }
 
         //  if we do this here the object can still change the breadcrumb
         $this->renderLocator();
 
         // current node
         $class_path = $ilCtrl->lookupClassPath($next_class);
         $class_name = $ilCtrl->getClassForClasspath($class_path);
         if ($this->std_request->getNewType()) {
             $gui = new $class_name(0, 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);
 
         //$this->renderBack();
 
         $tpl->setLocator();
     }

Here is the call graph for this function:

◆ initTree()

ilPersonalWorkspaceGUI::initTree ( )

protected

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

References $user, and $user_id.

                                  : void
     {
         $ilUser = $this->user;
 
         $user_id = $ilUser->getId();
 
         $this->tree = new ilWorkspaceTree($user_id);
         if (!$this->tree->getRootId()) {
             $this->tree->createTreeForUser($user_id);
         }
     }

◆ renderBack()

ilPersonalWorkspaceGUI::renderBack ( )

protected

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

References $ctrl, $lng, $tabs, $user, and ilLanguage\txt().

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

Here is the call graph for this function:

◆ renderLocator()

ilPersonalWorkspaceGUI::renderLocator ( )

protected

Build locator for current node.

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

References $ctrl, $lng, $locator, $obj_definition, $path, and ilLanguage\txt().

Referenced by executeCommand().

                                       : void
     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
         $ilLocator = $this->locator;
         $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);
     }