ilWorkspaceAccessGUI Class Reference

ACL access handler GUI. More...

Collaboration diagram for ilWorkspaceAccessGUI:

Public Member Functions
	__construct ($a_node_id, $a_access_handler, $a_is_portfolio=false, $a_footer=null)
	executeCommand ()
	addPermissionHandler ()
	removePermission ()

Data Fields
const	PERMISSION_REGISTERED = -1
const	PERMISSION_ALL_PASSWORD = -3
const	PERMISSION_ALL = -5

Protected Member Functions
	setObjectTitle ()
	restore object title More...
	getAccessHandler ()
	share ()
	initPasswordForm ()
	showPasswordForm (ilPropertyFormGUI $a_form=null)
	savePasswordForm ()

Protected Attributes
	$ctrl
	$lng
	$node_id
	$access_handler
	$footer

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

Version

$Id$

ilWorkspaceAccessGUI: ilMailSearchCoursesGUI, ilMailSearchGroupsGUI ilWorkspaceAccessGUI: ilMailSearchGUI, ilPublicUserProfileGUI, ilSingleUserShareGUI

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

Constructor & Destructor Documentation

__construct()

ilWorkspaceAccessGUI::__construct	(		$a_node_id,
			$a_access_handler,
			$a_is_portfolio = false,
			$a_footer = null
	)

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

References $ilCtrl, and $lng.

        {
                global $ilCtrl, $lng;
                
                $this->ctrl = $ilCtrl;
                $this->lng = $lng;
                $this->node_id = $a_node_id;
                $this->access_handler = $a_access_handler;              
                $this->is_portfolio = (bool)$a_is_portfolio;
                $this->footer = $a_footer;              
        }

Member Function Documentation

addPermissionHandler()

ilWorkspaceAccessGUI::addPermissionHandler

(

)

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

References $_REQUEST, getAccessHandler(), ilUserAccountSettings\getInstance(), ilUtil\sendSuccess(), and showPasswordForm().

        {
                switch($_REQUEST["action"])
                {
                        case "user":
                                include_once './Services/User/classes/class.ilUserAccountSettings.php';
                                if(ilUserAccountSettings::getInstance()->isUserAccessRestricted())
                                {
                                        $this->ctrl->redirectByClass("ilsingleusersharegui");
                                }
                                else
                                {
                                        $this->ctrl->setParameterByClass("ilmailsearchgui", "ref", "wsp");
                                        $this->ctrl->redirectByClass("ilmailsearchgui");
                                }
                        
                        case "group":
                                $this->ctrl->setParameterByClass("ilmailsearchgroupsgui", "ref", "wsp");
                                $this->ctrl->redirectByClass("ilmailsearchgroupsgui");
                        
                        case "course":
                                $this->ctrl->setParameterByClass("ilmailsearchcoursesgui", "ref", "wsp");
                                $this->ctrl->redirectByClass("ilmailsearchcoursesgui");
                        
                        case "registered":                              
                                $this->getAccessHandler()->addPermission($this->node_id, self::PERMISSION_REGISTERED);
                                ilUtil::sendSuccess($this->lng->txt("wsp_permission_registered_info"), true);
                                $this->ctrl->redirect($this, "share");
                        
                        case "password":
                                $this->showPasswordForm();
                                break;
                        
                        case "all":
                                $this->getAccessHandler()->addPermission($this->node_id, self::PERMISSION_ALL);
                                ilUtil::sendSuccess($this->lng->txt("wsp_permission_all_info"), true);
                                $this->ctrl->redirect($this, "share");
                }
        }

Here is the call graph for this function:

executeCommand()

ilWorkspaceAccessGUI::executeCommand

(

)

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

