docs/api/davical/ldap/ldapDrivers.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 Class ldapDrivers</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="class-name"><img src="../../media/images/Class_logo.png"
  13                                                                                                                 alt=" Class"
  14                                                                                                                 title=" Class"
  15                                                                                                                 style="vertical-align: middle"> ldapDrivers</h2>
  16
  17 <a name="sec-description"></a>
  18 <div class="info-box">
  19         <div class="info-box-title">Description</div>
  20         <div class="nav-bar">
  21                                         <span class="disabled">Description</span> |
  22                                                                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  23
  24                                         </div>
  25         <div class="info-box-body">
  26                         <!-- ========== Info from phpDoc block ========= -->
  27                 <p class="notes">
  28                         Located in <a class="field" href="_inc---drivers_ldap.php.html">/inc/drivers_ldap.php</a> (line <span class="field">16</span>)
  29                 </p>
  30
  31
  32                 <pre></pre>
  33
  34                         </div>
  35 </div>
  36
  37
  38
  39
  40         <a name="sec-method-summary"></a>
  41         <div class="info-box">
  42                 <div class="info-box-title">Method Summary</span></div>
  43                 <div class="nav-bar">
  44                         <a href="#sec-description">Description</a> |
  45                                                                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  46                 </div>
  47                 <div class="info-box-body">
  48                         <div class="method-summary">
  49                                                                                                                                                                                                                                                                                                                                                                                                 <div class="method-definition">
  50                                         <img src="../../media/images/Constructor.png" alt=" "/>
  51                                                                                         <span class="method-result">ldapDrivers</span>
  52                                                                                 <a href="#__construct" title="details" class="method-name">__construct</a>
  53                                                                                         (<span class="var-type">array</span>&nbsp;<span class="var-name">$config</span>)
  54                                                                         </div>
  55                                                                                                                                 <div class="method-definition">
  56                                         <img src="../../media/images/Method.png" alt=" "/>
  57                                                                                         <span class="method-result">void</span>
  58                                                                                 <a href="#getAllGroups" title="details" class="method-name">getAllGroups</a>
  59                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span>)
  60                                                                         </div>
  61                                                                                                                                 <div class="method-definition">
  62                                         <img src="../../media/images/Method.png" alt=" "/>
  63                                                                                         <span class="method-result">void</span>
  64                                                                                 <a href="#getAllUsers" title="details" class="method-name">getAllUsers</a>
  65                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span>)
  66                                                                         </div>
  67                                                                                                                                 <div class="method-definition">
  68                                         <img src="../../media/images/Method.png" alt=" "/>
  69                                                                                         <span class="method-result">array</span>
  70                                                                                 <a href="#requestUser" title="details" class="method-name">requestUser</a>
  71                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$filter</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">NULL</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$passwd</span>)
  72                                                                         </div>
  73                                                                                         </div>
  74                 </div>
  75         </div>
  76
  77
  78         <a name="sec-methods"></a>
  79         <div class="info-box">
  80                 <div class="info-box-title">Methods</div>
  81                 <div class="nav-bar">
  82                         <a href="#sec-description">Description</a> |
  83                                                                                                         <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  84
  85                 </div>
  86                 <div class="info-box-body">
  87                         <A NAME='method_detail'></A>
  88 <a name="method__construct" id="__construct"><!-- --></a>
  89 <div class="evenrow">
  90
  91         <div class="method-header">
  92                 <img src="../../media/images/Constructor.png" />
  93                 <span class="method-title">Constructor __construct</span> (line <span class="line-number">35</span>)
  94         </div>
  95
  96         <!-- ========== Info from phpDoc block ========= -->
  97 <p class="short-description">Initializes the LDAP connection</p>
  98
  99         <div class="method-signature">
 100                 <span class="method-result">ldapDrivers</span>
 101                 <span class="method-name">
 102                         __construct
 103                 </span>
 104                                         (<span class="var-type">array</span>&nbsp;<span class="var-name">$config</span>)
 105                         </div>
 106
 107                         <ul class="parameters">
 108                                         <li>
 109                                 <span class="var-type">array</span>
 110                                 <span class="var-name">$config</span><span class="var-description">: The configuration data</span>                      </li>
 111                                 </ul>
 112
 113
 114         </div>
 115 <a name="methodgetAllGroups" id="getAllGroups"><!-- --></a>
 116 <div class="oddrow">
 117
 118         <div class="method-header">
 119                 <img src="../../media/images/Method.png" />
 120                 <span class="method-title">getAllGroups</span> (line <span class="line-number">147</span>)
 121         </div>
 122
 123         <!-- ========== Info from phpDoc block ========= -->
 124 <p class="short-description">Retrieve all groups from the LDAP directory</p>
 125
 126         <div class="method-signature">
 127                 <span class="method-result">void</span>
 128                 <span class="method-name">
 129                         getAllGroups
 130                 </span>
 131                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span>)
 132                         </div>
 133
 134                         <ul class="parameters">
 135                                         <li>
 136                                 <span class="var-type"></span>
 137                                 <span class="var-name">$attributes</span>                       </li>
 138                                 </ul>
 139
 140
 141         </div>
 142 <a name="methodgetAllUsers" id="getAllUsers"><!-- --></a>
 143 <div class="evenrow">
 144
 145         <div class="method-header">
 146                 <img src="../../media/images/Method.png" />
 147                 <span class="method-title">getAllUsers</span> (line <span class="line-number">116</span>)
 148         </div>
 149
 150         <!-- ========== Info from phpDoc block ========= -->
 151 <p class="short-description">Retrieve all users from the LDAP directory</p>
 152
 153         <div class="method-signature">
 154                 <span class="method-result">void</span>
 155                 <span class="method-name">
 156                         getAllUsers
 157                 </span>
 158                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span>)
 159                         </div>
 160
 161                         <ul class="parameters">
 162                                         <li>
 163                                 <span class="var-type"></span>
 164                                 <span class="var-name">$attributes</span>                       </li>
 165                                 </ul>
 166
 167
 168         </div>
 169 <a name="methodrequestUser" id="requestUser"><!-- --></a>
 170 <div class="oddrow">
 171
 172         <div class="method-header">
 173                 <img src="../../media/images/Method.png" />
 174                 <span class="method-title">requestUser</span> (line <span class="line-number">182</span>)
 175         </div>
 176
 177         <!-- ========== Info from phpDoc block ========= -->
 178 <p class="short-description">Returns the result of the LDAP query</p>
 179         <ul class="tags">
 180                                 <li><span class="field">return:</span> Contains selected attributes from all entries corresponding to the given filter</li>
 181                         </ul>
 182
 183         <div class="method-signature">
 184                 <span class="method-result">array</span>
 185                 <span class="method-name">
 186                         requestUser
 187                 </span>
 188                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$filter</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">NULL</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$passwd</span>)
 189                         </div>
 190
 191                         <ul class="parameters">
 192                                         <li>
 193                                 <span class="var-type">string</span>
 194                                 <span class="var-name">$filter</span><span class="var-description">: The filter used to search entries</span>                   </li>
 195                                         <li>
 196                                 <span class="var-type">array</span>
 197                                 <span class="var-name">$attributes</span><span class="var-description">: Attributes to be returned</span>                       </li>
 198                                         <li>
 199                                 <span class="var-type">string</span>
 200                                 <span class="var-name">$passwd</span><span class="var-description">: password to check</span>                   </li>
 201                                         <li>
 202                                 <span class="var-type"></span>
 203                                 <span class="var-name">$username</span>                 </li>
 204                                 </ul>
 205
 206
 207         </div>
 208
 209                 </div>
 210         </div>
 211
 212
 213         <p class="notes" id="credit">
 214                 Documentation generated on Tue, 27 Sep 2011 11:30:46 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 215         </p>
 216         </div></body>
 217 </html>