?  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 / AuthPlugin / AuthPlugin.html
blobc8737757c39fe4e6e606f0a670464cde28b363aa
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 AuthPlugin</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"> AuthPlugin</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
99
100 </div>
101 <div class="info-box-body">
102 <!-- ========== Info from phpDoc block ========= -->
103 <p class="short-description">A class for authenticating and retrieving user information</p>
104 <p class="notes">
105 Located in <a class="field" href="_AuthPlugin.php.html">/AuthPlugin.php</a> (line <span class="field">23</span>)
106 </p>
107
108
109 <pre></pre>
110
111 </div>
112 </div>
113
114
115
116
117 <a name="sec-method-summary"></a>
118 <div class="info-box">
119 <div class="info-box-title">Method Summary</span></div>
120 <div class="nav-bar">
121 <a href="#sec-description">Description</a> |
122 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
123 </div>
124 <div class="info-box-body">
125 <div class="method-summary">
126
127 <div class="method-definition">
128 <img src="../../media/images/Constructor.png" alt=" "/>
129 <span class="method-result">AuthPlugin</span>
130 <a href="#AuthPlugin" title="details" class="method-name">AuthPlugin</a>
131 (<span class="var-type">array</span>&nbsp;<span class="var-name">$authparams</span>)
132 </div>
133
134 <div class="method-definition">
135 <img src="../../media/images/Method.png" alt=" "/>
136 <span class="method-result">object The</span>
137 <a href="#Authenticate" title="details" class="method-name">Authenticate</a>
138 (<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
139 </div>
140 </div>
141 </div>
142 </div>
143
144
145 <a name="sec-methods"></a>
146 <div class="info-box">
147 <div class="info-box-title">Methods</div>
148 <div class="nav-bar">
149 <a href="#sec-description">Description</a> |
150 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
151
152 </div>
153 <div class="info-box-body">
154 <A NAME='method_detail'></A>
155 <a name="methodAuthPlugin" id="AuthPlugin"><!-- --></a>
156 <div class="evenrow">
157
158 <div class="method-header">
159 <img src="../../media/images/Constructor.png" />
160 <span class="method-title">Constructor AuthPlugin</span> (line <span class="line-number">43</span>)
161 </div>
162
163 <!-- ========== Info from phpDoc block ========= -->
164 <p class="short-description">Create a new AuthPlugin object. This is as lightweight as possible.</p>
165
166 <div class="method-signature">
167 <span class="method-result">AuthPlugin</span>
168 <span class="method-name">
169 AuthPlugin
170 </span>
171 (<span class="var-type">array</span>&nbsp;<span class="var-name">$authparams</span>)
172 </div>
173
174 <ul class="parameters">
175 <li>
176 <span class="var-type">array</span>
177 <span class="var-name">$authparams</span><span class="var-description">: An array of parameters used for this authentication method.</span> </li>
178 </ul>
179
180
181 </div>
182 <a name="methodAuthenticate" id="Authenticate"><!-- --></a>
183 <div class="oddrow">
184
185 <div class="method-header">
186 <img src="../../media/images/Method.png" />
187 <span class="method-title">Authenticate</span> (line <span class="line-number">54</span>)
188 </div>
189
190 <!-- ========== Info from phpDoc block ========= -->
191 <p class="short-description">Authenticate. Do whatever we need to authenticate a username / password.</p>
192 <ul class="tags">
193 <li><span class="field">return:</span> &quot;user&quot; object, containing fields matching the 'usr' database table</li>
194 </ul>
195
196 <div class="method-signature">
197 <span class="method-result">object The</span>
198 <span class="method-name">
199 Authenticate
200 </span>
201 (<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
202 </div>
203
204 <ul class="parameters">
205 <li>
206 <span class="var-type">string</span>
207 <span class="var-name">$username</span><span class="var-description">: The username of the person attempting to log in</span> </li>
208 <li>
209 <span class="var-type">string</span>
210 <span class="var-name">$password</span><span class="var-description">: The password the person is trying to log in with</span> </li>
211 </ul>
212
213
214 </div>
215
216 </div>
217 </div>
218
219
220 <p class="notes" id="credit">
221 Documentation generated on Tue, 28 Dec 2010 02:01:34 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
222 </p>
223 </div></body>
224 </html>
Andrew's Web Libraries