Location: PHPKode > projects > Aukyla Document Management System > doc/html/a00122.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
  <head>
    <title>Aukyla PHP Framework</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <link rel="StyleSheet" href="auton.css" type="text/css" media="screen">
  </head>

  <body>
    <div id="mainmenu">
      <a href="http://www.auton.nl/" class="home">Home</a>
    </div>
    <div id="submenu">
      <a class="logo" href="http://www.auton.nl/"></a>

      <div class="head">Ads</div>
      <a href="http://sourceforge.net/"><img src="http://sourceforge.net/sflogo.php?group_id=116358&amp;type=1" alt="SourceForge.net Logo" style="padding: 2px 4px; width: 88px; height: 31px; border: 0px"></a>
      <a href="http://getfirefox.com/" title="Get Firefox - The Browser, Reloaded."><img src="http://www.mozilla.org/products/firefox/buttons/getfirefox_small.png" alt="Get Firefox" style="width: 110px; height: 32px; border: 0px"></a>
    </div>
    <div id="main">
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>Login Class Reference</h1><a href="a00047.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Class used for login management. 
<p>
The Login class handles user and group management. There's a ready to use <a class="el" href="a00123.html">LoginForm</a> which you may use to provide users a login form. The Login class will automatically notice when this form is submitted and the user will be logged in automatically. Active sessions are also automatically restored every time this class is instantiated. You can call the <a class="el" href="a00122.html#e6">logout()</a> function when the user should be logged out.<p>
The actual verification of the user credentials is done by a <a class="el" href="a00124.html">LoginHandler</a> class.<p>
This class emits the following signals:<ul>
<li>Login::UserLoggedIn($username), emitted when a user successfully logged in.</li><li>Login::FailedLoginAttempt($username), emitted when a user failed to log in.</li><li>Login::UserLoggedOut($username), emitted when a user successfully logged out.</li><li>Login::UserTimedOut($username), emitted when a user's session was removed because it was idle. </li></ul>

<p>

