303 lines
No EOL
11 KiB
HTML
303 lines
No EOL
11 KiB
HTML
<?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 Security</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 Security</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">Security Class</p>
|
|
<p class="description"><p>Collection of static methods for handling security within a website running on PICKLES. Requires sessions to be enabled.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../PICKLES/Security.html">Security</a></span><span class="src-sym">::</span><a href="../PICKLES/Security.html#methodlogin">login</a><span class="src-sym">(</span><span class="src-num">10</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
</ol></div></li>
|
|
<li><span class="field">usage:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../PICKLES/Security.html">Security</a></span><span class="src-sym">::</span><a href="../PICKLES/Security.html#methodisLevel">isLevel</a><span class="src-sym">(</span><span class="src-id">SECURITY_LEVEL_ADMIN</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
</ol></div></li>
|
|
</ul>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_classes---Security.php.html">/classes/Security.php</a> (line <span class="field">27</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">
|
|
static <span class="method-result">boolean</span>
|
|
<a href="#betweenLevel" title="details" class="method-name">betweenLevel</a>
|
|
(<span class="var-type">integer</span> <span class="var-name">$low</span>, <span class="var-type">integer</span> <span class="var-name">$high</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
static <span class="method-result">string</span>
|
|
<a href="#generateHash" title="details" class="method-name">generateHash</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">mixed</span> <span class="var-name">$salts</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
static <span class="method-result">boolean</span>
|
|
<a href="#hasLevel" title="details" class="method-name">hasLevel</a>
|
|
(<span class="var-type">integer</span> <span class="var-name">$access_level</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
static <span class="method-result">boolean</span>
|
|
<a href="#isLevel" title="details" class="method-name">isLevel</a>
|
|
(<span class="var-type">integer</span> <span class="var-name">$access_level</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
static <span class="method-result">boolean</span>
|
|
<a href="#login" title="details" class="method-name">login</a>
|
|
(<span class="var-type">$user_id</span> <span class="var-name">$user_id</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
static <span class="method-result">boolean</span>
|
|
<a href="#logout" title="details" class="method-name">logout</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="methodbetweenLevel" id="betweenLevel"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method betweenLevel</span> (line <span class="line-number">366</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Between Level</p>
|
|
<p class="description"><p>Checks the user's access level against the passed range.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not the user has access</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
static
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
betweenLevel
|
|
</span>
|
|
(<span class="var-type">integer</span> <span class="var-name">$low</span>, <span class="var-type">integer</span> <span class="var-name">$high</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">integer</span>
|
|
<span class="var-name">$low</span><span class="var-description">: access level to be checked against</span> </li>
|
|
<li>
|
|
<span class="var-type">integer</span>
|
|
<span class="var-name">$high</span><span class="var-description">: access level to be checked against</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodgenerateHash" id="generateHash"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method generateHash</span> (line <span class="line-number">49</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Generate Hash</p>
|
|
<p class="description"><p>Generates an SHA1 hash from the provided string. Optionally can be salted.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> SHA1 has</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
static
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
generateHash
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$value</span>, [<span class="var-type">mixed</span> <span class="var-name">$salts</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$value</span><span class="var-description">: value to hash</span> </li>
|
|
<li>
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$salts</span><span class="var-description">: optional salt or salts</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodhasLevel" id="hasLevel"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method hasLevel</span> (line <span class="line-number">328</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Has Level</p>
|
|
<p class="description"><p>Checks the user's access level against the passed level.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not the user has access</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
static
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
hasLevel
|
|
</span>
|
|
(<span class="var-type">integer</span> <span class="var-name">$access_level</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">integer</span>
|
|
<span class="var-name">$access_level</span><span class="var-description">: access level to be checked against</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodisLevel" id="isLevel"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method isLevel</span> (line <span class="line-number">291</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Is Level</p>
|
|
<p class="description"><p>Checks the user's access level is exactly the passed level</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not the user is that level</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
static
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
isLevel
|
|
</span>
|
|
(<span class="var-type">integer</span> <span class="var-name">$access_level</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">integer</span>
|
|
<span class="var-name">$access_level</span><span class="var-description">: access level to be checked against</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodlogin" id="login"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method login</span> (line <span class="line-number">158</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Login</p>
|
|
<p class="description"><p>Creates a session variable containing the user ID and generated token. The token is also assigned to a cookie to be used when validating the security level.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> whether or not the login could be completed</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
static
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
login
|
|
</span>
|
|
(<span class="var-type">$user_id</span> <span class="var-name">$user_id</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">$user_id</span>
|
|
<span class="var-name">$user_id</span><span class="var-description">: ID of the user that's been logged in</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodlogout" id="logout"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">static method logout</span> (line <span class="line-number">187</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Logout</p>
|
|
<p class="description"><p>Clears out the security information in the session and the cookie.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> true</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
static
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
logout
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Sat, 27 Nov 2010 21:43:42 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |