Docs For Class PlaExporter

constructor PlaExporter [line 131]

PlaExporter PlaExporter(
source
$source)

Constructor

Parameters:

source

$source

the decoree for this exporter

[ Top ]

method compress [line 205]

void compress(

$boolean)

Parameters:

$boolean

[ Top ]

method displayExportInfoHeader [line 190]

void displayExportInfoHeader(

$type, 
$ldapserver)

Display the header for the export

Parameters:

	$type
	$ldapserver

[ Top ]

method export [line 177]

void export(
)

Abstract method use to export data.

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.

Overridden in child classes as:

PlaLdifExporter::export(): Export entries to ldif format

PlaDsmlExporter::export(): Export the entries to DSML

PlaVcardExporter::export(): When doing an exporter, the method export need to be overriden.

PlaCSVExporter::export(): When doing an exporter, the method export need to be overriden.

MyCustomExporter::export(): When doing an exporter, the method export need to be overriden.

[ Top ]

method isCompressed [line 209]

void isCompressed(
)

[ Top ]

method is_safe_ascii [line 164]

bool is_safe_ascii(
String
$str)

Helper method to check if the attribute value should be base 64 encoded.

Tags:

return:

true if the string is safe ascii, false otherwise.

Parameters:

String

$str

the string to check.

[ Top ]

method pla_get_ldap_info [line 155]

LdapInfo pla_get_ldap_info(
)

Return a PlaLdapInfo Object

Tags:

return:

Object with info from the ldap serveur

Overrides PlaAbstractExporter::pla_get_ldap_info() (Return a PlaLdapInfo Object)

[ Top ]

method pla_num_entries [line 139]

int pla_num_entries(
)

Return the number of entries

Tags:

return:

the number of entries to be exported

Overrides PlaAbstractExporter::pla_num_entries() (Return the number of entries)

[ Top ]

method pla_results [line 147]

array pla_results(
)

Return the results

Tags:

return:

if there is some more entries to be processed

Overrides PlaAbstractExporter::pla_results() (Return the results)

[ Top ]

method setOutputFormat [line 183]

void setOutputFormat(
String
$br)

Set the carriage return /linefeed for the export

Parameters:

String

$br

the CRLF to be set

[ Top ]

Class: PlaExporter

Class Overview

Methods

Child classes:

Inherited Methods

Class: PlaAbstractExporter

Class Details

Class Methods

constructor PlaExporter [line 131]

Parameters:

method compress [line 205]

Parameters:

method displayExportInfoHeader [line 190]

Parameters:

method export [line 177]

method isCompressed [line 209]

method is_safe_ascii [line 164]

Tags:

Parameters:

method pla_get_ldap_info [line 155]

Tags:

method pla_num_entries [line 139]

Tags:

method pla_results [line 147]

Tags:

method setOutputFormat [line 183]

Parameters: