544 lines
17 KiB
HTML
544 lines
17 KiB
HTML
<html>
|
|
<head>
|
|
<title>Docs For Class PlaExporter</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_README.html">README</a></p>
|
|
<p><a href="../ric_INSTALL.html">INSTALL</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: PlaExporter</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><a href="../tools/PlaAbstractExporter.html">PlaAbstractExporter</a>
|
|
|
|
|
--PlaExporter</pre><br />
|
|
<div class="description">PlaExporter acts a wrapper around another exporter.</div><br /><br />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
<td valign="top">
|
|
<h3><a href="#class_vars">Variables</a></h3>
|
|
<ul>
|
|
<li><a href="../tools/PlaExporter.html#var$br">$br</a></li>
|
|
<li><a href="../tools/PlaExporter.html#var$exporter">$exporter</a></li>
|
|
</ul>
|
|
</td>
|
|
|
|
|
|
<td valign="top">
|
|
<h3><a href="#class_methods">Methods</a></h3>
|
|
<ul>
|
|
<li><a href="../tools/PlaExporter.html#methodPlaExporter">PlaExporter</a></li>
|
|
<li><a href="../tools/PlaExporter.html#methodexport">export</a></li>
|
|
<li><a href="../tools/PlaExporter.html#methodis_safe_ascii">is_safe_ascii</a></li>
|
|
<li><a href="../tools/PlaExporter.html#methodpla_fetch_entry_array">pla_fetch_entry_array</a></li>
|
|
<li><a href="../tools/PlaExporter.html#methodpla_fetch_entry_object">pla_fetch_entry_object</a></li>
|
|
<li><a href="../tools/PlaExporter.html#methodpla_get_ldap_info">pla_get_ldap_info</a></li>
|
|
<li><a href="../tools/PlaExporter.html#methodpla_has_entry">pla_has_entry</a></li>
|
|
<li><a href="../tools/PlaExporter.html#methodpla_num_entries">pla_num_entries</a></li>
|
|
<li><a href="../tools/PlaExporter.html#methodsetOutputFormat">setOutputFormat</a></li>
|
|
</ul>
|
|
</td>
|
|
|
|
</tr></table>
|
|
<hr />
|
|
|
|
<table width="100%" border="0"><tr>
|
|
|
|
|
|
|
|
<td valign="top">
|
|
<h3>Child classes:</h3>
|
|
<div class="tags">
|
|
<dl>
|
|
<dt><a href="../tools/PlaLdifExporter.html">PlaLdifExporter</a></dt>
|
|
<dd>Export entries to ldif format</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt><a href="../tools/PlaDsmlExporter.html">PlaDsmlExporter</a></dt>
|
|
<dd>Export entries to DSML v.1</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt><a href="../tools/PlaVcardExporter.html">PlaVcardExporter</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl>
|
|
<dt><a href="../tools/PlaCSVExporter.html">PlaCSVExporter</a></dt>
|
|
<dd>Export to cvs format</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt><a href="../tools/MyCustomExporter.html">MyCustomExporter</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</div>
|
|
</td>
|
|
|
|
|
|
|
|
<td valign="top">
|
|
<h3>Inherited Methods</h3>
|
|
<div class="tags">
|
|
<h4>Class: <a href="../tools/PlaAbstractExporter.html">PlaAbstractExporter</a></h4>
|
|
<dl>
|
|
<dt>
|
|
<a href="../tools/PlaAbstractExporter.html#methodpla_fetch_entry_array">PlaAbstractExporter::pla_fetch_entry_array()</a>
|
|
|
|
</dt>
|
|
<dd>
|
|
Return the entry as an array
|
|
</dd>
|
|
<dt>
|
|
<a href="../tools/PlaAbstractExporter.html#methodpla_fetch_entry_object">PlaAbstractExporter::pla_fetch_entry_object()</a>
|
|
|
|
</dt>
|
|
<dd>
|
|
Return the entry as an Entry object
|
|
</dd>
|
|
<dt>
|
|
<a href="../tools/PlaAbstractExporter.html#methodpla_get_ldap_info">PlaAbstractExporter::pla_get_ldap_info()</a>
|
|
|
|
</dt>
|
|
<dd>
|
|
Return a PlaLdapInfo Object
|
|
</dd>
|
|
<dt>
|
|
<a href="../tools/PlaAbstractExporter.html#methodpla_has_entry">PlaAbstractExporter::pla_has_entry()</a>
|
|
|
|
</dt>
|
|
<dd>
|
|
Return true if there is some more entries to be processed
|
|
</dd>
|
|
<dt>
|
|
<a href="../tools/PlaAbstractExporter.html#methodpla_num_entries">PlaAbstractExporter::pla_num_entries()</a>
|
|
|
|
</dt>
|
|
<dd>
|
|
Return the number of entries
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</td>
|
|
|
|
</tr></table>
|
|
<hr />
|
|
|
|
<a name="class_details"></a>
|
|
<h3>Class Details</h3>
|
|
<div class="tags">
|
|
[line 161]<br />
|
|
PlaExporter acts a wrapper around another exporter.<br /><br /><p>In other words, it will act as a decorator for another decorator</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$br"></a>
|
|
<p></p>
|
|
<h4>$br = <span class="value">"\n"</span></h4>
|
|
<p>[line 163]</p>
|
|
|
|
<br />
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>Type:</b> </td>
|
|
<td>mixed</td>
|
|
</tr>
|
|
</table>
|
|
</div><br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
|
<a name="var$exporter"></a>
|
|
<p></p>
|
|
<h4>$exporter = <span class="value"></span></h4>
|
|
<p>[line 165]</p>
|
|
|
|
<br />
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>Type:</b> </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="methodPlaExporter"></a>
|
|
<h3>constructor PlaExporter <span class="smalllinenumber">[line 171]</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>PlaExporter PlaExporter(
|
|
source
|
|
$source)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Constructor<br /><br /><br /><br />
|
|
|
|
|
|
|
|
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">source </td>
|
|
<td><b>$source</b> </td>
|
|
<td>the decoree for this exporter</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodexport"></a>
|
|
<h3>method export <span class="smalllinenumber">[line 233]</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>void export(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Abstract method use to export data.<br /><br /><p>Must be implemented in a sub-class if you write an exporter which export data. Leave it empty if you write a sub-class which do only some filtering.</p><br /><br /><br />
|
|
|
|
<p>Overridden in child classes as:<br />
|
|
<dl>
|
|
<dt><a href="../tools/PlaLdifExporter.html#methodexport">PlaLdifExporter::export()</a></dt>
|
|
<dd>Export entries to ldif format</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt><a href="../tools/PlaDsmlExporter.html#methodexport">PlaDsmlExporter::export()</a></dt>
|
|
<dd>Export the entries to DSML</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt><a href="../tools/PlaVcardExporter.html#methodexport">PlaVcardExporter::export()</a></dt>
|
|
<dd>When doing an exporter, the method export need to be overriden.</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt><a href="../tools/PlaCSVExporter.html#methodexport">PlaCSVExporter::export()</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl>
|
|
<dt><a href="../tools/MyCustomExporter.html#methodexport">MyCustomExporter::export()</a></dt>
|
|
<dd>When doing an exporter, the method export need to be overriden.</dd>
|
|
</dl>
|
|
</p>
|
|
|
|
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodis_safe_ascii"></a>
|
|
<h3>method is_safe_ascii <span class="smalllinenumber">[line 220]</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>bool is_safe_ascii(
|
|
String
|
|
$str)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Helper method to check if the attribute value should be base 64 encoded.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>true if the string is safe ascii, false otherwise.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
|
|
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">String </td>
|
|
<td><b>$str</b> </td>
|
|
<td>the string to check.</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodpla_fetch_entry_array"></a>
|
|
<h3>method pla_fetch_entry_array <span class="smalllinenumber">[line 195]</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>array pla_fetch_entry_array(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Return the entry as an array<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>an entry as an array</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
Overrides <a href="../tools/PlaAbstractExporter.html#methodpla_fetch_entry_array">PlaAbstractExporter::pla_fetch_entry_array()</a> (Return the entry as an array)<br /><br />
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodpla_fetch_entry_object"></a>
|
|
<h3>method pla_fetch_entry_object <span class="smalllinenumber">[line 203]</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>Entry pla_fetch_entry_object(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Return the entry as an Entry object<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>an entry as an Entry Object</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
Overrides <a href="../tools/PlaAbstractExporter.html#methodpla_fetch_entry_object">PlaAbstractExporter::pla_fetch_entry_object()</a> (Return the entry as an Entry object)<br /><br />
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodpla_get_ldap_info"></a>
|
|
<h3>method pla_get_ldap_info <span class="smalllinenumber">[line 211]</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>LdapInfo pla_get_ldap_info(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Return a PlaLdapInfo Object<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>Object with info from the ldap serveur</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
Overrides <a href="../tools/PlaAbstractExporter.html#methodpla_get_ldap_info">PlaAbstractExporter::pla_get_ldap_info()</a> (Return a PlaLdapInfo Object)<br /><br />
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodpla_has_entry"></a>
|
|
<h3>method pla_has_entry <span class="smalllinenumber">[line 187]</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>bool pla_has_entry(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Return true if there is some more entries to be processed<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>if there is some more entries to be processed</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
Overrides <a href="../tools/PlaAbstractExporter.html#methodpla_has_entry">PlaAbstractExporter::pla_has_entry()</a> (Return true if there is some more entries to be processed)<br /><br />
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodpla_num_entries"></a>
|
|
<h3>method pla_num_entries <span class="smalllinenumber">[line 179]</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>int pla_num_entries(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Return the number of entries<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>the number of entries to be exported</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
Overrides <a href="../tools/PlaAbstractExporter.html#methodpla_num_entries">PlaAbstractExporter::pla_num_entries()</a> (Return the number of entries)<br /><br />
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodsetOutputFormat"></a>
|
|
<h3>method setOutputFormat <span class="smalllinenumber">[line 239]</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>void setOutputFormat(
|
|
String
|
|
$br)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Set the carriage return /linefeed for the export<br /><br /><br /><br />
|
|
|
|
|
|
|
|
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">String </td>
|
|
<td><b>$br</b> </td>
|
|
<td>the CRLF to be set</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
</div><br />
|
|
|
|
|
|
<div class="credit">
|
|
<hr />
|
|
Documentation generated on Wed, 15 Nov 2006 18:00:43 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.2.3</a>
|
|
</div>
|
|
</td></tr></table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</body>
|
|
</html> |