TWiki/TWikiAccessControlExceptionDotPm.mdwn

   1 # <a name="Package &lt;code&gt;TWiki::_AccessControlEx"></a> Package =TWiki::AccessControlException
   2
   3 **extends** `Error`
   4
   5 Exception used raise an access control violation.
   6
   7 <div>
   8   <ul>
   9     <li><a href="#Package =TWiki::_AccessControlEx"> Package TWiki::AccessControlException</a><ul>
  10         <li><a href="#ClassMethod <strong>new</strong> ($mode,$user,$"> ClassMethod new <tt>($mode,$user,$web,$topic,$reason)</tt></a></li>
  11         <li><a href="#ObjectMethod <strong>stringify</strong> () -> $"> ObjectMethod stringify <tt>() -&gt; $string</tt></a></li>
  12       </ul>
  13     </li>
  14   </ul>
  15 </div>
  16
  17 ## <a name="ClassMethod &lt;strong&gt;new&lt;/strong&gt; ($mode,$user,$"></a> [[ClassMethod]] **new** `($mode,$user,$web,$topic,$reason)`
  18
  19 - `$mode` - mode of access (view, change etc)
  20 - `$user` - user object doing the accessing
  21 - `$web` - web being accessed
  22 - `$topic` - topic being accessed
  23 - `$reason` - string reason for failure
  24
  25 All the above fields are accessible from the object in a catch clause in the usual way e.g. `$e->{web}` and `$e->{reason}`
  26
  27 ## <a name="ObjectMethod &lt;strong&gt;stringify&lt;/strong&gt; () - $s"></a> [[ObjectMethod]] **stringify** `() -> $string`
  28
  29 Generate a summary string