phpLDAPadmin
[ class tree: phpLDAPadmin ] [ index: phpLDAPadmin ] [ all elements ]

Class: LdifEntryReader

Source Location: /lib/ldif_functions.php

Class Overview


Class in charge of reading a paricular entry


Methods



Class Details

[line 126]
Class in charge of reading a paricular entry



[ Top ]


Class Methods


constructor LdifEntryReader [line 147]

LdifEntryReader LdifEntryReader( String[] $lines)

Constructor of the LdifEntryReader



Parameters:

String[]   $lines   the line of the entry

[ Top ]

method getEntry [line 234]

LdifEntry getEntry( )

Return the entry read from the ldif lines



Tags:

return:  the entry


[ Top ]

method getLdifEntryReaderException [line 294]

Ldap_LdifEntryReaderException getLdifEntryReaderException( )

Return the exception handler of the entry Reader



Tags:

return:  the exception associate with the exception wich occur during parsing the file.


[ Top ]

method hasRaisedException [line 273]

bool hasRaisedException( )

Checked if the parsing of the entry has raised some exception



Tags:

return:  true if the reading of the entry raised some exceptions, else otherwise.


[ Top ]

method isValidDn [line 225]

boolean isValidDn( )

Check if the dn line is valid



Tags:

return:  true if the dn is valid, false otherwise.


[ Top ]

method readLines [line 149]

void readLines( &$lines)



Parameters:

   &$lines  

[ Top ]

method setLdifEntryReaderException [line 283]

void setLdifEntryReaderException( Ldap_ldifEntryReaderException $ldifEntryReaderException)

Set the exception handler for the entry reader



Parameters:

Ldap_ldifEntryReaderException   $ldifEntryReaderException   the exception handler associate with the parsing error.

[ Top ]

method _getAddAttributes [line 347]

void _getAddAttributes( )

Build the attributes array when the change type is add.



[ Top ]

method _getAttributeValue [line 302]

void _getAttributeValue( $attributeValuePart)

Method to retrieve the attribute value of a ldif line,

and get the base 64 decoded value if it is encoded




Parameters:

   $attributeValuePart  

[ Top ]

method _getBase64DecodedValue [line 196]

String _getBase64DecodedValue( $attr $attr)

Return the base64 decoded value of an attribute



Tags:

return:  base64 decoded value of an attribute


Parameters:

$attr   $attr   the attribute to be decoded

[ Top ]

method _getDnValue [line 206]

the _getDnValue( String $currentDnLine)

Fetch the dn value from a line of the ldif file



Tags:

return:  value of the distinguished name


Parameters:

String   $currentDnLine   line with a distinguished name

[ Top ]

method _getModifyAttributes [line 385]

void _getModifyAttributes( )

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



[ Top ]

method _getModrdnAttributes [line 473]

void _getModrdnAttributes( )

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



[ Top ]

method _isDnBase64Encoded [line 186]

boolean _isDnBase64Encoded( $dn)

Check if the distinguished name is base 64 encoded



Tags:

return:  true if the dn is base 64 encoded, false otherwise


Parameters:

   $dn  

[ Top ]

method _readChangeType [line 160]

String _readChangeType( )

Read the change type action associated with the entry



Tags:

return:  the change type action of the entry


[ Top ]


Documentation generated on Sun, 30 Dec 2007 17:50:17 -0800 by phpDocumentor 1.3.1