TWikiAccessDotPm < TWiki

Webs
Main
Sandbox
TWiki

You are here: FS > TWiki Web > TWikiAccessDotPm	r1 - 17 Dec 2005 - 13:33 - TWikiContributor
EditAttachPrintable

Start of topic | Skip to actions

---+ Package =TWiki::Access=

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


%TOC%

---++ ClassMethod *new* <tt>()</tt>

Construct a new singleton object to manage the permissions
database.



---++ ObjectMethod *permissionsSet* <tt>($web) -> $boolean</tt>

Are there any security restrictions for this Web
(ignoring settings on individual pages).



---++ ObjectMethod *getReason* <tt>() -> $string</tt>

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



---++ ObjectMethod *checkAccessPermission* <tt>($action,$user,$text,$topic,$web) -> $boolean</tt>
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.

End of topic
Skip to actions | Back to top

Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding FS? Send feedback