templates/3rdParty/pla/lib/export_functions.php

Properties

Description

Classes and functions for export data from LDAP

These classes provide differnet export formats.

Classes

Exporter

Properties

 
 
Export  
No 
No 

Description

Exporter Class
This class serves as a top level exporter class, which will return the correct Export class.

Methods

__construct, accept, getTemplate, types,

__construct(   $server_id,   $template_id, ) : n/a

Arguments

Name Type Description Default
$server_id n/a
$template_id n/a

Return value

Type Description
n/a n/a

accept( ) : n/a

Return value

Type Description
n/a n/a

getTemplate( ) : n/a

Return value

Type Description
n/a n/a

types( ) : n/a

Return value

Type Description
n/a n/a

Properties

$server_id, $template, $template_id,

  private  $server_id =




  private  $template =




  private  $template_id =




Export

Properties

 
 
Export  
Yes 
No 

Description

Export Class
This abstract classes provides all the common methods and variables for the custom export classes.

Methods

accept, getHeader, getServer, getServerID, isCompressed, isSafeAscii,

accept( ) : n/a

Return value

Type Description
n/a n/a

getHeader( ) : n/a

Return value

Type Description
n/a n/a

getServer( ) : object

Description

Return this LDAP Server object

Return value

Type Description
object DataStore Server

getServerID( ) : int

Description

Return the LDAP server ID

Return value

Type Description
int Server ID

isCompressed( ) : n/a

Return value

Type Description
n/a n/a

isSafeAscii(   $str, ) : boolean

Description

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

Arguments

Name Type Description Default
$str n/a

Return value

Type Description
boolean true if the string is safe ascii, false otherwise.

Properties

$br, $compress, $items, $results, $resultsdata,

  protected  $br =




  protected  $compress =




  protected  $items = 0




  protected  $results =




  protected  $resultsdata =




ExportCSV

Properties

 
 
Export  
No 
No 

Description

Export entries to CSV
This abstract classes provides all the common methods and variables for the custom export classes.

Methods

LdapEscape, export, getType,

LdapEscape(   $var, ) : n/a

Description

Function to escape data, where the qualifier happens to also be in the data.

Arguments

Name Type Description Default
$var n/a

Return value

Type Description
n/a n/a

export( ) : n/a

Return value

Type Description
n/a n/a

getType( ) : n/a

Return value

Type Description
n/a n/a

Properties

$escapeCode, $multivalue_separator, $qualifier, $separator,

  private  $escapeCode = '"'




  private  $multivalue_separator = ' | '




  private  $qualifier = '"'




  private  $separator = ','




ExportDSML

Properties

 
 
Export  
No 
No 

Description

Export entries to DSML v.1
This abstract classes provides all the common methods and variables for the custom export classes.

Methods

export, getType,

export( ) : n/a

Description

Export entries to DSML format

Return value

Type Description
n/a n/a

getType( ) : n/a

Return value

Type Description
n/a n/a

ExportLDIF

Properties

 
 
Export  
No 
No 

Description

Export from LDAP using an LDIF format
This abstract classes provides all the common methods and variables for the custom export classes.

Methods

export, getType, multiLineDisplay,

export( ) : n/a

Description

Export entries to LDIF format

Return value

Type Description
n/a n/a

getType( ) : n/a

Return value

Type Description
n/a n/a

multiLineDisplay(   $str, ) : n/a

Description

Helper method to wrap ldif lines

Arguments

Name Type Description Default
$str n/a

Return value

Type Description
n/a n/a

Properties

$line_length,

  private  $line_length = 76




ExportVCARD

Properties

 
 
Export  
No 
No 

Description

Export entries to VCARD v2.1
This abstract classes provides all the common methods and variables for the custom export classes.

Methods

export, getType,

export( ) : n/a

Description

Export entries to VCARD format

Return value

Type Description
n/a n/a

getType( ) : n/a

Return value

Type Description
n/a n/a

Properties

$deliveryAddress, $mapping,

  private  $deliveryAddress = array('postofficebox', 'street', 'l', 'st', 'postalcode', 'c')




  private  $mapping = array('cn' => 'FN', 'title' => 'TITLE', 'homephone' => 'TEL;HOME', 'mobile' => 'TEL;CELL', 'mail' => 'EMAIL;Internet', 'labeleduri' => 'URL', 'o' => 'ORG', 'audio' => 'SOUND', 'facsmiletelephoneNumber' => 'TEL;WORK;HOME;VOICE;FAX', 'jpegphoto' => 'PHOTO;ENCODING=BASE64', 'businesscategory' => 'ROLE', 'description' => 'NOTE')




Documentation was generated by phpDocumentor 2.0.1 .

Namespaces

  • global

    Packages