This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilObjectPermissionStatusGUI:

Public Member Functions
	__construct (ilObject $a_obj)
	Constructor public. More...

	executeCommand ()
	execute command More...

	perminfo ()
	cmd function More...

	addToolbar ()
	Creates Toolbar entries. More...

	accessStatusInfo ()
	Access- and Statusinformation Info. More...

	accessPermissionsTable ()
	Access Permissions Table. More...

	getAssignedValidRoles ()
	get Assigned Valid Roles More...

	getCommands (string $a_type)
	get Commands More...

	getUser ()
	ilUser More...

	getAccessStatusInfoData ()
	Access Status Info Data. More...

	getAccessPermissionTableData ()
	Access Permissions Table Data. More...

Data Fields
ilObjUser	$user

const	IMG_OK = 0

const	IMG_NOT_OK = 1

Protected Attributes
ilLanguage	$lng

ilCtrlInterface	$ctrl

ilGlobalTemplateInterface	$tpl

ilObject	$object

ilRbacReview	$rbacreview

ilToolbarGUI	$toolbar

array	$user_roles

array	$global_roles

array	$valid_roles

array	$assigned_valid_roles

Private Member Functions
	availableRolesTable ()
	Available Roles Table. More...

	getAvailableRolesTableData ()
	Available Roles Table Data. More...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning This class displays the permission status of a user concerning a specific object. ("Permissions" -> "Permission of User")

Author: Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de

Version: $Id$ ilObjectPermissionStatusGUI: ilRepositorySearchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectPermissionStatusGUI::__construct ( ilObject $a_obj )

Constructor public.

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

References $DIC, ILIAS\Repository\ctrl(), getAssignedValidRoles(), getUser(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->object = $a_obj;
         $this->rbacreview = $DIC->rbac()->review();
         $this->toolbar = $DIC->toolbar();
 
         $this->user = $this->getUser();
         $this->user_roles = $this->rbacreview->assignedRoles($this->user->getId());
         $this->global_roles = $this->rbacreview->getGlobalRoles();
         $this->valid_roles = $this->rbacreview->getParentRoleIds($this->object->getRefId());
         $this->assigned_valid_roles = $this->getAssignedValidRoles();
     }

Here is the call graph for this function:

Member Function Documentation

◆ accessPermissionsTable()

ilObjectPermissionStatusGUI::accessPermissionsTable ( )

Access Permissions Table.

Definition at line 144 of file class.ilObjectPermissionStatusGUI.php.

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