<p>
Definition at line <a class="el" href="a00220.html#l00055">55</a> of file <a class="el" href="a00220.html">Login.php</a>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a0">__construct</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a1">__destruct</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e0">login</a> ($username, $password)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e2">username</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e3">fullName</a> ($username= '')</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e4">userMail</a> ($username= '')</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e5">ipRange</a> ($username= '')</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e6">logout</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e7">setSessionVariable</a> ($variable, $value=false)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e8">sessionVariable</a> ($variable, $default= '')</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e9">saveSessionVariables</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e10">users</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e11">usersOfGroup</a> ($group)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e12">groups</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e13">memberGroups</a> ($username= '')</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e14">isMemberOf</a> ($group)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#e15">randomPassword</a> ($len=8)</td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a0" doxytag="Login::__construct"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::__construct           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constructor.<p>
Does initialization and automatically restores any previous session. If the user had just filled in a login form, the constructor will try to log in the user with the credentials he supplied. If this succeeds a new session is created for him, if it failes the view is reset to the login form.<p>
You do not have to instantiate this class yourself, instead you can use the static functions provided by this class.
<p>
Definition at line <a class="el" href="a00220.html#l00069">69</a> of file <a class="el" href="a00220.html">Login.php</a>.
<p>
References <a class="el" href="a00207.html#l00205">Config::globals()</a>, and <a class="el" href="a00207.html#l00243">Config::request()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a1" doxytag="Login::__destruct"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::__destruct           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Destructor.<p>
Saves session variables to disk.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00122.html#e9">saveSessionVariables()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00102">102</a> of file <a class="el" href="a00220.html">Login.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e3" doxytag="Login::fullName"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::fullName           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>username</em> = <code>''</code>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the full name of the user. If an anonymous username is given, this defaults to i18n('Anonymous').<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>username</em>&nbsp;</td><td>The user to get the full name of. If this is ommitted, the full name of the currently logged in user is given. This parameter was added in Aukyla 1.1. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The full name of the user.</dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00199">199</a> of file <a class="el" href="a00220.html">Login.php</a>.
<p>
References <a class="el" href="a00235.html#l00070">String::startsWith()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e12" doxytag="Login::groups"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::groups           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns all existing groups.<p>
<dl compact><dt><b>Returns:</b></dt><dd>An array of strings containing the names of all groups.</dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00408">408</a> of file <a class="el" href="a00220.html">Login.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e5" doxytag="Login::ipRange"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::ipRange           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>username</em> = <code>''</code>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the IP range from which a user may login.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>username</em>&nbsp;</td><td>The user to get the allowed IP range of. If this is ommitted, the allowed IP range for the currently logged in user is given. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The IP range for which the given user may login.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00153.html#e7">String::isIpInRange()</a></dd></dl>
<dl compact><dt><b>Since:</b></dt><dd>Aukyla 1.1</dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00258">258</a> of file <a class="el" href="a00220.html">Login.php</a>.
<p>
References <a class="el" href="a00235.html#l00070">String::startsWith()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e14" doxytag="Login::isMemberOf"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::isMemberOf           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>group</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Checks whether the user belongs to a certain group.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>The group to check for whether the user is a member. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if the user is a member of group, <code>false</code> otherwise.</dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00443">443</a> of file <a class="el" href="a00220.html">Login.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e0" doxytag="Login::login"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::login           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>username</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>password</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Logs the user in with the given <code>username</code> and <code>password</code>.<p>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if the user is successfully logged in, <code>false</code> otherwise.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>This function is called automatically if the user submits a <a class="el" href="a00123.html">LoginForm</a>.</dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00115">115</a> of file <a class="el" href="a00220.html">Login.php</a>.
<p>
References <a class="el" href="a00224.html#l00066">Messages::confirm()</a>, <a class="el" href="a00234.html#l00069">Signal::emit()</a>, <a class="el" href="a00224.html#l00056">Messages::error()</a>, <a class="el" href="a00219.html#l00066">Locale::init()</a>, <a class="el" href="a00235.html#l00176">String::isIpInRange()</a>, <a class="el" href="a00207.html#l00243">Config::request()</a>, <a class="el" href="a00207.html#l00275">Config::setRequest()</a>, and <a class="el" href="a00207.html#l00310">Config::unsetRequests()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e6" doxytag="Login::logout"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::logout           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Logs the current user out.
<p>
Definition at line <a class="el" href="a00220.html#l00280">280</a> of file <a class="el" href="a00220.html">Login.php</a>.
<p>
References <a class="el" href="a00224.html#l00066">Messages::confirm()</a>, <a class="el" href="a00234.html#l00069">Signal::emit()</a>, and <a class="el" href="a00235.html#l00070">String::startsWith()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e13" doxytag="Login::memberGroups"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::memberGroups           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>username</em> = <code>''</code>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns all groups the user is a member of.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>username</em>&nbsp;</td><td>The user to find the member groups of. If this is ommitted, the member groups of the currently logged in user are given. This parameter was added in Aukyla 1.1. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>An array of strings containing the names of all groups the user is a member of.</dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00424">424</a> of file <a class="el" href="a00220.html">Login.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e15" doxytag="Login::randomPassword"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::randomPassword           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>len</em> = <code>8</code>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Function for generating random passwords or session ID's.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>Length of the password/session ID to return. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A highly random string containing upper and lower case letters and numbers of the given length.</dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00657">657</a> of file <a class="el" href="a00220.html">Login.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e9" doxytag="Login::saveSessionVariables"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::saveSessionVariables           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Saves the session variables to disk.<p>
Usually, you shouldn't have to call this function yourself as it's called automatically by the destructor.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00122.html#e8">sessionVariable()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00356">356</a> of file <a class="el" href="a00220.html">Login.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e8" doxytag="Login::sessionVariable"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::sessionVariable           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>variable</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>default</em> = <code>''</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets a previously stored session variable.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>variable</em>&nbsp;</td><td>Name of the variable to get. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>default</em>&nbsp;</td><td>The default value for in case the variable could not be found. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The value of the variable, or the default value if the variable was not found.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00122.html#e7">setSessionVariable()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00334">334</a> of file <a class="el" href="a00220.html">Login.php</a>.
<p>
Referenced by <a class="el" href="a00238.html#l00056">ViewContainer::__construct()</a>, and <a class="el" href="a00226.html#l00067">TabWidget::__construct()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e7" doxytag="Login::setSessionVariable"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::setSessionVariable           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>variable</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>value</em> = <code>false</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets a variable for the length of this session.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>variable</em>&nbsp;</td><td>The name of the variable to set. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The value of the variable. If you set this to <code>false</code> (the default), the given variable will be unset.</td></tr>
  </table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00122.html#e8">sessionVariable()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00309">309</a> of file <a class="el" href="a00220.html">Login.php</a>.
<p>
Referenced by <a class="el" href="a00238.html#l00056">ViewContainer::__construct()</a>, and <a class="el" href="a00226.html#l00067">TabWidget::__construct()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e4" doxytag="Login::userMail"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::userMail           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>username</em> = <code>''</code>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the email address of the user.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>username</em>&nbsp;</td><td>The user to get the email address of. If this is ommitted, the email addresse of the currently logged in user is given. This parameter was added in Aukyla 1.1. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The email address of the user. If none is given, this is an empty string.</dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00227">227</a> of file <a class="el" href="a00220.html">Login.php</a>.
<p>
References <a class="el" href="a00235.html#l00070">String::startsWith()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e2" doxytag="Login::username"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::username           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the username of the currently logged in user. If the username begins with "anonymous", the user is <b>not</b> logged in.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The username of the currently logged in user.</dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00183">183</a> of file <a class="el" href="a00220.html">Login.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e10" doxytag="Login::users"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::users           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns all existing users.<p>
<dl compact><dt><b>Returns:</b></dt><dd>An array of strings containing the names of all users.</dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00380">380</a> of file <a class="el" href="a00220.html">Login.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e11" doxytag="Login::usersOfGroup"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Login::usersOfGroup           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>group</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns all users in a given group.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>group</em>&nbsp;</td><td>The group in which to look for users. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>An array of strings containing the names of all users in the given group.</dd></dl>
<dl compact><dt><b>Since:</b></dt><dd>Aukyla 1.1</dd></dl>

<p>
Definition at line <a class="el" href="a00220.html#l00396">396</a> of file <a class="el" href="a00220.html">Login.php</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00220.html">Login.php</a></ul>
    </div>
  </body>
</html>
Return current item: Aukyla Document Management System