/usr/share/doc/rt4-doc-html/RT/CurrentUser.html is in rt4-doc-html 4.0.19-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 | <ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#METHODS">METHODS</a>
<ul>
<li><a href="#new">new</a></li>
<li><a href="#Create-Delete-and-Set">Create, Delete and Set*</a></li>
<li><a href="#UserObj">UserObj</a></li>
<li><a href="#LoadByGecos">LoadByGecos</a></li>
<li><a href="#LoadByName">LoadByName</a></li>
<li><a href="#LanguageHandle">LanguageHandle</a></li>
<li><a href="#CurrentUser">CurrentUser</a></li>
</ul>
</li>
</ul>
<h1 id="NAME"><a href="#___top">NAME</a></h1>
<pre><code> RT::CurrentUser - an RT object representing the current user</code></pre>
<h1 id="SYNOPSIS"><a href="#___top">SYNOPSIS</a></h1>
<pre><code> use RT::CurrentUser;
# laod
my $current_user = RT::CurrentUser->new;
$current_user->Load(...);
# or
my $current_user = RT::CurrentUser->new( $user_obj );
# or
my $current_user = RT::CurrentUser->new( $address || $name || $id );
# manipulation
$current_user->UserObj->SetName('new_name');</code></pre>
<h1 id="DESCRIPTION"><a href="#___top">DESCRIPTION</a></h1>
<p><b>Read-only</b> subclass of <a href="../../../rt/latest/RT/User.html">RT::User</a> class. Used to define the current user. You should pass an instance of this class to constructors of many RT classes, then the instance used to check ACLs and localize strings.</p>
<h1 id="METHODS"><a href="#___top">METHODS</a></h1>
<p>See also <a href="../../../rt/latest/RT/User.html">RT::User</a> for a list of methods this class has.</p>
<h2 id="new"><a href="#___top">new</a></h2>
<p>Returns new CurrentUser object. Unlike all other classes of RT it takes either subclass of <code>RT::User</code> class object or scalar value that is passed to Load method.</p>
<h2 id="Create-Delete-and-Set"><a href="#___top">Create, Delete and Set*</a></h2>
<p>As stated above it's a subclass of <a href="../../../rt/latest/RT/User.html">RT::User</a>, but this class is read-only and calls to these methods are illegal. Return 'permission denied' message and log an error.</p>
<h2 id="UserObj"><a href="#___top">UserObj</a></h2>
<p>Returns the <a href="../../../rt/latest/RT/User.html">RT::User</a> object associated with this CurrentUser object.</p>
<h2 id="LoadByGecos"><a href="#___top">LoadByGecos</a></h2>
<p>Loads a User into this CurrentUser object. Takes a unix username as its only argument.</p>
<h2 id="LoadByName"><a href="#___top">LoadByName</a></h2>
<p>Loads a User into this CurrentUser object. Takes a Name.</p>
<h2 id="LanguageHandle"><a href="#___top">LanguageHandle</a></h2>
<p>Returns this current user's langauge handle. Should take a language specification. but currently doesn't</p>
<h2 id="CurrentUser"><a href="#___top">CurrentUser</a></h2>
<p>Return the current currentuser object</p>
<a href="./../">← Back to index</a>
|