ilRbacReview Class Reference

class ilRbacReview Contains Review functions of core Rbac. More...

Collaboration diagram for ilRbacReview:

Public Member Functions
	__construct ()
	Constructor public. More...
	roleExists ($a_title, $a_id=0)
	Checks if a role already exists. More...
	getParentRoleIds ($a_endnode_id, $a_templates=false)
	get an array of parent role ids of all parent roles, if last parameter is set true you get also all parent templates public More...
	getRoleListByObject ($a_ref_id, $a_templates=false)
	Returns a list of roles in an container public. More...
	getAssignableRoles ($a_templates=false, $a_internal_roles=false, $title_filter='')
	Returns a list of all assignable roles public. More...
	getAssignableRolesInSubtree ($ref_id)
	Returns a list of assignable roles in a subtree of the repository public. More...
	getAssignableChildRoles ($a_ref_id)
	Get all assignable roles directly under a specific node public. More...
	getNumberOfAssignedUsers (array $a_roles)
	Get the number of assigned users to roles ilDB $ilDB. More...
	assignedUsers ($a_rol_id)
	get all assigned users to a given role public More...
	isAssigned ($a_usr_id, $a_role_id)
	check if a specific user is assigned to specific role public More...
	isAssignedToAtLeastOneGivenRole ($a_usr_id, $a_role_ids)
	check if a specific user is assigned to at least one of the given role ids. More...
	assignedRoles ($a_usr_id)
	get all assigned roles to a given user public More...
	assignedGlobalRoles ($a_usr_id)
	Get assigned global roles for an user. More...
	isAssignable ($a_rol_id, $a_ref_id)
	Check if its possible to assign users public. More...
	hasMultipleAssignments ($a_role_id)
	Temporary bugfix. More...
	getFoldersAssignedToRole ($a_rol_id, $a_assignable=false)
	Returns an array of objects assigned to a role. More...
	getRolesOfObject ($a_ref_id, $a_assignable_only=false)
	Get roles of object. More...
	getRolesOfRoleFolder ($a_ref_id, $a_nonassignable=true)
	get all roles of a role folder including linked local roles that are created due to stopped inheritance returns an array with role ids public More...
	getGlobalRoles ()
	get only 'global' roles public More...
	getLocalRoles ($a_ref_id)
	Get local roles of object. More...
	getLocalPolicies ($a_ref_id)
	Get all roles with local policies. More...
	getGlobalRolesArray ()
	get only 'global' roles public More...
	getGlobalAssignableRoles ()
	get only 'global' roles (with flag 'assign_users') public More...
	isRoleAssignedToObject ($a_role_id, $a_parent_id)
	Check if role is assigned to an object. More...
	getOperations ()
	get all possible operations public More...
	getOperation ($ops_id)
	get one operation by operation id public More...
	getAllOperationsOfRole ($a_rol_id, $a_parent=0)
	get all possible operations of a specific role The ref_id of the role folder (parent object) is necessary to distinguish local roles public More...
	getActiveOperationsOfRole ($a_ref_id, $a_role_id)
	Get active operations for a role. More...
	getOperationsOfRole ($a_rol_id, $a_type, $a_parent=0)
	get all possible operations of a specific role The ref_id of the role folder (parent object) is necessary to distinguish local roles public More...
	getRoleOperationsOnObject ($a_role_id, $a_ref_id)
	ilDB $ilDB More...
	getOperationsOnType ($a_typ_id)
	all possible operations of a type public More...
	getOperationsOnTypeString ($a_type)
	all possible operations of a type public More...
	getOperationsByTypeAndClass ($a_type, $a_class)
	Get operations by type and class. More...
	getObjectsWithStopedInheritance ($a_rol_id, $a_filter=array())
	get all objects in which the inheritance of role with role_id was stopped the function returns all reference ids of objects containing a role folder. More...
	isDeleted ($a_node_id)
	Checks if a rolefolder is set as deleted (negative tree_id) public. More...
	isGlobalRole ($a_role_id)
	Check if role is a global role. More...
	getRolesByFilter ($a_filter=0, $a_user_id=0, $title_filter='')
	ilDB $ilDB More...
	getTypeId ($a_type)
	Get type id of object ilDB $ilDB. More...
	isProtected ($a_ref_id, $a_role_id)
	isBlockedAtPosition ($a_role_id, $a_ref_id)
	Check if role is blocked at position ilDB $ilDB. More...
	isBlockedInUpperContext ($a_role_id, $a_ref_id)
	Check if role is blocked in upper context. More...
	getObjectOfRole ($a_role_id)
	Get object id of objects a role is assigned to. More...
	getObjectReferenceOfRole ($a_role_id)
	Get reference of role. More...
	isRoleDeleted ($a_role_id)
	return if role is only attached to deleted role folders More...
	getRolesForIDs ($role_ids, $use_templates)
	ilDB $ilDB More...
	getOperationAssignment ()
	get operation assignments More...
	isDeleteable ($a_role_id, $a_rolf_id)
	Check if role is deleteable at a specific position. More...
	isSystemGeneratedRole ($a_role_id)
	Check if the role is system generate role or role template. More...
	getRoleFolderOfRole ($a_role_id)
	Get role folder of role ilDB $ilDB. More...
	getUserPermissionsOnObject ($a_user_id, $a_ref_id)
	Get all user permissions on an object. More...
	setAssignedCacheEntry ($a_role_id, $a_user_id, $a_value)
	set entry of assigned_chache More...
	getAssignedCacheEntry ($a_role_id, $a_user_id)
	get entry of assigned_chache More...
	clearCaches ()
	Clear assigned users caches. More...

Static Public Member Functions
static	_getOperationIdsByName ($operations)
	get ops_id's by name. More...
static	_getOperationIdByName ($a_operation)
	get operation id by name of operation public static More...
static	lookupCreateOperationIds ($a_type_arr)
	Lookup operation ids. More...
static	_getOperationList ($a_type=null)
	get operation list by object type public static More...
static	_groupOperationsByClass ($a_ops_arr)

Data Fields
const	FILTER_ALL = 1
const	FILTER_ALL_GLOBAL = 2
const	FILTER_ALL_LOCAL = 3
const	FILTER_INTERNAL = 4
const	FILTER_NOT_INTERNAL = 5
const	FILTER_TEMPLATES = 6

Protected Member Functions
	__getParentRoles ($a_path, $a_templates)
	Note: This function performs faster than the new getParentRoles function, because it uses database indexes whereas getParentRoles needs a full table space scan. More...
	__setTemplateFilter ($a_templates)
	get roles and templates or only roles; returns string for where clause private More...
	__setRoleType ($a_role_list)
	computes role type in role list array: global: roles in ROLE_FOLDER_ID local: assignable roles in other role folders linked: roles with stoppped inheritance template: role templates More...
	__setProtectedStatus ($a_parent_roles, $a_role_hierarchy, $a_ref_id)
	Set protected status type $rbacsystem type $ilUser type $log. More...

Protected Attributes
	$log

Static Protected Attributes
static	$assigned_users_cache = array()
static	$is_assigned_cache = array()

Static Private Attributes
static	$_opsCache = null

Detailed Description

class ilRbacReview Contains Review functions of core Rbac.

This class offers the possibility to view the contents of the user <-> role (UR) relation and the permission <-> role (PR) relation. For example, from the UA relation the administrator should have the facility to view all user assigned to a given role.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilRbacReview::__construct

(

)

Constructor public.

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

References $ilDB, $ilErr, array, ilLoggerFactory\getLogger(), and PEAR_ERROR_CALLBACK.

    {
        global $ilDB,$ilErr,$ilias;

        $this->log = ilLoggerFactory::getLogger('ac');

        // set db & error handler
        (isset($ilDB)) ? $this->ilDB =&$ilDB : $this->ilDB =&$ilias->db;
        
        if (!isset($ilErr)) {
            $ilErr = new ilErrorHandling();
            $ilErr->setErrorHandling(PEAR_ERROR_CALLBACK, array($ilErr,'errorHandler'));
        } else {
            $this->ilErr =&$ilErr;
        }
    }

Here is the call graph for this function:

Member Function Documentation

__getParentRoles()

ilRbacReview::__getParentRoles (   $a_path,   $a_templates  )

protected

Note: This function performs faster than the new getParentRoles function, because it uses database indexes whereas getParentRoles needs a full table space scan.

Get parent roles in a path. If last parameter is set 'true' it delivers also all templates in the path protected

Parameters

array	array with path_ids
boolean	true for role templates (default: false)

Returns

array array with all parent roles (obj_ids)

Todo:

refactor rolf => DONE

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

References $id, $message, __setProtectedStatus(), array, and getRoleListByObject().

