ilRepositoryGUI Class Reference

Class ilRepositoryGUI. More...

Inheritance diagram for ilRepositoryGUI:

Collaboration diagram for ilRepositoryGUI:

Public Member Functions
	executeCommand ()
	show ()
	showRepTree ()

Data Fields
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
ilTree	$tree
ilRbacSystem	$rbacsystem
int	$cur_ref_id
string	$cmd
string	$mode = ""
ilCtrl	$ctrl

Protected Member Functions
	redirectToRoot ()

Protected Attributes
ilObjectDefinition	$objDefinition
ilLogger	$log
ilObjUser	$user
ilSetting	$settings
ilHelpGUI	$help
ilErrorHandling	$error
ilAccessHandler	$access
ContextServices	$tool_context
StandardGUIRequest	$request
bool	$creation_mode
ilObjectGUI	$gui_obj

Private Attributes
ILIAS HTTP Services	$http

Detailed Description

Class ilRepositoryGUI.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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 ilRepositoryGUI: ilPermissionGUI

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

Member Function Documentation

executeCommand()

ilRepositoryGUI::executeCommand

(

)

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

References $cmd, $error, $help, $ilErr, $lng, $rbacsystem, ilObject\_lookupType(), ilRbacSystem\checkAccess(), ILIAS\Repository\ctrl(), ilPublicSectionSettings\getInstance(), ilLoggerFactory\getLogger(), ILIAS\FileDelivery\http(), ilHelpGUI\ID_PART_SCREEN, null, ilObject2GUI\REPOSITORY_NODE_ID, show(), ilLanguage\txt(), and ILIAS\Repository\user().

                                    : void
    {
        $rbacsystem = $this->rbacsystem;
        $lng = $this->lng;
        $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();

        // check creation mode
        // determined by "new_type" parameter
        $new_type = $this->request->getNewType();

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

        $cmd = $this->ctrl->getCmd();

        // determine next class
        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->setParameterByClass($next_class, "new_type", $new_type);
                $this->ctrl->redirectByClass($next_class, $this->ctrl->getCmd());
            }
        } elseif ((($next_class = $this->ctrl->getNextClass($this)) == "")
            || ($next_class === "ilrepositorygui" && $this->ctrl->getCmd() === "return")) {
            // 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");

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

            if ($this->ctrl->getCmd() !== "showRepTree") {
                $this->ctrl->redirectByClass($next_class, $this->ctrl->getCmd());
            }
        }

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

        switch ($next_class) {
            // forward asynchronous file uploads to the upload handler.
            // possible via dropzones in list guis or global template
            // sections like title.
            case strtolower(ilObjFileUploadHandlerGUI::class):
                $this->ctrl->forwardCommand(new ilObjFileUploadHandlerGUI());
                break;

            default:
                // forward all other classes to gui commands
                if ($next_class !== null && $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);
                        }
                    } elseif (is_subclass_of($class_name, "ilObject2GUI")) {
                        $this->gui_obj = new $class_name(0, ilObject2GUI::REPOSITORY_NODE_ID, $this->cur_ref_id);
                    } else {
                        $this->gui_obj = new $class_name("", 0, true, false);
                    }
                    $this->gui_obj->setCreationMode($this->creation_mode);
                    $this->ctrl->setReturn($this, "return");

                    $this->show();
                } else {        //
                    $cmd = (string) $this->ctrl->getCmd("");

                    // check read access for category
                    if ($cmd !== "showRepTree" && $this->cur_ref_id > 0 && !$rbacsystem->checkAccess("read", $this->cur_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:

redirectToRoot()

ilRepositoryGUI::redirectToRoot ( )

protected

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

References $ctrl, ilCtrl\redirectByClass(), and ilCtrl\setParameterByClass().

                                       : void
    {
        $ctrl = $this->ctrl;
        $ctrl->setParameterByClass(
            self::class,
            "ref_id",
            $this->tree->getRootId()
        );

        $ctrl->redirectByClass(self::class, "");
    }

Here is the call graph for this function:

show()

ilRepositoryGUI::show

(

)

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

References ILIAS\Repository\ctrl().

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

showRepTree()

ilRepositoryGUI::showRepTree

(

)

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

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

Field Documentation

$access

ilAccessHandler ilRepositoryGUI::$access

protected

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

$cmd

string ilRepositoryGUI::$cmd

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

Referenced by executeCommand().

$creation_mode

bool ilRepositoryGUI::$creation_mode

protected

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

$ctrl

ilCtrl ilRepositoryGUI::$ctrl

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

Referenced by redirectToRoot().

$cur_ref_id

int ilRepositoryGUI::$cur_ref_id

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

$error

ilErrorHandling ilRepositoryGUI::$error

protected

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

Referenced by executeCommand().

$gui_obj

ilObjectGUI ilRepositoryGUI::$gui_obj

protected

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

$help

ilHelpGUI ilRepositoryGUI::$help

protected

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

Referenced by executeCommand().

$http

ILIAS HTTP Services ilRepositoryGUI::$http

private

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

$lng

ilLanguage ilRepositoryGUI::$lng

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

Referenced by executeCommand().

$log

ilLogger ilRepositoryGUI::$log

protected

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

$mode

string ilRepositoryGUI::$mode = ""

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

$objDefinition

ilObjectDefinition ilRepositoryGUI::$objDefinition

protected

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

$rbacsystem

ilRbacSystem ilRepositoryGUI::$rbacsystem

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

Referenced by executeCommand().

$request

StandardGUIRequest ilRepositoryGUI::$request

protected

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

$settings

ilSetting ilRepositoryGUI::$settings

protected

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

$tool_context

ContextServices ilRepositoryGUI::$tool_context

protected

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

$tpl

ilGlobalTemplateInterface ilRepositoryGUI::$tpl

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

$tree

ilTree ilRepositoryGUI::$tree

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

$user

ilObjUser ilRepositoryGUI::$user

protected

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

---

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

• components/ILIAS/Repository/classes/class.ilRepositoryGUI.php