• This web contains the official documentation of the TWiki Release 4.1, code named EdinburghRelease. It is a read-only web for reference.
• This is an older release, see TWiki-6.1 for the latest release documentation.
Tags:
create new tag
view all tags

Package TWiki::Access

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

ClassMethod new ()

Construct a new singleton object to manage the permissions database.

ObjectMethod permissionsSet ($web) -> $boolean

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

Edit | Attach | Watch | Print version | History: r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r3 - 2007-01-16 - TWikiContributor
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2026 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.