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