1 <?xml version=
"1.0" encoding=
"iso-8859-1"?>
2 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml">
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs for page Session.php
</title>
7 <link rel=
"stylesheet" href=
"../../media/stylesheet.css" />
8 <script src=
"../../media/lib/classTree.js"></script>
9 <script language=
"javascript" type=
"text/javascript">
10 var imgPlus = new Image();
11 var imgMinus = new Image();
12 imgPlus.src =
"../../media/images/plus.png";
13 imgMinus.src =
"../../media/images/minus.png";
15 function showNode(Node){
16 switch(navigator.family){
18 // Nav
4.x code fork...
19 var oTable = document.layers[
"span" + Node];
20 var oImg = document.layers[
"img" + Node];
23 // IE
4/
5 code fork...
24 var oTable = document.all[
"span" + Node];
25 var oImg = document.all[
"img" + Node];
28 // Standards Compliant code fork...
29 var oTable = document.getElementById(
"span" + Node);
30 var oImg = document.getElementById(
"img" + Node);
33 oImg.src = imgMinus.src;
34 oTable.style.display =
"block";
37 function hideNode(Node){
38 switch(navigator.family){
40 // Nav
4.x code fork...
41 var oTable = document.layers[
"span" + Node];
42 var oImg = document.layers[
"img" + Node];
45 // IE
4/
5 code fork...
46 var oTable = document.all[
"span" + Node];
47 var oImg = document.all[
"img" + Node];
50 // Standards Compliant code fork...
51 var oTable = document.getElementById(
"span" + Node);
52 var oImg = document.getElementById(
"img" + Node);
55 oImg.src = imgPlus.src;
56 oTable.style.display =
"none";
59 function nodeIsVisible(Node){
60 switch(navigator.family){
62 // Nav
4.x code fork...
63 var oTable = document.layers[
"span" + Node];
66 // IE
4/
5 code fork...
67 var oTable = document.all[
"span" + Node];
70 // Standards Compliant code fork...
71 var oTable = document.getElementById(
"span" + Node);
74 return (oTable && oTable.style.display ==
"block");
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
87 <div class=
"page-body">
88 <h2 class=
"file-name"><img src=
"../../media/images/Page_logo.png" alt=
"File" style=
"vertical-align: middle">/Session.php
</h2>
90 <a name=
"sec-description"></a>
91 <div class=
"info-box">
92 <div class=
"info-box-title">Description
</div>
94 <span class=
"disabled">Description
</span> |
95 <a href=
"#sec-classes">Classes
</a>
96 |
<a href=
"#sec-includes">Includes
</a>
97 |
<a href=
"#sec-variables">Variables
</a>
98 |
<a href=
"#sec-functions">Functions
</a>
100 <div class=
"info-box-body">
101 <!-- ========== Info from phpDoc block ========= -->
102 <p class=
"short-description">Session handling class and associated functions
</p>
103 <p class=
"description"><p>This subpackage provides some functions that are useful around web application session management.
</p><p>The class is intended to be as lightweight as possible while holding all session data in the database:
<ul><li>Session hash is not predictable.
</li><li>No clear text information is held in cookies.
</li><li>Passwords are generally salted MD5 hashes, but individual users may
104 have plain text passwords set by an administrator.
</li><li>Temporary passwords are supported.
</li><li>Logout is supported
</li><li>"Remember me
" cookies are supported, and will result in a new
105 Session for each browser session.
</li></ul></p></p>
107 <li><span class=
"field">author:
</span> Andrew McMillan
<<a href=
"mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz
</a>></li>
108 <li><span class=
"field">copyright:
</span> Catalyst IT Ltd, Morphoss Ltd
<http://www.morphoss.com/
></li>
109 <li><span class=
"field">license:
</span> <a href=
"http://gnu.org/copyleft/gpl.html">GNU GPL v2
</a></li>
115 <a name=
"sec-classes"></a>
116 <div class=
"info-box">
117 <div class=
"info-box-title">Classes
</div>
118 <div class=
"nav-bar">
119 <a href=
"#sec-description">Description
</a> |
120 <span class=
"disabled">Classes
</span>
121 |
<a href=
"#sec-includes">Includes
</a>
122 |
<a href=
"#sec-variables">Variables
</a>
123 |
<a href=
"#sec-functions">Functions
</a>
125 <div class=
"info-box-body">
126 <table cellpadding=
"2" cellspacing=
"0" class=
"class-table">
128 <th class=
"class-table-header">Class
</th>
129 <th class=
"class-table-header">Description
</th>
132 <td style=
"padding-right: 2em; vertical-align: top; white-space: nowrap">
133 <img src=
"../../media/images/Class.png"
136 <a href=
"../../awl/Session/Session.html">Session
</a>
139 A class for creating and holding session information.
146 <a name=
"sec-includes"></a>
147 <div class=
"info-box">
148 <div class=
"info-box-title">Includes
</div>
149 <div class=
"nav-bar">
150 <a href=
"#sec-description">Description
</a> |
151 <a href=
"#sec-classes">Classes
</a>
152 |
<span class=
"disabled">Includes
</span>
153 |
<a href=
"#sec-variables">Variables
</a>
154 |
<a href=
"#sec-functions">Functions
</a>
156 <div class=
"info-box-body">
157 <a name=
"_AWLUtilities_php"><!-- --></a>
161 <img src=
"../../media/images/Page.png" alt=
" " />
162 <span class=
"include-title">
163 <span class=
"include-type">require_once
</span>
164 (
<span class=
"include-name"><a href=
"../../awl/Utilities/_AWLUtilities.php.html">"AWLUtilities.php"</a></span>)
165 (line
<span class=
"line-number">25</span>)
169 <!-- ========== Info from phpDoc block ========= -->
172 <a name=
"_PgQuery_php"><!-- --></a>
173 <div class=
"evenrow">
176 <img src=
"../../media/images/Page.png" alt=
" " />
177 <span class=
"include-title">
178 <span class=
"include-type">require_once
</span>
179 (
<span class=
"include-name"><a href=
"../../awl/PgQuery/_PgQuery.php.html">'PgQuery.php'
</a></span>)
180 (line
<span class=
"line-number">30</span>)
184 <!-- ========== Info from phpDoc block ========= -->
185 <p class=
"short-description">All session data is held in the database.
</p>
192 <a name=
"sec-variables"></a>
193 <div class=
"info-box">
194 <div class=
"info-box-title">Variables
</div>
195 <div class=
"nav-bar">
196 <a href=
"#sec-description">Description
</a> |
197 <a href=
"#sec-classes">Classes
</a>
198 |
<a href=
"#sec-includes">Includes
</a>
199 |
<span class=
"disabled">Variables
</span>
200 |
<a href=
"#sec-functions">Functions
</a>
202 <div class=
"info-box-body">
203 <a name=
"global$session
204 The session object is global." id=
"global$session
205 The session object is global."><!-- --></a>
209 <img src=
"../../media/images/Global.png" />
210 <span class=
"var-title">
211 <span class=
"var-type">resource
</span>
212 <span class=
"var-name">$session
213 The session object is global.
</span>
214 (line
<span class=
"line-number">908</span>)
218 <!-- ========== Info from phpDoc block ========= -->
220 <li><span class=
"field">name:
</span> $session
221 The session object is global.
</li>
229 <a name=
"sec-functions"></a>
230 <div class=
"info-box">
231 <div class=
"info-box-title">Functions
</div>
232 <div class=
"nav-bar">
233 <a href=
"#sec-description">Description
</a> |
234 <a href=
"#sec-classes">Classes
</a>
235 |
<a href=
"#sec-includes">Includes
</a>
236 |
<a href=
"#sec-variables">Variables
</a>
237 |
<span class=
"disabled">Functions
</span>
239 <div class=
"info-box-body">
240 <a name=
"functioncheck_temporary_passwords" id=
"functioncheck_temporary_passwords"><!-- --></a>
241 <div class=
"evenrow">
244 <img src=
"../../media/images/Function.png" />
245 <span class=
"method-title">check_temporary_passwords
</span> (line
<span class=
"line-number">39</span>)
248 <!-- ========== Info from phpDoc block ========= -->
249 <p class=
"short-description">Checks what a user entered against any currently valid temporary passwords on their account.
</p>
251 <li><span class=
"field">return:
</span> Whether or not the user correctly guessed a temporary password within the necessary window of opportunity.
</li>
253 <div class=
"method-signature">
254 <span class=
"method-result">boolean
</span>
255 <span class=
"method-name">
256 check_temporary_passwords
258 (
<span class=
"var-type">string
</span> <span class=
"var-name">$they_sent
</span>,
<span class=
"var-type">int
</span> <span class=
"var-name">$user_no
</span>)
261 <ul class=
"parameters">
263 <span class=
"var-type">string
</span>
264 <span class=
"var-name">$they_sent
</span><span class=
"var-description">: What the user entered.
</span> </li>
266 <span class=
"var-type">int
</span>
267 <span class=
"var-name">$user_no
</span><span class=
"var-description">: Which user is attempting to log on.
</span> </li>
275 <p class=
"notes" id=
"credit">
276 Documentation generated on Tue,
28 Oct
2008 20:
25:
19 +
1300 by
<a href=
"http://www.phpdoc.org" target=
"_blank">phpDocumentor
1.3.2</a>