docs/api/davical/authentication/_inc---auth-functions.php.html

   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 page auth-functions.php</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 <h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/auth-functions.php</h2>
  13
  14 <a name="sec-description"></a>
  15 <div class="info-box">
  16         <div class="info-box-title">Description</div>
  17         <div class="nav-bar">
  18                                         <span class="disabled">Description</span> |
  19                                                                         <a href="#sec-includes">Includes</a>
  20                         |                                                                                       <a href="#sec-functions">Functions</a>
  21                         </div>
  22         <div class="info-box-body">
  23                 <!-- ========== Info from phpDoc block ========= -->
  24 <p class="short-description">The authentication handling plugins can be used by the Session class to  provide authentication.</p>
  25 <p class="description"><p>Each authenticate hook needs to: <ul><li>Accept a username / password</li><li>Confirm the username / password are correct</li><li>Create (or update) a 'usr' record in our database</li><li>Return the 'usr' record as an object</li><li>Return === false when authentication fails</li></ul>  It can expect that: <ul><li>Configuration data will be in $c-&gt;authenticate_hook['config'], which might be an array, or whatever is needed.</li></ul>  In order to be called: <ul><li>This file should be included</li><li>$c-&gt;authenticate_hook['call'] should be set to the name of the plugin</li><li>$c-&gt;authenticate_hook['config'] should be set up with any configuration data for the plugin</li></ul></p></p>
  26         <ul class="tags">
  27                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
  28                                 <li><span class="field">copyright:</span> Catalyst IT Ltd, Morphoss Ltd</li>
  29                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
  30                         </ul>
  31
  32                         </div>
  33 </div>
  34
  35
  36         <a name="sec-includes"></a>
  37         <div class="info-box">
  38                 <div class="info-box-title">Includes</div>
  39                 <div class="nav-bar">
  40                         <a href="#sec-description">Description</a> |
  41                                                 <span class="disabled">Includes</span>
  42                         |                                                                                                       <a href="#sec-functions">Functions</a>
  43                                         </div>
  44                 <div class="info-box-body">
  45                         <a name="_DataUpdate_php"><!-- --></a>
  46 <div class="oddrow">
  47
  48         <div>
  49                 <img src="../../media/images/Page.png" alt=" " />
  50                 <span class="include-title">
  51                         <span class="include-type">require_once</span>
  52                         (<span class="include-name">"DataUpdate.php"</span>)
  53                         (line <span class="line-number">28</span>)
  54                 </span>
  55         </div>
  56
  57         <!-- ========== Info from phpDoc block ========= -->
  58 <p class="short-description">The authentication handling plugins can be used by the Session class to  provide authentication.</p>
  59 <p class="description"><p>Each authenticate hook needs to: <ul><li>Accept a username / password</li><li>Confirm the username / password are correct</li><li>Create (or update) a 'usr' record in our database</li><li>Return the 'usr' record as an object</li><li>Return === false when authentication fails</li></ul>  It can expect that: <ul><li>Configuration data will be in $c-&gt;authenticate_hook['config'], which might be an array, or whatever is needed.</li></ul>  In order to be called: <ul><li>This file should be included</li><li>$c-&gt;authenticate_hook['call'] should be set to the name of the plugin</li><li>$c-&gt;authenticate_hook['config'] should be set up with any configuration data for the plugin</li></ul></p></p>
  60         <ul class="tags">
  61                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
  62                                 <li><span class="field">copyright:</span> Catalyst IT Ltd, Morphoss Ltd</li>
  63                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
  64                         </ul>
  65
  66 </div>
  67                 </div>
  68         </div>
  69
  70
  71
  72         <a name="sec-functions"></a>
  73         <div class="info-box">
  74                 <div class="info-box-title">Functions</div>
  75                 <div class="nav-bar">
  76                         <a href="#sec-description">Description</a> |
  77                                                                                 <a href="#sec-includes">Includes</a>
  78                                 |                                                                                               <span class="disabled">Functions</span>
  79                 </div>
  80                 <div class="info-box-body">
  81                         <a name="functionAuthExternalAWL" id="functionAuthExternalAWL"><!-- --></a>
  82 <div class="evenrow">
  83
  84         <div>
  85                 <img src="../../media/images/Function.png" />
  86                 <span class="method-title">AuthExternalAWL</span> (line <span class="line-number">271</span>)
  87         </div>
  88
  89         <!-- ========== Info from phpDoc block ========= -->
  90 <p class="short-description">Authenticate against a different PostgreSQL database which contains a usr table in  the AWL format.</p>
  91 <p class="description"><p>Use this as in the following example config snippet:</p><p>require_once('auth-functions.php');   $c-&gt;authenticate_hook = array(       'call'   =&gt; 'AuthExternalAwl',       'config' =&gt; array(            // A PgSQL database connection string for the database containing user records           'connection[]' =&gt; 'dbname=wrms host=otherhost port=5433 user=general',            // Which columns should be fetched from the database           'columns'    =&gt; &quot;user_no, active, email_ok, joined, last_update AS updated, last_used, username, password, fullname, email&quot;,            // a WHERE clause to limit the records returned.           'where'    =&gt; &quot;active AND org_code=7&quot;       )   );</p></p>
  92         <div class="method-signature">
  93                 <span class="method-result">void</span>
  94                 <span class="method-name">
  95                         AuthExternalAWL
  96                 </span>
  97                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$username</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$password</span>)
  98                         </div>
  99
 100                         <ul class="parameters">
 101                                         <li>
 102                                 <span class="var-type"></span>
 103                                 <span class="var-name">$username</span>                 </li>
 104                                         <li>
 105                                 <span class="var-type"></span>
 106                                 <span class="var-name">$password</span>                 </li>
 107                                 </ul>
 108
 109
 110 </div>
 111 <a name="functionauth_functions_deprecated" id="functionauth_functions_deprecated"><!-- --></a>
 112 <div class="oddrow">
 113
 114         <div>
 115                 <img src="../../media/images/Function.png" />
 116                 <span class="method-title">auth_functions_deprecated</span> (line <span class="line-number">31</span>)
 117         </div>
 118
 119         <!-- ========== Info from phpDoc block ========= -->
 120         <div class="method-signature">
 121                 <span class="method-result">void</span>
 122                 <span class="method-name">
 123                         auth_functions_deprecated
 124                 </span>
 125                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$method</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$message</span> = <span class="var-default">null</span>])
 126                         </div>
 127
 128                         <ul class="parameters">
 129                                         <li>
 130                                 <span class="var-type"></span>
 131                                 <span class="var-name">$method</span>                   </li>
 132                                         <li>
 133                                 <span class="var-type"></span>
 134                                 <span class="var-name">$message</span>                  </li>
 135                                 </ul>
 136
 137
 138 </div>
 139 <a name="functionCreateDefaultRelationships" id="functionCreateDefaultRelationships"><!-- --></a>
 140 <div class="evenrow">
 141
 142         <div>
 143                 <img src="../../media/images/Function.png" />
 144                 <span class="method-title">CreateDefaultRelationships</span> (line <span class="line-number">150</span>)
 145         </div>
 146
 147         <!-- ========== Info from phpDoc block ========= -->
 148 <p class="short-description">Defunct function for creating default relationships.</p>
 149         <div class="method-signature">
 150                 <span class="method-result">void</span>
 151                 <span class="method-name">
 152                         CreateDefaultRelationships
 153                 </span>
 154                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
 155                         </div>
 156
 157                         <ul class="parameters">
 158                                         <li>
 159                                 <span class="var-type">string</span>
 160                                 <span class="var-name">$username</span><span class="var-description">: The username of the user we are creating relationships for.</span>                       </li>
 161                                 </ul>
 162
 163
 164 </div>
 165 <a name="functionCreateHomeCalendar" id="functionCreateHomeCalendar"><!-- --></a>
 166 <div class="oddrow">
 167
 168         <div>
 169                 <img src="../../media/images/Function.png" />
 170                 <span class="method-title">CreateHomeCalendar</span> (line <span class="line-number">141</span>)
 171         </div>
 172
 173         <!-- ========== Info from phpDoc block ========= -->
 174 <p class="short-description">Backward compatibility</p>
 175         <div class="method-signature">
 176                 <span class="method-result">void</span>
 177                 <span class="method-name">
 178                         CreateHomeCalendar
 179                 </span>
 180                                         (<span class="var-type">unknown_type</span>&nbsp;<span class="var-name">$username</span>)
 181                         </div>
 182
 183                         <ul class="parameters">
 184                                         <li>
 185                                 <span class="var-type">unknown_type</span>
 186                                 <span class="var-name">$username</span>                 </li>
 187                                 </ul>
 188
 189
 190 </div>
 191 <a name="functionCreateHomeCollections" id="functionCreateHomeCollections"><!-- --></a>
 192 <div class="evenrow">
 193
 194         <div>
 195                 <img src="../../media/images/Function.png" />
 196                 <span class="method-title">CreateHomeCollections</span> (line <span class="line-number">71</span>)
 197         </div>
 198
 199         <!-- ========== Info from phpDoc block ========= -->
 200 <p class="short-description">Creates some default home collections for the user.</p>
 201         <div class="method-signature">
 202                 <span class="method-result">void</span>
 203                 <span class="method-name">
 204                         CreateHomeCollections
 205                 </span>
 206                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
 207                         </div>
 208
 209                         <ul class="parameters">
 210                                         <li>
 211                                 <span class="var-type">string</span>
 212                                 <span class="var-name">$username</span><span class="var-description">: The username of the user we are creating relationships for.</span>                       </li>
 213                                 </ul>
 214
 215
 216 </div>
 217 <a name="functiongetPrincipalByID" id="functiongetPrincipalByID"><!-- --></a>
 218 <div class="oddrow">
 219
 220         <div>
 221                 <img src="../../media/images/Function.png" />
 222                 <span class="method-title">getPrincipalByID</span> (line <span class="line-number">61</span>)
 223         </div>
 224
 225         <!-- ========== Info from phpDoc block ========= -->
 226         <div class="method-signature">
 227                 <span class="method-result">void</span>
 228                 <span class="method-name">
 229                         getPrincipalByID
 230                 </span>
 231                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$principal_id</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$use_cache</span> = <span class="var-default">true</span>])
 232                         </div>
 233
 234                         <ul class="parameters">
 235                                         <li>
 236                                 <span class="var-type"></span>
 237                                 <span class="var-name">$principal_id</span>                     </li>
 238                                         <li>
 239                                 <span class="var-type"></span>
 240                                 <span class="var-name">$use_cache</span>                        </li>
 241                                 </ul>
 242
 243
 244 </div>
 245 <a name="functiongetUserByEMail" id="functiongetUserByEMail"><!-- --></a>
 246 <div class="evenrow">
 247
 248         <div>
 249                 <img src="../../media/images/Function.png" />
 250                 <span class="method-title">getUserByEMail</span> (line <span class="line-number">51</span>)
 251         </div>
 252
 253         <!-- ========== Info from phpDoc block ========= -->
 254         <div class="method-signature">
 255                 <span class="method-result">void</span>
 256                 <span class="method-name">
 257                         getUserByEMail
 258                 </span>
 259                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$email</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$use_cache</span> = <span class="var-default">true</span>])
 260                         </div>
 261
 262                         <ul class="parameters">
 263                                         <li>
 264                                 <span class="var-type"></span>
 265                                 <span class="var-name">$email</span>                    </li>
 266                                         <li>
 267                                 <span class="var-type"></span>
 268                                 <span class="var-name">$use_cache</span>                        </li>
 269                                 </ul>
 270
 271
 272 </div>
 273 <a name="functiongetUserByID" id="functiongetUserByID"><!-- --></a>
 274 <div class="oddrow">
 275
 276         <div>
 277                 <img src="../../media/images/Function.png" />
 278                 <span class="method-title">getUserByID</span> (line <span class="line-number">56</span>)
 279         </div>
 280
 281         <!-- ========== Info from phpDoc block ========= -->
 282         <div class="method-signature">
 283                 <span class="method-result">void</span>
 284                 <span class="method-name">
 285                         getUserByID
 286                 </span>
 287                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$user_no</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$use_cache</span> = <span class="var-default">true</span>])
 288                         </div>
 289
 290                         <ul class="parameters">
 291                                         <li>
 292                                 <span class="var-type"></span>
 293                                 <span class="var-name">$user_no</span>                  </li>
 294                                         <li>
 295                                 <span class="var-type"></span>
 296                                 <span class="var-name">$use_cache</span>                        </li>
 297                                 </ul>
 298
 299
 300 </div>
 301 <a name="functiongetUserByName" id="functiongetUserByName"><!-- --></a>
 302 <div class="evenrow">
 303
 304         <div>
 305                 <img src="../../media/images/Function.png" />
 306                 <span class="method-title">getUserByName</span> (line <span class="line-number">46</span>)
 307         </div>
 308
 309         <!-- ========== Info from phpDoc block ========= -->
 310         <div class="method-signature">
 311                 <span class="method-result">void</span>
 312                 <span class="method-name">
 313                         getUserByName
 314                 </span>
 315                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$username</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$use_cache</span> = <span class="var-default">true</span>])
 316                         </div>
 317
 318                         <ul class="parameters">
 319                                         <li>
 320                                 <span class="var-type"></span>
 321                                 <span class="var-name">$username</span>                 </li>
 322                                         <li>
 323                                 <span class="var-type"></span>
 324                                 <span class="var-name">$use_cache</span>                        </li>
 325                                 </ul>
 326
 327
 328 </div>
 329 <a name="functionUpdateUserFromExternal" id="functionUpdateUserFromExternal"><!-- --></a>
 330 <div class="oddrow">
 331
 332         <div>
 333                 <img src="../../media/images/Function.png" />
 334                 <span class="method-title">UpdateUserFromExternal</span> (line <span class="line-number">186</span>)
 335         </div>
 336
 337         <!-- ========== Info from phpDoc block ========= -->
 338 <p class="short-description">Update the local cache of the remote user details</p>
 339         <div class="method-signature">
 340                 <span class="method-result">void</span>
 341                 <span class="method-name">
 342                         UpdateUserFromExternal
 343                 </span>
 344                                         (<span class="var-type"></span>&nbsp;<span class="var-name">&$usr</span>, <span class="var-type">object</span>&nbsp;<span class="var-name">$usr</span>)
 345                         </div>
 346
 347                         <ul class="parameters">
 348                                         <li>
 349                                 <span class="var-type">object</span>
 350                                 <span class="var-name">$usr</span><span class="var-description">: The user details we read from the remote.</span>                      </li>
 351                                         <li>
 352                                 <span class="var-type"></span>
 353                                 <span class="var-name">&$usr</span>                     </li>
 354                                 </ul>
 355
 356
 357 </div>
 358                 </div>
 359         </div>
 360
 361         <p class="notes" id="credit">
 362                 Documentation generated on Tue, 27 Sep 2011 11:30:43 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 363         </p>
 364         </div></body>
 365 </html>