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

 
 
Import  
No 
No 

Description

Importer Class
This 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

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 =




Import

Properties

 
 
Import  
Yes 
No 

Description

Import Class
This abstract classes provides all the common methods and variables for the custom import classes.

Methods

LDAPimport, __construct, accept, getSource,

LDAPimport( ) : n/a

Return value

Type Description
n/a n/a

__construct(   $server_id, ) : n/a

Arguments

Name Type Description Default
$server_id n/a

Return value

Type Description
n/a n/a

accept( ) : n/a

Return value

Type Description
n/a n/a

getSource(   $attr, ) : n/a

Arguments

Name Type Description Default
$attr n/a

Return value

Type Description
n/a n/a

Properties

$input, $server_id, $source,

  protected  $input = null




  protected  $server_id = null




  protected  $source = array()




ImportLDIF

Properties

 
 
Import  
No 
No 

Description

Import entries from LDIF
The 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

Type Description
n/a n/a

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

Type Description
n/a n/a

getAttrValue(   $line, ) : n/a

Description

Get the Attribute and Decoded Value

Arguments

Name Type Description Default
$line n/a

Return value

Type Description
n/a n/a

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 encoded

Arguments

Name Type Description Default
$value n/a

Return value

Type Description
n/a n/a

getModRDNAttributes(   $lines, ) : n/a

Description

Build the attributes for the entry when the change type is modrdn

Arguments

Name Type Description Default
$lines n/a

Return value

Type Description
n/a n/a

getModifyDetails(   $lines, ) : n/a

Description

Build the attributes array for the entry when the change type is modify

Arguments

Name Type Description Default
$lines n/a

Return value

Type Description
n/a n/a

getServer( ) : n/a

Return value

Type Description
n/a n/a

getTemplate( ) : n/a

Return value

Type Description
n/a n/a

getType( ) : n/a

Return value

Type Description
n/a n/a

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 line

Return value

Type Description
n/a n/a

nextLines( ) : \The

Description

Get the lines of the next entry

Return value

Type Description
\The lines (unfolded) of the next entry

readEntry( ) : n/a

Return value

Type Description
n/a n/a

Properties

$_currentLine, $_currentLineNumber, $error, $template,

  private  $_currentLine = ''




  private  $_currentLineNumber = 0




  public  $error = array()




  private  $template =




Documentation was generated by phpDocumentor 2.0.1 .

Namespaces

  • global

    Packages