References $_REQUEST, $cmd, $ilErr, $tpl, getAccessHandler(), and setObjectTitle().

        {
                global $ilTabs, $tpl, $ilErr;

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

                if (!$this->getAccessHandler()->checkAccess("write", "", $this->node_id))
                {
                        $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->WARNING);
                }

                switch($next_class)
                {
                        case "ilmailsearchcoursesgui";                                                  
                                $ilTabs->setBackTarget($this->lng->txt("back"),
                                        $this->ctrl->getLinkTarget($this, "share"));
                                include_once('Services/Contact/classes/class.ilMailSearchCoursesGUI.php');
                                $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"));
                                include_once('Services/Contact/classes/class.ilMailSearchGroupsGUI.php');
                                $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"));
                                include_once('Services/Contact/classes/class.ilMailSearchGUI.php');
                                $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"));
                                include_once('Services/PersonalWorkspace/classes/class.ilSingleUserShareGUI.php');
                                $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"));    
                                
                                include_once('./Services/User/classes/class.ilPublicUserProfileGUI.php');
                                $prof = new ilPublicUserProfileGUI($_REQUEST["user"]);
                                $prof->setBackUrl($this->ctrl->getLinkTarget($this, "share"));
                                $tpl->setContent($prof->getHTML());
                                break;

                        default:
                                // $this->prepareOutput(); 
                                if(!$cmd)
                                {
                                        $cmd = "share";
                                }
                                return $this->$cmd();
                }

                return true;
        }

Here is the call graph for this function:

getAccessHandler()

ilWorkspaceAccessGUI::getAccessHandler ( )

protected

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

References $access_handler.

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

        {
                return $this->access_handler;
        }

Here is the caller graph for this function:

initPasswordForm()

ilWorkspaceAccessGUI::initPasswordForm ( )

protected

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

References ilFormPropertyGUI\setRequired().

Referenced by savePasswordForm(), and showPasswordForm().

        {
                include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
                $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;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

removePermission()

ilWorkspaceAccessGUI::removePermission

(

)

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

References $_REQUEST, getAccessHandler(), and ilUtil\sendSuccess().

        {
                if($_REQUEST["obj_id"])
                {
                        $this->getAccessHandler()->removePermission($this->node_id, (int)$_REQUEST["obj_id"]);
                    ilUtil::sendSuccess($this->lng->txt("wsp_permission_removed"), true);
                }

                $this->ctrl->redirect($this, "share");
        }

Here is the call graph for this function:

savePasswordForm()

ilWorkspaceAccessGUI::savePasswordForm ( )

protected

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

References getAccessHandler(), initPasswordForm(), ilUtil\sendSuccess(), and showPasswordForm().

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

Here is the call graph for this function:

setObjectTitle()

ilWorkspaceAccessGUI::setObjectTitle ( )

protected

restore object title

Returns

string

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

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

Referenced by executeCommand().

        {
                global $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));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

share()

ilWorkspaceAccessGUI::share ( )

protected

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

References $ilSetting, $ilUser, $options, $tpl, ilParticipants\_getMembershipByType(), getAccessHandler(), and ilSubmitButton\getInstance().

        {
                global $ilToolbar, $tpl, $ilUser, $ilSetting;
                
                $options = array();
                $options["user"] = $this->lng->txt("wsp_set_permission_single_user");
                
                include_once 'Modules/Group/classes/class.ilGroupParticipants.php';
                $grp_ids = ilGroupParticipants::_getMembershipByType($ilUser->getId(), 'grp');
                if(sizeof($grp_ids))
                {                       
                        $options["group"] = $this->lng->txt("wsp_set_permission_group");
                }
                
                include_once 'Modules/Course/classes/class.ilCourseParticipants.php';
                $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");            
                        }
                }
                
                include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
                $actions = new ilSelectInputGUI("", "action");          
                $actions->setOptions($options);         
                $ilToolbar->addStickyItem($actions);
                
                $ilToolbar->setFormAction($this->ctrl->getFormAction($this));           
                
                include_once "Services/UIComponent/Button/classes/class.ilSubmitButton.php";
                $button = ilSubmitButton::getInstance();
                $button->setCaption("add");
                $button->setCommand("addpermissionhandler");
                $ilToolbar->addStickyItem($button);
        
                include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceAccessTableGUI.php";
                $table = new ilWorkspaceAccessTableGUI($this, "share", $this->node_id, $this->getAccessHandler());
                $tpl->setContent($table->getHTML().$this->footer);
        }

