ACL access handler GUI. More...

Collaboration diagram for ilWorkspaceAccessGUI:

Public Member Functions
	__construct (int $a_node_id, $a_access_handler, bool $a_is_portfolio=false, string $a_footer="")

	setBlockingMessage (string $a_val)

	getBlockingMessage ()

	executeCommand ()

	addPermissionHandler ()

	removePermission ()

Data Fields
const	PERMISSION_REGISTERED = -1

const	PERMISSION_ALL_PASSWORD = -3

const	PERMISSION_ALL = -5

Protected Member Functions
	setObjectTitle ()

	getAccessHandler ()

	share ()

	initPasswordForm ()

	showPasswordForm (ilPropertyFormGUI $a_form=null)

	savePasswordForm ()

Protected Attributes
bool	$is_portfolio

ilTabsGUI	$tabs

ilGlobalTemplateInterface	$tpl

ilToolbarGUI	$toolbar

ilObjUser	$user

ilSetting	$settings

ilCtrl	$ctrl

ilLanguage	$lng

int	$node_id

	$access_handler

string	$footer = ""

string	$blocking_message = ""

StandardGUIRequest	$std_request

Detailed Description

ACL access handler GUI.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om @ilCtrl_Calls ilWorkspaceAccessGUI: ilMailSearchCoursesGUI, ilMailSearchGroupsGUI @ilCtrl_Calls ilWorkspaceAccessGUI: ilMailSearchGUI, ilPublicUserProfileGUI, ilSingleUserShareGUI

Definition at line 28 of file class.ilWorkspaceAccessGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilWorkspaceAccessGUI::__construct	(	int	$a_node_id,
			$a_access_handler,
		bool	$a_is_portfolio = `false`,
		string	$a_footer = `""`
	)

Parameters

ilPortfolioAccessHandler | ilWorkspaceAccessHandler $a_access_handler

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

      {
        global $DIC;
 
        $this->tabs = $DIC->tabs();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->toolbar = $DIC->toolbar();
        $this->user = $DIC->user();
        $this->settings = $DIC->settings();
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();
 
        $this->ctrl = $ilCtrl;
        $this->lng = $lng;
        $this->node_id = $a_node_id;
        $this->access_handler = $a_access_handler;
        $this->is_portfolio = $a_is_portfolio;
        $this->footer = $a_footer;
        $this->std_request = new StandardGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );
    }

