Welcome | Register | Changes | Topics | Index | Search | Go

<<O>> Difference Topic TWikiAccessDotPm (4 - 2008-01-22 - TWikiContributor)

  Package =TWiki::Access 

A singleton object of this class manages the access control database.


On this page: 
  Basics of dynamic access control
   When to check the user is an admin
   Why caching matters
   How permission should be cached and cached data should be used
   Data structure
   Notes for unit test
   ClassMethod new ($session)
   ObjectMethod finish ()
   ObjectMethod getReason () -> $string
   ObjectMethod checkAccessPermission ($action,$user,$text,$meta,$topic,$web) -> $boolean
-<
<
+ ClassMethod new ()
->
>
+ ClassMethod new ($session)
-<
<
+Construct a new singleton object to manage the permissions
->
>
+Constructor.
-<
<
+database.
-<
<
+ ObjectMethod permissionsSet ($web) -> $boolean
->
>
+ ObjectMethod finish ()
->
>
+Break circular references.
-<
<
+Are there any security restrictions for this Web
(ignoring settings on individual pages).
-<
<
  ObjectMethod getReason () -> $string 

Return a string describing the reason why the last access control failure
occurred.



 ObjectMethod *checkAccessPermission ($action,$user,$text,$meta,$topic,$web) -> $boolean 

Check if user is allowed to access topic 

 $action  - 'VIEW', 'CHANGE', 'CREATE', etc.
-<
<
+ $user    - User object
->
>
+ $user    - User id (not wikiname)
  $text    - If undef or '': Read '$theWebName.$theTopicName' to check permissions
  $meta    - If undef, but $text is defined, then metadata will be parsed from $text. If defined, then metadata embedded in $text will be ignored. Always ignored if $text is undefined. Settings in $meta override * Set settings in plain text.
  $topic   - Topic name to check, e.g. 'SomeTopic' *undef to check web perms only)
  $web     - Web, e.g. 'Know'
 
If the check fails, the reason can be recoveered using getReason.

View | History: r5 < r4 < r3 < r2 | More

Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiAccessDotPm.

Welcome | Register | Changes | Topics | Index | Search | Go

Package =TWiki::Access

ClassMethod new `()`

ClassMethod new `($session)`

ObjectMethod permissionsSet `($web) -> $boolean`

ObjectMethod finish `()`

ObjectMethod getReason `() -> $string`

ObjectMethod *checkAccessPermission `($action,$user,$text,$meta,$topic,$web) -> $boolean`