<html> <head> <title>Docs For Class PlaAbstractExporter</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---tests---schemaTest.php.html"> schemaTest.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/LAMTool.html">LAMTool</a><br /> <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: PlaAbstractExporter</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 represents the base class of all exporters</div><br /><br /> <h4>Author(s):</h4> <ul> </ul> </td> <td valign="top"> <h3><a href="#class_methods">Methods</a></h3> <ul> <li><a href="../tools/PlaAbstractExporter.html#methodpla_fetch_entry_array">pla_fetch_entry_array</a></li> <li><a href="../tools/PlaAbstractExporter.html#methodpla_fetch_entry_object">pla_fetch_entry_object</a></li> <li><a href="../tools/PlaAbstractExporter.html#methodpla_get_ldap_info">pla_get_ldap_info</a></li> <li><a href="../tools/PlaAbstractExporter.html#methodpla_has_entry">pla_has_entry</a></li> <li><a href="../tools/PlaAbstractExporter.html#methodpla_num_entries">pla_num_entries</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/PlaExporter.html">PlaExporter</a></dt> <dd>PlaExporter acts a wrapper around another exporter.</dd> </dl> <dl> <dt><a href="../tools/PlaLdapExporter.html">PlaLdapExporter</a></dt> <dd>Export data from a ldap server</dd> </dl> </div> </td> </tr></table> <hr /> <a name="class_details"></a> <h3>Class Details</h3> <div class="tags"> [line 119]<br /> This class represents the base class of all exporters<br /><br /><p>It can be subclassed directly if your intend is to write a source exporter(ie. it will act only as a decoree which will be wrapped by an another exporter.) If you consider writting an exporter for filtering data or directly display entries, please consider subclass the PlaExporter</p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>see:</b> </td><td><a href="../tools/PlaExporter.html">PlaExporter</a></td> </tr> </table> </div> </div><br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /> <hr /> <a name="class_methods"></a> <h3>Class Methods</h3> <div class="tags"> <hr /> <a name="methodpla_fetch_entry_array"></a> <h3>method pla_fetch_entry_array <span class="smalllinenumber">[line 137]</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 /> <p>Overridden in child classes as:<br /> <dl> <dt><a href="../tools/PlaExporter.html#methodpla_fetch_entry_array">PlaExporter::pla_fetch_entry_array()</a></dt> <dd>Return the entry as an array</dd> </dl> <dl> <dt><a href="../tools/PlaLdapExporter.html#methodpla_fetch_entry_array">PlaLdapExporter::pla_fetch_entry_array()</a></dt> <dd>Return the entry as an array</dd> </dl> </p> <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 143]</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 /> <p>Overridden in child classes as:<br /> <dl> <dt><a href="../tools/PlaExporter.html#methodpla_fetch_entry_object">PlaExporter::pla_fetch_entry_object()</a></dt> <dd>Return the entry as an Entry object</dd> </dl> <dl> <dt><a href="../tools/PlaLdapExporter.html#methodpla_fetch_entry_object">PlaLdapExporter::pla_fetch_entry_object()</a></dt> <dd>Return the entry as an Entry object</dd> </dl> </p> <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 149]</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 /> <p>Overridden in child classes as:<br /> <dl> <dt><a href="../tools/PlaExporter.html#methodpla_get_ldap_info">PlaExporter::pla_get_ldap_info()</a></dt> <dd>Return a PlaLdapInfo Object</dd> </dl> <dl> <dt><a href="../tools/PlaLdapExporter.html#methodpla_get_ldap_info">PlaLdapExporter::pla_get_ldap_info()</a></dt> <dd>Return a PlaLdapInfo Object</dd> </dl> </p> <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 131]</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 /> <p>Overridden in child classes as:<br /> <dl> <dt><a href="../tools/PlaExporter.html#methodpla_has_entry">PlaExporter::pla_has_entry()</a></dt> <dd>Return true if there is some more entries to be processed</dd> </dl> <dl> <dt><a href="../tools/PlaLdapExporter.html#methodpla_has_entry">PlaLdapExporter::pla_has_entry()</a></dt> <dd>Return true if there is some more entries to be processed</dd> </dl> </p> <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 125]</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 /> <p>Overridden in child classes as:<br /> <dl> <dt><a href="../tools/PlaExporter.html#methodpla_num_entries">PlaExporter::pla_num_entries()</a></dt> <dd>Return the number of entries</dd> </dl> <dl> <dt><a href="../tools/PlaLdapExporter.html#methodpla_num_entries">PlaLdapExporter::pla_num_entries()</a></dt> <dd>Return the number of entries</dd> </dl> </p> <div class="top">[ <a href="#top">Top</a> ]</div> </div> </div><br /> <div class="credit"> <hr /> Documentation generated on Thu, 07 Feb 2008 20:26:27 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a> </div> </td></tr></table> </td> </tr> </table> </body> </html>