?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Release 0.52
[awl.git] / docs / api / awl / Session / _Session.php.html
blobc2f7e7d02ce22fe68d3e9ef0ff76b4294889d8d9
1
2 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
3 <?xml version="1.0" encoding="iso-8859-1"?>
4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <!-- template designed by Marco Von Ballmoos -->
8 <title>Docs for page Session.php</title>
9 <link rel="stylesheet" href="../../media/stylesheet.css" />
10 <script src="../../media/lib/classTree.js"></script>
11 <script language="javascript" type="text/javascript">
12 var imgPlus = new Image();
13 var imgMinus = new Image();
14 imgPlus.src = "../../media/images/plus.png";
15 imgMinus.src = "../../media/images/minus.png";
16
17 function showNode(Node){
18 switch(navigator.family){
19 case 'nn4':
20 // Nav 4.x code fork...
21 var oTable = document.layers["span" + Node];
22 var oImg = document.layers["img" + Node];
23 break;
24 case 'ie4':
25 // IE 4/5 code fork...
26 var oTable = document.all["span" + Node];
27 var oImg = document.all["img" + Node];
28 break;
29 case 'gecko':
30 // Standards Compliant code fork...
31 var oTable = document.getElementById("span" + Node);
32 var oImg = document.getElementById("img" + Node);
33 break;
34 }
35 oImg.src = imgMinus.src;
36 oTable.style.display = "block";
37 }
38
39 function hideNode(Node){
40 switch(navigator.family){
41 case 'nn4':
42 // Nav 4.x code fork...
43 var oTable = document.layers["span" + Node];
44 var oImg = document.layers["img" + Node];
45 break;
46 case 'ie4':
47 // IE 4/5 code fork...
48 var oTable = document.all["span" + Node];
49 var oImg = document.all["img" + Node];
50 break;
51 case 'gecko':
52 // Standards Compliant code fork...
53 var oTable = document.getElementById("span" + Node);
54 var oImg = document.getElementById("img" + Node);
55 break;
56 }
57 oImg.src = imgPlus.src;
58 oTable.style.display = "none";
59 }
60
61 function nodeIsVisible(Node){
62 switch(navigator.family){
63 case 'nn4':
64 // Nav 4.x code fork...
65 var oTable = document.layers["span" + Node];
66 break;
67 case 'ie4':
68 // IE 4/5 code fork...
69 var oTable = document.all["span" + Node];
70 break;
71 case 'gecko':
72 // Standards Compliant code fork...
73 var oTable = document.getElementById("span" + Node);
74 break;
75 }
76 return (oTable && oTable.style.display == "block");
77 }
78
79 function toggleNodeVisibility(Node){
80 if (nodeIsVisible(Node)){
81 hideNode(Node);
82 }else{
83 showNode(Node);
84 }
85 }
86 </script>
87 </head>
88 <body>
89 <div class="page-body">
90 <h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/Session.php</h2>
91
92 <a name="sec-description"></a>
93 <div class="info-box">
94 <div class="info-box-title">Description</div>
95 <div class="nav-bar">
96 <span class="disabled">Description</span> |
97 <a href="#sec-classes">Classes</a>
98 | <a href="#sec-includes">Includes</a>
99 | <a href="#sec-variables">Variables</a>
100 | <a href="#sec-functions">Functions</a>
101 </div>
102 <div class="info-box-body">
103 <!-- ========== Info from phpDoc block ========= -->
104 <p class="short-description">Session handling class and associated functions</p>
105 <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
106 have plain text passwords set by an administrator.</li><li>Temporary passwords are supported.</li><li>Logout is supported</li><li>&quot;Remember me&quot; cookies are supported, and will result in a new
107 Session for each browser session.</li></ul></p></p>
108 <ul class="tags">
109 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
110 <li><span class="field">copyright:</span> Catalyst IT Ltd, Morphoss Ltd &lt;http://www.morphoss.com/&gt;</li>
111 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
112 </ul>
113
114 </div>
115 </div>
116
117 <a name="sec-classes"></a>
118 <div class="info-box">
119 <div class="info-box-title">Classes</div>
120 <div class="nav-bar">
121 <a href="#sec-description">Description</a> |
122 <span class="disabled">Classes</span>
123 | <a href="#sec-includes">Includes</a>
124 | <a href="#sec-variables">Variables</a>
125 | <a href="#sec-functions">Functions</a>
126 </div>
127 <div class="info-box-body">
128 <table cellpadding="2" cellspacing="0" class="class-table">
129 <tr>
130 <th class="class-table-header">Class</th>
131 <th class="class-table-header">Description</th>
132 </tr>
133 <tr>
134 <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
135 <img src="../../media/images/Class.png"
136 alt=" class"
137 title=" class"/>
138 <a href="../../awl/Session/Session.html">Session</a>
139 </td>
140 <td>
141 A class for creating and holding session information.
142 </td>
143 </tr>
144 </table>
145 </div>
146 </div>
147
148 <a name="sec-includes"></a>
149 <div class="info-box">
150 <div class="info-box-title">Includes</div>
151 <div class="nav-bar">
152 <a href="#sec-description">Description</a> |
153 <a href="#sec-classes">Classes</a>
154 | <span class="disabled">Includes</span>
155 | <a href="#sec-variables">Variables</a>
156 | <a href="#sec-functions">Functions</a>
157 </div>
158 <div class="info-box-body">
159
160 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
161
162 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
163 <a name="_AWLUtilities_php"><!-- --></a>
164 <div class="evenrow">
165
166 <div>
167 <img src="../../media/images/Page.png" alt=" " />
168 <span class="include-title">
169 <span class="include-type">require_once</span>
170 (<span class="include-name"><a href="../../awl/Utilities/_AWLUtilities.php.html">'AWLUtilities.php'</a></span>)
171 (line <span class="line-number">25</span>)
172 </span>
173 </div>
174
175 <!-- ========== Info from phpDoc block ========= -->
176
177 </div>
178 <a name="_EMail_php"><!-- --></a>
179 <div class="oddrow">
180
181 <div>
182 <img src="../../media/images/Page.png" alt=" " />
183 <span class="include-title">
184 <span class="include-type">require_once</span>
185 (<span class="include-name"><a href="../../awl/EMail/_EMail.php.html">'EMail.php'</a></span>)
186 (line <span class="line-number">27</span>)
187 </span>
188 </div>
189
190 <!-- ========== Info from phpDoc block ========= -->
191
192 </div>
193 <a name="_AwlQuery_php"><!-- --></a>
194 <div class="evenrow">
195
196 <div>
197 <img src="../../media/images/Page.png" alt=" " />
198 <span class="include-title">
199 <span class="include-type">require_once</span>
200 (<span class="include-name"><a href="../../awl/AwlDatabase/_AwlQuery.php.html">'AwlQuery.php'</a></span>)
201 (line <span class="line-number">26</span>)
202 </span>
203 </div>
204
205 <!-- ========== Info from phpDoc block ========= -->
206
207 </div>
208 </div>
209 </div>
210
211
212 <a name="sec-variables"></a>
213 <div class="info-box">
214 <div class="info-box-title">Variables</div>
215 <div class="nav-bar">
216 <a href="#sec-description">Description</a> |
217 <a href="#sec-classes">Classes</a>
218 | <a href="#sec-includes">Includes</a>
219 | <span class="disabled">Variables</span>
220 | <a href="#sec-functions">Functions</a>
221 </div>
222 <div class="info-box-body">
223
224 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
225
226 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
227 <a name="global$session
228 The session object is global." id="global$session
229 The session object is global."><!-- --></a>
230 <div class="oddrow">
231
232 <div>
233 <img src="../../media/images/Global.png" />
234 <span class="var-title">
235 <span class="var-type">resource</span>
236 <span class="var-name">$session
237 The session object is global.</span>
238 (line <span class="line-number">949</span>)
239 </span>
240 </div>
241
242 <!-- ========== Info from phpDoc block ========= -->
243 <ul class="tags">
244 <li><span class="field">name:</span> $session
245 The session object is global.</li>
246 </ul>
247
248
249 </div>
250 </div>
251 </div>
252
253 <a name="sec-functions"></a>
254 <div class="info-box">
255 <div class="info-box-title">Functions</div>
256 <div class="nav-bar">
257 <a href="#sec-description">Description</a> |
258 <a href="#sec-classes">Classes</a>
259 | <a href="#sec-includes">Includes</a>
260 | <a href="#sec-variables">Variables</a>
261 | <span class="disabled">Functions</span>
262 </div>
263 <div class="info-box-body">
264
265 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
266
267 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
268 <a name="functioncheck_temporary_passwords" id="functioncheck_temporary_passwords"><!-- --></a>
269 <div class="evenrow">
270
271 <div>
272 <img src="../../media/images/Function.png" />
273 <span class="method-title">check_temporary_passwords</span> (line <span class="line-number">36</span>)
274 </div>
275
276 <!-- ========== Info from phpDoc block ========= -->
277 <p class="short-description">Checks what a user entered against any currently valid temporary passwords on their account.</p>
278 <ul class="tags">
279 <li><span class="field">return:</span> Whether or not the user correctly guessed a temporary password within the necessary window of opportunity.</li>
280 </ul>
281 <div class="method-signature">
282 <span class="method-result">boolean</span>
283 <span class="method-name">
284 check_temporary_passwords
285 </span>
286 (<span class="var-type">string</span>&nbsp;<span class="var-name">$they_sent</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$user_no</span>)
287 </div>
288
289 <ul class="parameters">
290 <li>
291 <span class="var-type">string</span>
292 <span class="var-name">$they_sent</span><span class="var-description">: What the user entered.</span> </li>
293 <li>
294 <span class="var-type">int</span>
295 <span class="var-name">$user_no</span><span class="var-description">: Which user is attempting to log on.</span> </li>
296 </ul>
297
298
299 </div>
300 </div>
301 </div>
302
303 <p class="notes" id="credit">
304 Documentation generated on Sun, 17 Jun 2012 10:00:17 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
305 </p>
306 </div></body>
307 </html>
Andrew's Web Libraries