See
PublishedAPI for packages intended to be used by Plugin and Contrib authors, or
browse all packages.
See also
Developing plugins,
Developer's Bible,
Technical Overview
internal package
Foswiki::Access
A singleton object of this class manages the access control database.
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
haveAccess($mode, $User, $web, $topic, $attachment) → $boolean
ObjectMethod
haveAccess($mode, $User, $meta) → $boolean
ObjectMethod
haveAccess($mode, $User, $address) → $boolean
-
$mode
- 'VIEW', 'CHANGE', 'CREATE', etc. (defaults to VIEW)
-
$cUID
- Canonical user id (defaults to current user)
Check if the user has the given mode of access to the topic. This call
may result in the topic being read.