References $DIC, $lng, ILIAS\Repository\ctrl(), ILIAS\UI\examples\MainControls\Footer\footer(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ addPermissionHandler()

ilWorkspaceAccessGUI::addPermissionHandler ( )

Definition at line 250 of file class.ilWorkspaceAccessGUI.php.

                                          : void
    {
        switch ($this->std_request->getAction()) {
            case "user":
 
                if (ilUserAccountSettings::getInstance()->isUserAccessRestricted()) {
                    $this->ctrl->redirectByClass("ilsingleusersharegui");
                } else {
                    $this->ctrl->setParameterByClass("ilmailsearchgui", "ref", "wsp");
                    $this->ctrl->redirectByClass("ilmailsearchgui");
                }
                break;
 
            case "group":
                $this->ctrl->setParameterByClass("ilmailsearchgroupsgui", "ref", "wsp");
                $this->ctrl->redirectByClass("ilmailsearchgroupsgui");
                break;
 
            case "course":
                $this->ctrl->setParameterByClass("ilmailsearchcoursesgui", "ref", "wsp");
                $this->ctrl->redirectByClass("ilmailsearchcoursesgui");
                break;
 
            case "registered":
                $this->getAccessHandler()->addPermission($this->node_id, self::PERMISSION_REGISTERED);
                $this->tpl->setOnScreenMessage('success', $this->lng->txt("wsp_permission_registered_info"), true);
                $this->ctrl->redirect($this, "share");
                break;
 
            case "password":
                $this->showPasswordForm();
                break;
 
            case "all":
                $this->getAccessHandler()->addPermission($this->node_id, self::PERMISSION_ALL);
                $this->tpl->setOnScreenMessage('success', $this->lng->txt("wsp_permission_all_info"), true);
                $this->ctrl->redirect($this, "share");
        }
    }

References ILIAS\Repository\ctrl(), getAccessHandler(), ilUserAccountSettings\getInstance(), ILIAS\Repository\lng(), and showPasswordForm().

Here is the call graph for this function:

◆ executeCommand()

ilWorkspaceAccessGUI::executeCommand ( )

Definition at line 93 of file class.ilWorkspaceAccessGUI.php.

                                    : void
    {
        $ilTabs = $this->tabs;
        $tpl = $this->tpl;
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            case "ilmailsearchcoursesgui":
                $ilTabs->setBackTarget(
                    $this->lng->txt("back"),
                    $this->ctrl->getLinkTarget($this, "share")
                );
                $csearch = new ilMailSearchCoursesGUI($this->access_handler, $this->node_id);
                $this->ctrl->setReturn($this, 'share');
                $this->ctrl->forwardCommand($csearch);
 
                $this->setObjectTitle();
                break;
 
            case "ilmailsearchgroupsgui":
                $ilTabs->setBackTarget(
                    $this->lng->txt("back"),
                    $this->ctrl->getLinkTarget($this, "share")
                );
                $gsearch = new ilMailSearchGroupsGUI($this->access_handler, $this->node_id);
                $this->ctrl->setReturn($this, 'share');
                $this->ctrl->forwardCommand($gsearch);
 
                $this->setObjectTitle();
                break;
 
            case "ilmailsearchgui":
                $ilTabs->setBackTarget(
                    $this->lng->txt("back"),
                    $this->ctrl->getLinkTarget($this, "share")
                );
                $usearch = new ilMailSearchGUI($this->access_handler, $this->node_id);
                $this->ctrl->setReturn($this, 'share');
                $this->ctrl->forwardCommand($usearch);
 
                $this->setObjectTitle();
                break;
 
            case "ilsingleusersharegui":
                $ilTabs->setBackTarget(
                    $this->lng->txt("back"),
                    $this->ctrl->getLinkTarget($this, "share")
                );
                $ushare = new ilSingleUserShareGUI($this->access_handler, $this->node_id);
                $this->ctrl->setReturn($this, 'share');
                $this->ctrl->forwardCommand($ushare);
 
                $this->setObjectTitle();
                break;
 
            case "ilpublicuserprofilegui":
                $ilTabs->clearTargets();
                $ilTabs->setBackTarget(
                    $this->lng->txt("back"),
                    $this->ctrl->getLinkTarget($this, "share")
                );
 
                $prof = new ilPublicUserProfileGUI(
                    $this->std_request->getUser()
                );
                $prof->setBackUrl($this->ctrl->getLinkTarget($this, "share"));
                $tpl->setContent($prof->getHTML());
                break;
 
            default:
                // $this->prepareOutput();
                if (!$cmd) {
                    $cmd = "share";
                }
                //return $this->$cmd();
                $this->$cmd();
                break;
        }
    }

References $tabs, $tpl, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\setContent(), and setObjectTitle().

Here is the call graph for this function:

◆ getAccessHandler()

ilWorkspaceAccessGUI::getAccessHandler ( )

protected

Returns: ilPortfolioAccessHandler|ilWorkspaceAccessHandler

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

    {
        return $this->access_handler;
    }

References $access_handler.

Referenced by addPermissionHandler(), removePermission(), savePasswordForm(), and share().

Here is the caller graph for this function:

◆ getBlockingMessage()

ilWorkspaceAccessGUI::getBlockingMessage ( )

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

                                        : string
    {
        return $this->blocking_message;
    }

References $blocking_message.

Referenced by share().

Here is the caller graph for this function:

◆ initPasswordForm()

ilWorkspaceAccessGUI::initPasswordForm ( )

protected

Definition at line 301 of file class.ilWorkspaceAccessGUI.php.

                                         : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt("wsp_set_permission_all_password"));
 
        $password = new ilPasswordInputGUI($this->lng->txt("password"), "password");
        $password->setRequired(true);
        $form->addItem($password);
 
        $form->addCommandButton('savepasswordform', $this->lng->txt("save"));
        $form->addCommandButton('share', $this->lng->txt("cancel"));
 
        return $form;
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by savePasswordForm(), and showPasswordForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removePermission()

ilWorkspaceAccessGUI::removePermission ( )

Definition at line 290 of file class.ilWorkspaceAccessGUI.php.

                                      : void
    {
        $obj_id = $this->std_request->getObjId();
        if ($obj_id !== 0) {
            $this->getAccessHandler()->removePermission($this->node_id, $obj_id);
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("wsp_permission_removed"), true);
        }
 
        $this->ctrl->redirect($this, "share");
    }