Here is the call graph for this function:

showPasswordForm()

ilWorkspaceAccessGUI::showPasswordForm ( ilPropertyFormGUI  $a_form = null )

protected

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

References $tpl, and initPasswordForm().

Referenced by addPermissionHandler(), and savePasswordForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access_handler

ilWorkspaceAccessGUI::$access_handler

protected

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

Referenced by getAccessHandler().

$ctrl

ilWorkspaceAccessGUI::$ctrl

protected

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

$footer

ilWorkspaceAccessGUI::$footer

protected

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

$lng

ilWorkspaceAccessGUI::$lng

protected

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

Referenced by __construct().

$node_id

ilWorkspaceAccessGUI::$node_id

protected

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

Referenced by setObjectTitle().

PERMISSION_ALL

const ilWorkspaceAccessGUI::PERMISSION_ALL = -5

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

Referenced by ilPortfolioAccessHandler\checkAccessOfUser(), ilWorkspaceAccessHandler\checkAccessOfUser(), ilWorkspaceShareTableGUI\fillRow(), ilWorkspaceAccessHandler\findSharedObjects(), ilPortfolioAccessHandler\findSharedObjects(), ilWorkspaceAccessHandler\getPermissions(), ilWorkspaceAccessHandler\getPossibleSharedTargets(), ilPortfolioAccessHandler\getPossibleSharedTargets(), ilSharedResourceGUI\hasAccess(), ilPortfolioAccessHandler\hasGlobalPermission(), ilWorkspaceAccessHandler\hasGlobalPermission(), ilWorkspaceAccessTableGUI\importData(), and ilPortfolioRepositoryGUI\setDefaultGlobal().

PERMISSION_ALL_PASSWORD

const ilWorkspaceAccessGUI::PERMISSION_ALL_PASSWORD = -3

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

Referenced by ilPortfolioAccessHandler\checkAccessOfUser(), ilWorkspaceAccessHandler\checkAccessOfUser(), ilObjWorkspaceFolderGUI\copyShared(), ilWorkspaceShareTableGUI\fillRow(), ilWorkspaceAccessHandler\findSharedObjects(), ilPortfolioAccessHandler\findSharedObjects(), ilWorkspaceAccessHandler\getPermissions(), ilWorkspaceAccessHandler\getPossibleSharedTargets(), ilPortfolioAccessHandler\getPossibleSharedTargets(), ilWorkspaceAccessHandler\getSharedNodePassword(), ilPortfolioAccessHandler\getSharedNodePassword(), ilSharedResourceGUI\hasAccess(), ilPortfolioAccessHandler\hasGlobalPasswordPermission(), ilWorkspaceAccessHandler\hasGlobalPasswordPermission(), and ilWorkspaceAccessTableGUI\importData().

PERMISSION_REGISTERED

const ilWorkspaceAccessGUI::PERMISSION_REGISTERED = -1

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

Referenced by ilPortfolioAccessHandler\checkAccessOfUser(), ilWorkspaceAccessHandler\checkAccessOfUser(), ilWorkspaceShareTableGUI\fillRow(), ilWorkspaceAccessHandler\findSharedObjects(), ilPortfolioAccessHandler\findSharedObjects(), ilWorkspaceAccessHandler\getPossibleSharedTargets(), ilPortfolioAccessHandler\getPossibleSharedTargets(), ilPortfolioAccessHandler\hasRegisteredPermission(), ilWorkspaceAccessHandler\hasRegisteredPermission(), ilWorkspaceAccessTableGUI\importData(), and ilPortfolioRepositoryGUI\setDefaultRegistered().

---

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

• Services/PersonalWorkspace/classes/class.ilWorkspaceAccessGUI.php