Referenced by getParentRoleIds().

    {
        if (!isset($a_path) or !is_array($a_path)) {
            $message = get_class($this) . "::getParentRoles(): No path given or wrong datatype!";
            $this->ilErr->raiseError($message, $this->ilErr->WARNING);
        }

        $parent_roles = array();
        $role_hierarchy = array();
        
        foreach ($a_path as $ref_id) {
            $roles = $this->getRoleListByObject($ref_id, $a_templates);
            foreach ($roles as $role) {
                $id = $role["obj_id"];
                $role["parent"] = $ref_id;
                $parent_roles[$id] = $role;

                if (!array_key_exists($role['obj_id'], $role_hierarchy)) {
                    $role_hierarchy[$id] = $ref_id;
                }
            }
        }
        return $this->__setProtectedStatus($parent_roles, $role_hierarchy, reset($a_path));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__setProtectedStatus()

ilRbacReview::__setProtectedStatus (   $a_parent_roles,   $a_role_hierarchy,   $a_ref_id  )

protected

Set protected status type $rbacsystem type $ilUser type $log.

Parameters

type	$a_parent_roles
type	$a_role_hierarchy
type	$a_ref_id

Returns

boolean

Todo:

refactor rolf => DONE

Definition at line 1382 of file class.ilRbacReview.php.

References $ilUser, $log, and assignedRoles().

Referenced by __getParentRoles().

    {
        //vd('refId',$a_ref_id,'parent roles',$a_parent_roles,'role-hierarchy',$a_role_hierarchy);
        
        global $rbacsystem,$ilUser,$log;
        
        if (in_array(SYSTEM_ROLE_ID, $this->assignedRoles($ilUser->getId()))) {
            $leveladmin = true;
        } else {
            $leveladmin = false;
        }
        #vd("RoleHierarchy",$a_role_hierarchy);
        foreach ($a_role_hierarchy as $role_id => $rolf_id) {
            //$log->write("ilRBACreview::__setProtectedStatus(), 0");
            #echo "<br/>ROLF: ".$rolf_id." ROLE_ID: ".$role_id." (".$a_parent_roles[$role_id]['title'].") ";
            //var_dump($leveladmin,$a_parent_roles[$role_id]['protected']);

            if ($leveladmin == true) {
                $a_parent_roles[$role_id]['protected'] = false;
                continue;
            }
                
            if ($a_parent_roles[$role_id]['protected'] == true) {
                $arr_lvl_roles_user = array_intersect($this->assignedRoles($ilUser->getId()), array_keys($a_role_hierarchy, $rolf_id));
                
                #vd("intersection",$arr_lvl_roles_user);
                
                foreach ($arr_lvl_roles_user as $lvl_role_id) {
                    #echo "<br/>level_role: ".$lvl_role_id;
                    #echo "<br/>a_ref_id: ".$a_ref_id;
                    
                    //$log->write("ilRBACreview::__setProtectedStatus(), 1");
                    // check if role grants 'edit_permission' to parent
                    $rolf = $a_parent_roles[$role_id]['parent'];
                    #$parent_obj = $GLOBALS['tree']->getParentId($rolf);
                    if ($rbacsystem->checkPermission($rolf, $lvl_role_id, 'edit_permission')) {
                        #echo "<br />Permission granted";
                        //$log->write("ilRBACreview::__setProtectedStatus(), 2");
                        // user may change permissions of that higher-ranked role
                        $a_parent_roles[$role_id]['protected'] = false;
                        
                        // remember successful check
                        //$leveladmin = true;
                    }
                }
            }
        }
        return $a_parent_roles;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__setRoleType()

ilRbacReview::__setRoleType (   $a_role_list )

protected

computes role type in role list array: global: roles in ROLE_FOLDER_ID local: assignable roles in other role folders linked: roles with stoppped inheritance template: role templates

private

Parameters

array

role list

Returns

array role list with additional entry for role_type

Todo:

refactor rolf => DONE

Definition at line 335 of file class.ilRbacReview.php.

References $key.

Referenced by getAssignableRoles(), getRoleListByObject(), getRolesByFilter(), and getRolesForIDs().

    {
        foreach ($a_role_list as $key => $val) {
            // determine role type
            if ($val["type"] == "rolt") {
                $a_role_list[$key]["role_type"] = "template";
            } else {
                if ($val["assign"] == "y") {
                    if ($val["parent"] == ROLE_FOLDER_ID) {
                        $a_role_list[$key]["role_type"] = "global";
                    } else {
                        $a_role_list[$key]["role_type"] = "local";
                    }
                } else {
                    $a_role_list[$key]["role_type"] = "linked";
                }
            }
            
            if ($val["protected"] == "y") {
                $a_role_list[$key]["protected"] = true;
            } else {
                $a_role_list[$key]["protected"] = false;
            }
        }
        
        return $a_role_list;
    }

Here is the caller graph for this function:

__setTemplateFilter()

ilRbacReview::__setTemplateFilter (   $a_templates )

protected

get roles and templates or only roles; returns string for where clause private

Parameters

boolean

true: with templates

Returns

string where clause

Todo:

refactor rolf => DONE

Definition at line 310 of file class.ilRbacReview.php.

References $ilDB, and array.

Referenced by getAssignableRoles(), getRoleListByObject(), and getRolesForIDs().

    {
        global $ilDB;
        
        if ($a_templates === true) {
            $where = "WHERE " . $ilDB->in('object_data.type', array('role','rolt'), false, 'text') . " ";
        } else {
            $where = "WHERE " . $ilDB->in('object_data.type', array('role'), false, 'text') . " ";
        }
        
        return $where;
    }

Here is the caller graph for this function:

_getOperationIdByName()

static ilRbacReview::_getOperationIdByName (   $a_operation )

static

get operation id by name of operation public static

Parameters

string

operation name

Returns

integer operation id

Todo:

refactor rolf => DONE

Definition at line 1233 of file class.ilRbacReview.php.

References $ilDB, $ilErr, $message, $r, $row, array, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilRepositoryObjectPlugin\beforeActivation(), ilRbacSystem\checkAccessOfUser(), and ilObjBlog\getRolesWithContributeOrRedact().

    {
        global $ilDB,$ilErr;

        if (!isset($a_operation)) {
            $message = "perm::getOperationId(): No operation given!";
            $ilErr->raiseError($message, $ilErr->WARNING);
        }

        // Cache operation ids
        if (!is_array(self::$_opsCache)) {
            self::$_opsCache = array();

            $q = "SELECT ops_id, operation FROM rbac_operations";
            $r = $ilDB->query($q);
            while ($row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                self::$_opsCache[$row->operation] = $row->ops_id;
            }
        }

        // Get operation ID by name from cache
        if (array_key_exists($a_operation, self::$_opsCache)) {
            return self::$_opsCache[$a_operation];
        }
        return null;
    }

Here is the caller graph for this function:

_getOperationIdsByName()

static ilRbacReview::_getOperationIdsByName (   $operations )

static

get ops_id's by name.

Example usage: $rbacadmin->grantPermission($roles,ilRbacReview::_getOperationIdsByName(array('visible','read'),$ref_id));

public

Parameters

array

string name of operation. see rbac_operations

Returns

array integer ops_id's

Todo:

refactor rolf => DONE

Definition at line 1207 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, and array.

Referenced by ilUtil\_getObjectsByOperations(), ilLicense\getPotentialAccesses(), and ilECSObjectSettings\handlePermissionUpdate().

    {
        global $ilDB;

        if (!count($operations)) {
            return array();
        }
        
        $query = 'SELECT ops_id FROM rbac_operations ' .
            'WHERE ' . $ilDB->in('operation', $operations, false, 'text');
        
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $ops_ids[] = $row->ops_id;
        }
        return $ops_ids ? $ops_ids : array();
    }

Here is the caller graph for this function:

_getOperationList()

static ilRbacReview::_getOperationList (   $a_type = null )

static

get operation list by object type public static

Parameters

string	object type you want to have the operation list
string	order column
string	order direction (possible values: ASC or DESC)

Returns

array returns array of operations

Todo:

refactor rolf => DONE

Definition at line 1442 of file class.ilRbacReview.php.

References $a_type, $ilDB, $query, $res, $row, and array.

Referenced by ilSettingsPermissionGUI\__construct(), ilObjTypeDefinitionGUI\editObject(), ilObjectPermissionStatusGUI\getAccessPermissionTableData(), ilObjectPermissionStatusGUI\getAssignedValidRoles(), and ilObjTypeDefinitionGUI\viewObject().

    {
        global $ilDB;
    
        $arr = array();

        if ($a_type) {
            $query = sprintf(
                'SELECT * FROM rbac_operations ' .
                'JOIN rbac_ta ON rbac_operations.ops_id = rbac_ta.ops_id ' .
                'JOIN object_data ON rbac_ta.typ_id = object_data.obj_id ' .
                'WHERE object_data.title = %s ' .
                'AND object_data.type = %s ' .
                'ORDER BY op_order ASC',
                $ilDB->quote($a_type, 'text'),
                $ilDB->quote('typ', 'text')
            );
        } else {
            $query = 'SELECT * FROM rbac_operations ORDER BY op_order ASC';
        }
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            $arr[] = array(
                        "ops_id"        => $row['ops_id'],
                        "operation"     => $row['operation'],
                        "desc"          => $row['description'],
                        "class"         => $row['class'],
                        "order"         => $row['op_order']
                        );
        }
        return $arr;
    }

