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
         
 
      
No 
      
No 
      
 
Description
Exporter ClassThis 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
 
accept(
          
          )
        
        :
        n/a
Return value
 
getTemplate(
          
          )
        
        :
        n/a
Return value
 
types(
          
          )
        
        :
        n/a
Return value
 
 
 
Export
Properties
         
 
      
Yes 
      
No 
      
 
Description
Export ClassThis 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
 
getHeader(
          
          )
        
        :
        n/a
Return value
 
getServer(
          
          )
        
        :
        object
Description
Return this LDAP Server objectReturn value
| Type | Description | 
| object | DataStore Server | 
 
getServerID(
          
          )
        
        :
        int
Description
Return the LDAP server IDReturn value
| Type | Description | 
| int | Server ID | 
 
isCompressed(
          
          )
        
        :
        n/a
Return value
 
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. | 
 
 
 
ExportCSV
Properties
         
 
      
No 
      
No 
      
 
Description
Export entries to CSVThis 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
 
export(
          
          )
        
        :
        n/a
Return value
 
getType(
          
          )
        
        :
        n/a
Return value
 
 
 
ExportDSML
Properties
         
 
      
No 
      
No 
      
 
Description
Export entries to DSML v.1This 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 formatReturn value
 
getType(
          
          )
        
        :
        n/a
Return value
 
 
 
ExportLDIF
Properties
         
 
      
No 
      
No 
      
 
Description
Export from LDAP using an LDIF formatThis 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 formatReturn value
 
getType(
          
          )
        
        :
        n/a
Return value
 
multiLineDisplay(
          
             
            $str,
          
          )
        
        :
        n/a
Description
Helper method to wrap ldif linesArguments
| Name | Type | Description | Default | 
| $str | n/a |  |  | 
Return value
 
 
 
ExportVCARD
Properties
         
 
      
No 
      
No 
      
 
Description
Export entries to VCARD v2.1This 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 formatReturn value
 
getType(
          
          )
        
        :
        n/a
Return value
 
 
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')