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