cleanup text-match
[awl.git] / docs / api / awl / User / User.html
blob10ddffb5438259cd6de49f56140bb4130323e33c
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 Class User</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";
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;
35 oImg.src = imgMinus.src;
36 oTable.style.display = "block";
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;
57 oImg.src = imgPlus.src;
58 oTable.style.display = "none";
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;
76 return (oTable && oTable.style.display == "block");
79 function toggleNodeVisibility(Node){
80 if (nodeIsVisible(Node)){
81 hideNode(Node);
82 }else{
83 showNode(Node);
86 </script>
87 </head>
88 <body>
89 <div class="page-body">
90 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
91 alt=" Class"
92 title=" Class"
93 style="vertical-align: middle"> User</h2>
95 <a name="sec-description"></a>
96 <div class="info-box">
97 <div class="info-box-title">Description</div>
98 <div class="nav-bar">
99 <span class="disabled">Description</span> |
100 <a href="#sec-vars">Vars</a>
101 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
103 </div>
104 <div class="info-box-body">
106 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
107 <!-- ========== Info from phpDoc block ========= -->
108 <p class="short-description">A class to handle reading, writing, viewing, editing and validating usr records.</p>
109 <p class="notes">
110 Located in <a class="field" href="_User.php.html">/User.php</a> (line <span class="field">34</span>)
111 </p>
114 <pre><a href="../../awl/DataUpdate/DBRecord.html">DBRecord</a>
116 --User</pre>
118 </div>
119 </div>
124 <a name="sec-method-summary"></a>
125 <div class="info-box">
126 <div class="info-box-title">Method Summary</span></div>
127 <div class="nav-bar">
128 <a href="#sec-description">Description</a> |
129 <a href="#sec-vars">Vars</a>
132 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
133 </div>
134 <div class="info-box-body">
135 <div class="method-summary">
137 <div class="method-definition">
138 <img src="../../media/images/Constructor.png" alt=" "/>
139 <span class="method-result">User</span>
140 <a href="#User" title="details" class="method-name">User</a>
141 (<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">&quot;&quot;</span>])
142 </div>
144 <div class="method-definition">
145 <img src="../../media/images/Method.png" alt=" "/>
146 <span class="method-result">boolean</span>
147 <a href="#AllowedTo" title="details" class="method-name">AllowedTo</a>
148 (<span class="var-type">string</span>&nbsp;<span class="var-name">$whatever</span>)
149 </div>
151 <div class="method-definition">
152 <img src="../../media/images/Method.png" alt=" "/>
153 <span class="method-result">void</span>
154 <a href="#GetRoles" title="details" class="method-name">GetRoles</a>
156 </div>
158 <div class="method-definition">
159 <img src="../../media/images/Method.png" alt=" "/>
160 <span class="method-result">string</span>
161 <a href="#Render" title="details" class="method-name">Render</a>
163 </div>
165 <div class="method-definition">
166 <img src="../../media/images/Method.png" alt=" "/>
167 <span class="method-result">string</span>
168 <a href="#RenderFields" title="details" class="method-name">RenderFields</a>
169 (<span class="var-type">object</span>&nbsp;<span class="var-name">$ef</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">null</span>])
170 </div>
172 <div class="method-definition">
173 <img src="../../media/images/Method.png" alt=" "/>
174 <span class="method-result">string</span>
175 <a href="#RenderRoles" title="details" class="method-name">RenderRoles</a>
176 (<span class="var-type"></span>&nbsp;<span class="var-name">$ef</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">null</span>])
177 </div>
179 <div class="method-definition">
180 <img src="../../media/images/Method.png" alt=" "/>
181 <span class="method-result">boolean</span>
182 <a href="#Validate" title="details" class="method-name">Validate</a>
184 </div>
186 <div class="method-definition">
187 <img src="../../media/images/Method.png" alt=" "/>
188 <span class="method-result">Success.</span>
189 <a href="#Write" title="details" class="method-name">Write</a>
191 </div>
193 <div class="method-definition">
194 <img src="../../media/images/Method.png" alt=" "/>
195 <span class="method-result">Success.</span>
196 <a href="#WriteRoles" title="details" class="method-name">WriteRoles</a>
198 </div>
199 </div>
200 </div>
201 </div>
203 <a name="sec-vars"></a>
204 <div class="info-box">
205 <div class="info-box-title">Variables</div>
206 <div class="nav-bar">
207 <a href="#sec-description">Description</a> |
208 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
212 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
214 </div>
215 <div class="info-box-body">
217 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
219 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
221 <h4>Inherited Variables</h4>
222 <A NAME='inherited_vars'><!-- --></A>
223 <p>Inherited from <span class="classname"><a href="../../awl/DataUpdate/DBRecord.html">DBRecord</a></span></p>
224 <blockquote>
225 <img src="../../media/images/Variable.png" />
226 <span class="var-title">
227 <span class="var-name"><a href="../../awl/DataUpdate/DBRecord.html#var$EditMode">DBRecord::$EditMode</a></span><br>
228 </span>
229 </blockquote>
231 </div>
232 </div>
234 <a name="sec-methods"></a>
235 <div class="info-box">
236 <div class="info-box-title">Methods</div>
237 <div class="nav-bar">
238 <a href="#sec-description">Description</a> |
239 <a href="#sec-vars">Vars</a>
240 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
242 </div>
243 <div class="info-box-body">
245 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
247 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
248 <A NAME='method_detail'></A>
249 <a name="methodUser" id="User"><!-- --></a>
250 <div class="evenrow">
252 <div class="method-header">
253 <img src="../../media/images/Constructor.png" />
254 <span class="method-title">Constructor User</span> (line <span class="line-number">57</span>)
255 </div>
257 <!-- ========== Info from phpDoc block ========= -->
258 <p class="short-description">The constructor initialises a new record, potentially reading it from the database.</p>
260 <div class="method-signature">
261 <span class="method-result">User</span>
262 <span class="method-name">
263 User
264 </span>
265 (<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">&quot;&quot;</span>])
266 </div>
268 <ul class="parameters">
269 <li>
270 <span class="var-type">int</span>
271 <span class="var-name">$id</span><span class="var-description">: The user_no, or 0 if we are creating a new one</span> </li>
272 <li>
273 <span class="var-type">string</span>
274 <span class="var-name">$prefix</span><span class="var-description">: The prefix for entry fields</span> </li>
275 </ul>
278 </div>
279 <a name="methodAllowedTo" id="AllowedTo"><!-- --></a>
280 <div class="oddrow">
282 <div class="method-header">
283 <img src="../../media/images/Method.png" />
284 <span class="method-title">AllowedTo</span> (line <span class="line-number">98</span>)
285 </div>
287 <!-- ========== Info from phpDoc block ========= -->
288 <p class="short-description">Can the user do this?</p>
289 <ul class="tags">
290 <li><span class="field">return:</span> Whether they are allowed to.</li>
291 </ul>
293 <div class="method-signature">
294 <span class="method-result">boolean</span>
295 <span class="method-name">
296 AllowedTo
297 </span>
298 (<span class="var-type">string</span>&nbsp;<span class="var-name">$whatever</span>)
299 </div>
301 <ul class="parameters">
302 <li>
303 <span class="var-type">string</span>
304 <span class="var-name">$whatever</span><span class="var-description">: What the user wants to do</span> </li>
305 </ul>
308 </div>
309 <a name="methodGetRoles" id="GetRoles"><!-- --></a>
310 <div class="evenrow">
312 <div class="method-header">
313 <img src="../../media/images/Method.png" />
314 <span class="method-title">GetRoles</span> (line <span class="line-number">149</span>)
315 </div>
317 <!-- ========== Info from phpDoc block ========= -->
318 <p class="short-description">Get the group memberships for the user</p>
320 <div class="method-signature">
321 <span class="method-result">void</span>
322 <span class="method-name">
323 GetRoles
324 </span>
326 </div>
330 </div>
331 <a name="methodRender" id="Render"><!-- --></a>
332 <div class="oddrow">
334 <div class="method-header">
335 <img src="../../media/images/Method.png" />
336 <span class="method-title">Render</span> (line <span class="line-number">164</span>)
337 </div>
339 <!-- ========== Info from phpDoc block ========= -->
340 <p class="short-description">Render the form / viewer as HTML to show the user</p>
341 <ul class="tags">
342 <li><span class="field">return:</span> An HTML fragment to display in the page.</li>
343 </ul>
345 <div class="method-signature">
346 <span class="method-result">string</span>
347 <span class="method-name">
348 Render
349 </span>
351 </div>
355 </div>
356 <a name="methodRenderFields" id="RenderFields"><!-- --></a>
357 <div class="evenrow">
359 <div class="method-header">
360 <img src="../../media/images/Method.png" />
361 <span class="method-title">RenderFields</span> (line <span class="line-number">198</span>)
362 </div>
364 <!-- ========== Info from phpDoc block ========= -->
365 <p class="short-description">Render the core details to show to the user</p>
366 <ul class="tags">
367 <li><span class="field">return:</span> An HTML fragment to display in the page.</li>
368 </ul>
370 <div class="method-signature">
371 <span class="method-result">string</span>
372 <span class="method-name">
373 RenderFields
374 </span>
375 (<span class="var-type">object</span>&nbsp;<span class="var-name">$ef</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">null</span>])
376 </div>
378 <ul class="parameters">
379 <li>
380 <span class="var-type">object</span>
381 <span class="var-name">$ef</span><span class="var-description">: The entry form.</span> </li>
382 <li>
383 <span class="var-type">string</span>
384 <span class="var-name">$title</span><span class="var-description">: The title to display above the entry fields.</span> </li>
385 </ul>
388 </div>
389 <a name="methodRenderRoles" id="RenderRoles"><!-- --></a>
390 <div class="oddrow">
392 <div class="method-header">
393 <img src="../../media/images/Method.png" />
394 <span class="method-title">RenderRoles</span> (line <span class="line-number">269</span>)
395 </div>
397 <!-- ========== Info from phpDoc block ========= -->
398 <p class="short-description">Render the user's administrative roles</p>
399 <ul class="tags">
400 <li><span class="field">return:</span> The string of html to be output</li>
401 </ul>
403 <div class="method-signature">
404 <span class="method-result">string</span>
405 <span class="method-name">
406 RenderRoles
407 </span>
408 (<span class="var-type"></span>&nbsp;<span class="var-name">$ef</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">null</span>])
409 </div>
411 <ul class="parameters">
412 <li>
413 <span class="var-type"></span>
414 <span class="var-name">$ef</span> </li>
415 <li>
416 <span class="var-type"></span>
417 <span class="var-name">$title</span> </li>
418 </ul>
421 </div>
422 <a name="methodValidate" id="Validate"><!-- --></a>
423 <div class="evenrow">
425 <div class="method-header">
426 <img src="../../media/images/Method.png" />
427 <span class="method-title">Validate</span> (line <span class="line-number">315</span>)
428 </div>
430 <!-- ========== Info from phpDoc block ========= -->
431 <p class="short-description">Validate the information the user submitted</p>
432 <ul class="tags">
433 <li><span class="field">return:</span> Whether the form data validated OK.</li>
434 </ul>
436 <div class="method-signature">
437 <span class="method-result">boolean</span>
438 <span class="method-name">
439 Validate
440 </span>
442 </div>
446 </div>
447 <a name="methodWrite" id="Write"><!-- --></a>
448 <div class="oddrow">
450 <div class="method-header">
451 <img src="../../media/images/Method.png" />
452 <span class="method-title">Write</span> (line <span class="line-number">349</span>)
453 </div>
455 <!-- ========== Info from phpDoc block ========= -->
456 <p class="short-description">Write the User record.</p>
458 <div class="method-signature">
459 <span class="method-result">Success.</span>
460 <span class="method-name">
461 Write
462 </span>
464 </div>
467 <hr class="separator" />
468 <div class="notes">Redefinition of:</div>
469 <dl>
470 <dt><a href="../../awl/DataUpdate/DBRecord.html#methodWrite">DBRecord::Write()</a></dt>
471 <dd>To write the record to the database</dd>
472 </dl>
474 </div>
475 <a name="methodWriteRoles" id="WriteRoles"><!-- --></a>
476 <div class="evenrow">
478 <div class="method-header">
479 <img src="../../media/images/Method.png" />
480 <span class="method-title">WriteRoles</span> (line <span class="line-number">377</span>)
481 </div>
483 <!-- ========== Info from phpDoc block ========= -->
484 <p class="short-description">Write the roles associated with the user</p>
486 <div class="method-signature">
487 <span class="method-result">Success.</span>
488 <span class="method-name">
489 WriteRoles
490 </span>
492 </div>
496 </div>
497 <h4>Inherited Methods</h4>
498 <a name='inherited_methods'><!-- --></a>
499 <!-- =========== Summary =========== -->
500 <p>Inherited From <span class="classname"><a href="../../awl/DataUpdate/DBRecord.html">DBRecord</a></span></p>
501 <blockquote>
502 <img src="../../media/images/Constructor.png" alt=" "/>
503 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodDBRecord">DBRecord::DBRecord()</a></span><br>
504 <img src="../../media/images/Method.png" alt=" "/>
505 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodAddTable">DBRecord::AddTable()</a></span><br>
506 <img src="../../media/images/Method.png" alt=" "/>
507 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodGet">DBRecord::Get()</a></span><br>
508 <img src="../../media/images/Method.png" alt=" "/>
509 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodInitialise">DBRecord::Initialise()</a></span><br>
510 <img src="../../media/images/Method.png" alt=" "/>
511 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodPostToValues">DBRecord::PostToValues()</a></span><br>
512 <img src="../../media/images/Method.png" alt=" "/>
513 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodRead">DBRecord::Read()</a></span><br>
514 <img src="../../media/images/Method.png" alt=" "/>
515 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodSet">DBRecord::Set()</a></span><br>
516 <img src="../../media/images/Method.png" alt=" "/>
517 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodUndefine">DBRecord::Undefine()</a></span><br>
518 <img src="../../media/images/Method.png" alt=" "/>
519 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodWrite">DBRecord::Write()</a></span><br>
520 <img src="../../media/images/Method.png" alt=" "/>
521 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#method_BuildFieldList">DBRecord::_BuildFieldList()</a></span><br>
522 <img src="../../media/images/Method.png" alt=" "/>
523 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#method_BuildJoinClause">DBRecord::_BuildJoinClause()</a></span><br>
524 <img src="../../media/images/Method.png" alt=" "/>
525 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#method_BuildWhereClause">DBRecord::_BuildWhereClause()</a></span><br>
526 </blockquote>
528 </div>
529 </div>
533 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
534 <p class="notes" id="credit">
535 Documentation generated on Wed, 04 Jul 2012 07:06:16 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
536 </p>
537 </div></body>
538 </html>