385 lines
		
	
	
		
			12 KiB
		
	
	
	
		
			HTML
		
	
	
	
		
		
			
		
	
	
			385 lines
		
	
	
		
			12 KiB
		
	
	
	
		
			HTML
		
	
	
	
|  | <html> | ||
|  | <head> | ||
|  | <title>Docs For Class PlaVcardExporter</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: PlaVcardExporter</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> | ||
|  |    | | ||
|  |    --<a href="../tools/PlaExporter.html">PlaExporter</a> | ||
|  |       | | ||
|  |       --PlaVcardExporter</pre><br /> | ||
|  | <div class="description"></div><br /><br /> | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  |          | ||
|  | </td> | ||
|  | 
 | ||
|  | <td valign="top"> | ||
|  | <h3><a href="#class_vars">Variables</a></h3> | ||
|  | <ul> | ||
|  |     <li><a href="../tools/PlaVcardExporter.html#var$deliveryAddress">$deliveryAddress</a></li> | ||
|  |     <li><a href="../tools/PlaVcardExporter.html#var$vcardMapping">$vcardMapping</a></li> | ||
|  |   </ul> | ||
|  | </td> | ||
|  | 
 | ||
|  | 
 | ||
|  | <td valign="top"> | ||
|  | <h3><a href="#class_methods">Methods</a></h3> | ||
|  | <ul> | ||
|  |     <li><a href="../tools/PlaVcardExporter.html#methodPlaVcardExporter">PlaVcardExporter</a></li> | ||
|  |     <li><a href="../tools/PlaVcardExporter.html#methodexport">export</a></li> | ||
|  |   </ul> | ||
|  | </td> | ||
|  | 
 | ||
|  | </tr></table> | ||
|  | <hr /> | ||
|  | 
 | ||
|  | <table width="100%" border="0"><tr> | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | <td valign="top"> | ||
|  | <h3>Inherited Variables</h3> | ||
|  | <div class="tags"> | ||
|  | <h4>Class: <a href="../tools/PlaExporter.html">PlaExporter</a></h4> | ||
|  | <dl> | ||
|  | <dt> | ||
|  |   <a href="../tools/PlaExporter.html#var$br">PlaExporter::$br</a> | ||
|  |    | ||
|  | </dt> | ||
|  | <dd> | ||
|  |     | ||
|  | </dd> | ||
|  | <dt> | ||
|  |   <a href="../tools/PlaExporter.html#var$exporter">PlaExporter::$exporter</a> | ||
|  |    | ||
|  | </dt> | ||
|  | <dd> | ||
|  |     | ||
|  | </dd> | ||
|  | </dl> | ||
|  | </div> | ||
|  | </td> | ||
|  | 
 | ||
|  | <td valign="top"> | ||
|  | <h3>Inherited Methods</h3> | ||
|  | <div class="tags"> | ||
|  | <h4>Class: <a href="../tools/PlaExporter.html">PlaExporter</a></h4> | ||
|  | <dl> | ||
|  |     <dt> | ||
|  |     <a href="../tools/PlaExporter.html#methodPlaExporter">PlaExporter::PlaExporter()</a> | ||
|  | 
 | ||
|  |   </dt> | ||
|  |   <dd> | ||
|  |     Constructor | ||
|  |   </dd> | ||
|  |     <dt> | ||
|  |     <a href="../tools/PlaExporter.html#methodexport">PlaExporter::export()</a> | ||
|  | 
 | ||
|  |   </dt> | ||
|  |   <dd> | ||
|  |     Abstract method use to export data. | ||
|  |   </dd> | ||
|  |     <dt> | ||
|  |     <a href="../tools/PlaExporter.html#methodis_safe_ascii">PlaExporter::is_safe_ascii()</a> | ||
|  | 
 | ||
|  |   </dt> | ||
|  |   <dd> | ||
|  |     Helper method to check if the attribute value should be base 64 encoded. | ||
|  |   </dd> | ||
|  |     <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> | ||
|  |     <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> | ||
|  |     <dt> | ||
|  |     <a href="../tools/PlaExporter.html#methodpla_get_ldap_info">PlaExporter::pla_get_ldap_info()</a> | ||
|  | 
 | ||