Here is the caller graph for this function:

_groupOperationsByClass()

static ilRbacReview::_groupOperationsByClass (   $a_ops_arr )

static

Parameters

type

$a_ops_arr

Returns

type

Todo:

refactor rolf => DONE

Definition at line 1481 of file class.ilRbacReview.php.

References array.

    {
        $arr = array();

        foreach ($a_ops_arr as $ops) {
            $arr[$ops['class']][] = array('ops_id'      => $ops['ops_id'],
                                           'name'       => $ops['operation']
                                         );
        }
        return $arr;
    }

assignedGlobalRoles()

ilRbacReview::assignedGlobalRoles

(

$a_usr_id

)

Get assigned global roles for an user.

Parameters

int

$a_usr_id

Id of user account

Todo:

refactor rolf => DONE

Definition at line 495 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, and array.

    {
        global $ilDB;
        
        $query = "SELECT ua.rol_id FROM rbac_ua ua " .
            "JOIN rbac_fa fa ON ua.rol_id = fa.rol_id " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . ' ' .
            "AND parent = " . $ilDB->quote(ROLE_FOLDER_ID) . " " .
            "AND assign = 'y' ";
        
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $role_arr[] = $row->rol_id;
        }
        return $role_arr ? $role_arr : array();
    }

assignedRoles()

ilRbacReview::assignedRoles

(

$a_usr_id

)

get all assigned roles to a given user public

Parameters

integer

usr_id

Returns

array all roles (id) the user have

Todo:

refactor rolf => DONE

Definition at line 475 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, and array.

Referenced by __setProtectedStatus(), and getRolesByFilter().

    {
        global $ilDB;
        
        $role_arr = array();
        
        $query = "SELECT rol_id FROM rbac_ua WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer');

        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $role_arr[] = $row->rol_id;
        }
        return $role_arr ? $role_arr : array();
    }

Here is the caller graph for this function:

assignedUsers()

ilRbacReview::assignedUsers

(

$a_rol_id

)

get all assigned users to a given role public

Parameters

integer

role_id

Returns

array all users (id) assigned to role

Definition at line 389 of file class.ilRbacReview.php.

References $ilBench, $ilDB, $message, $query, $res, $row, and array.

    {
        global $ilBench,$ilDB;
        
        if (!isset($a_rol_id)) {
            $message = get_class($this) . "::assignedUsers(): No role_id given!";
            $this->ilErr->raiseError($message, $this->ilErr->WARNING);
        }
        if (isset(self::$assigned_users_cache[$a_rol_id])) {
            return self::$assigned_users_cache[$a_rol_id];
        }
        
        $result_arr = array();

        $query = "SELECT usr_id FROM rbac_ua WHERE rol_id= " . $ilDB->quote($a_rol_id, 'integer');
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            array_push($result_arr, $row["usr_id"]);
        }

        self::$assigned_users_cache[$a_rol_id] = $result_arr;

        return $result_arr;
    }

clearCaches()

ilRbacReview::clearCaches

(

)

Clear assigned users caches.

Definition at line 1757 of file class.ilRbacReview.php.

References array.

    {
        self::$is_assigned_cache = array();
        self::$assigned_users_cache = array();
    }

getActiveOperationsOfRole()

ilRbacReview::getActiveOperationsOfRole	(		$a_ref_id,
			$a_role_id
	)

Get active operations for a role.

Parameters

object	$a_ref_id
object	$a_role_id

Returns

Todo:

refactor rolf => DONE

Definition at line 841 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, array, and ilDBConstants\FETCHMODE_ASSOC.

    {
        global $ilDB;
        
        $query = 'SELECT * FROM rbac_pa ' .
            'WHERE ref_id = ' . $ilDB->quote($a_ref_id, 'integer') . ' ' .
            'AND rol_id = ' . $ilDB->quote($a_role_id, 'integer') . ' ';
            
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            return unserialize($row['ops_id']);
        }
        return array();
    }

getAllOperationsOfRole()

ilRbacReview::getAllOperationsOfRole	(		$a_rol_id,
			$a_parent = 0
	)

get all possible operations of a specific role The ref_id of the role folder (parent object) is necessary to distinguish local roles public

Parameters

integer	role_id
integer	role folder id

Returns

array array of operation_id and types

Todo:

refactor rolf => DONE

Definition at line 814 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, and array.

    {
        global $ilDB;

        if (!$a_parent) {
            $a_parent = ROLE_FOLDER_ID;
        }
        
        $query = "SELECT ops_id,type FROM rbac_templates " .
            "WHERE rol_id = " . $ilDB->quote($a_rol_id, 'integer') . " " .
            "AND parent = " . $ilDB->quote($a_parent, 'integer');
        $res = $ilDB->query($query);

        $ops_arr = array();
        while ($row = $ilDB->fetchObject($res)) {
            $ops_arr[$row->type][] = $row->ops_id;
        }
        return (array) $ops_arr;
    }

getAssignableChildRoles()

ilRbacReview::getAssignableChildRoles

(

$a_ref_id

)

Get all assignable roles directly under a specific node public.

Parameters

ref_id

Returns

array set ids

Todo:

refactor rolf => Find a better name; reduce sql fields

Definition at line 285 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, array, and ilDB\quote().

    {
        global $ilDB;

        $query = "SELECT fa.*, rd.* " .
             "FROM object_data rd " .
             "JOIN rbac_fa fa ON rd.obj_id = fa.rol_id " .
             "WHERE fa.assign = 'y' " .
             "AND fa.parent = " . $this->ilDB->quote($a_ref_id, 'integer') . " "
            ;
        
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            $roles_data[] = $row;
        }
        return $roles_data ? $roles_data : array();
    }

Here is the call graph for this function:

getAssignableRoles()

ilRbacReview::getAssignableRoles	(		$a_templates = false,
			$a_internal_roles = false,
			$title_filter = ''
	)

Returns a list of all assignable roles public.

Parameters

boolean

if true fetch template roles too

Returns

array set ids

Todo:

refactor rolf => DONE

Definition at line 215 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, __setRoleType(), __setTemplateFilter(), and array.

Referenced by getRolesByFilter().

    {
        global $ilDB;

        $role_list = array();

        $where = $this->__setTemplateFilter($a_templates);

        $query = "SELECT * FROM object_data " .
             "JOIN rbac_fa ON obj_id = rol_id " .
             $where .
             "AND rbac_fa.assign = 'y' ";

        if (strlen($title_filter)) {
            $query .= (' AND ' . $ilDB->like(
                'title',
                'text',
                $title_filter . '%'
            ));
        }
        $res = $ilDB->query($query);

        while ($row = $ilDB->fetchAssoc($res)) {
            $row["desc"] = $row["description"];
            $row["user_id"] = $row["owner"];
            $role_list[] = $row;
        }
        
        $role_list = $this->__setRoleType($role_list);

        return $role_list;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssignableRolesInSubtree()

ilRbacReview::getAssignableRolesInSubtree

(

$ref_id

)

Returns a list of assignable roles in a subtree of the repository public.

Parameters

ref_id

Root node of subtree

Returns

array set ids

Todo:

refactor rolf => DONE

Definition at line 255 of file class.ilRbacReview.php.

References $GLOBALS, $ilDB, $query, $res, $row, array, and ilDBConstants\FETCHMODE_OBJECT.

    {
        global $ilDB;
        
        $query = 'SELECT rol_id FROM rbac_fa fa ' .
                'JOIN tree t1 ON t1.child = fa.parent ' .
                'JOIN object_data obd ON fa.rol_id = obd.obj_id ' .
                'WHERE assign = ' . $ilDB->quote('y', 'text') . ' ' .
                'AND obd.type = ' . $ilDB->quote('role', 'text') . ' ' .
                'AND t1.child IN (' .
                $GLOBALS['tree']->getSubTreeQuery($ref_id, array('child')) . ' ' .
                ') ';
        

        $res = $ilDB->query($query);
        
        $role_list = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $role_list[] = $row->rol_id;
        }
        return $role_list;
    }

getAssignedCacheEntry()

