mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-05-03 16:31:12 +00:00
224 lines
7.7 KiB
HTML
224 lines
7.7 KiB
HTML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<!-- template designed by Marco Von Ballmoos -->
|
|
<title>Docs for page drivers_ldap.php</title>
|
|
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</head>
|
|
<body>
|
|
<div class="page-body">
|
|
|
|
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/drivers_ldap.php</h2>
|
|
|
|
<a name="sec-description"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Description</div>
|
|
<div class="nav-bar">
|
|
<span class="disabled">Description</span> |
|
|
<a href="#sec-classes">Classes</a>
|
|
| <a href="#sec-includes">Includes</a>
|
|
| <a href="#sec-functions">Functions</a>
|
|
</div>
|
|
<div class="info-box-body">
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Manages LDAP repository connection</p>
|
|
<ul class="tags">
|
|
<li><span class="field">author:</span> Maxime Delorme <<a href="mailto:mdelorme@tennaxia.net">mdelorme@tennaxia.net</a>></li>
|
|
<li><span class="field">copyright:</span> Maxime Delorme</li>
|
|
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-classes"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Classes</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<span class="disabled">Classes</span>
|
|
| <a href="#sec-includes">Includes</a>
|
|
| <a href="#sec-functions">Functions</a>
|
|
</div>
|
|
<div class="info-box-body">
|
|
<table cellpadding="2" cellspacing="0" class="class-table">
|
|
<tr>
|
|
<th class="class-table-header">Class</th>
|
|
<th class="class-table-header">Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
|
<img src="../../media/images/Class.png"
|
|
alt=" class"
|
|
title=" class"/>
|
|
<a href="../../davical/ldap/ldapDrivers.html">ldapDrivers</a>
|
|
</td>
|
|
<td>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-includes"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Includes</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-classes">Classes</a>
|
|
| <span class="disabled">Includes</span>
|
|
| <a href="#sec-functions">Functions</a>
|
|
</div>
|
|
<div class="info-box-body">
|
|
<a name="_auth-functions_php"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div>
|
|
<img src="../../media/images/Page.png" alt=" " />
|
|
<span class="include-title">
|
|
<span class="include-type">require_once</span>
|
|
(<span class="include-name"><a href="../../davical/authentication/_inc---auth-functions.php.html">"auth-functions.php"</a></span>)
|
|
(line <span class="line-number">13</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Manages LDAP repository connection</p>
|
|
<ul class="tags">
|
|
<li><span class="field">author:</span> Maxime Delorme <<a href="mailto:mdelorme@tennaxia.net">mdelorme@tennaxia.net</a>></li>
|
|
<li><span class="field">copyright:</span> Maxime Delorme</li>
|
|
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<a name="sec-functions"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Functions</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-classes">Classes</a>
|
|
| <a href="#sec-includes">Includes</a>
|
|
| <span class="disabled">Functions</span>
|
|
</div>
|
|
<div class="info-box-body">
|
|
<a name="functiongetStaticLdap" id="functiongetStaticLdap"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div>
|
|
<img src="../../media/images/Function.png" />
|
|
<span class="method-title">getStaticLdap</span> (line <span class="line-number">213</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">A generic function to create and fetch static objects</p>
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
getStaticLdap
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="functionLDAP_check" id="functionLDAP_check"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div>
|
|
<img src="../../media/images/Function.png" />
|
|
<span class="method-title">LDAP_check</span> (line <span class="line-number">260</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Check the username / password against the LDAP server</p>
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
LDAP_check
|
|
</span>
|
|
(<span class="var-type"></span> <span class="var-name">$username</span>, <span class="var-type"></span> <span class="var-name">$password</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$username</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$password</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="functionsync_LDAP" id="functionsync_LDAP"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div>
|
|
<img src="../../media/images/Function.png" />
|
|
<span class="method-title">sync_LDAP</span> (line <span class="line-number">329</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">sync LDAP against the DB</p>
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
sync_LDAP
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="functionsync_user_from_LDAP" id="functionsync_user_from_LDAP"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div>
|
|
<img src="../../media/images/Function.png" />
|
|
<span class="method-title">sync_user_from_LDAP</span> (line <span class="line-number">230</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Synchronise a cached user with one from LDAP</p>
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
sync_user_from_LDAP
|
|
</span>
|
|
(<span class="var-type"></span> <span class="var-name">&$usr</span>, <span class="var-type"></span> <span class="var-name">$mapping</span>, <span class="var-type"></span> <span class="var-name">$ldap_values</span>, <span class="var-type">object</span> <span class="var-name">$usr</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">object</span>
|
|
<span class="var-name">$usr</span><span class="var-description">: A user record to be updated (or created)</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">&$usr</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$mapping</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$ldap_values</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Fri, 05 Feb 2010 08:51:18 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
|
</p>
|
|
</div></body>
|
|
</html>
|