TWiki/TWikiAccessDotPm.mdwn

   1 # <a name="Package &lt;code&gt;TWiki::Access="></a> Package =TWiki::Access
   2
   3 A singleton object of this class manages the access control database.
   4
   5 <div>
   6   <ul>
   7     <li><a href="#Package =TWiki::Access="> Package TWiki::Access</a><ul>
   8         <li><a href="#ClassMethod <strong>new</strong> ($session)"> ClassMethod new <tt>($session)</tt></a></li>
   9         <li><a href="#ObjectMethod <strong>finish</strong> ()"> ObjectMethod finish <tt>()</tt></a></li>
  10         <li><a href="#ObjectMethod <strong>getReason</strong> () -> $"> ObjectMethod getReason <tt>() -&gt; $string</tt></a></li>
  11         <li><a href="#ObjectMethod *check_AccessPermis"> ObjectMethod checkAccessPermission <tt>($action,$user,$text,$meta,$topic,$web) -&gt; $boolean</tt></a></li>
  12       </ul>
  13     </li>
  14   </ul>
  15 </div>
  16
  17 ## <a name="ClassMethod &lt;strong&gt;new&lt;/strong&gt; ($session)"></a> [[ClassMethod]] **new** `($session)`
  18
  19 Constructor.
  20
  21 ## <a name="ObjectMethod &lt;strong&gt;finish&lt;/strong&gt; ()"></a> [[ObjectMethod]] **finish** `()`
  22
  23 Break circular references.
  24
  25 ## <a name="ObjectMethod &lt;strong&gt;getReason&lt;/strong&gt; () - $s"></a> [[ObjectMethod]] **getReason** `() -> $string`
  26
  27 Return a string describing the reason why the last access control failure occurred.
  28
  29 ## <a name="ObjectMethod &lt;strong&gt;check_AccessPermis"></a> [[ObjectMethod]] \*checkAccessPermission `($action,$user,$text,$meta,$topic,$web) -> $boolean`
  30
  31 Check if user is allowed to access topic
  32
  33 - `$action` - 'VIEW', 'CHANGE', 'CREATE', etc.
  34 - `$user` - User id (**not** wikiname)
  35 - `$text` - If undef or '': Read '$theWebName.$theTopicName' to check permissions
  36 - `$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.
  37 - `$topic` - Topic name to check, e.g. 'SomeTopic' \*undef to check web perms only)
  38 - `$web` - Web, e.g. 'Know'
  39
  40 If the check fails, the reason can be recoveered using getReason.