ilRbacReview::getAssignedCacheEntry	(		$a_role_id,
			$a_user_id
	)

get entry of assigned_chache

Parameters

int	$a_role_id
int	$a_user_id

Definition at line 1749 of file class.ilRbacReview.php.

    {
        return self::$is_assigned_cache[$a_role_id][$a_user_id];
    }

getFoldersAssignedToRole()

ilRbacReview::getFoldersAssignedToRole	(		$a_rol_id,
			$a_assignable = false
	)

Returns an array of objects assigned to a role.

A role with stopped inheritance may be assigned to more than one objects. To get only the original location of a role, set the second parameter to true

public

Parameters

integer	role id
boolean	get only rolefolders where role is assignable (true)

Returns

array reference IDs of role folders

Todo:

refactor rolf => RENAME (rest done)

Definition at line 573 of file class.ilRbacReview.php.

References $ilDB, $message, $query, $res, $row, and array.

Referenced by isRoleDeleted().

    {
        global $ilDB;
        
        if (!isset($a_rol_id)) {
            $message = get_class($this) . "::getFoldersAssignedToRole(): No role_id given!";
            $this->ilErr->raiseError($message, $this->ilErr->WARNING);
        }
        
        if ($a_assignable) {
            $where = " AND assign ='y'";
        }

        $query = "SELECT DISTINCT parent FROM rbac_fa " .
             "WHERE rol_id = " . $ilDB->quote($a_rol_id, 'integer') . " " . $where . " ";

        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $folders[] = $row->parent;
        }
        return $folders ? $folders : array();
    }

Here is the caller graph for this function:

getGlobalAssignableRoles()

ilRbacReview::getGlobalAssignableRoles

(

)

get only 'global' roles (with flag 'assign_users') public

Returns

array Array with rol_ids

Todo:

refactor rolf => DONE

Definition at line 734 of file class.ilRbacReview.php.

References ilObjRole\_getAssignUsersStatus(), array, and getGlobalRoles().

    {
        include_once './Services/AccessControl/classes/class.ilObjRole.php';

        foreach ($this->getGlobalRoles() as $role_id) {
            if (ilObjRole::_getAssignUsersStatus($role_id)) {
                $ga[] = array('obj_id' => $role_id,
                              'role_type' => 'global');
            }
        }
        return $ga ? $ga : array();
    }

Here is the call graph for this function:

getGlobalRoles()

ilRbacReview::getGlobalRoles

(

)

get only 'global' roles public

Returns

array Array with rol_ids

Todo:

refactor rolf => DONE

Definition at line 676 of file class.ilRbacReview.php.

References getRolesOfRoleFolder().

Referenced by getGlobalAssignableRoles(), getRolesByFilter(), and isGlobalRole().

    {
        return $this->getRolesOfRoleFolder(ROLE_FOLDER_ID, false);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getGlobalRolesArray()

ilRbacReview::getGlobalRolesArray

(

)

get only 'global' roles public

Returns

array Array with rol_ids

Todo:

refactor rolf => DONE

Definition at line 719 of file class.ilRbacReview.php.

References array, and getRolesOfRoleFolder().

    {
        foreach ($this->getRolesOfRoleFolder(ROLE_FOLDER_ID, false) as $role_id) {
            $ga[] = array('obj_id'              => $role_id,
                          'role_type'   => 'global');
        }
        return $ga ? $ga : array();
    }

Here is the call graph for this function:

getLocalPolicies()

ilRbacReview::getLocalPolicies

(

$a_ref_id

)

Get all roles with local policies.

Parameters

type

$a_ref_id

Returns

type

Definition at line 704 of file class.ilRbacReview.php.

References array, and getRolesOfRoleFolder().

    {
        $lroles = array();
        foreach ($this->getRolesOfRoleFolder($a_ref_id) as $role_id) {
            $lroles[] = $role_id;
        }
        return $lroles;
    }

Here is the call graph for this function:

getLocalRoles()

ilRbacReview::getLocalRoles

(

$a_ref_id

)

Get local roles of object.

Parameters

int

$a_ref_id

Todo:

refactor rolf => DONE

Definition at line 686 of file class.ilRbacReview.php.

References $ilDB, array, getRolesOfRoleFolder(), and isAssignable().

    {
        global $ilDB;

        $lroles = array();
        foreach ($this->getRolesOfRoleFolder($a_ref_id) as $role_id) {
            if ($this->isAssignable($role_id, $a_ref_id)) {
                $lroles[] = $role_id;
            }
        }
        return $lroles;
    }

Here is the call graph for this function:

getNumberOfAssignedUsers()

ilRbacReview::getNumberOfAssignedUsers

(

array

$a_roles

)

Get the number of assigned users to roles ilDB $ilDB.

Parameters

array

$a_roles

Returns

int

Todo:

refactor rolf => DONE

Definition at line 370 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

    {
        global $ilDB;

        $query = 'SELECT COUNT(DISTINCT(usr_id)) as num FROM rbac_ua ' .
            'WHERE ' . $ilDB->in('rol_id', $a_roles, false, 'integer') . ' ';

        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        return $row->num ? $row->num : 0;
    }

getObjectOfRole()

ilRbacReview::getObjectOfRole

(

$a_role_id

)

Get object id of objects a role is assigned to.

Todo:

refactor rolf (due to performance reasons the new version does not check for deleted roles only in object reference)

public

Parameters

int

role id

Definition at line 1502 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, and array.

    {
        // internal cache
        static $obj_cache = array();

        global $ilDB;
        
        
        if (isset($obj_cache[$a_role_id]) and $obj_cache[$a_role_id]) {
            return $obj_cache[$a_role_id];
        }
        
        $query = 'SELECT obr.obj_id FROM rbac_fa rfa ' .
                'JOIN object_reference obr ON rfa.parent = obr.ref_id ' .
                'WHERE assign = ' . $ilDB->quote('y', 'text') . ' ' .
                'AND rol_id = ' . $ilDB->quote($a_role_id, 'integer') . ' ' .
                'AND deleted IS NULL';
        
        #$query = "SELECT obr.obj_id FROM rbac_fa rfa ".
        #       "JOIN tree ON rfa.parent = tree.child ".
        #       "JOIN object_reference obr ON tree.parent = obr.ref_id ".
        #       "WHERE tree.tree = 1 ".
        #       "AND assign = 'y' ".
        #       "AND rol_id = ".$ilDB->quote($a_role_id,'integer')." ";
        $res = $ilDB->query($query);
        
        $obj_cache[$a_role_id] = 0;
        while ($row = $ilDB->fetchObject($res)) {
            $obj_cache[$a_role_id] = $row->obj_id;
        }
        return $obj_cache[$a_role_id];
    }

getObjectReferenceOfRole()

ilRbacReview::getObjectReferenceOfRole

(

$a_role_id

)

Get reference of role.

Parameters

object

$a_role_id

Returns

int

Todo:

refactor rolf (no deleted check)

Definition at line 1541 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

    {
        global $ilDB;
        
        $query = 'SELECT parent p_ref FROM rbac_fa ' .
                'WHERE rol_id = ' . $ilDB->quote($a_role_id, 'integer') . ' ' .
                'AND assign = ' . $ilDB->quote('y', 'text');
        
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->p_ref;
        }
        return 0;
    }

getObjectsWithStopedInheritance()

ilRbacReview::getObjectsWithStopedInheritance	(		$a_rol_id,
			$a_filter = array()
	)

get all objects in which the inheritance of role with role_id was stopped the function returns all reference ids of objects containing a role folder.

public

Parameters

integer	role_id
array	filter ref_ids

Returns

array with ref_ids of objects

Todo:

refactor rolf => DONE

Definition at line 1019 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, array, and ilDBConstants\FETCHMODE_OBJECT.

    {
        global $ilDB;
        
        #$query = 'SELECT t.parent p FROM tree t JOIN rbac_fa fa ON fa.parent = child '.
        #       'WHERE assign = '.$ilDB->quote('n','text').' '.
        #       'AND rol_id = '.$ilDB->quote($a_rol_id,'integer').' ';
        
        $query = 'SELECT parent p FROM rbac_fa ' .
                'WHERE assign = ' . $ilDB->quote('n', 'text') . ' ' .
                'AND rol_id = ' . $ilDB->quote($a_rol_id, 'integer') . ' ';
        
        if ($a_filter) {
            $query .= ('AND ' . $ilDB->in('parent', (array) $a_filter, false, 'integer'));
        }

        $res = $ilDB->query($query);
        $parent = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $parent[] = $row->p;
        }
        return $parent;
    }

getOperation()

ilRbacReview::getOperation

(

$ops_id

)

get one operation by operation id public

Returns

array data of operation_id

Todo:

refactor rolf => DONE

