Tiny programs (C, C++, C#, ...)
File detail
Source code
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class UserAuth</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class UserAuth</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">User authorization framework.</p>
<p class="description"><p>Design pattern singleton.</p></p>
<p class="notes">
Located in <a class="field" href="_db.php.html">/db.php</a> (line <span class="field">72</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">UserAuth</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<span class="method-result">Return</span>
<a href="#getRole" title="details" class="method-name">getRole</a>
()
</div>
<div class="method-definition">
<span class="method-result">Return</span>
<a href="#getUser" title="details" class="method-name">getUser</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#logged" title="details" class="method-name">logged</a>
()
</div>
<div class="method-definition">
<span class="method-result">Return</span>
<a href="#login" title="details" class="method-name">login</a>
(<span class="var-type">szUser</span> <span class="var-name">$szUser</span>, <span class="var-type">szPasswd</span> <span class="var-name">$szPasswd</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#logout" title="details" class="method-name">logout</a>
([<span class="var-type">eReason</span> <span class="var-name">$eReason</span> = <span class="var-default">self::USER_LOGOUT</span>])
</div>
<div class="method-definition">
<span class="method-result">Return</span>
<a href="#singleton" title="details" class="method-name">singleton</a>
()
</div>
<div class="method-definition">
<span class="method-result">Return</span>
<a href="#tryAccess" title="details" class="method-name">tryAccess</a>
(<span class="var-type">szRole</span> <span class="var-name">$szRole</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#updateLastAccess" title="details" class="method-name">updateLastAccess</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#userAlive" title="details" class="method-name">userAlive</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#__clone" title="details" class="method-name">__clone</a>
()
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">209</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">UserAuth</span>
<span class="method-name">
__construct
</span>
()
</div>
</div>
<a name="methodgetRole" id="getRole"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getRole</span> (line <span class="line-number">167</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">return:</span> logged-in user role as string.</li>
</ul>
<div class="method-signature">
<span class="method-result">Return</span>
<span class="method-name">
getRole
</span>
()
</div>
</div>
<a name="methodgetUser" id="getUser"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getUser</span> (line <span class="line-number">160</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">return:</span> logged-in user name, empty string if nobody is logged in IS.</li>
</ul>
<div class="method-signature">
<span class="method-result">Return</span>
<span class="method-name">
getUser
</span>
()
</div>
</div>
<a name="methodlogged" id="logged"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">logged</span> (line <span class="line-number">135</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
logged
</span>
()
</div>
</div>
<a name="methodlogin" id="login"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">login</span> (line <span class="line-number">102</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Try login user with given login and passwd.</p>
<p class="description"><p>If 'login incorrect' occur, logout method is called automatically.</p></p>
<ul class="tags">
<li><span class="field">return:</span> logged user role as string, e.g. "manager", ...</li>
</ul>
<div class="method-signature">
<span class="method-result">Return</span>
<span class="method-name">
login
</span>
(<span class="var-type">szUser</span> <span class="var-name">$szUser</span>, <span class="var-type">szPasswd</span> <span class="var-name">$szPasswd</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">szUser</span>
<span class="var-name">$szUser</span><span class="var-description">: User name to login with.</span> </li>
<li>
<span class="var-type">szPasswd</span>
<span class="var-name">$szPasswd</span><span class="var-description">: Password to use. Passsword is passed as plain text - be carreful.</span> </li>
</ul>
</div>
<a name="methodlogout" id="logout"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">logout</span> (line <span class="line-number">126</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logout current user, if such exists.</p>
<p class="description"><p>Automatically redirects to /login.php with reason as parameter. This should be called before placing any text to page.</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
logout
</span>
([<span class="var-type">eReason</span> <span class="var-name">$eReason</span> = <span class="var-default">self::USER_LOGOUT</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">eReason</span>
<span class="var-name">$eReason</span><span class="var-description">: Reason of logout enumeration. This will be passed to /login.php as parameter.</span> </li>
</ul>
</div>
<a name="methodsingleton" id="singleton"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">singleton</span> (line <span class="line-number">76</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">return:</span> reference to singleton object.</li>
</ul>
<div class="method-signature">
<span class="method-result">Return</span>
<span class="method-name">
singleton
</span>
()
</div>
</div>
<a name="methodtryAccess" id="tryAccess"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">tryAccess</span> (line <span class="line-number">145</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This authorizate user to access privileged page of IS.</p>
<p class="description"><p>If 'access denied' occur, user is automatically redirected to /login.php with ACCESS_DENIED as reason.</p></p>
<ul class="tags">
<li><span class="field">return:</span> true if access is granted.</li>
</ul>
<div class="method-signature">
<span class="method-result">Return</span>
<span class="method-name">
tryAccess
</span>
(<span class="var-type">szRole</span> <span class="var-name">$szRole</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">szRole</span>
<span class="var-name">$szRole</span><span class="var-description">: Role of user needed to access page. (as string)</span> </li>
</ul>
</div>
<a name="methodupdateLastAccess" id="updateLastAccess"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">updateLastAccess</span> (line <span class="line-number">190</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
updateLastAccess
</span>
()
</div>
</div>
<a name="methoduserAlive" id="userAlive"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">userAlive</span> (line <span class="line-number">195</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
userAlive
</span>
()
</div>
</div>
<a name="method__clone" id="__clone"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">__clone</span> (line <span class="line-number">204</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
__clone
</span>
()
</div>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 16 Dec 2006 17:12:38 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0</a>
</p>
</div></body>
</html>
Back to main page
UserAuth.html [Download]