LDAPAccountManager/lam-web/developers/phpdoc/tools/LdapExportInfo.html

252 lines
8.2 KiB
HTML

<html>
<head>
<title>Docs For Class LdapExportInfo</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">tools</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="../classtrees_tools.html" class="menu">class tree: tools</a> ]
[ <a href="../elementindex_tools.html" class="menu">index: tools</a> ]
[ <a href="../elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<div id="ric">
<p><a href="../ric_INSTALL.html">INSTALL</a></p>
<p><a href="../ric_README.html">README</a></p>
</div>
<b>Packages:</b><br />
<a href="../li_configuration.html">configuration</a><br />
<a href="../li_Help.html">Help</a><br />
<a href="../li_LDAP.html">LDAP</a><br />
<a href="../li_lib.html">lib</a><br />
<a href="../li_lists.html">lists</a><br />
<a href="../li_main.html">main</a><br />
<a href="../li_modules.html">modules</a><br />
<a href="../li_PDF.html">PDF</a><br />
<a href="../li_profiles.html">profiles</a><br />
<a href="../li_selfService.html">selfService</a><br />
<a href="../li_tests.html">tests</a><br />
<a href="../li_tools.html">tools</a><br />
<a href="../li_types.html">types</a><br />
<br /><br />
<b>Files:</b><br />
<div class="package">
<a href="../tools/_lib---export.inc.html"> export.inc
</a><br>
<a href="../tools/_templates---tests---index.php.html"> index.php
</a><br>
<a href="../tools/_templates---tests---lamdaemonTest.php.html"> lamdaemonTest.php
</a><br>
<a href="../tools/_templates---massBuildAccounts.php.html"> massBuildAccounts.php
</a><br>
<a href="../tools/_templates---masscreate.php.html"> masscreate.php
</a><br>
<a href="../tools/_templates---massDoUpload.php.html"> massDoUpload.php
</a><br>
<a href="../tools/_templates---ou_edit.php.html"> ou_edit.php
</a><br>
<a href="../tools/_templates---schema---schema.php.html"> schema.php
</a><br>
<a href="../tools/_templates---tools.php.html"> tools.php
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="../tools/LdapExportInfo.html">LdapExportInfo</a><br />
<a href="../tools/MyCustomExporter.html">MyCustomExporter</a><br />
<a href="../tools/PlaAbstractExporter.html">PlaAbstractExporter</a><br />
<a href="../tools/PlaCSVExporter.html">PlaCSVExporter</a><br />
<a href="../tools/PlaDsmlExporter.html">PlaDsmlExporter</a><br />
<a href="../tools/PlaExporter.html">PlaExporter</a><br />
<a href="../tools/PlaLdapExporter.html">PlaLdapExporter</a><br />
<a href="../tools/PlaLdifExporter.html">PlaLdifExporter</a><br />
<a href="../tools/PlaVcardExporter.html">PlaVcardExporter</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<h1>Class: LdapExportInfo</h1>
Source Location: /lib/export.inc<br /><br />
<table width="100%" border="0">
<tr><td valign="top">
<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description">This class encapsulate informations about the ldap server from which the export is done.</div><br /><br />
</td>
<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
<li><a href="../tools/LdapExportInfo.html#var$base_dn">$base_dn</a></li>
<li><a href="../tools/LdapExportInfo.html#var$query_filter">$query_filter</a></li>
<li><a href="../tools/LdapExportInfo.html#var$scope">$scope</a></li>
</ul>
</td>
<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
<li><a href="../tools/LdapExportInfo.html#methodLdapExportInfo">LdapExportInfo</a></li>
</ul>
</td>
</tr></table>
<hr />
<table width="100%" border="0"><tr>
</tr></table>
<hr />
<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 84]<br />
This class encapsulate informations about the ldap server from which the export is done.<br /><br /><p>The following info are provided within this class:</p><p>$base_dn: if the source of the export is the ldap server, it indicates the base dn of the search. $query_filter: if the source of the export is the ldap server, it indicates the query filter for the search. $scope: if the source of the export is the ldap server, it indicates the scope of the search.</p><br /></div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<hr />
<a name="class_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
<a name="var$base_dn"></a>
<p></p>
<h4>$base_dn = <span class="value"></span></h4>
<p>[line 86]</p>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$query_filter"></a>
<p></p>
<h4>$query_filter = <span class="value"></span></h4>
<p>[line 87]</p>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$scope"></a>
<p></p>
<h4>$scope = <span class="value"></span></h4>
<p>[line 88]</p>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />
<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
<hr />
<a name="methodLdapExportInfo"></a>
<h3>constructor LdapExportInfo <span class="smalllinenumber">[line 98]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>LdapExportInfo LdapExportInfo(
[String
$base_dn = NULL], [String
$query_filter = NULL], [String
$scope = NULL])</code>
</td></tr></table>
</td></tr></table><br />
Create a new LdapExportInfo object<br /><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">String&nbsp;&nbsp;</td>
<td><b>$base_dn</b>&nbsp;&nbsp;</td>
<td>the base_dn for the search in a ldap server</td>
</tr>
<tr>
<td class="type">String&nbsp;&nbsp;</td>
<td><b>$query_filter</b>&nbsp;&nbsp;</td>
<td>the query filter for the search</td>
</tr>
<tr>
<td class="type">String&nbsp;&nbsp;</td>
<td><b>$scope</b>&nbsp;&nbsp;</td>
<td>the scope of the search in a ldap server</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div><br />
<div class="credit">
<hr />
Documentation generated on Sun, 04 Nov 2007 12:10:45 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>