docs/api/awl/AuthPlugin/_AuthPlugins.php.html

   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 page AuthPlugins.php</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="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/AuthPlugins.php</h2>
  91
  92 <a name="sec-description"></a>
  93 <div class="info-box">
  94         <div class="info-box-title">Description</div>
  95         <div class="nav-bar">
  96                                         <span class="disabled">Description</span> |
  97                                                                         <a href="#sec-includes">Includes</a>
  98                         |                                                                                       <a href="#sec-functions">Functions</a>
  99                         </div>
 100         <div class="info-box-body">
 101
 102 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
 103 <!-- ========== Info from phpDoc block ========= -->
 104 <p class="short-description">The authentication handling plugins can be used by the Session class to  provide authentication.</p>
 105 <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>
 106         <ul class="tags">
 107                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
 108                                 <li><span class="field">copyright:</span> Catalyst IT Ltd, Morphoss Ltd &lt;http://www.morphoss.com/&gt;</li>
 109                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
 110                         </ul>
 111
 112                         </div>
 113 </div>
 114
 115
 116         <a name="sec-includes"></a>
 117         <div class="info-box">
 118                 <div class="info-box-title">Includes</div>
 119                 <div class="nav-bar">
 120                         <a href="#sec-description">Description</a> |
 121                                                 <span class="disabled">Includes</span>
 122                         |                                                                                                       <a href="#sec-functions">Functions</a>
 123                                         </div>
 124                 <div class="info-box-body">
 125
 126 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
 127
 128 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
 129 <a name="_AWLUtilities_php"><!-- --></a>
 130 <div class="evenrow">
 131
 132         <div>
 133                 <img src="../../media/images/Page.png" alt=" " />
 134                 <span class="include-title">
 135                         <span class="include-type">require_once</span>
 136                         (<span class="include-name"><a href="../../awl/Utilities/_AWLUtilities.php.html">'AWLUtilities.php'</a></span>)
 137                         (line <span class="line-number">28</span>)
 138                 </span>
 139         </div>
 140
 141         <!-- ========== Info from phpDoc block ========= -->
 142
 143 </div>
 144 <a name="_DataUpdate_php"><!-- --></a>
 145 <div class="oddrow">
 146
 147         <div>
 148                 <img src="../../media/images/Page.png" alt=" " />
 149                 <span class="include-title">
 150                         <span class="include-type">require_once</span>
 151                         (<span class="include-name"><a href="../../awl/DataUpdate/_DataUpdate.php.html">'DataUpdate.php'</a></span>)
 152                         (line <span class="line-number">29</span>)
 153                 </span>
 154         </div>
 155
 156         <!-- ========== Info from phpDoc block ========= -->
 157
 158 </div>
 159                 </div>
 160         </div>
 161
 162
 163
 164         <a name="sec-functions"></a>
 165         <div class="info-box">
 166                 <div class="info-box-title">Functions</div>
 167                 <div class="nav-bar">
 168                         <a href="#sec-description">Description</a> |
 169                                                                                 <a href="#sec-includes">Includes</a>
 170                                 |                                                                                               <span class="disabled">Functions</span>
 171                 </div>
 172                 <div class="info-box-body">
 173
 174 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
 175
 176 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
 177 <a name="functionauth_external" id="functionauth_external"><!-- --></a>
 178 <div class="evenrow">
 179
 180         <div>
 181                 <img src="../../media/images/Function.png" />
 182                 <span class="method-title">auth_external</span> (line <span class="line-number">97</span>)
 183         </div>
 184
 185         <!-- ========== Info from phpDoc block ========= -->
 186 <p class="short-description">Authentication has already happened.  We know the username, we just need  to do the authorisation / access control.  The password is ignored.</p>
 187         <div class="method-signature">
 188                 <span class="method-result">void</span>
 189                 <span class="method-name">
 190                         auth_external
 191                 </span>
 192                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$username</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$password</span>)
 193                         </div>
 194
 195                         <ul class="parameters">
 196                                         <li>
 197                                 <span class="var-type"></span>
 198                                 <span class="var-name">$username</span>                 </li>
 199                                         <li>
 200                                 <span class="var-type"></span>
 201                                 <span class="var-name">$password</span>                 </li>
 202                                 </ul>
 203
 204
 205 </div>
 206 <a name="functionauth_other_awl" id="functionauth_other_awl"><!-- --></a>
 207 <div class="oddrow">
 208
 209         <div>
 210                 <img src="../../media/images/Function.png" />
 211                 <span class="method-title">auth_other_awl</span> (line <span class="line-number">37</span>)
 212         </div>
 213
 214         <!-- ========== Info from phpDoc block ========= -->
 215 <p class="short-description">Authenticate against a different PostgreSQL database which contains a usr table in  the AWL format.</p>
 216         <div class="method-signature">
 217                 <span class="method-result">void</span>
 218                 <span class="method-name">
 219                         auth_other_awl
 220                 </span>
 221                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$username</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$password</span>)
 222                         </div>
 223
 224                         <ul class="parameters">
 225                                         <li>
 226                                 <span class="var-type"></span>
 227                                 <span class="var-name">$username</span>                 </li>
 228                                         <li>
 229                                 <span class="var-type"></span>
 230                                 <span class="var-name">$password</span>                 </li>
 231                                 </ul>
 232
 233
 234 </div>
 235                 </div>
 236         </div>
 237
 238
 239 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
 240         <p class="notes" id="credit">
 241                 Documentation generated on Sun, 17 Jun 2012 10:00:13 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 242         </p>
 243         </div></body>
 244 </html>