This is a DistributionDocument
. This document is generated, please do not change it
. Put questions, error notes, and suggestions concerning the documentation
of this topic in the comments section below
. Use the Support
web for problems you are having using
A singleton object of this class manages the access control database.
Construct a new singleton object to manage the permissions
ObjectMethod permissionsSet ($web) -> $boolean
Are there any security restrictions for this Web
(ignoring settings on individual pages).
Return a string describing the reason why the last access control failure
ObjectMethod checkAccessPermission ($action,$user,$text,$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
$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.
Comments & Questions about this Distribution Document Topic
With T4.1.2, there is now a $meta parameter that is between text and topic. From the code:
* =$meta= - If undef, but =$text= is defined, then metadata will be parsed from =$text=. If defi
ned, then metadata embedded in =$text= will be ignored. Always ignored if =$text= is undefined. Settin
gs in =$meta= override * Set settings in plain text.
- 18 May 2007
Please do not use TWiki::Access in your plugin, use only the official API in TWikiFuncDotPm
- 19 May 2007
Thanks Peter, my point here was that this was out of date, in case people are trying to debug code that didn't use Func. I thought this was generated content, so I was surprised its out of sync with the POD.
- 01 Jun 2007
To reduce confusion, we will stop shipping the internal modul doc. See DontShipDotPmTopics
- 01 Jun 2007