|  |   </dt> | ||
|  |   <dd> | ||
|  |     Return a PlaLdapInfo Object | ||
|  |   </dd> | ||
|  |     <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> | ||
|  |     <dt> | ||
|  |     <a href="../tools/PlaExporter.html#methodpla_num_entries">PlaExporter::pla_num_entries()</a> | ||
|  | 
 | ||
|  |   </dt> | ||
|  |   <dd> | ||
|  |     Return the number of entries | ||
|  |   </dd> | ||
|  |     <dt> | ||
|  |     <a href="../tools/PlaExporter.html#methodsetOutputFormat">PlaExporter::setOutputFormat()</a> | ||
|  | 
 | ||
|  |   </dt> | ||
|  |   <dd> | ||
|  |     Set the carriage return /linefeed for the export | ||
|  |   </dd> | ||
|  |   </dl> | ||
|  | <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 565]<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$deliveryAddress"></a> | ||
|  | 	<p></p> | ||
|  | 	<h4>$deliveryAddress = <span class="value">array("postOfficeBox",<br> | ||
|  |             "street",<br> | ||
|  |             "l",<br> | ||
|  |             "st",<br> | ||
|  |             "postalCode",<br> | ||
|  |             "c")</span></h4> | ||
|  | 	<p>[line 582]</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$vcardMapping"></a> | ||
|  | 	<p></p> | ||
|  | 	<h4>$vcardMapping = <span class="value">array('cn' => 'FN',<br> | ||
|  |              'title' => 'TITLE',<br> | ||
|  |              'homePhone' => 'TEL;HOME',<br> | ||
|  |              'mobile' => 'TEL;CELL',<br> | ||
|  |              'mail' => 'EMAIL;Internet',<br> | ||
|  |              'labeledURI' =>'URL',<br> | ||
|  |              'o' => 'ORG',<br> | ||
|  |              'audio' => 'SOUND',<br> | ||
|  |              'facsmileTelephoneNumber' =>'TEL;WORK;HOME;VOICE;FAX',<br> | ||
|  |              'jpegPhoto' => 'PHOTO;ENCODING=BASE64',<br> | ||
|  |              'businessCategory' => 'ROLE',<br> | ||
|  |              'description' => 'NOTE'<br> | ||
|  |              )</span></h4> | ||
|  | 	<p>[line 568]</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="methodPlaVcardExporter"></a> | ||
|  | 	<h3>constructor PlaVcardExporter <span class="smalllinenumber">[line 589]</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>PlaVcardExporter PlaVcardExporter( | ||
|  | mixed | ||
|  | $exporter)</code> | ||
|  |     </td></tr></table> | ||
|  |     </td></tr></table><br /> | ||
|  | 	 | ||
|  | 		<br /><br /> | ||
|  | 
 | ||
|  | 	 | ||
|  | 
 | ||
|  | 
 | ||
|  |         <div class="top">[ <a href="#top">Top</a> ]</div> | ||
|  |   </div> | ||
|  |   <hr /> | ||
|  | 	<a name="methodexport"></a> | ||
|  | 	<h3>method export <span class="smalllinenumber">[line 598]</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 /> | ||
|  | 	 | ||
|  | 		When doing an exporter, the method export need to be overriden.<br /><br /><p>A basic implementation is provided here. Customize to your need</p><br /><br /><br /> | ||
|  | 
 | ||
|  | 	 | ||
|  | Overrides <a href="../tools/PlaExporter.html#methodexport">PlaExporter::export()</a> (Abstract method use to export data.)<br /><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:44 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.2.3</a> | ||
|  | 	      </div> | ||
|  |       </td></tr></table> | ||
|  |     </td> | ||
|  |   </tr> | ||
|  | </table> | ||
|  | 
 | ||
|  | </body> | ||
|  | </html> |