Definition at line 790 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, array, and ilDB\query().

    {
        global $ilDB;

        $query = 'SELECT * FROM rbac_operations WHERE ops_id = ' . $ilDB->quote($ops_id, 'integer');
        $res = $this->ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $ops = array('ops_id' => $row->ops_id,
                         'operation' => $row->operation,
                         'description' => $row->description);
        }

        return $ops ? $ops : array();
    }

Here is the call graph for this function:

getOperationAssignment()

ilRbacReview::getOperationAssignment

(

)

get operation assignments

Returns

array array(array('typ_id' => $typ_id,'title' => $title,'ops_id => '$ops_is,'operation' => $operation),...

Todo:

refactor rolf => DONE

Definition at line 1617 of file class.ilRbacReview.php.

References $counter, $ilDB, $info, $query, $res, $row, and array.

    {
        global $ilDB;

        $query = 'SELECT ta.typ_id, obj.title, ops.ops_id, ops.operation FROM rbac_ta ta ' .
             'JOIN object_data obj ON obj.obj_id = ta.typ_id ' .
             'JOIN rbac_operations ops ON ops.ops_id = ta.ops_id ';
        $res = $ilDB->query($query);
        
        $counter = 0;
        while ($row = $ilDB->fetchObject($res)) {
            $info[$counter]['typ_id'] = $row->typ_id;
            $info[$counter]['type'] = $row->title;
            $info[$counter]['ops_id'] = $row->ops_id;
            $info[$counter]['operation'] = $row->operation;
            $counter++;
        }
        return $info ? $info : array();
    }

getOperations()

ilRbacReview::getOperations

(

)

get all possible operations public

Returns

array array of operation_id

Todo:

refactor rolf => DONE

Definition at line 769 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, array, and ilDB\query().

    {
        global $ilDB;

        $query = 'SELECT * FROM rbac_operations ORDER BY ops_id ';
        $res = $this->ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $ops[] = array('ops_id' => $row->ops_id,
                           'operation' => $row->operation,
                           'description' => $row->description);
        }

        return $ops ? $ops : array();
    }

Here is the call graph for this function:

getOperationsByTypeAndClass()

ilRbacReview::getOperationsByTypeAndClass	(		$a_type,
			$a_class
	)

Get operations by type and class.

Parameters

string	$a_type	Type is "object" or
string	$a_class

Returns

Todo:

refactor rolf => DONE

Definition at line 982 of file class.ilRbacReview.php.

References $a_type, $ilDB, $query, $res, $row, array, and ilDBConstants\FETCHMODE_OBJECT.

    {
        global $ilDB;
        
        if ($a_class != 'create') {
            $condition = "AND class != " . $ilDB->quote('create', 'text');
        } else {
            $condition = "AND class = " . $ilDB->quote('create', 'text');
        }
        
        $query = "SELECT ro.ops_id FROM rbac_operations ro " .
            "JOIN rbac_ta rt ON  ro.ops_id = rt.ops_id " .
            "JOIN object_data od ON rt.typ_id = od.obj_id " .
            "WHERE type = " . $ilDB->quote('typ', 'text') . " " .
            "AND title = " . $ilDB->quote($a_type, 'text') . " " .
            $condition . " " .
            "ORDER BY op_order ";
            
        $res = $ilDB->query($query);
        
        $ops = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $ops[] = $row->ops_id;
        }
        return $ops;
    }

getOperationsOfRole()

ilRbacReview::getOperationsOfRole	(		$a_rol_id,
			$a_type,
			$a_parent = 0
	)

get all possible operations of a specific role The ref_id of the role folder (parent object) is necessary to distinguish local roles public

Parameters

integer	role_id
string	object type
integer	role folder id

Returns

array array of operation_id

Todo:

refactor rolf => DONE

Definition at line 867 of file class.ilRbacReview.php.

References $a_type, $ilDB, $ilLog, $message, $query, $res, $row, and array.

    {
        global $ilDB,$ilLog;
        
        if (!isset($a_rol_id) or !isset($a_type)) {
            $message = get_class($this) . "::getOperationsOfRole(): Missing Parameter!" .
                       "role_id: " . $a_rol_id .
                       "type: " . $a_type .
                       "parent_id: " . $a_parent;
            $ilLog->logStack("Missing parameter! ");
            $this->ilErr->raiseError($message, $this->ilErr->WARNING);
        }

        $ops_arr = array();

        // if no rolefolder id is given, assume global role folder as target
        if ($a_parent == 0) {
            $a_parent = ROLE_FOLDER_ID;
        }
        
        $query = "SELECT ops_id FROM rbac_templates " .
             "WHERE type =" . $ilDB->quote($a_type, 'text') . " " .
             "AND rol_id = " . $ilDB->quote($a_rol_id, 'integer') . " " .
             "AND parent = " . $ilDB->quote($a_parent, 'integer');
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $ops_arr[] = $row->ops_id;
        }
        
        return $ops_arr;
    }

getOperationsOnType()

ilRbacReview::getOperationsOnType

(

$a_typ_id

)

all possible operations of a type public

Parameters

integer

object_ID of type

Returns

array valid operation_IDs

Todo:

rafactor rolf => DONE

Definition at line 929 of file class.ilRbacReview.php.

References $ilDB, $message, $query, $res, $row, and array.

Referenced by getOperationsOnTypeString().

    {
        global $ilDB;

        if (!isset($a_typ_id)) {
            $message = get_class($this) . "::getOperationsOnType(): No type_id given!";
            $this->ilErr->raiseError($message, $this->ilErr->WARNING);
        }

        #$query = "SELECT * FROM rbac_ta WHERE typ_id = ".$ilDB->quote($a_typ_id,'integer');
        
        $query = 'SELECT * FROM rbac_ta ta JOIN rbac_operations o ON ta.ops_id = o.ops_id ' .
            'WHERE typ_id = ' . $ilDB->quote($a_typ_id, 'integer') . ' ' .
            'ORDER BY op_order';

        $res = $ilDB->query($query);

        while ($row = $ilDB->fetchObject($res)) {
            $ops_id[] = $row->ops_id;
        }

        return $ops_id ? $ops_id : array();
    }

Here is the caller graph for this function:

getOperationsOnTypeString()

ilRbacReview::getOperationsOnTypeString

(

$a_type

)

all possible operations of a type public

Parameters

integer

object_ID of type

Returns

array valid operation_IDs

Todo:

rafactor rolf => DONE

Definition at line 961 of file class.ilRbacReview.php.

References $a_type, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, getOperationsOnType(), and ilDB\query().

    {
        global $ilDB;

        $query = "SELECT * FROM object_data WHERE type = 'typ' AND title = " . $ilDB->quote($a_type, 'text') . " ";
            

        $res = $this->ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $this->getOperationsOnType($row->obj_id);
        }
        return false;
    }

Here is the call graph for this function:

getParentRoleIds()

ilRbacReview::getParentRoleIds	(		$a_endnode_id,
			$a_templates = false
	)

get an array of parent role ids of all parent roles, if last parameter is set true you get also all parent templates public

Parameters

integer	ref_id of an object which is end node
boolean	true for role templates (default: false)

Returns

array array(role_ids => role_data)

Todo:

refactor rolf => DONE

Definition at line 145 of file class.ilRbacReview.php.

References $GLOBALS, $message, and __getParentRoles().

    {
        global $tree;

        if (!isset($a_endnode_id)) {
            $GLOBALS['ilLog']->logStack();
            $message = get_class($this) . "::getParentRoleIds(): No node_id (ref_id) given!";
            $this->ilErr->raiseError($message, $this->ilErr->WARNING);
        }
        
        //var_dump($a_endnode_id);exit;
        //$log->write("ilRBACreview::getParentRoleIds(), 0");
        $pathIds  = $tree->getPathId($a_endnode_id);
        
        // add system folder since it may not in the path
        //$pathIds[0] = SYSTEM_FOLDER_ID;
        $pathIds[0] = ROLE_FOLDER_ID;
        //$log->write("ilRBACreview::getParentRoleIds(), 1");
        #return $this->getParentRoles($a_endnode_id,$a_templates,$a_keep_protected);
        return $this->__getParentRoles($pathIds, $a_templates);
    }

Here is the call graph for this function:

getRoleFolderOfRole()

ilRbacReview::getRoleFolderOfRole

(

$a_role_id

)

Get role folder of role ilDB $ilDB.

Parameters

int

$a_role_id

Returns

int

Todo:

refactor rolf => RENAME

Definition at line 1678 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, ilObject\_lookupType(), and ilDBConstants\FETCHMODE_OBJECT.

    {
        global $ilDB;
        
        if (ilObject::_lookupType($a_role_id) == 'role') {
            $and = ('AND assign = ' . $ilDB->quote('y', 'text'));
        } else {
            $and = '';
        }

        $query = 'SELECT * FROM rbac_fa ' .
            'WHERE rol_id = ' . $ilDB->quote($a_role_id, 'integer') . ' ' .
            $and;
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->parent;
        }
        return 0;
    }