Referenced by perminfo().

                                             : string
     {
         $table = new ilAccessPermissionsStatusTableGUI($this, "perminfo");
 
         $table->setData($this->getAccessPermissionTableData());
         $table->setTitle($this->lng->txt("info_access_permissions"));
 
         return $table->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ accessStatusInfo()

ilObjectPermissionStatusGUI::accessStatusInfo ( )

Access- and Statusinformation Info.

Definition at line 127 of file class.ilObjectPermissionStatusGUI.php.

References $data, ILIAS\Repository\ctrl(), getAccessStatusInfoData(), and ILIAS\Repository\lng().

Referenced by perminfo().

                                       : string
     {
         $info = new ilInfoScreenGUI(new stdClass());
         $info->setFormAction($this->ctrl->getFormAction($this));
 
         $info->addSection($this->lng->txt("info_access_and_status_info"));
 
         foreach ($this->getAccessStatusInfoData() as $data) {
             $info->addProperty($data[0], $data[1]);
         }
 
         return $info->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addToolbar()

ilObjectPermissionStatusGUI::addToolbar ( )

Creates Toolbar entries.

Definition at line 109 of file class.ilObjectPermissionStatusGUI.php.

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

Referenced by perminfo().

                                 : void
     {
         $this->toolbar->setFormAction($this->ctrl->getFormAction($this, "perminfo"));
         $this->toolbar->addText($this->lng->txt('user'));
 
         $login = new ilTextInputGUI($this->lng->txt("username"), "user_login");
         $login->setDataSource($this->ctrl->getLinkTargetByClass([get_class($this),
                                                                       'ilRepositorySearchGUI'
         ], 'doUserAutoComplete', '', true));
         $login->setSize(15);
         $login->setValue($this->user->getLogin());
         $this->toolbar->addInputItem($login);
         $this->toolbar->addFormButton($this->lng->txt("info_change_user_view"), "perminfo");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ availableRolesTable()

ilObjectPermissionStatusGUI::availableRolesTable ( )

private

Available Roles Table.

Returns: string HTML

Definition at line 158 of file class.ilObjectPermissionStatusGUI.php.

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

Referenced by perminfo().

                                           : string
     {
         $table = new ilAvailableRolesStatusTableGUI($this, "perminfo");
 
         $table->setData($this->getAvailableRolesTableData());
         $table->setTitle($this->lng->txt("info_available_roles"));
 
         return $table->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjectPermissionStatusGUI::executeCommand ( )

execute command

Definition at line 71 of file class.ilObjectPermissionStatusGUI.php.

References ILIAS\Repository\ctrl().

                                     : void
     {
         // determine next class in the call structure
         $next_class = $this->ctrl->getNextClass($this);
 
         switch ($next_class) {
             case 'ilrepositorysearchgui':
                 $rep_search = new ilRepositorySearchGUI();
                 $this->ctrl->setReturn($this, 'perminfo');
                 $this->ctrl->forwardCommand($rep_search);
                 break;
 
             default:
                 $cmd = $this->ctrl->getCmd();
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ getAccessPermissionTableData()

ilObjectPermissionStatusGUI::getAccessPermissionTableData ( )

Access Permissions Table Data.

Definition at line 340 of file class.ilObjectPermissionStatusGUI.php.

References $DIC, ilRbacReview\_getOperationList(), getAssignedValidRoles(), ILIAS\Repository\lng(), ilObjectPlugin\lookupTxtById(), ILIAS\Repository\object(), and ILIAS\Repository\user().

Referenced by accessPermissionsTable().

                                                   : array
     {
         global $DIC;
 
         $ilAccess = $DIC['ilAccess'];
         $ilObjDataCache = $DIC['ilObjDataCache'];
         $objDefinition = $DIC['objDefinition'];
 
         // get all possible operation of current object
         $ops_list = ilRbacReview::_getOperationList($this->object->getType());
 
         $counter = 0;
         $result_set = [];
 
         // check permissions of user
         foreach ($ops_list as $ops) {
             $access = $ilAccess->doRBACCheck(
                 $ops['operation'],
                 "info",
                 $this->object->getRefId(),
                 $this->user->getId(),
                 $this->object->getType()
             );
 
             $result_set[$counter]["img"] = $access ? self::IMG_OK : self::IMG_NOT_OK;
 
             if (substr($ops['operation'], 0, 7) == "create_" &&
                 $objDefinition->isPlugin(substr($ops['operation'], 7))) {
                 $result_set[$counter]["operation"] = ilObjectPlugin::lookupTxtById(
                     substr($ops['operation'], 7),
                     'obj_' . substr($ops['operation'], 7)
                 );
             } elseif ($objDefinition->isPlugin($this->object->getType())) {
                 $result_set[$counter]["operation"] = ilObjectPlugin::lookupTxtById(
                     $this->object->getType(),
                     $this->object->getType() . "_" . $ops['operation']
                 );
             } elseif (substr($ops['operation'], 0, 7) == 'create_') {
                 $result_set[$counter]["operation"] = $this->lng->txt('rbac_' . $ops['operation']);
             } else {
                 $result_set[$counter]["operation"] = $this->lng->txt($this->object->getType() . "_" . $ops['operation']);
             }
 
             $list_role = [];
 
             // Check ownership
             if ($this->user->getId() == $ilObjDataCache->lookupOwner($this->object->getId())) {
                 if (
                     (substr($ops['operation'], 0, 7) !== 'create_') and
                     ($ops['operation'] !== 'edit_permission') and
                     ($ops['operation'] !== 'edit_learning_progress')
                 ) {
                     $list_role[] = $this->lng->txt('info_owner_of_object');
                 }
             }
             // get operations on object for each assigned role to user
             foreach ($this->getAssignedValidRoles() as $role) {
                 if (in_array($ops['ops_id'], $role['ops'])) {
                     $list_role[] = $role['translation'];
                 }
             }
 
             if (empty($list_role)) {
                 $list_role[] = $this->lng->txt('none');
             }
 
             $result_set[$counter]["role_ownership"] = $list_role;
 
             ++$counter;
         }
 
         return $result_set;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAccessStatusInfoData()

ilObjectPermissionStatusGUI::getAccessStatusInfoData ( )

Access Status Info Data.

Definition at line 253 of file class.ilObjectPermissionStatusGUI.php.

References $DIC, getAssignedValidRoles(), getCommands(), ilAccessInfo\IL_NO_PARENT_ACCESS, ilAccessInfo\IL_STATUS_MESSAGE, ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\user().

Referenced by accessStatusInfo().

                                              : array
     {
         global $DIC;
 
         $ilAccess = $DIC['ilAccess'];
         $infos = [];
 
         $result_set[0][] = $this->lng->txt('user');
         $result_set[0][] = $this->user->getFullname() . " (#" . $this->user->getId() . ")";
 
         $assigned_valid_roles = [];
 
         foreach ($this->getAssignedValidRoles() as $role) {
             $assigned_valid_roles[] = $role["translation"];
         }
 
         $roles_str = implode(", ", $assigned_valid_roles);
 
         $result_set[1][] = $this->lng->txt("roles");
         $result_set[1][] = $roles_str;
 
         $result_set[2][] = $this->lng->txt("status");
 
         $ilAccess->clear();
         $ilAccess->checkAccessOfUser(
             $this->user->getId(),
             'read',
             '',
             $this->object->getRefId(),
             $this->object->getType(),
             $this->object->getId()
         );
 
         $infos = array_merge($infos, $ilAccess->getInfo());
 
         $cmds = $this->getCommands($this->object->getType());
 
         foreach ($cmds as $cmd) {
             if (count($cmd) === 0) {
                 continue;
             }
             $ilAccess->clear();
             $ilAccess->doStatusCheck(
                 $cmd['permission'],
                 $cmd['cmd'],
                 $this->object->getRefId(),
                 $this->user->getId(),
                 $this->object->getId(),
                 $this->object->getType()
             );
             $infos = array_merge($infos, $ilAccess->getInfo());
         }
 
         $alert = "il_ItemAlertProperty";
         $okay = "il_ItemOkayProperty";
         $text = "";
 
         if ($infos === []) {
             $text = "<span class=\"" . $okay . "\">" . $this->lng->txt("access") . "</span><br/> ";
         } else {
             foreach ($infos as $info) {
                 switch ($info['type']) {
                     case ilAccessInfo::IL_STATUS_MESSAGE:
                         $text .= "<span class=\"" . $okay . "\">" . $info['text'] . "</span><br/> ";
                         break;
 
                     case ilAccessInfo::IL_NO_PARENT_ACCESS:
                         $factory = new ilObjectFactory();
                         $obj = $factory->getInstanceByRefId((int) $info['data']);
                         $text .= "<span class=\"" . $alert . "\">" . $info['text'] . " (" . $this->lng->txt("obj_" . $obj->getType()) . " #" . $obj->getId() . ": " . $obj->getTitle() . ")</span><br/> ";
                         break;
 
                     default:
                         $text .= "<span class=\"" . $alert . "\">" . $info['text'] . "</span><br/> ";
                         break;
                 }
             }
         }
 
         $result_set[2][] = $text;
 
         return $result_set;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignedValidRoles()

ilObjectPermissionStatusGUI::getAssignedValidRoles ( )

get Assigned Valid Roles

Definition at line 171 of file class.ilObjectPermissionStatusGUI.php.

References $assigned_valid_roles, ilRbacReview\_getOperationList(), ilObjRole\_getTranslation(), ILIAS\Repository\int(), ILIAS\Repository\object(), and SYSTEM_ROLE_ID.

Referenced by __construct(), getAccessPermissionTableData(), and getAccessStatusInfoData().

                                            : array
     {
         $assigned_valid_roles = [];
 
         $ops = [];
         foreach ($this->valid_roles as $role) {
             $role_id = (int) $role["obj_id"];
             if (in_array($role_id, $this->user_roles)) {
                 if ($role_id === SYSTEM_ROLE_ID) {
                     // get all possible operation of current object
                     $ops_list = ilRbacReview::_getOperationList($this->object->getType());
 
                     foreach ($ops_list as $ops_data) {
                         $ops[] = (int) $ops_data['ops_id'];
                     }
 
                     $role['ops'] = $ops;
                 } else {
                     $role['ops'] = $this->rbacreview->getRoleOperationsOnObject(
                         $role_id,
                         $this->object->getRefId()
                     );
                 }
 
                 $role['translation'] = str_replace(" ", "&nbsp;", ilObjRole::_getTranslation($role["title"]));
                 $assigned_valid_roles[] = $role;
             }
         }
         $this->assigned_valid_roles = $assigned_valid_roles;
         return $assigned_valid_roles;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAvailableRolesTableData()

ilObjectPermissionStatusGUI::getAvailableRolesTableData ( )

private

Available Roles Table Data.

Definition at line 417 of file class.ilObjectPermissionStatusGUI.php.

References $DIC, $path, ilObjRole\_getTranslation(), ilObjRole\_removeObjectId(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilObjectPlugin\lookupTxtById(), and ILIAS\Repository\object().

Referenced by availableRolesTable().

                                                  : array
     {
         global $DIC;
 
         $tree = $DIC['tree'];
 
         $path = array_reverse($tree->getPathId($this->object->getRefId()));
 
         $counter = 0;
 
         $result_set = [];
         foreach ($this->valid_roles as $role) {
             $role_id = (int) $role["obj_id"];
             $result_set[$counter]["img"] = in_array(
                 $role_id,
                 $this->user_roles
             ) ? self::IMG_OK : self::IMG_NOT_OK;
 
             if (is_subclass_of($this->object, ilObjectPlugin::class) && $role["parent"] == $this->object->getRefId()) {
                 $result_set[$counter][] = ilObjectPlugin::lookupTxtById(
                     $this->object->getType(),
                     ilObjRole::_removeObjectId($role["title"])
                 );
             } else {
                 $result_set[$counter][] = str_replace(" ", "&nbsp;", ilObjRole::_getTranslation($role["title"]));
             }
 
             $result_set[$counter]["role"] = str_replace(" ", "&nbsp;", ilObjRole::_getTranslation($role["title"]));
 
 
             if ($role['role_type'] != "linked") {
                 $result_set[$counter]["effective_from"] = "";
             } else {
                 $rolfs = $this->rbacreview->getFoldersAssignedToRole($role_id);
 
                 // ok, try to match the next rolf in path
                 foreach ($path as $node) {
                     if ($node == 1) {
                         break;
                     }
 
                     if (in_array($node, $rolfs)) {
                         $nodedata = $tree->getNodeData($node);
                         $result_set[$counter]["effective_from"] = $nodedata["title"];
                         $result_set[$counter]["effective_from_ref_id"] = $node;
                         break;
                     }
                 }
             }
 
             if (in_array($role['obj_id'], $this->global_roles)) {
                 $result_set[$counter]["original_position"] = $this->lng->txt("global");
                 $result_set[$counter]["original_position_ref_id"] = false;
             } else {
                 $rolf = $this->rbacreview->getFoldersAssignedToRole($role_id, true);
                 $parent_node = $tree->getNodeData($rolf[0]);
                 if (!array_key_exists('ref_id', $parent_node)) {
                     unset($result_set[$counter]);
                     continue;
                 }
                 $result_set[$counter]['original_position'] = $parent_node['title'];
                 $result_set[$counter]['original_position_ref_id'] = $parent_node['ref_id'];
             }
 
             ++$counter;
         }
         return $result_set;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCommands()

ilObjectPermissionStatusGUI::getCommands ( string $a_type )

get Commands

Definition at line 206 of file class.ilObjectPermissionStatusGUI.php.

References $DIC, and $location.

Referenced by getAccessStatusInfoData().

                                                : array
     {
         global $DIC;
 
         $objDefinition = $DIC['objDefinition'];
 
         $class = $objDefinition->getClassName($a_type);
         $location = $objDefinition->getLocation($a_type);
         $full_class = "ilObj" . $class . "Access";
 
         $cmds = call_user_func([$full_class, "_getCommands"]);
 
         $cmds[] = ['permission' => 'visible', 'cmd' => 'info'];
 
         return $cmds;
     }

Here is the caller graph for this function:

◆ getUser()

ilObjectPermissionStatusGUI::getUser ( )

ilUser

Definition at line 226 of file class.ilObjectPermissionStatusGUI.php.

References $DIC, $user, ilObjUser\_lookupId(), ilObjectFactory\getInstanceByObjId(), ilObject\getType(), and ILIAS\Repository\lng().

Referenced by __construct().

                              : ilObjUser
     {
         global $DIC;
 
         $user_login = '';
         if ($DIC->http()->wrapper()->post()->has('user_login')) {
             $user_login = $DIC->http()->wrapper()->post()->retrieve(
                 'user_login',
                 $DIC->refinery()->kindlyTo()->string()
             );
         }
         if (!strlen($user_login)) {
             return $DIC->user();
         }
         $user_id = ilObjUser::_lookupId($user_login);
         $user = ilObjectFactory::getInstanceByObjId($user_id, false);
         if (!$user instanceof ilObjUser || $user->getType() != 'usr') {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('info_err_user_not_exist'));
             return $DIC->user();
         }
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('info_user_view_changed'));
         return $user;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ perminfo()

ilObjectPermissionStatusGUI::perminfo ( )

cmd function

Todo:: use global template

Definition at line 94 of file class.ilObjectPermissionStatusGUI.php.

References accessPermissionsTable(), accessStatusInfo(), addToolbar(), availableRolesTable(), ilGlobalTemplateInterface\get(), ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setVariable().

                               : void
     {
         $tpl = new ilTemplate("tpl.info_layout.html", false, false, "Services/AccessControl");
 
         $tpl->setVariable("INFO_SUMMARY", $this->accessStatusInfo());
         $tpl->setVariable("INFO_PERMISSIONS", $this->accessPermissionsTable());
         $tpl->setVariable("INFO_ROLES", $this->availableRolesTable());
         $tpl->setVariable("INFO_REMARK_INTERRUPTED", $this->lng->txt('info_remark_interrupted'));
         $this->tpl->setVariable("ADM_CONTENT", $tpl->get());
         $this->addToolbar();
     }