templates/3rdParty/pla/lib/import_functions.php
Properties
 
Description
Classes and functions for importing data to LDAP
These classes provide differnet import formats.
Classes
Importer
Properties
         
 
      
No 
      
No 
      
 
Description
Importer ClassThis class serves as a top level importer class, which will return
the correct Import 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
 
 
 
Import
Properties
         
 
      
Yes 
      
No 
      
 
Description
Import ClassThis abstract classes provides all the common methods and variables for the
custom import classes.
Methods
LDAPimport,
      
__construct,
      
accept,
      
getSource,
      
LDAPimport(
          
          )
        
        :
        n/a
Return value
 
__construct(
          
             
            $server_id,
          
          )
        
        :
        n/a
Arguments
| Name | Type | Description | Default | 
| $server_id | n/a |  |  | 
Return value
 
accept(
          
          )
        
        :
        n/a
Return value
 
getSource(
          
             
            $attr,
          
          )
        
        :
        n/a
Arguments
| Name | Type | Description | Default | 
| $attr | n/a |  |  | 
Return value
 
 
 
ImportLDIF
Properties
         
 
      
No 
      
No 
      
 
Description
Import entries from LDIFThe LDIF spec is described by RFC2849
http://www.ietf.org/rfc/rfc2849.txt
Methods
eof,
      
error,
      
getAddDetails,
      
getAttrValue,
      
getAttributeValue,
      
getModRDNAttributes,
      
getModifyDetails,
      
getServer,
      
getTemplate,
      
getType,
      
hasMoreEntries,
      
isBlankLine,
      
isCommentLine,
      
isWrappedLine,
      
nextLine,
      
nextLines,
      
readEntry,
      
eof(
          
          )
        
        :
        boolean
Description
Returns true if we reached the end of the input.Return value
| Type | Description | 
| boolean | true if it's the end of file, false otherwise. | 
 
error(
          
             
            $msg,
          
             
            $data,
          
          )
        
        :
        n/a
Arguments
| Name | Type | Description | Default | 
| $msg | n/a |  |  | 
| $data | n/a |  |  | 
Return value
 
getAddDetails(
          
             
            $lines,
          
          )
        
        :
        n/a
Description
Build the attributes array when the change type is add.Arguments
| Name | Type | Description | Default | 
| $lines | n/a |  |  | 
Return value
 
getAttrValue(
          
             
            $line,
          
          )
        
        :
        n/a
Description
Get the Attribute and Decoded ValueArguments
| Name | Type | Description | Default | 
| $line | n/a |  |  | 
Return value
 
getAttributeValue(
          
             
            $value,
          
          )
        
        :
        n/a
Description
Method to retrieve the attribute value of a ldif line,
and get the base 64 decoded value if it is encodedArguments
| Name | Type | Description | Default | 
| $value | n/a |  |  | 
Return value
 
getModRDNAttributes(
          
             
            $lines,
          
          )
        
        :
        n/a
Description
Build the attributes for the entry when the change type is modrdnArguments
| Name | Type | Description | Default | 
| $lines | n/a |  |  | 
Return value
 
getModifyDetails(
          
             
            $lines,
          
          )
        
        :
        n/a
Description
Build the attributes array for the entry when the change type is modifyArguments
| Name | Type | Description | Default | 
| $lines | n/a |  |  | 
Return value
 
getServer(
          
          )
        
        :
        n/a
Return value
 
getTemplate(
          
          )
        
        :
        n/a
Return value
 
getType(
          
          )
        
        :
        n/a
Return value
 
hasMoreEntries(
          
          )
        
        :
        boolean
Description
Private method to check if there is more entries in the input.Return value
| Type | Description | 
| boolean | true if an entry was found, false otherwise. | 
 
isBlankLine(
          
          )
        
        :
        boolean
Description
Check if is the current line is a blank line.Return value
| Type | Description | 
| boolean | if it is a blank line,false otherwise. | 
 
isCommentLine(
          
          )
        
        :
        boolean
Description
Check if it's a comment line.Return value
| Type | Description | 
| boolean | true if it's a comment line,false otherwise | 
 
isWrappedLine(
          
          )
        
        :
        boolean
Description
Check if it's a wrapped line.Return value
| Type | Description | 
| boolean | true if it's a wrapped line,false otherwise | 
 
nextLine(
          
          )
        
        :
        n/a
Description
Helper method to switch to the next lineReturn value
 
nextLines(
          
          )
        
        :
        \The
Description
Get the lines of the next entryReturn value
| Type | Description | 
| \The | lines (unfolded) of the next entry | 
 
readEntry(
          
          )
        
        :
        n/a
Return value