ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f87
ilClaimingPermissionHelper Class Reference

Claiming permission helper base class. More...

+ Inheritance diagram for ilClaimingPermissionHelper:
+ Collaboration diagram for ilClaimingPermissionHelper:

Public Member Functions

 reset ()
 Reset (internal caches) More...
 
 hasPermission ($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
 Check permission. More...
 
 hasPermissions ($a_context_type, $a_context_id, array $a_action_ids)
 Check permissions. More...
 

Static Public Member Functions

static getInstance ($a_user_id=null, $a_ref_id=null)
 Factory. More...
 

Protected Member Functions

 __construct ($a_user_id, $a_ref_id)
 Constructor. More...
 
 setUserId ($a_value)
 Set user id. More...
 
 getUserId ()
 Get user id. More...
 
 setRefId ($a_value)
 Set ref id. More...
 
 getRefId ()
 Get ref id. More...
 
 readContextIds ($a_context_type)
 Get all context ids for context type (from DB, is cached) More...
 
 buildPermissionMap ()
 Build map of context and actions. More...
 
 isValidContextAndAction ($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
 Check if given combination of context and action is valid. More...
 
 getValidContextIds ($a_context_type)
 Get context ids for context type (uses cache) More...
 
 checkPermission ($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
 Check permission (helper: rbac, plugins) More...
 
 checkRBAC ()
 Check permission against RBAC. More...
 
 getActivePlugins ()
 Get active plugins (for current slot) More...
 
 checkPlugins ($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
 Check permission against plugins. More...
 

Protected Attributes

 $user_id
 
 $ref_id
 
 $map
 
 $context_ids
 
 $plugins
 

Static Protected Attributes

static $instances
 

Detailed Description

Claiming permission helper base class.

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

Definition at line 12 of file class.ilClaimingPermissionHelper.php.

Constructor & Destructor Documentation

◆ __construct()

ilClaimingPermissionHelper::__construct (   $a_user_id,
  $a_ref_id 
)
protected

Constructor.

Parameters
int$a_user_id
int$a_ref_id
Returns
self

Definition at line 32 of file class.ilClaimingPermissionHelper.php.

References buildPermissionMap(), reset(), setRefId(), and setUserId().

33  {
34  $this->setUserId($a_user_id);
35  $this->setRefId($a_ref_id);
36  $this->map = $this->buildPermissionMap();
37  $this->reset();
38  }
buildPermissionMap()
Build map of context and actions.
+ Here is the call graph for this function:

Member Function Documentation

◆ buildPermissionMap()

ilClaimingPermissionHelper::buildPermissionMap ( )
abstractprotected

Build map of context and actions.

Returns
array

Referenced by __construct(), and getRefId().

+ Here is the caller graph for this function:

◆ checkPermission()

ilClaimingPermissionHelper::checkPermission (   $a_context_type,
  $a_context_id,
  $a_action_id,
  $a_action_sub_id = null 
)
protected

Check permission (helper: rbac, plugins)

Parameters
int$a_context_type
int$a_context_id
int$a_action_id
int$a_action_sub_id
Returns
bool

Definition at line 259 of file class.ilClaimingPermissionHelper.php.

References checkPlugins(), and checkRBAC().

Referenced by hasPermission().

260  {
261  return ($this->checkRBAC() &&
262  $this->checkPlugins($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id));
263  }
checkRBAC()
Check permission against RBAC.
checkPlugins($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
Check permission against plugins.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ checkPlugins()

ilClaimingPermissionHelper::checkPlugins (   $a_context_type,
  $a_context_id,
  $a_action_id,
  $a_action_sub_id = null 
)
protected

Check permission against plugins.

Parameters
int$a_context_type
int$a_context_id
int$a_action_id
int$a_action_sub_id
Returns
boolean

Definition at line 294 of file class.ilClaimingPermissionHelper.php.

References $valid, and getActivePlugins().

Referenced by checkPermission().

295  {
296  $valid = true;
297 
298  if(!is_array($this->plugins))
299  {
300  $this->plugins = (array)$this->getActivePlugins();
301  }
302 
303  foreach($this->plugins as $plugin)
304  {
305  if(!$plugin->checkPermission($this->getUserId(), $a_context_type, $a_context_id, $a_action_id, $a_action_sub_id))
306  {
307  $valid = false;
308  break;
309  }
310  }
311 
312  return $valid;
313  }
$valid
getActivePlugins()
Get active plugins (for current slot)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ checkRBAC()

ilClaimingPermissionHelper::checkRBAC ( )
protected

Check permission against RBAC.

Returns
bool

Definition at line 270 of file class.ilClaimingPermissionHelper.php.

References getActivePlugins(), getRefId(), and getUserId().

Referenced by checkPermission().

271  {
272  global $ilAccess;
273 
274  // we are currently only supporting write operations
275  return $ilAccess->checkAccessOfUser($this->getUserId(), "write", "", $this->getRefId());
276  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getActivePlugins()

ilClaimingPermissionHelper::getActivePlugins ( )
abstractprotected

Get active plugins (for current slot)

Returns
array ilPlugin

Referenced by checkPlugins(), and checkRBAC().

+ Here is the caller graph for this function:

◆ getInstance()

static ilClaimingPermissionHelper::getInstance (   $a_user_id = null,
  $a_ref_id = null 
)
static

Factory.

Parameters
int$a_user_id
int$a_ref_id
Returns
self

Definition at line 47 of file class.ilClaimingPermissionHelper.php.

References $_REQUEST, and $ilUser.

Referenced by ilCustomUserFieldsGUI\__construct(), and ilAdvancedMDSettingsGUI\__construct().

48  {
49  global $ilUser;
50 
51  if(!$a_user_id)
52  {
53  $a_user_id = $ilUser->getId();
54  }
55  if(!$a_ref_id)
56  {
57  $a_ref_id = (int)$_REQUEST["ref_id"];
58  }
59  if(!isset(self::$instances[$a_user_id][$a_ref_id]))
60  {
61  self::$instances[$a_user_id][$a_ref_id] = new static($a_user_id, $a_ref_id);
62  }
63  return self::$instances[$a_user_id][$a_ref_id];
64  }
global $ilUser
Definition: imgupload.php:15
if($_REQUEST['ilias_path']) define('ILIAS_HTTP_PATH' $_REQUEST['ilias_path']
Definition: index.php:7
+ Here is the caller graph for this function:

◆ getRefId()

ilClaimingPermissionHelper::getRefId ( )
protected

Get ref id.

Returns
int

Definition at line 112 of file class.ilClaimingPermissionHelper.php.

References $ref_id, buildPermissionMap(), and readContextIds().

Referenced by checkRBAC().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getUserId()

ilClaimingPermissionHelper::getUserId ( )
protected

Get user id.

Returns
int

Definition at line 92 of file class.ilClaimingPermissionHelper.php.

References $user_id.

Referenced by checkRBAC().

+ Here is the caller graph for this function:

◆ getValidContextIds()

ilClaimingPermissionHelper::getValidContextIds (   $a_context_type)
protected

Get context ids for context type (uses cache)

See also
self::readContextIds()
Parameters
int$a_context_type
Returns
array

Definition at line 193 of file class.ilClaimingPermissionHelper.php.

References readContextIds().

Referenced by isValidContextAndAction().

194  {
195  if(!array_key_exists($a_context_type, $this->context_ids))
196  {
197  $this->context_ids[$a_context_type] = $this->readContextIds($a_context_type);
198  }
199  return (array)$this->context_ids[$a_context_type];
200  }
readContextIds($a_context_type)
Get all context ids for context type (from DB, is cached)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ hasPermission()

ilClaimingPermissionHelper::hasPermission (   $a_context_type,
  $a_context_id,
  $a_action_id,
  $a_action_sub_id = null 
)

Check permission.

Parameters
int$a_context_type
int$a_context_id
int$a_action_id
int$a_action_sub_id
Returns
bool

Definition at line 211 of file class.ilClaimingPermissionHelper.php.

References checkPermission(), and isValidContextAndAction().

Referenced by hasPermissions(), and ilAdvancedMDFieldDefinition\importDefinitionFormPostValues().

212  {
213  if($this->isValidContextAndAction($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id))
214  {
215  return $this->checkPermission($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id);
216  }
217  // :TODO: exception?
218  }
checkPermission($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
Check permission (helper: rbac, plugins)
isValidContextAndAction($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
Check if given combination of context and action is valid.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ hasPermissions()

ilClaimingPermissionHelper::hasPermissions (   $a_context_type,
  $a_context_id,
array  $a_action_ids 
)

Check permissions.

Parameters
int$a_context_type
int$a_context_id
array$a_action_ids
Returns
bool

Definition at line 228 of file class.ilClaimingPermissionHelper.php.

References $res, and hasPermission().

Referenced by ilAdvancedMDFieldDefinition\addToFieldDefinitionForm().

229  {
230  $res = array();
231 
232  foreach($a_action_ids as $action_id)
233  {
234  if(is_array($action_id))
235  {
236  $action_sub_id = $action_id[1];
237  $action_id = $action_id[0];
238 
239  $res[$action_id][$action_sub_id] = $this->hasPermission($a_context_type, $a_context_id, $action_id, $action_sub_id);
240  }
241  else
242  {
243  $res[$action_id] = $this->hasPermission($a_context_type, $a_context_id, $action_id);
244  }
245  }
246 
247  return $res;
248  }
hasPermission($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
Check permission.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isValidContextAndAction()

ilClaimingPermissionHelper::isValidContextAndAction (   $a_context_type,
  $a_context_id,
  $a_action_id,
  $a_action_sub_id = null 
)
protected

Check if given combination of context and action is valid.

Parameters
int$a_context_type
mixed$a_context_id
int$a_action_id
int$a_action_sub_id
Returns
boolean

Definition at line 148 of file class.ilClaimingPermissionHelper.php.

References $valid, and getValidContextIds().

Referenced by hasPermission().

149  {
150  $valid = false;
151 
152  if(array_key_exists($a_context_type, $this->map))
153  {
154  if(!$a_action_sub_id)
155  {
156  if(in_array($a_action_id, $this->map[$a_context_type]["actions"]))
157  {
158  $valid = true;
159  }
160  }
161  else
162  {
163  if(array_key_exists($a_action_id, $this->map[$a_context_type]["subactions"]) &&
164  in_array($a_action_sub_id, $this->map[$a_context_type]["subactions"][$a_action_id]))
165  {
166  $valid = true;
167  }
168  }
169  }
170 
171  if($valid &&
172  $a_context_id &&
173  !in_array($a_context_id, $this->getValidContextIds($a_context_type)))
174  {
175  $valid = false;
176  }
177 
178  if(DEVMODE && !$valid)
179  {
180  trigger_error("INVALID permission context - ".$a_context_type.":".$a_context_id.":".$a_action_id.":".$a_action_sub_id, E_USER_WARNING);
181  }
182 
183  return $valid;
184  }
$valid
getValidContextIds($a_context_type)
Get context ids for context type (uses cache)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ readContextIds()

ilClaimingPermissionHelper::readContextIds (   $a_context_type)
abstractprotected

Get all context ids for context type (from DB, is cached)

See also
self::getValidContextIds()
Parameters
int$a_context_type
Returns
array

Referenced by getRefId(), and getValidContextIds().

+ Here is the caller graph for this function:

◆ reset()

ilClaimingPermissionHelper::reset ( )

Reset (internal caches)

Definition at line 69 of file class.ilClaimingPermissionHelper.php.

Referenced by __construct().

70  {
71  $this->context_ids = array();
72  }
+ Here is the caller graph for this function:

◆ setRefId()

ilClaimingPermissionHelper::setRefId (   $a_value)
protected

Set ref id.

Parameters
int$a_value

Definition at line 102 of file class.ilClaimingPermissionHelper.php.

Referenced by __construct().

103  {
104  $this->ref_id = (int)$a_value;
105  }
+ Here is the caller graph for this function:

◆ setUserId()

ilClaimingPermissionHelper::setUserId (   $a_value)
protected

Set user id.

Parameters
int$a_value

Definition at line 82 of file class.ilClaimingPermissionHelper.php.

Referenced by __construct().

83  {
84  $this->user_id = (int)$a_value;
85  }
+ Here is the caller graph for this function:

Field Documentation

◆ $context_ids

ilClaimingPermissionHelper::$context_ids
protected

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

◆ $instances

ilClaimingPermissionHelper::$instances
staticprotected

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

◆ $map

ilClaimingPermissionHelper::$map
protected

Definition at line 16 of file class.ilClaimingPermissionHelper.php.

◆ $plugins

ilClaimingPermissionHelper::$plugins
protected

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

◆ $ref_id

ilClaimingPermissionHelper::$ref_id
protected

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

Referenced by getRefId().

◆ $user_id

ilClaimingPermissionHelper::$user_id
protected

Definition at line 14 of file class.ilClaimingPermissionHelper.php.

Referenced by getUserId().


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