Here is the call graph for this function:

getRoleListByObject()

ilRbacReview::getRoleListByObject	(		$a_ref_id,
			$a_templates = false
	)

Returns a list of roles in an container public.

Parameters

integer	ref_id of object
boolean	if true fetch template roles too

Returns

array set ids

Todo:

refactor rolf => DONE

Definition at line 175 of file class.ilRbacReview.php.

References $ilDB, $message, $query, $res, $row, __setRoleType(), __setTemplateFilter(), and array.

Referenced by __getParentRoles().

    {
        global $ilDB;
        
        if (!isset($a_ref_id) or !isset($a_templates)) {
            $message = get_class($this) . "::getRoleListByObject(): Missing parameter!" .
                       "ref_id: " . $a_ref_id .
                       "tpl_flag: " . $a_templates;
            $this->ilErr->raiseError($message, $this->ilErr->WARNING);
        }

        $role_list = array();

        $where = $this->__setTemplateFilter($a_templates);
    
        $query = "SELECT * FROM object_data " .
             "JOIN rbac_fa ON obj_id = rol_id " .
             $where .
             "AND object_data.obj_id = rbac_fa.rol_id " .
             "AND rbac_fa.parent = " . $ilDB->quote($a_ref_id, 'integer') . " ";
             
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            $row["desc"] = $row["description"];
            $row["user_id"] = $row["owner"];
            $role_list[] = $row;
        }

        $role_list = $this->__setRoleType($role_list);
        
        return $role_list;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRoleOperationsOnObject()

ilRbacReview::getRoleOperationsOnObject	(		$a_role_id,
			$a_ref_id
	)

ilDB $ilDB

Parameters

type	$a_role_id
type	$a_ref_id

Returns

type

Todo:

rafactor rolf => DONE

Definition at line 906 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, and array.

    {
        global $ilDB;
        
        $query = "SELECT * FROM rbac_pa " .
            "WHERE rol_id = " . $ilDB->quote($a_role_id, 'integer') . " " .
            "AND ref_id = " . $ilDB->quote($a_ref_id, 'integer') . " ";

        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $ops = unserialize($row->ops_id);
        }

        return $ops ? $ops : array();
    }

getRolesByFilter()

ilRbacReview::getRolesByFilter	(		$a_filter = 0,
			$a_user_id = 0,
			$title_filter = ''
	)

ilDB $ilDB

Parameters

type	$a_filter
type	$a_user_id
type	$title_filter

Returns

type

Todo:

refactor rolf => DONE

Definition at line 1098 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, __setRoleType(), array, assignedRoles(), getAssignableRoles(), and getGlobalRoles().

    {
        global $ilDB;
        
        $assign = "y";

        switch ($a_filter) {
            // all (assignable) roles
            case self::FILTER_ALL:
                return $this->getAssignableRoles(true, true, $title_filter);
                break;

            // all (assignable) global roles
            case self::FILTER_ALL_GLOBAL:
                $where = 'WHERE ' . $ilDB->in('rbac_fa.rol_id', $this->getGlobalRoles(), false, 'integer') . ' ';
                break;

            // all (assignable) local roles
            case self::FILTER_ALL_LOCAL:
            case self::FILTER_INTERNAL:
            case self::FILTER_NOT_INTERNAL:
                $where = 'WHERE ' . $ilDB->in('rbac_fa.rol_id', $this->getGlobalRoles(), true, 'integer');
                break;
                
            // all role templates
            case self::FILTER_TEMPLATES:
                $where = "WHERE object_data.type = 'rolt'";
                $assign = "n";
                break;

            // only assigned roles, handled by ilObjUserGUI::roleassignmentObject()
            case 0:
            default:
                if (!$a_user_id) {
                    return array();
                }

                $where = 'WHERE ' . $ilDB->in('rbac_fa.rol_id', $this->assignedRoles($a_user_id), false, 'integer') . ' ';
                break;
        }
        
        $roles = array();

        $query = "SELECT * FROM object_data " .
             "JOIN rbac_fa ON obj_id = rol_id " .
             $where .
             "AND rbac_fa.assign = " . $ilDB->quote($assign, 'text') . " ";

        if (strlen($title_filter)) {
            $query .= (' AND ' . $ilDB->like(
                'title',
                'text',
                '%' . $title_filter . '%'
            ));
        }
        
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            $prefix = (substr($row["title"], 0, 3) == "il_") ? true : false;

            // all (assignable) internal local roles only
            if ($a_filter == 4 and !$prefix) {
                continue;
            }

            // all (assignable) non internal local roles only
            if ($a_filter == 5 and $prefix) {
                continue;
            }
            
            $row["desc"] = $row["description"];
            $row["user_id"] = $row["owner"];
            $roles[] = $row;
        }

        $roles = $this->__setRoleType($roles);

        return $roles ? $roles : array();
    }

Here is the call graph for this function:

getRolesForIDs()

ilRbacReview::getRolesForIDs	(		$role_ids,
			$use_templates
	)

ilDB $ilDB

Parameters

type	$role_ids
type	$use_templates

Returns

type

Todo:

refactor rolf => DONE

Definition at line 1587 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, __setRoleType(), __setTemplateFilter(), and array.

    {
        global $ilDB;
        
        $role_list = array();

        $where = $this->__setTemplateFilter($use_templates);

        $query = "SELECT * FROM object_data " .
             "JOIN rbac_fa ON object_data.obj_id = rbac_fa.rol_id " .
             $where .
             "AND rbac_fa.assign = 'y' " .
             'AND ' . $ilDB->in('object_data.obj_id', $role_ids, false, 'integer');
             
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            $row["desc"] = $row["description"];
            $row["user_id"] = $row["owner"];
            $role_list[] = $row;
        }
        
        $role_list = $this->__setRoleType($role_list);
        return $role_list;
    }

Here is the call graph for this function:

getRolesOfObject()

ilRbacReview::getRolesOfObject	(		$a_ref_id,
			$a_assignable_only = false
	)

Get roles of object.

Parameters

type	$a_ref_id
type	$a_assignable

Exceptions

InvalidArgumentException

Todo:

refactor rolf => DONE

Definition at line 603 of file class.ilRbacReview.php.

References $GLOBALS, $ilDB, $query, $res, $row, and array.

    {
        global $ilDB;
        
        if (!isset($a_ref_id)) {
            $GLOBALS['ilLog']->logStack();
            throw new InvalidArgumentException(__METHOD__ . ': No ref_id given!');
        }
        if ($a_assignable_only === true) {
            $and = 'AND assign = ' . $ilDB->quote('y', 'text');
        }
        $query = "SELECT rol_id FROM rbac_fa " .
             "WHERE parent = " . $ilDB->quote($a_ref_id, 'integer') . " " .
             $and;

        $res = $ilDB->query($query);
        
        $role_ids = array();
        while ($row = $ilDB->fetchObject($res)) {
            $role_ids[] = $row->rol_id;
        }
        return $role_ids;
    }

getRolesOfRoleFolder()

ilRbacReview::getRolesOfRoleFolder	(		$a_ref_id,
			$a_nonassignable = true
	)

get all roles of a role folder including linked local roles that are created due to stopped inheritance returns an array with role ids public

Parameters

integer	ref_id of object
boolean	if false only get true local roles

Returns

array Array with rol_ids

Deprecated:

since version 4.5.0

Todo:

refactor rolf => RENAME

Definition at line 640 of file class.ilRbacReview.php.

References $ilBench, $ilDB, $ilLog, $message, $query, $res, $row, array, and ilLoggerFactory\getLogger().

Referenced by getGlobalRoles(), getGlobalRolesArray(), getLocalPolicies(), and getLocalRoles().

    {
        global $ilBench,$ilDB,$ilLog;
        
        $ilBench->start("RBAC", "review_getRolesOfRoleFolder");

        if (!isset($a_ref_id)) {
            $message = get_class($this) . "::getRolesOfRoleFolder(): No ref_id given!";
            ilLoggerFactory::getLogger('ac')->logStack();
            $this->ilErr->raiseError($message, $this->ilErr->WARNING);
        }
        
        if ($a_nonassignable === false) {
            $and = " AND assign='y'";
        }

        $query = "SELECT rol_id FROM rbac_fa " .
             "WHERE parent = " . $ilDB->quote($a_ref_id, 'integer') . " " .
             $and;

        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $rol_id[] = $row->rol_id;
        }

        $ilBench->stop("RBAC", "review_getRolesOfRoleFolder");

        return $rol_id ? $rol_id : array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTypeId()