References ILIAS\Repository\ctrl(), getAccessHandler(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ savePasswordForm()

ilWorkspaceAccessGUI::savePasswordForm ( )

protected

Definition at line 327 of file class.ilWorkspaceAccessGUI.php.

                                         : void
    {
        $form = $this->initPasswordForm();
        if ($form->checkInput()) {
            $this->getAccessHandler()->addPermission(
                $this->node_id,
                self::PERMISSION_ALL_PASSWORD,
                md5($form->getInput("password"))
            );
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("wsp_permission_all_pw_info"), true);
            $this->ctrl->redirect($this, "share");
        }
 
        $form->setValuesByPost();
        $this->showPasswordForm($form);
    }

References ILIAS\Repository\ctrl(), getAccessHandler(), initPasswordForm(), ILIAS\Repository\lng(), and showPasswordForm().

Here is the call graph for this function:

◆ setBlockingMessage()

ilWorkspaceAccessGUI::setBlockingMessage ( string $a_val )

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

                                                     : void
    {
        $this->blocking_message = $a_val;
    }

◆ setObjectTitle()

ilWorkspaceAccessGUI::setObjectTitle ( )

protected

Definition at line 174 of file class.ilWorkspaceAccessGUI.php.

                                       : void
    {
        $tpl = $this->tpl;
 
        if (!$this->is_portfolio) {
            $obj_id = $this->access_handler->getTree()->lookupObjectId($this->node_id);
        } else {
            $obj_id = $this->node_id;
        }
        $tpl->setTitle(ilObject::_lookupTitle($obj_id));
    }

References $node_id, $tpl, ilObject\_lookupTitle(), and ilGlobalTemplateInterface\setTitle().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ share()

ilWorkspaceAccessGUI::share ( )

protected

Definition at line 194 of file class.ilWorkspaceAccessGUI.php.

                              : void
    {
        $ilToolbar = $this->toolbar;
        $tpl = $this->tpl;
        $ilUser = $this->user;
        $ilSetting = $this->settings;
 
 
        // blocking message
        if ($this->getBlockingMessage() != "") {
            $tpl->setContent($this->getBlockingMessage());
            return;
        }
 
        $options = array();
        $options["user"] = $this->lng->txt("wsp_set_permission_single_user");
 
        $grp_ids = ilGroupParticipants::_getMembershipByType($ilUser->getId(), ['grp']);
        if (sizeof($grp_ids)) {
            $options["group"] = $this->lng->txt("wsp_set_permission_group");
        }
 
        $crs_ids = ilCourseParticipants::_getMembershipByType($ilUser->getId(), ['crs']);
        if (sizeof($crs_ids)) {
            $options["course"] = $this->lng->txt("wsp_set_permission_course");
        }
 
        if (!$this->getAccessHandler()->hasRegisteredPermission($this->node_id)) {
            $options["registered"] = $this->lng->txt("wsp_set_permission_registered");
        }
 
        if ($ilSetting->get("enable_global_profiles")) {
            if (!$this->getAccessHandler()->hasGlobalPasswordPermission($this->node_id)) {
                $options["password"] = $this->lng->txt("wsp_set_permission_all_password");
            }
 
            if (!$this->getAccessHandler()->hasGlobalPermission($this->node_id)) {
                $options["all"] = $this->lng->txt("wsp_set_permission_all");
            }
        }
 
        $actions = new ilSelectInputGUI("", "action");
        $actions->setOptions($options);
        $ilToolbar->addStickyItem($actions);
 
        $ilToolbar->setFormAction($this->ctrl->getFormAction($this));
 
        $button = ilSubmitButton::getInstance();
        $button->setCaption("add");
        $button->setCommand("addpermissionhandler");
        $ilToolbar->addStickyItem($button);
 
        $table = new ilWorkspaceAccessTableGUI($this, "share", $this->node_id, $this->getAccessHandler());
        $tpl->setContent($table->getHTML() . $this->footer);
    }

References $ilSetting, $ilUser, $settings, $toolbar, $tpl, $user, ilParticipants\_getMembershipByType(), ILIAS\Repository\ctrl(), getAccessHandler(), getBlockingMessage(), ilSubmitButton\getInstance(), ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setContent().

Here is the call graph for this function:

◆ showPasswordForm()

ilWorkspaceAccessGUI::showPasswordForm ( ilPropertyFormGUI $a_form = null )

protected

Definition at line 317 of file class.ilWorkspaceAccessGUI.php.

                                                                         : void
    {
        $tpl = $this->tpl;
 
        if (!$a_form) {
            $a_form = $this->initPasswordForm();
        }
        $tpl->setContent($a_form->getHTML());
    }