Package TWiki::Access

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

On this page:

ClassMethod new ($session)

Constructor.

ObjectMethod finish ()

Break circular references.

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 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.

This topic: TWiki > TWikiAccessDotPm
Topic revision: r4 - 22 Jan 2008 - 00:21:27 - TWikiContributor
 
This site is powered by the TWiki collaboration platformCopyright � 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