ilRbacReview::getTypeId

(

$a_type

)

Get type id of object ilDB $ilDB.

Parameters

type

$a_type

Returns

type

Todo:

refactor rolf => DONE

Definition at line 1185 of file class.ilRbacReview.php.

References $a_type, $ilDB, $r, $row, and ilDBConstants\FETCHMODE_OBJECT.

    {
        global $ilDB;

        $q = "SELECT obj_id FROM object_data " .
             "WHERE title=" . $ilDB->quote($a_type, 'text') . " AND type='typ'";
        $r = $ilDB->query($q);
        
        $row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        return $row->obj_id;
    }

getUserPermissionsOnObject()

ilRbacReview::getUserPermissionsOnObject	(		$a_user_id,
			$a_ref_id
	)

Get all user permissions on an object.

Parameters

int	$a_user_id	user id
int	$a_ref_id	ref id

Todo:

refactor rolf => DONE

Definition at line 1705 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, and array.

    {
        global $ilDB;
        
        $query = "SELECT ops_id FROM rbac_pa JOIN rbac_ua " .
            "ON (rbac_pa.rol_id = rbac_ua.rol_id) " .
            "WHERE rbac_ua.usr_id = " . $ilDB->quote($a_user_id, 'integer') . " " .
            "AND rbac_pa.ref_id = " . $ilDB->quote($a_ref_id, 'integer') . " ";

        $res = $ilDB->query($query);
        $all_ops = array();
        while ($row = $ilDB->fetchObject($res)) {
            $ops = unserialize($row->ops_id);
            $all_ops = array_merge($all_ops, $ops);
        }
        $all_ops = array_unique($all_ops);
        
        $set = $ilDB->query("SELECT operation FROM rbac_operations " .
            " WHERE " . $ilDB->in("ops_id", $all_ops, false, "integer"));
        $perms = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $perms[] = $rec["operation"];
        }
        
        return $perms;
    }

hasMultipleAssignments()

ilRbacReview::hasMultipleAssignments

(

$a_role_id

)

Temporary bugfix.

Todo:

refactor rolf => DONE

Definition at line 552 of file class.ilRbacReview.php.

References $ilDB, $query, and $res.

    {
        global $ilDB;
        
        $query = "SELECT * FROM rbac_fa WHERE rol_id = " . $ilDB->quote($a_role_id, 'integer') . ' ' .
            "AND assign = " . $ilDB->quote('y', 'text');
        $res = $ilDB->query($query);
        return $res->numRows() > 1;
    }

isAssignable()

ilRbacReview::isAssignable	(		$a_rol_id,
			$a_ref_id
	)

Check if its possible to assign users public.

Parameters

integer	object id of role
integer	ref_id of object in question

Returns

boolean

Todo:

refactor rolf (expects object reference id instead of rolf) => DONE

Definition at line 520 of file class.ilRbacReview.php.

References $ilBench, $ilDB, $message, $query, $res, and $row.

Referenced by getLocalRoles(), and isDeleteable().

    {
        global $ilBench,$ilDB;

        $ilBench->start("RBAC", "review_isAssignable");

        // exclude system role from rbac
        if ($a_rol_id == SYSTEM_ROLE_ID) {
            $ilBench->stop("RBAC", "review_isAssignable");
            return true;
        }

        if (!isset($a_rol_id) or !isset($a_ref_id)) {
            $message = get_class($this) . "::isAssignable(): Missing parameter!" .
                       " role_id: " . $a_rol_id . " ,ref_id: " . $a_ref_id;
            $this->ilErr->raiseError($message, $this->ilErr->WARNING);
        }
        $query = "SELECT * FROM rbac_fa " .
             "WHERE rol_id = " . $ilDB->quote($a_rol_id, 'integer') . " " .
             "AND parent = " . $ilDB->quote($a_ref_id, 'integer') . " ";
        $res = $ilDB->query($query);
        $row = $ilDB->fetchObject($res);
    
        $ilBench->stop("RBAC", "review_isAssignable");
        return $row->assign == 'y' ? true : false;
    }

Here is the caller graph for this function:

isAssigned()

ilRbacReview::isAssigned	(		$a_usr_id,
			$a_role_id
	)

check if a specific user is assigned to specific role public

Parameters

integer	usr_id
integer	role_id

Returns

boolean

Todo:

refactor rolf => DONE

Definition at line 423 of file class.ilRbacReview.php.

References $ilDB, $query, and $res.

    {
        if (isset(self::$is_assigned_cache[$a_role_id][$a_usr_id])) {
            return self::$is_assigned_cache[$a_role_id][$a_usr_id];
        }
        // Quickly determine if user is assigned to a role
        global $ilDB;

        $ilDB->setLimit(1, 0);
        $query = "SELECT usr_id FROM rbac_ua WHERE " .
                    "rol_id= " . $ilDB->quote($a_role_id, 'integer') . " " .
                    "AND usr_id= " . $ilDB->quote($a_usr_id);
        $res = $ilDB->query($query);

        $is_assigned = $res->numRows() == 1;
        self::$is_assigned_cache[$a_role_id][$a_usr_id] = $is_assigned;

        return $is_assigned;
    }

isAssignedToAtLeastOneGivenRole()

ilRbacReview::isAssignedToAtLeastOneGivenRole	(		$a_usr_id,
			$a_role_ids
	)

check if a specific user is assigned to at least one of the given role ids.

This function is used to quickly check whether a user is member of a course or a group.

public

Parameters

integer	usr_id
array[integer]	role_ids

Returns

boolean

Todo:

refactor rolf => DONE

Definition at line 455 of file class.ilRbacReview.php.

References $ilDB, $query, and $res.

    {
        global $ilDB;

        $ilDB->setLimit(1, 0);
        $query = "SELECT usr_id FROM rbac_ua WHERE " .
                    $ilDB->in('rol_id', $a_role_ids, false, 'integer') .
                    " AND usr_id= " . $ilDB->quote($a_usr_id);
        $res = $ilDB->query($query);

        return $ilDB->numRows($res) == 1;
    }

isBlockedAtPosition()

ilRbacReview::isBlockedAtPosition	(		$a_role_id,
			$a_ref_id
	)

Check if role is blocked at position ilDB $ilDB.

Parameters

type	$a_role_id
type	$a_ref_id

Returns

boolean

Definition at line 1324 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by isBlockedInUpperContext().

    {
        global $ilDB;
        
        $query = 'SELECT blocked from rbac_fa ' .
                'WHERE rol_id = ' . $ilDB->quote($a_role_id, 'integer') . ' ' .
                'AND parent = ' . $ilDB->quote($a_ref_id, 'integer');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (bool) $row->blocked;
        }
        return false;
    }

Here is the caller graph for this function:

isBlockedInUpperContext()

ilRbacReview::isBlockedInUpperContext	(		$a_role_id,
			$a_ref_id
	)

Check if role is blocked in upper context.

Parameters

type	$a_role_id
type	$a_ref_id

