?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
The real release 0.46 :-)
[awl.git] / docs / api / awl / User / User.html
blob558df39cc821aa579ee076970855ae434089bbc4
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">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class User</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";
14
15 function showNode(Node){
16 switch(navigator.family){
17 case 'nn4':
18 // Nav 4.x code fork...
19 var oTable = document.layers["span" + Node];
20 var oImg = document.layers["img" + Node];
21 break;
22 case 'ie4':
23 // IE 4/5 code fork...
24 var oTable = document.all["span" + Node];
25 var oImg = document.all["img" + Node];
26 break;
27 case 'gecko':
28 // Standards Compliant code fork...
29 var oTable = document.getElementById("span" + Node);
30 var oImg = document.getElementById("img" + Node);
31 break;
32 }
33 oImg.src = imgMinus.src;
34 oTable.style.display = "block";
35 }
36
37 function hideNode(Node){
38 switch(navigator.family){
39 case 'nn4':
40 // Nav 4.x code fork...
41 var oTable = document.layers["span" + Node];
42 var oImg = document.layers["img" + Node];
43 break;
44 case 'ie4':
45 // IE 4/5 code fork...
46 var oTable = document.all["span" + Node];
47 var oImg = document.all["img" + Node];
48 break;
49 case 'gecko':
50 // Standards Compliant code fork...
51 var oTable = document.getElementById("span" + Node);
52 var oImg = document.getElementById("img" + Node);
53 break;
54 }
55 oImg.src = imgPlus.src;
56 oTable.style.display = "none";
57 }
58
59 function nodeIsVisible(Node){
60 switch(navigator.family){
61 case 'nn4':
62 // Nav 4.x code fork...
63 var oTable = document.layers["span" + Node];
64 break;
65 case 'ie4':
66 // IE 4/5 code fork...
67 var oTable = document.all["span" + Node];
68 break;
69 case 'gecko':
70 // Standards Compliant code fork...
71 var oTable = document.getElementById("span" + Node);
72 break;
73 }
74 return (oTable && oTable.style.display == "block");
75 }
76
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
79 hideNode(Node);
80 }else{
81 showNode(Node);
82 }
83 }
84 </script>
85 </head>
86 <body>
87 <div class="page-body">
88 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
89 alt=" Class"
90 title=" Class"
91 style="vertical-align: middle"> User</h2>
92
93 <a name="sec-description"></a>
94 <div class="info-box">
95 <div class="info-box-title">Description</div>
96 <div class="nav-bar">
97 <span class="disabled">Description</span> |
98 <a href="#sec-vars">Vars</a>
99 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
100
101 </div>
102 <div class="info-box-body">
103 <!-- ========== Info from phpDoc block ========= -->
104 <p class="short-description">A class to handle reading, writing, viewing, editing and validating usr records.</p>
105 <p class="notes">
106 Located in <a class="field" href="_User.php.html">/User.php</a> (line <span class="field">34</span>)
107 </p>
108
109
110 <pre><a href="../../awl/DataUpdate/DBRecord.html">DBRecord</a>
111 |
112 --User</pre>
113
114 </div>
115 </div>
116
117
118
119
120 <a name="sec-method-summary"></a>
121 <div class="info-box">
122 <div class="info-box-title">Method Summary</span></div>
123 <div class="nav-bar">
124 <a href="#sec-description">Description</a> |
125 <a href="#sec-vars">Vars</a>
126
127 |
128 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
129 </div>
130 <div class="info-box-body">
131 <div class="method-summary">
132
133 <div class="method-definition">
134 <img src="../../media/images/Constructor.png" alt=" "/>
135 <span class="method-result">User</span>
136 <a href="#User" title="details" class="method-name">User</a>
137 (<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>])
138 </div>
139
140 <div class="method-definition">
141 <img src="../../media/images/Method.png" alt=" "/>
142 <span class="method-result">boolean</span>
143 <a href="#AllowedTo" title="details" class="method-name">AllowedTo</a>
144 (<span class="var-type">string</span>&nbsp;<span class="var-name">$whatever</span>)
145 </div>
146
147 <div class="method-definition">
148 <img src="../../media/images/Method.png" alt=" "/>
149 <span class="method-result">void</span>
150 <a href="#GetRoles" title="details" class="method-name">GetRoles</a>
151 ()
152 </div>
153
154 <div class="method-definition">
155 <img src="../../media/images/Method.png" alt=" "/>
156 <span class="method-result">string</span>
157 <a href="#Render" title="details" class="method-name">Render</a>
158 ()
159 </div>
160
161 <div class="method-definition">
162 <img src="../../media/images/Method.png" alt=" "/>
163 <span class="method-result">string</span>
164 <a href="#RenderFields" title="details" class="method-name">RenderFields</a>
165 (<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>])
166 </div>
167
168 <div class="method-definition">
169 <img src="../../media/images/Method.png" alt=" "/>
170 <span class="method-result">string</span>
171 <a href="#RenderRoles" title="details" class="method-name">RenderRoles</a>
172 (<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>])
173 </div>
174
175 <div class="method-definition">
176 <img src="../../media/images/Method.png" alt=" "/>
177 <span class="method-result">boolean</span>
178 <a href="#Validate" title="details" class="method-name">Validate</a>
179 ()
180 </div>
181
182 <div class="method-definition">
183 <img src="../../media/images/Method.png" alt=" "/>
184 <span class="method-result">Success.</span>
185 <a href="#Write" title="details" class="method-name">Write</a>
186 ()
187 </div>
188
189 <div class="method-definition">
190 <img src="../../media/images/Method.png" alt=" "/>
191 <span class="method-result">Success.</span>
192 <a href="#WriteRoles" title="details" class="method-name">WriteRoles</a>
193 ()
194 </div>
195 </div>
196 </div>
197 </div>
198
199 <a name="sec-vars"></a>
200 <div class="info-box">
201 <div class="info-box-title">Variables</div>
202 <div class="nav-bar">
203 <a href="#sec-description">Description</a> |
204 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
205
206
207 |
208 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
209
210 </div>
211 <div class="info-box-body">
212
213 <h4>Inherited Variables</h4>
214 <A NAME='inherited_vars'><!-- --></A>
215 <p>Inherited from <span class="classname"><a href="../../awl/DataUpdate/DBRecord.html">DBRecord</a></span></p>
216 <blockquote>
217 <img src="../../media/images/Variable.png" />
218 <span class="var-title">
219 <span class="var-name"><a href="../../awl/DataUpdate/DBRecord.html#var$EditMode">DBRecord::$EditMode</a></span><br>
220 </span>
221 </blockquote>
222
223 </div>
224 </div>
225
226 <a name="sec-methods"></a>
227 <div class="info-box">
228 <div class="info-box-title">Methods</div>
229 <div class="nav-bar">
230 <a href="#sec-description">Description</a> |
231 <a href="#sec-vars">Vars</a>
232 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
233
234 </div>
235 <div class="info-box-body">
236 <A NAME='method_detail'></A>
237 <a name="methodUser" id="User"><!-- --></a>
238 <div class="evenrow">
239
240 <div class="method-header">
241 <img src="../../media/images/Constructor.png" />
242 <span class="method-title">Constructor User</span> (line <span class="line-number">57</span>)
243 </div>
244
245 <!-- ========== Info from phpDoc block ========= -->
246 <p class="short-description">The constructor initialises a new record, potentially reading it from the database.</p>
247
248 <div class="method-signature">
249 <span class="method-result">User</span>
250 <span class="method-name">
251 User
252 </span>
253 (<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>])
254 </div>
255
256 <ul class="parameters">
257 <li>
258 <span class="var-type">int</span>
259 <span class="var-name">$id</span><span class="var-description">: The user_no, or 0 if we are creating a new one</span> </li>
260 <li>
261 <span class="var-type">string</span>
262 <span class="var-name">$prefix</span><span class="var-description">: The prefix for entry fields</span> </li>
263 </ul>
264
265
266 </div>
267 <a name="methodAllowedTo" id="AllowedTo"><!-- --></a>
268 <div class="oddrow">
269
270 <div class="method-header">
271 <img src="../../media/images/Method.png" />
272 <span class="method-title">AllowedTo</span> (line <span class="line-number">98</span>)
273 </div>
274
275 <!-- ========== Info from phpDoc block ========= -->
276 <p class="short-description">Can the user do this?</p>
277 <ul class="tags">
278 <li><span class="field">return:</span> Whether they are allowed to.</li>
279 </ul>
280
281 <div class="method-signature">
282 <span class="method-result">boolean</span>
283 <span class="method-name">
284 AllowedTo
285 </span>
286 (<span class="var-type">string</span>&nbsp;<span class="var-name">$whatever</span>)
287 </div>
288
289 <ul class="parameters">
290 <li>
291 <span class="var-type">string</span>
292 <span class="var-name">$whatever</span><span class="var-description">: What the user wants to do</span> </li>
293 </ul>
294
295
296 </div>
297 <a name="methodGetRoles" id="GetRoles"><!-- --></a>
298 <div class="evenrow">
299
300 <div class="method-header">
301 <img src="../../media/images/Method.png" />
302 <span class="method-title">GetRoles</span> (line <span class="line-number">149</span>)
303 </div>
304
305 <!-- ========== Info from phpDoc block ========= -->
306 <p class="short-description">Get the group memberships for the user</p>
307
308 <div class="method-signature">
309 <span class="method-result">void</span>
310 <span class="method-name">
311 GetRoles
312 </span>
313 ()
314 </div>
315
316
317
318 </div>
319 <a name="methodRender" id="Render"><!-- --></a>
320 <div class="oddrow">
321
322 <div class="method-header">
323 <img src="../../media/images/Method.png" />
324 <span class="method-title">Render</span> (line <span class="line-number">164</span>)
325 </div>
326
327 <!-- ========== Info from phpDoc block ========= -->
328 <p class="short-description">Render the form / viewer as HTML to show the user</p>
329 <ul class="tags">
330 <li><span class="field">return:</span> An HTML fragment to display in the page.</li>
331 </ul>
332
333 <div class="method-signature">
334 <span class="method-result">string</span>
335 <span class="method-name">
336 Render
337 </span>
338 ()
339 </div>
340
341
342
343 </div>
344 <a name="methodRenderFields" id="RenderFields"><!-- --></a>
345 <div class="evenrow">
346
347 <div class="method-header">
348 <img src="../../media/images/Method.png" />
349 <span class="method-title">RenderFields</span> (line <span class="line-number">198</span>)
350 </div>
351
352 <!-- ========== Info from phpDoc block ========= -->
353 <p class="short-description">Render the core details to show to the user</p>
354 <ul class="tags">
355 <li><span class="field">return:</span> An HTML fragment to display in the page.</li>
356 </ul>
357
358 <div class="method-signature">
359 <span class="method-result">string</span>
360 <span class="method-name">
361 RenderFields
362 </span>
363 (<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>])
364 </div>
365
366 <ul class="parameters">
367 <li>
368 <span class="var-type">object</span>
369 <span class="var-name">$ef</span><span class="var-description">: The entry form.</span> </li>
370 <li>
371 <span class="var-type">string</span>
372 <span class="var-name">$title</span><span class="var-description">: The title to display above the entry fields.</span> </li>
373 </ul>
374
375
376 </div>
377 <a name="methodRenderRoles" id="RenderRoles"><!-- --></a>
378 <div class="oddrow">
379
380 <div class="method-header">
381 <img src="../../media/images/Method.png" />
382 <span class="method-title">RenderRoles</span> (line <span class="line-number">269</span>)
383 </div>
384
385 <!-- ========== Info from phpDoc block ========= -->
386 <p class="short-description">Render the user's administrative roles</p>
387 <ul class="tags">
388 <li><span class="field">return:</span> The string of html to be output</li>
389 </ul>
390
391 <div class="method-signature">
392 <span class="method-result">string</span>
393 <span class="method-name">
394 RenderRoles
395 </span>
396 (<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>])
397 </div>
398
399 <ul class="parameters">
400 <li>
401 <span class="var-type"></span>
402 <span class="var-name">$ef</span> </li>
403 <li>
404 <span class="var-type"></span>
405 <span class="var-name">$title</span> </li>
406 </ul>
407
408
409 </div>
410 <a name="methodValidate" id="Validate"><!-- --></a>
411 <div class="evenrow">
412
413 <div class="method-header">
414 <img src="../../media/images/Method.png" />
415 <span class="method-title">Validate</span> (line <span class="line-number">315</span>)
416 </div>
417
418 <!-- ========== Info from phpDoc block ========= -->
419 <p class="short-description">Validate the information the user submitted</p>
420 <ul class="tags">
421 <li><span class="field">return:</span> Whether the form data validated OK.</li>
422 </ul>
423
424 <div class="method-signature">
425 <span class="method-result">boolean</span>
426 <span class="method-name">
427 Validate
428 </span>
429 ()
430 </div>
431
432
433
434 </div>
435 <a name="methodWrite" id="Write"><!-- --></a>
436 <div class="oddrow">
437
438 <div class="method-header">
439 <img src="../../media/images/Method.png" />
440 <span class="method-title">Write</span> (line <span class="line-number">349</span>)
441 </div>
442
443 <!-- ========== Info from phpDoc block ========= -->
444 <p class="short-description">Write the User record.</p>
445
446 <div class="method-signature">
447 <span class="method-result">Success.</span>
448 <span class="method-name">
449 Write
450 </span>
451 ()
452 </div>
453
454
455 <hr class="separator" />
456 <div class="notes">Redefinition of:</div>
457 <dl>
458 <dt><a href="../../awl/DataUpdate/DBRecord.html#methodWrite">DBRecord::Write()</a></dt>
459 <dd>To write the record to the database</dd>
460 </dl>
461
462 </div>
463 <a name="methodWriteRoles" id="WriteRoles"><!-- --></a>
464 <div class="evenrow">
465
466 <div class="method-header">
467 <img src="../../media/images/Method.png" />
468 <span class="method-title">WriteRoles</span> (line <span class="line-number">377</span>)
469 </div>
470
471 <!-- ========== Info from phpDoc block ========= -->
472 <p class="short-description">Write the roles associated with the user</p>
473
474 <div class="method-signature">
475 <span class="method-result">Success.</span>
476 <span class="method-name">
477 WriteRoles
478 </span>
479 ()
480 </div>
481
482
483
484 </div>
485 <h4>Inherited Methods</h4>
486 <a name='inherited_methods'><!-- --></a>
487 <!-- =========== Summary =========== -->
488 <p>Inherited From <span class="classname"><a href="../../awl/DataUpdate/DBRecord.html">DBRecord</a></span></p>
489 <blockquote>
490 <img src="../../media/images/Constructor.png" alt=" "/>
491 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodDBRecord">DBRecord::DBRecord()</a></span><br>
492 <img src="../../media/images/Method.png" alt=" "/>
493 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodAddTable">DBRecord::AddTable()</a></span><br>
494 <img src="../../media/images/Method.png" alt=" "/>
495 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodGet">DBRecord::Get()</a></span><br>
496 <img src="../../media/images/Method.png" alt=" "/>
497 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodInitialise">DBRecord::Initialise()</a></span><br>
498 <img src="../../media/images/Method.png" alt=" "/>
499 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodPostToValues">DBRecord::PostToValues()</a></span><br>
500 <img src="../../media/images/Method.png" alt=" "/>
501 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodRead">DBRecord::Read()</a></span><br>
502 <img src="../../media/images/Method.png" alt=" "/>
503 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodSet">DBRecord::Set()</a></span><br>
504 <img src="../../media/images/Method.png" alt=" "/>
505 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodUndefine">DBRecord::Undefine()</a></span><br>
506 <img src="../../media/images/Method.png" alt=" "/>
507 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#methodWrite">DBRecord::Write()</a></span><br>
508 <img src="../../media/images/Method.png" alt=" "/>
509 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#method_BuildFieldList">DBRecord::_BuildFieldList()</a></span><br>
510 <img src="../../media/images/Method.png" alt=" "/>
511 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#method_BuildJoinClause">DBRecord::_BuildJoinClause()</a></span><br>
512 <img src="../../media/images/Method.png" alt=" "/>
513 <span class="method-name"><a href="../../awl/DataUpdate/DBRecord.html#method_BuildWhereClause">DBRecord::_BuildWhereClause()</a></span><br>
514 </blockquote>
515
516 </div>
517 </div>
518
519
520 <p class="notes" id="credit">
521 Documentation generated on Tue, 28 Dec 2010 02:01:37 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
522 </p>
523 </div></body>
524 </html>
Andrew's Web Libraries