docs/api/awl/Session/_Session.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 Session.php</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="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/Session.php</h2>
  89
  90 <a name="sec-description"></a>
  91 <div class="info-box">
  92         <div class="info-box-title">Description</div>
  93         <div class="nav-bar">
  94                                         <span class="disabled">Description</span> |
  95                                                         <a href="#sec-classes">Classes</a>
  96                         |                                                       <a href="#sec-includes">Includes</a>
  97                         |                                                                       <a href="#sec-variables">Variables</a>
  98                         |                                                       <a href="#sec-functions">Functions</a>
  99                         </div>
 100         <div class="info-box-body">
 101                 <!-- ========== Info from phpDoc block ========= -->
 102 <p class="short-description">Session handling class and associated functions</p>
 103 <p class="description"><p>This subpackage provides some functions that are useful around web  application session management.</p><p>The class is intended to be as lightweight as possible while holding  all session data in the database: <ul><li>Session hash is not predictable.</li><li>No clear text information is held in cookies.</li><li>Passwords are generally salted MD5 hashes, but individual users may
 104     have plain text passwords set by an administrator.</li><li>Temporary passwords are supported.</li><li>Logout is supported</li><li>&quot;Remember me&quot; cookies are supported, and will result in a new
 105     Session for each browser session.</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         <a name="sec-classes"></a>
 116         <div class="info-box">
 117                 <div class="info-box-title">Classes</div>
 118                 <div class="nav-bar">
 119                         <a href="#sec-description">Description</a> |
 120                         <span class="disabled">Classes</span>
 121                         |                                                       <a href="#sec-includes">Includes</a>
 122                                 |                                                                                                       <a href="#sec-variables">Variables</a>
 123                                 |                                                                               <a href="#sec-functions">Functions</a>
 124                                         </div>
 125                 <div class="info-box-body">
 126                         <table cellpadding="2" cellspacing="0" class="class-table">
 127                                 <tr>
 128                                         <th class="class-table-header">Class</th>
 129                                         <th class="class-table-header">Description</th>
 130                                 </tr>
 131                                                                 <tr>
 132                                         <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
 133                                                 <img src="../../media/images/Class.png"
 134                                                                  alt=" class"
 135                                                                  title=" class"/>
 136                                                 <a href="../../awl/Session/Session.html">Session</a>
 137                                         </td>
 138                                         <td>
 139                                                                                         A class for creating and holding session information.
 140                                                                                 </td>
 141                                 </tr>
 142                                                         </table>
 143                 </div>
 144         </div>
 145
 146         <a name="sec-includes"></a>
 147         <div class="info-box">
 148                 <div class="info-box-title">Includes</div>
 149                 <div class="nav-bar">
 150                         <a href="#sec-description">Description</a> |
 151                                                         <a href="#sec-classes">Classes</a>
 152                                 |                                               <span class="disabled">Includes</span>
 153                         |                                                                               <a href="#sec-variables">Variables</a>
 154                                 |                                                                               <a href="#sec-functions">Functions</a>
 155                                         </div>
 156                 <div class="info-box-body">
 157                         <a name="_AWLUtilities_php"><!-- --></a>
 158 <div class="oddrow">
 159
 160         <div>
 161                 <img src="../../media/images/Page.png" alt=" " />
 162                 <span class="include-title">
 163                         <span class="include-type">require_once</span>
 164                         (<span class="include-name"><a href="../../awl/Utilities/_AWLUtilities.php.html">'AWLUtilities.php'</a></span>)
 165                         (line <span class="line-number">25</span>)
 166                 </span>
 167         </div>
 168
 169         <!-- ========== Info from phpDoc block ========= -->
 170
 171 </div>
 172 <a name="_EMail_php"><!-- --></a>
 173 <div class="evenrow">
 174
 175         <div>
 176                 <img src="../../media/images/Page.png" alt=" " />
 177                 <span class="include-title">
 178                         <span class="include-type">require_once</span>
 179                         (<span class="include-name"><a href="../../awl/EMail/_EMail.php.html">'EMail.php'</a></span>)
 180                         (line <span class="line-number">27</span>)
 181                 </span>
 182         </div>
 183
 184         <!-- ========== Info from phpDoc block ========= -->
 185
 186 </div>
 187 <a name="_AwlQuery_php"><!-- --></a>
 188 <div class="oddrow">
 189
 190         <div>
 191                 <img src="../../media/images/Page.png" alt=" " />
 192                 <span class="include-title">
 193                         <span class="include-type">require_once</span>
 194                         (<span class="include-name"><a href="../../awl/AwlDatabase/_AwlQuery.php.html">'AwlQuery.php'</a></span>)
 195                         (line <span class="line-number">26</span>)
 196                 </span>
 197         </div>
 198
 199         <!-- ========== Info from phpDoc block ========= -->
 200
 201 </div>
 202                 </div>
 203         </div>
 204
 205
 206         <a name="sec-variables"></a>
 207         <div class="info-box">
 208                 <div class="info-box-title">Variables</div>
 209                 <div class="nav-bar">
 210                         <a href="#sec-description">Description</a> |
 211                                                         <a href="#sec-classes">Classes</a>
 212                                 |                                                                               <a href="#sec-includes">Includes</a>
 213                                 |                                                                       <span class="disabled">Variables</span>
 214                         |                                                       <a href="#sec-functions">Functions</a>
 215                                         </div>
 216                 <div class="info-box-body">
 217                         <a name="global$session
 218  The session object is global." id="global$session
 219  The session object is global."><!-- --></a>
 220 <div class="evenrow">
 221
 222         <div>
 223                 <img src="../../media/images/Global.png" />
 224                 <span class="var-title">
 225                         <span class="var-type">resource</span>
 226                         <span class="var-name">$session
 227  The session object is global.</span>
 228                                                 (line <span class="line-number">939</span>)
 229                 </span>
 230         </div>
 231
 232         <!-- ========== Info from phpDoc block ========= -->
 233         <ul class="tags">
 234                                 <li><span class="field">name:</span> $session
 235  The session object is global.</li>
 236                         </ul>
 237
 238
 239 </div>
 240                 </div>
 241         </div>
 242
 243         <a name="sec-functions"></a>
 244         <div class="info-box">
 245                 <div class="info-box-title">Functions</div>
 246                 <div class="nav-bar">
 247                         <a href="#sec-description">Description</a> |
 248                                                         <a href="#sec-classes">Classes</a>
 249                                 |                                                                               <a href="#sec-includes">Includes</a>
 250                                 |                                                                                                       <a href="#sec-variables">Variables</a>
 251                                 |                                               <span class="disabled">Functions</span>
 252                 </div>
 253                 <div class="info-box-body">
 254                         <a name="functioncheck_temporary_passwords" id="functioncheck_temporary_passwords"><!-- --></a>
 255 <div class="oddrow">
 256
 257         <div>
 258                 <img src="../../media/images/Function.png" />
 259                 <span class="method-title">check_temporary_passwords</span> (line <span class="line-number">36</span>)
 260         </div>
 261
 262         <!-- ========== Info from phpDoc block ========= -->
 263 <p class="short-description">Checks what a user entered against any currently valid temporary passwords on their account.</p>
 264         <ul class="tags">
 265                                 <li><span class="field">return:</span> Whether or not the user correctly guessed a temporary password within the necessary window of opportunity.</li>
 266                         </ul>
 267         <div class="method-signature">
 268                 <span class="method-result">boolean</span>
 269                 <span class="method-name">
 270                         check_temporary_passwords
 271                 </span>
 272                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$they_sent</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$user_no</span>)
 273                         </div>
 274
 275                         <ul class="parameters">
 276                                         <li>
 277                                 <span class="var-type">string</span>
 278                                 <span class="var-name">$they_sent</span><span class="var-description">: What the user entered.</span>                   </li>
 279                                         <li>
 280                                 <span class="var-type">int</span>
 281                                 <span class="var-name">$user_no</span><span class="var-description">: Which user is attempting to log on.</span>                        </li>
 282                                 </ul>
 283
 284
 285 </div>
 286                 </div>
 287         </div>
 288
 289         <p class="notes" id="credit">
 290                 Documentation generated on Tue, 28 Dec 2010 02:01:36 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 291         </p>
 292         </div></body>
 293 </html>