Definition at line 1343 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, array, ilDBConstants\FETCHMODE_OBJECT, and isBlockedAtPosition().

    {
        global $ilDB, $tree;
        
        if ($this->isBlockedAtPosition($a_role_id, $a_ref_id)) {
            return false;
        }
        $query = 'SELECT parent from rbac_fa ' .
                'WHERE rol_id = ' . $ilDB->quote($a_role_id, 'integer') . ' ' .
                'AND blocked = ' . $ilDB->quote(1, 'integer');
        $res = $ilDB->query($query);
        
        $parent_ids = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $parent_ids[] = $row->parent;
        }
        
        foreach ($parent_ids as $parent_id) {
            if ($tree->isGrandChild($parent_id, $a_ref_id)) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

isDeleteable()

ilRbacReview::isDeleteable	(		$a_role_id,
			$a_rolf_id
	)

Check if role is deleteable at a specific position.

Parameters

object	$a_role_id
	int	rolf_id

Returns

Todo:

refactor rolf => DONE

Definition at line 1644 of file class.ilRbacReview.php.

References ilObject\_lookupTitle(), and isAssignable().

    {
        if (!$this->isAssignable($a_role_id, $a_rolf_id)) {
            return false;
        }
        if ($a_role_id == SYSTEM_ROLE_ID or $a_role_id == ANONYMOUS_ROLE_ID) {
            return false;
        }
        if (substr(ilObject::_lookupTitle($a_role_id), 0, 3) == 'il_') {
            return false;
        }
        return true;
    }

Here is the call graph for this function:

isDeleted()

ilRbacReview::isDeleted

(

$a_node_id

)

Checks if a rolefolder is set as deleted (negative tree_id) public.

Parameters

integer

ref_id of rolefolder

Returns

boolean true if rolefolder is set as deleted

Todo:

refactor rolf => DELETE method

Definition at line 1050 of file class.ilRbacReview.php.

References $ilDB, $message, $r, $row, ilDBConstants\FETCHMODE_OBJECT, and ilDB\query().

Referenced by isRoleDeleted().

    {
        global $ilDB;
        
        $q = "SELECT tree FROM tree WHERE child =" . $ilDB->quote($a_node_id) . " ";
        $r = $this->ilDB->query($q);
        
        $row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        
        if (!$row) {
            $message = sprintf(
                '%s::isDeleted(): Role folder with ref_id %s not found!',
                get_class($this),
                $a_node_id
            );
            $this->log->write($message, $this->log->FATAL);

            return true;
        }

        // rolefolder is deleted
        if ($row->tree < 0) {
            return true;
        }
        
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isGlobalRole()

ilRbacReview::isGlobalRole

(

$a_role_id

)

Check if role is a global role.

Parameters

type

$a_role_id

Returns

type

Todo:

refactor rolf => DONE

Definition at line 1084 of file class.ilRbacReview.php.

References getGlobalRoles().

    {
        return in_array($a_role_id, $this->getGlobalRoles());
    }

Here is the call graph for this function:

isProtected()

ilRbacReview::isProtected	(		$a_ref_id,
			$a_role_id
	)

Todo:

refactor rolf => search calls ilDB $ilDB

Parameters

type	$a_ref_id
type	$a_role_id

Returns

type

Todo:

refactor rolf => DONE

Definition at line 1304 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, and ilUtil\yn2tf().

    {
        global $ilDB;

        // ref_id not used yet. protected permission acts 'global' for each role,
        $query = "SELECT protected FROM rbac_fa " .
             "WHERE rol_id = " . $ilDB->quote($a_role_id, 'integer') . " ";
        $res = $ilDB->query($query);
        $row = $ilDB->fetchAssoc($res);
        
        return ilUtil::yn2tf($row['protected']);
    }

Here is the call graph for this function:

isRoleAssignedToObject()

ilRbacReview::isRoleAssignedToObject	(		$a_role_id,
			$a_parent_id
	)

Check if role is assigned to an object.

Todo:

refactor rolf => DONE (renamed)

Definition at line 752 of file class.ilRbacReview.php.

References $ilDB, $query, and $res.

    {
        global $rbacreview, $ilDB;

        $query = 'SELECT * FROM rbac_fa ' .
            'WHERE rol_id = ' . $ilDB->quote($a_role_id, 'integer') . ' ' .
            'AND parent = ' . $ilDB->quote($a_parent_id, 'integer');
        $res = $ilDB->query($query);
        return $res->numRows() ? true : false;
    }

isRoleDeleted()

ilRbacReview::isRoleDeleted

(

$a_role_id

)

return if role is only attached to deleted role folders

Parameters

int

$a_role_id

Returns

boolean

Todo:

refactor rolf => DONE

Definition at line 1563 of file class.ilRbacReview.php.

References getFoldersAssignedToRole(), and isDeleted().

    {
        $rolf_list = $this->getFoldersAssignedToRole($a_role_id, false);
        $deleted = true;
        if (count($rolf_list)) {
            foreach ($rolf_list as $rolf) {
                // only list roles that are not set to status "deleted"
                if (!$this->isDeleted($rolf)) {
                    $deleted = false;
                    break;
                }
            }
        }
        return $deleted;
    }

Here is the call graph for this function:

isSystemGeneratedRole()

ilRbacReview::isSystemGeneratedRole

(

$a_role_id

)

Check if the role is system generate role or role template.

Parameters

int

$a_role_id

Returns

bool

Todo:

refactor rolf => DONE

Definition at line 1664 of file class.ilRbacReview.php.

References $title, and ilObject\_lookupTitle().

    {
        $title = ilObject::_lookupTitle($a_role_id);
        return substr($title, 0, 3) == 'il_' ? true : false;
    }

Here is the call graph for this function:

lookupCreateOperationIds()

static ilRbacReview::lookupCreateOperationIds (   $a_type_arr )

static

Lookup operation ids.

Parameters

array

$a_type_arr

e.g array('cat','crs','grp'). The operation name (e.g. 'create_cat') is generated automatically

Returns

array int Array with operation ids

Todo:

refactor rolf => DONE

Definition at line 1266 of file class.ilRbacReview.php.

References $ilDB, $query, $res, $row, $type, and array.

Referenced by ilObjectXMLWriter\__appendOperations(), ilObjectRoleTemplatePermissionTableGUI\parse(), ilObjectRolePermissionTableGUI\parse(), ilPermissionGUI\savePermissions(), and ilObjStudyProgrammeTest\testCreatePermissionExists().

    {
        global $ilDB;
        
        $operations = array();
        foreach ($a_type_arr as $type) {
            $operations[] = ('create_' . $type);
        }
        
        if (!count($operations)) {
            return array();
        }
        
        $query = 'SELECT ops_id, operation FROM rbac_operations ' .
            'WHERE ' . $ilDB->in('operation', $operations, false, 'text');
            
        $res = $ilDB->query($query);
    
        $ops_ids = array();
        while ($row = $ilDB->fetchObject($res)) {
            $type_arr = explode('_', $row->operation);
            $type = $type_arr[1];
            
            $ops_ids[$type] = $row->ops_id;
        }
        return $ops_ids;
    }

Here is the caller graph for this function:

roleExists()

ilRbacReview::roleExists	(		$a_title,
			$a_id = 0
	)

Checks if a role already exists.

Role title should be unique public

Parameters

string	role title
integer	obj_id of role to exclude in the check. Commonly this is the current role you want to edit

Returns

boolean true if exists

Todo:

refactor rolf => DONE

Definition at line 75 of file class.ilRbacReview.php.

References $ilDB, $message, $r, $row, ilDBConstants\FETCHMODE_OBJECT, and ilDB\query().

    {
        global $ilDB;
        
        if (empty($a_title)) {
            $message = get_class($this) . "::roleExists(): No title given!";
            $this->ilErr->raiseError($message, $this->ilErr->WARNING);
        }
        
        $clause = ($a_id) ? " AND obj_id != " . $ilDB->quote($a_id) . " " : "";
        
        $q = "SELECT DISTINCT(obj_id) obj_id FROM object_data " .
             "WHERE title =" . $ilDB->quote($a_title) . " " .
             "AND type IN('role','rolt')" .
             $clause . " ";
        $r = $this->ilDB->query($q);

        while ($row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->obj_id;
        }
        return false;
    }

Here is the call graph for this function:

setAssignedCacheEntry()

ilRbacReview::setAssignedCacheEntry	(		$a_role_id,
			$a_user_id,
			$a_value
	)

set entry of assigned_chache

Parameters

int	$a_role_id
int	$a_user_id
bool	$a_value

Definition at line 1738 of file class.ilRbacReview.php.

    {
        self::$is_assigned_cache[$a_role_id][$a_user_id] = $a_value;
    }

Field Documentation

$_opsCache

ilRbacReview::$_opsCache = null

staticprivate

Definition at line 29 of file class.ilRbacReview.php.

$assigned_users_cache

ilRbacReview::$assigned_users_cache = array()

staticprotected

Definition at line 34 of file class.ilRbacReview.php.

$is_assigned_cache

ilRbacReview::$is_assigned_cache = array()

staticprotected

Definition at line 39 of file class.ilRbacReview.php.

$log

ilRbacReview::$log

protected

Definition at line 44 of file class.ilRbacReview.php.

Referenced by __setProtectedStatus().

FILTER_ALL

const ilRbacReview::FILTER_ALL = 1

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

Referenced by ilRoleTableGUI\initFilter(), and ilRoleTableGUI\parse().

FILTER_ALL_GLOBAL

const ilRbacReview::FILTER_ALL_GLOBAL = 2

Definition at line 22 of file class.ilRbacReview.php.

Referenced by ilRoleTableGUI\initFilter().

FILTER_ALL_LOCAL

const ilRbacReview::FILTER_ALL_LOCAL = 3

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

Referenced by ilRoleTableGUI\initFilter().

FILTER_INTERNAL

const ilRbacReview::FILTER_INTERNAL = 4

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

Referenced by ilRoleTableGUI\initFilter(), and ilRoleTableGUI\parse().

FILTER_NOT_INTERNAL

const ilRbacReview::FILTER_NOT_INTERNAL = 5

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

Referenced by ilRoleTableGUI\initFilter().

FILTER_TEMPLATES

const ilRbacReview::FILTER_TEMPLATES = 6

Definition at line 26 of file class.ilRbacReview.php.

Referenced by ilRoleTableGUI\initFilter().

---

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

• Services/AccessControl/classes/class.ilRbacReview.php