tools
[ class tree: tools ] [ index: tools ] [ all elements ]
Packages:
configuration
Help
LDAP
lib
lists
main
modules
PDF
profiles
selfService
tests
tools
types


Files:
export.inc
index.php
lamdaemonTest.php
massBuildAccounts.php
masscreate.php
massDoUpload.php
ou_edit.php
schema.php
schemaTest.php
tools.php

Classes:
LAMTool
LdapExportInfo
MyCustomExporter
PlaAbstractExporter
PlaCSVExporter
PlaDsmlExporter
PlaExporter
PlaLdapExporter
PlaLdifExporter
PlaVcardExporter

Class: PlaAbstractExporter

Source Location: /lib/export.inc

Class Overview




This class represents the base class of all exporters




Author(s):


    
        





    

        






Methods















Child classes:






PlaExporter

	
PlaExporter acts a wrapper around another exporter.






PlaLdapExporter

	
Export data from a ldap server

















Class Details



[line 119]

This class represents the base class of all exporters

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





Tags:





  

    see:  PlaExporter
  










[ Top ]








Class Methods




  

	
	
method pla_fetch_entry_array [line 137]

	

    

    

		array pla_fetch_entry_array(
)
    

    


	
		Return the entry as an array





Tags:





  

    return:  an entry as an array
  









	
Overridden in child classes as:

		

	
PlaExporter::pla_fetch_entry_array()

		
Return the entry as an array

	

		

	
PlaLdapExporter::pla_fetch_entry_array()

		
Return the entry as an array

	

	

	
        
[ Top ]

  

  

	
	
method pla_fetch_entry_object [line 143]

	

    

    

		Entry pla_fetch_entry_object(
)
    

    


	
		Return the entry as an Entry object





Tags:





  

    return:  an entry  as an Entry Object
  









	
Overridden in child classes as:

		

	
PlaExporter::pla_fetch_entry_object()

		
Return the entry as an Entry object

	

		

	
PlaLdapExporter::pla_fetch_entry_object()

		
Return the entry as an Entry object

	

	

	
        
[ Top ]

  

  

	
	
method pla_get_ldap_info [line 149]

	

    

    

		LdapInfo pla_get_ldap_info(
)
    

    


	
		Return a PlaLdapInfo Object





Tags:





  

    return:  Object with info from the ldap serveur
  









	
Overridden in child classes as:

		

	
PlaExporter::pla_get_ldap_info()

		
Return a PlaLdapInfo Object

	

		

	
PlaLdapExporter::pla_get_ldap_info()

		
Return a PlaLdapInfo Object

	

	

	
        
[ Top ]

  

  

	
	
method pla_has_entry [line 131]

	

    

    

		bool pla_has_entry(
)
    

    


	
		Return true if there is some more entries to be processed





Tags:





  

    return:  if there is some more entries to be processed
  









	
Overridden in child classes as:

		

	
PlaExporter::pla_has_entry()

		
Return true if there is some more entries to be processed

	

		

	
PlaLdapExporter::pla_has_entry()

		
Return true if there is some more entries to be processed

	

	

	
        
[ Top ]

  

  

	
	
method pla_num_entries [line 125]

	

    

    

		int pla_num_entries(
)
    

    


	
		Return the number of entries





Tags:





  

    return:  the number of entries to be exported
  









	
Overridden in child classes as:

		

	
PlaExporter::pla_num_entries()

		
Return the number of entries

	

		

	
PlaLdapExporter::pla_num_entries()

		
Return the number of entries

	

	

	
        
[ Top ]

  






        

		    

		    Documentation generated on Sun, 06 Jan 2008 18:59:00 +0100 by phpDocumentor 1.4.0