docs/api/awl/AuthPlugin/_AuthPlugin.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 AuthPlugin.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">/AuthPlugin.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-classes">Classes</a>
  98                                                                                                                 </div>
  99         <div class="info-box-body">
 100                 <!-- ========== Info from phpDoc block ========= -->
 101 <p class="short-description">Authentication handling class</p>
 102 <p class="description"><p>This class provides a basic set of methods which are used by the Session  class to provide authentication.</p><p>This class is expected to be replaced, overridden or extended in some  instances to enable different pluggable authentication methods.</p></p>
 103         <ul class="tags">
 104                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
 105                                 <li><span class="field">copyright:</span> Catalyst IT Ltd</li>
 106                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
 107                         </ul>
 108
 109                         </div>
 110 </div>
 111
 112         <a name="sec-classes"></a>
 113         <div class="info-box">
 114                 <div class="info-box-title">Classes</div>
 115                 <div class="nav-bar">
 116                         <a href="#sec-description">Description</a> |
 117                         <span class="disabled">Classes</span>
 118                                                                                                                                         </div>
 119                 <div class="info-box-body">
 120                         <table cellpadding="2" cellspacing="0" class="class-table">
 121                                 <tr>
 122                                         <th class="class-table-header">Class</th>
 123                                         <th class="class-table-header">Description</th>
 124                                 </tr>
 125                                                                 <tr>
 126                                         <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
 127                                                 <img src="../../media/images/Class.png"
 128                                                                  alt=" class"
 129                                                                  title=" class"/>
 130                                                 <a href="../../awl/AuthPlugin/AuthPlugin.html">AuthPlugin</a>
 131                                         </td>
 132                                         <td>
 133                                                                                         A class for authenticating and retrieving user information
 134                                                                                 </td>
 135                                 </tr>
 136                                                         </table>
 137                 </div>
 138         </div>
 139
 140
 141
 142
 143
 144         <p class="notes" id="credit">
 145                 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>
 146         </p>
 147         </div></body>
 148 </html>