docs/api/davical/pwauth/_inc---drivers_pwauth_pam.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 drivers_pwauth_pam.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/drivers_pwauth_pam.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-classes">Classes</a>
  20                         |                                                       <a href="#sec-includes">Includes</a>
  21                         |                                                                                       <a href="#sec-functions">Functions</a>
  22                         </div>
  23         <div class="info-box-body">
  24                 <!-- ========== Info from phpDoc block ========= -->
  25 <p class="short-description">Manages PAM repository connection with pwauth</p>
  26         <ul class="tags">
  27                                 <li><span class="field">author:</span> Eric Seigne &lt;<a href="mailto:eric.seigne@ryxeo.com">eric.seigne@ryxeo.com</a>&gt;,    Michael B. Trausch &lt;mike@trausch.us&gt;,    Andrew McMillan &lt;andrew@mcmillan.net.nz&gt;</li>
  28                                 <li><span class="field">copyright:</span> Eric Seigne</li>
  29                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later
  30
  31  Based on drivers_squid_pam.php</a></li>
  32                         </ul>
  33
  34                         </div>
  35 </div>
  36
  37         <a name="sec-classes"></a>
  38         <div class="info-box">
  39                 <div class="info-box-title">Classes</div>
  40                 <div class="nav-bar">
  41                         <a href="#sec-description">Description</a> |
  42                         <span class="disabled">Classes</span>
  43                         |                                                       <a href="#sec-includes">Includes</a>
  44                                 |                                                                                                                               <a href="#sec-functions">Functions</a>
  45                                         </div>
  46                 <div class="info-box-body">
  47                         <table cellpadding="2" cellspacing="0" class="class-table">
  48                                 <tr>
  49                                         <th class="class-table-header">Class</th>
  50                                         <th class="class-table-header">Description</th>
  51                                 </tr>
  52                                                                 <tr>
  53                                         <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
  54                                                 <img src="../../media/images/Class.png"
  55                                                                  alt=" class"
  56                                                                  title=" class"/>
  57                                                 <a href="../../davical/pwauth/pwauthPamDrivers.html">pwauthPamDrivers</a>
  58                                         </td>
  59                                         <td>
  60
  61                                                                                 </td>
  62                                 </tr>
  63                                                         </table>
  64                 </div>
  65         </div>
  66
  67         <a name="sec-includes"></a>
  68         <div class="info-box">
  69                 <div class="info-box-title">Includes</div>
  70                 <div class="nav-bar">
  71                         <a href="#sec-description">Description</a> |
  72                                                         <a href="#sec-classes">Classes</a>
  73                                 |                                               <span class="disabled">Includes</span>
  74                         |                                                                                                       <a href="#sec-functions">Functions</a>
  75                                         </div>
  76                 <div class="info-box-body">
  77                         <a name="_auth-functions_php"><!-- --></a>
  78 <div class="oddrow">
  79
  80         <div>
  81                 <img src="../../media/images/Page.png" alt=" " />
  82                 <span class="include-title">
  83                         <span class="include-type">require_once</span>
  84                         (<span class="include-name"><a href="../../davical/authentication/_inc---auth-functions.php.html">"auth-functions.php"</a></span>)
  85                         (line <span class="line-number">17</span>)
  86                 </span>
  87         </div>
  88
  89         <!-- ========== Info from phpDoc block ========= -->
  90 <p class="short-description">Manages PAM repository connection with pwauth</p>
  91         <ul class="tags">
  92                                 <li><span class="field">author:</span> Eric Seigne &lt;<a href="mailto:eric.seigne@ryxeo.com">eric.seigne@ryxeo.com</a>&gt;,    Michael B. Trausch &lt;mike@trausch.us&gt;,    Andrew McMillan &lt;andrew@mcmillan.net.nz&gt;</li>
  93                                 <li><span class="field">copyright:</span> Eric Seigne</li>
  94                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later
  95
  96  Based on drivers_squid_pam.php</a></li>
  97                         </ul>
  98
  99 </div>
 100                 </div>
 101         </div>
 102
 103
 104
 105         <a name="sec-functions"></a>
 106         <div class="info-box">
 107                 <div class="info-box-title">Functions</div>
 108                 <div class="nav-bar">
 109                         <a href="#sec-description">Description</a> |
 110                                                         <a href="#sec-classes">Classes</a>
 111                                 |                                                                               <a href="#sec-includes">Includes</a>
 112                                 |                                                                                               <span class="disabled">Functions</span>
 113                 </div>
 114                 <div class="info-box-body">
 115                         <a name="functionPWAUTH_PAM_check" id="functionPWAUTH_PAM_check"><!-- --></a>
 116 <div class="evenrow">
 117
 118         <div>
 119                 <img src="../../media/images/Function.png" />
 120                 <span class="method-title">PWAUTH_PAM_check</span> (line <span class="line-number">48</span>)
 121         </div>
 122
 123         <!-- ========== Info from phpDoc block ========= -->
 124 <p class="short-description">Check the username / password against the PAM system</p>
 125         <div class="method-signature">
 126                 <span class="method-result">void</span>
 127                 <span class="method-name">
 128                         PWAUTH_PAM_check
 129                 </span>
 130                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$username</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$password</span>)
 131                         </div>
 132
 133                         <ul class="parameters">
 134                                         <li>
 135                                 <span class="var-type"></span>
 136                                 <span class="var-name">$username</span>                 </li>
 137                                         <li>
 138                                 <span class="var-type"></span>
 139                                 <span class="var-name">$password</span>                 </li>
 140                                 </ul>
 141
 142
 143 </div>
 144                 </div>
 145         </div>
 146
 147         <p class="notes" id="credit">
 148                 Documentation generated on Tue, 27 Sep 2011 11:30:47 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 149         </p>
 150         </div></body>
 151 </html>