root/trunk/wifidog-auth/doc/WiFiDogAuthServer/Authenticator.html @ 871

Revision 871, 16.6 KB (checked in by max-horvath, 7 years ago)

2005-12-26 Max Horvath <max.horvath@…>

  • added new headers to every source file
  • converted file to represent a tab as four (4) spaces
  • added PhpDocumentor? documentation
  • added WiFiDog skin to HTMLeditor
  • language selection in a content class now shows the language name instead of the language code
  • added caching support to content classes Langstring and TrivialLangstring?
  • Property svn:eol-style set to native
Line 
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 Authenticator</title>
7                        <link rel="stylesheet" href="../media/stylesheet.css" />
8                        <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9                </head>
10                <body>
11                        <div class="page-body">                 
12
13<h2 class="class-name">Class Authenticator</h2>
14
15<a name="sec-description"></a>
16<div class="info-box">
17        <div class="info-box-title">Description</div>
18        <div class="nav-bar">
19                                        <span class="disabled">Description</span> |
20                                                        <a href="#sec-descendents">Descendents</a>
21                        |                                                                                       <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
22                                                |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
23                                               
24                                        </div>
25        <div class="info-box-body">
26                        <!-- ========== Info from phpDoc block ========= -->
27<p class="short-description">Abstract class to represent an authentication source</p>
28        <ul class="tags">
29                                <li><span class="field">abstract:</span> </li>
30                        </ul>
31                <p class="notes">
32                        Located in <a class="field" href="_wifidog_classes_Authenticator_php.html">/classes/Authenticator.php</a> (line <span class="field"><a href="..//__filesource/fsource_WiFiDogAuthServer__classesAuthenticator.php.html#a48">48</a></span>)
33                </p>
34               
35                               
36                <pre></pre>
37       
38                        </div>
39</div>
40
41        <a name="sec-descendents"></a>
42        <div class="info-box">
43                <div class="info-box-title">Direct descendents</div>
44                <div class="nav-bar">
45                        <a href="#sec-description">Description</a> |
46                        <span class="disabled">Descendents</span>
47                        |                                                                                               <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
48                                                                |                                                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
49                                                       
50                                                                </div>
51                <div class="info-box-body">
52                        <table cellpadding="2" cellspacing="0" class="class-table">
53                                <tr>
54                                        <th class="class-table-header">Class</th>
55                                        <th class="class-table-header">Description</th>
56                                </tr>
57                                                                <tr>
58                                        <td style="padding-right: 2em"><a href="../WiFiDogAuthServer/AuthenticatorLocalUser.html">AuthenticatorLocalUser</a></td>
59                                        <td>
60                                                                                        Internal wifidog user database authentication source
61                                                                                </td>
62                                </tr>
63                                                                <tr>
64                                        <td style="padding-right: 2em"><a href="../WiFiDogAuthServer/AuthenticatorRadius.html">AuthenticatorRadius</a></td>
65                                        <td>
66                                                                                        Internal wifidog user database authentication source
67                                                                                </td>
68                                </tr>
69                                                        </table>
70                </div>
71        </div>
72
73
74        <a name="sec-var-summary"></a>
75        <div class="info-box">
76                <div class="info-box-title">Variable Summary</span></div>
77                <div class="nav-bar">
78                        <a href="#sec-description">Description</a> |
79                                                        <a href="#sec-descendents">Descendents</a> |
80                                                <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
81                                                        |
82                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
83                                                       
84                                                                </div>
85                <div class="info-box-body">
86                        <div class="var-summary">
87                                                                <div class="var-title">
88                                        <span class="var-type">mixed</span>
89                                        <a href="#$mNetwork" title="details" class="var-name">$mNetwork</a>
90                                </div>
91                                                        </div>
92                </div>
93        </div>
94
95        <a name="sec-method-summary"></a>
96        <div class="info-box">
97                <div class="info-box-title">Method Summary</span></div>
98                <div class="nav-bar">
99                        <a href="#sec-description">Description</a> |
100                                                        <a href="#sec-descendents">Descendents</a> |
101                                                                                                                                                <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
102                                 
103                                |
104                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
105                </div>
106                <div class="info-box-body">                     
107                        <div class="method-summary">
108                                                               
109                                <div class="method-definition">
110                                                                                        <span class="method-result">Authenticator</span>
111                                                                                <a href="#__construct" title="details" class="method-name">__construct</a>
112                                                                                        (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$network_id</span>)
113                                                                        </div>
114                                                               
115                                <div class="method-definition">
116                                                                                        <span class="method-result">void</span>
117                                                                                <a href="#acctStart" title="details" class="method-name">acctStart</a>
118                                                                                        (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$conn_id</span>)
119                                                                        </div>
120                                                               
121                                <div class="method-definition">
122                                                                                        <span class="method-result">void</span>
123                                                                                <a href="#acctStop" title="details" class="method-name">acctStop</a>
124                                                                                        (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$conn_id</span>)
125                                                                        </div>
126                                                               
127                                <div class="method-definition">
128                                                                                        <span class="method-result">void</span>
129                                                                                <a href="#acctUpdate" title="details" class="method-name">acctUpdate</a>
130                                                                                        (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$conn_id</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$incoming</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$outgoing</span>)
131                                                                        </div>
132                                                               
133                                <div class="method-definition">
134                                                                                        <span class="method-result">void</span>
135                                                                                <a href="#getNetwork" title="details" class="method-name">getNetwork</a>
136                                                                                ()
137                                                                        </div>
138                                                               
139                                <div class="method-definition">
140                                                                                        <span class="method-result">void</span>
141                                                                                <a href="#isRegistrationPermitted" title="details" class="method-name">isRegistrationPermitted</a>
142                                                                                ()
143                                                                        </div>
144                                                               
145                                <div class="method-definition">
146                                                                                        <span class="method-result">void</span>
147                                                                                <a href="#login" title="details" class="method-name">login</a>
148                                                                                ()
149                                                                        </div>
150                                                               
151                                <div class="method-definition">
152                                                                                        <span class="method-result">void</span>
153                                                                                <a href="#logout" title="details" class="method-name">logout</a>
154                                                                                        ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$conn_id</span> = <span class="var-default">null</span>])
155                                                                        </div>
156                                                        </div>
157                </div>
158        </div>         
159
160        <a name="sec-vars"></a>
161        <div class="info-box">
162                <div class="info-box-title">Variables</div>
163                <div class="nav-bar">
164                        <a href="#sec-description">Description</a> |
165                                                        <a href="#sec-descendents">Descendents</a> |
166                                                                                <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
167                                               
168                       
169                                                                                |
170                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
171                                                       
172                                        </div>
173                <div class="info-box-body">
174                        <a name="var$mNetwork" id="$mNetwork"><!-- --></A>
175<div class="evenrow">
176
177        <div class="var-header">
178                <span class="var-title">
179                        <span class="var-type">mixed</span>
180                        <span class="var-name">$mNetwork</span>
181                                                (line <span class="line-number"><a href="..//__filesource/fsource_WiFiDogAuthServer__classesAuthenticator.php.html#a50">50</a></span>)
182                </span>
183        </div>
184
185        <!-- ========== Info from phpDoc block ========= -->
186        <ul class="tags">
187                                <li><span class="field">access:</span> private</li>
188                        </ul>
189       
190       
191               
192               
193
194</div>
195
196                                               
197                </div>
198        </div>
199       
200        <a name="sec-methods"></a>
201        <div class="info-box">
202                <div class="info-box-title">Methods</div>
203                <div class="nav-bar">
204                        <a href="#sec-description">Description</a> |
205                                                        <a href="#sec-descendents">Descendents</a> |
206                                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
207                                                                                                                                        <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
208                                               
209                </div>
210                <div class="info-box-body">
211                        <A NAME='method_detail'></A>
212<a name="method__construct" id="__construct"><!-- --></a>
213<div class="oddrow">
214       
215        <div class="method-header">
216                <span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="..//__filesource/fsource_WiFiDogAuthServer__classesAuthenticator.php.html#a52">52</a></span>)
217        </div> 
218       
219        <!-- ========== Info from phpDoc block ========= -->
220       
221        <div class="method-signature">
222                <span class="method-result">Authenticator</span>
223                <span class="method-name">
224                        __construct
225                </span>
226                                        (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$network_id</span>)
227                        </div>
228       
229               
230               
231                        <hr class="separator" />
232                <div class="notes">Redefined in descendants as:</div>
233                <ul class="redefinitions">
234                                        <li>
235                                <a href="../WiFiDogAuthServer/AuthenticatorLocalUser.html#method__construct">AuthenticatorLocalUser::__construct()</a>
236                                                        </li>
237                                        <li>
238                                <a href="../WiFiDogAuthServer/AuthenticatorRadius.html#method__construct">AuthenticatorRadius::__construct()</a>
239                                                                : AuthenticatorRadius constructor
240                                                        </li>
241                                </ul>
242        </div>
243<a name="methodacctStart" id="acctStart"><!-- --></a>
244<div class="evenrow">
245       
246        <div class="method-header">
247                <span class="method-title">acctStart</span> (line <span class="line-number"><a href="..//__filesource/fsource_WiFiDogAuthServer__classesAuthenticator.php.html#a129">129</a></span>)
248        </div> 
249       
250        <!-- ========== Info from phpDoc block ========= -->
251<p class="short-description">Start accounting traffic for the user</p>
252<p class="description"><p>$conn_id:  The connection id for the connection to work on</p></p>
253       
254        <div class="method-signature">
255                <span class="method-result">void</span>
256                <span class="method-name">
257                        acctStart
258                </span>
259                                        (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$conn_id</span>)
260                        </div>
261       
262               
263               
264                        <hr class="separator" />
265                <div class="notes">Redefined in descendants as:</div>
266                <ul class="redefinitions">
267                                        <li>
268                                <a href="../WiFiDogAuthServer/AuthenticatorLocalUser.html#methodacctStart">AuthenticatorLocalUser::acctStart()</a>
269                                                                : Start accounting traffic for the user
270                                                        </li>
271                                        <li>
272                                <a href="../WiFiDogAuthServer/AuthenticatorRadius.html#methodacctStart">AuthenticatorRadius::acctStart()</a>
273                                                                : Start accounting traffic for the user
274                                                        </li>
275                                </ul>
276        </div>
277<a name="methodacctStop" id="acctStop"><!-- --></a>
278<div class="oddrow">
279       
280        <div class="method-header">
281                <span class="method-title">acctStop</span> (line <span class="line-number"><a href="..//__filesource/fsource_WiFiDogAuthServer__classesAuthenticator.php.html#a177">177</a></span>)
282        </div> 
283       
284        <!-- ========== Info from phpDoc block ========= -->
285<p class="short-description">Final update and stop accounting</p>
286<p class="description"><p>$conn_id:  The connection id (the token id) for the connection to work on</p></p>
287       
288        <div class="method-signature">
289                <span class="method-result">void</span>
290                <span class="method-name">
291                        acctStop
292                </span>
293                                        (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$conn_id</span>)
294                        </div>
295       
296               
297               
298                        <hr class="separator" />
299                <div class="notes">Redefined in descendants as:</div>
300                <ul class="redefinitions">
301                                        <li>
302                                <a href="../WiFiDogAuthServer/AuthenticatorLocalUser.html#methodacctStop">AuthenticatorLocalUser::acctStop()</a>
303                                                                : Final update and stop accounting
304                                                        </li>
305                                        <li>
306                                <a href="../WiFiDogAuthServer/AuthenticatorRadius.html#methodacctStop">AuthenticatorRadius::acctStop()</a>
307                                                                : Final update and stop accounting
308                                                        </li>
309                                </ul>
310        </div>
311<a name="methodacctUpdate" id="acctUpdate"><!-- --></a>
312<div class="evenrow">
313       
314        <div class="method-header">
315                <span class="method-title">acctUpdate</span> (line <span class="line-number"><a href="..//__filesource/fsource_WiFiDogAuthServer__classesAuthenticator.php.html#a166">166</a></span>)
316        </div> 
317       
318        <!-- ========== Info from phpDoc block ========= -->
319<p class="short-description">Update traffic counters</p>
320<p class="description"><p>$conn_id: The connection id for the connection to work on</p></p>
321       
322        <div class="method-signature">
323                <span class="method-result">void</span>
324                <span class="method-name">
325                        acctUpdate
326                </span>
327                                        (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$conn_id</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$incoming</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$outgoing</span>)
328                        </div>
329       
330               
331               
332                        <hr class="separator" />
333                <div class="notes">Redefined in descendants as:</div>
334                <ul class="redefinitions">
335                                        <li>
336                                <a href="../WiFiDogAuthServer/AuthenticatorLocalUser.html#methodacctUpdate">AuthenticatorLocalUser::acctUpdate()</a>
337                                                                : Update traffic counters
338                                                        </li>
339                                        <li>
340                                <a href="../WiFiDogAuthServer/AuthenticatorRadius.html#methodacctUpdate">AuthenticatorRadius::acctUpdate()</a>
341                                                                : Update traffic counters
342                                                        </li>
343                                </ul>
344        </div>
345<a name="methodgetNetwork" id="getNetwork"><!-- --></a>
346<div class="oddrow">
347       
348        <div class="method-header">
349                <span class="method-title">getNetwork</span> (line <span class="line-number"><a href="..//__filesource/fsource_WiFiDogAuthServer__classesAuthenticator.php.html#a57">57</a></span>)
350        </div> 
351       
352        <!-- ========== Info from phpDoc block ========= -->
353        <ul class="tags">
354                                <li><span class="field">access:</span> public</li>
355                        </ul>
356       
357        <div class="method-signature">
358                <span class="method-result">void</span>
359                <span class="method-name">
360                        getNetwork
361                </span>
362                                ()
363                        </div>
364       
365               
366               
367        </div>
368<a name="methodisRegistrationPermitted" id="isRegistrationPermitted"><!-- --></a>
369<div class="evenrow">
370       
371        <div class="method-header">
372                <span class="method-title">isRegistrationPermitted</span> (line <span class="line-number"><a href="..//__filesource/fsource_WiFiDogAuthServer__classesAuthenticator.php.html#a188">188</a></span>)
373        </div> 
374       
375        <!-- ========== Info from phpDoc block ========= -->
376<p class="short-description">Property method that tells if the class allows registration</p>
377       
378        <div class="method-signature">
379                <span class="method-result">void</span>
380                <span class="method-name">
381                        isRegistrationPermitted
382                </span>
383                                ()
384                        </div>
385       
386               
387               
388                        <hr class="separator" />
389                <div class="notes">Redefined in descendants as:</div>
390                <ul class="redefinitions">
391                                        <li>
392                                <a href="../WiFiDogAuthServer/AuthenticatorLocalUser.html#methodisRegistrationPermitted">AuthenticatorLocalUser::isRegistrationPermitted()</a>
393                                                                : The basic AuthenticatorLocalUser allows user signup
394                                                        </li>
395                                        <li>
396                                <a href="../WiFiDogAuthServer/AuthenticatorLocalUserNoSignup.html#methodisRegistrationPermitted">AuthenticatorLocalUserNoSignup::isRegistrationPermitted()</a>
397                                                                : The basic AuthenticatorLocalUser allows user signup
398                                                        </li>
399                                </ul>
400        </div>
401<a name="methodlogin" id="login"><!-- --></a>
402<div class="oddrow">
403       
404        <div class="method-header">
405                <span class="method-title">login</span> (line <span class="line-number"><a href="..//__filesource/fsource_WiFiDogAuthServer__classesAuthenticator.php.html#a63">63</a></span>)
406        </div> 
407       
408        <!-- ========== Info from phpDoc block ========= -->
409<p class="short-description">Attempts to login a user against the authentication source.  If successfull, returns a User object</p>
410       
411        <div class="method-signature">
412                <span class="method-result">void</span>
413                <span class="method-name">
414                        login
415                </span>
416                                ()
417                        </div>
418       
419               
420               
421                        <hr class="separator" />
422                <div class="notes">Redefined in descendants as:</div>
423                <ul class="redefinitions">
424                                        <li>
425                                <a href="../WiFiDogAuthServer/AuthenticatorLocalUser.html#methodlogin">AuthenticatorLocalUser::login()</a>
426                                                                : Attempts to login a user against the authentication source.  If successfull, returns a User object
427                                                        </li>
428                                        <li>
429                                <a href="../WiFiDogAuthServer/AuthenticatorRadius.html#methodlogin">AuthenticatorRadius::login()</a>
430                                                                : Attempts to login a user against the authentication source.  If successfull, returns a User object
431                                                        </li>
432                                </ul>
433        </div>
434<a name="methodlogout" id="logout"><!-- --></a>
435<div class="evenrow">
436       
437        <div class="method-header">
438                <span class="method-title">logout</span> (line <span class="line-number"><a href="..//__filesource/fsource_WiFiDogAuthServer__classesAuthenticator.php.html#a73">73</a></span>)
439        </div> 
440       
441        <!-- ========== Info from phpDoc block ========= -->
442<p class="short-description">Logs out the user  $conn_id:  The connection id for the connection to work on.  Optionnal.</p>
443<p class="description"><p>If  it is not present, the behaviour depends if the network supports  multiple logins.  If it does not, all connections associated with the  current user will be destroyed.  If it does, only the connections  tied to the current node will be destroyed</p></p>
444       
445        <div class="method-signature">
446                <span class="method-result">void</span>
447                <span class="method-name">
448                        logout
449                </span>
450                                        ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$conn_id</span> = <span class="var-default">null</span>])
451                        </div>
452       
453               
454               
455        </div>
456                                               
457                </div>
458        </div>
459
460
461        <p class="notes" id="credit">
462                Documentation generated on Mon, 26 Dec 2005 19:13:30 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC5</a>
463        </p>
464        </div></body>
465</html>
Note: See TracBrowser for help on using the browser.