phpLDAPadmin
[ class tree: phpLDAPadmin ] [ index: phpLDAPadmin ] [ all elements ]
Packages:
default
horde-cipher
lam
PHPLayersMenu
phpLDAPadmin


Files:
add_attr.php
add_attr_form.php
add_oclass.php
add_oclass_form.php
add_value.php
add_value_form.php
AJAXTree.php
Attribute.php
AttributeFactory.php
BinaryAttribute.php
cmd.php
collapse.php
common.php
common.php
compare.php
compare_form.php
config_default.php
copy.php
copy_form.php
create.php
DateAttribute.php
DefaultCreatingEntry.php
DefaultEditingEntry.php
DefaultEntryFactory.php
delete.php
delete_attr.php
delete_form.php
DnAttribute.php
download_binary_attr.php
draw_tree_node.php
Entry.php
EntryFactory.php
EntryReader.php
EntryWriter.php
EntryWriter1.php
EntryWriter2.php
entry_chooser.php
expand.php
export.php
export_form.php
export_functions.php
functions.php
GidAttribute.php
header.php
hooks.php
HTMLTree.php
index.php
index.php
index.php
JpegAttribute.php
ldif_functions.php
ldif_import.php
ldif_import_form.php
login.php
login_form.php
logout.php
mass_delete.php
modify_member_form.php
MultiLineAttribute.php
ObjectClassAttribute.php
page.php
PasswordAttribute.php
password_checker.php
PLMTree.php
purge_cache.php
RandomPasswordAttribute.php
rdelete.php
refresh.php
rename.php
rename_form.php
SambaPasswordAttribute.php
schema.php
schema_functions.php
search.php
search_form_advanced.php
search_form_predefined.php
search_form_simple.php
search_results_list.php
search_results_table.php
SelectionAttribute.php
server_functions.php
server_info.php
session_functions.php
ShadowAttribute.php
show_cache.php
syslog.php
TemplateCreatingEntry.php
TemplateEditingEntry.php
TemplateEntryFactory.php
template_engine.php
template_functions.php
timeout.php
timeout_functions.php
Tree.php
unit_test.php
update.php
update_confirm.php
view_jpeg_photo.php
Visitor.php
welcome.php

Classes:
AJAXTree
Attribute
AttributeFactory
AttributeType
BinaryAttribute
block
Config
DateAttribute
DefaultCreatingEntry
DefaultEditingEntry
DefaultEntryFactory
DnAttribute
Entry
EntryFactory
EntryReader
EntryWriter
EntryWriter1
EntryWriter2
FileReader
GidAttribute
HTMLTree
JpegAttribute
LdapExportInfo
LDAPserver
LDAPservers
LdapWriter
LdifEntry
LdifEntryReader
LdifEntryReaderException
LdifReader
LdifReaderException
LdifReaderStdIn
MatchingRule
MatchingRuleUse
MultiLineAttribute
MyCustomExporter
ObjectClass
ObjectClassAttribute
ObjectClass_ObjectClassAttribute
page
PasswordAttribute
PlaAbstractExporter
PlaCSVExporter
PlaDsmlExporter
PlaExporter
PlaLdapExporter
PlaLdifExporter
PlaVcardExporter
PLMTree
RandomPasswordAttribute
Reader
SambaPasswordAttribute
SchemaItem
SelectionAttribute
ShadowAttribute
Syntax
TemplateCreatingEntry
TemplateEditingEntry
TemplateEntryFactory
Templates
Tree
Visitor
xml2array

Class: Reader

Source Location: /lib/ldif_functions.php

Class Overview




Helper base class to read file.









        






Methods















Child classes:






FileReader

	
Helper base class to read file.






LdifReaderStdIn

	
Helper base class to read file.

















Class Details



[line 573]

Helper base class to read file.





[ Top ]








Class Methods




  

	
	
method fetchEntryArray [line 700]

	

    

    

		void fetchEntryArray(
)
    

    


	
		Return the current entry as an array





	
        
[ Top ]

  

  

	
	
method fetchEntryObject [line 692]

	

    

    

		Ldap_Ldif_entry fetchEntryObject(
)
    

    


	
		Return the current entry as an object





Tags:





  

    return:  the current ldif entry
  









	
        
[ Top ]

  

  

	
	
method fetchEntryRaw [line 707]

	

    

    

		String[] fetchEntryRaw(
)
    

    


	
		Return the entry as it is.





Tags:





  

    return:  The lines from the entry.
  









	
        
[ Top ]

  

  

	
	
method getCurrentLines [line 664]

	

    

    

		String[] getCurrentLines(
)
    

    


	
		Returns the lines that generated the Ldif Entry.





Tags:





  

    return:  The lines from the entry.
  









	
        
[ Top ]

  

  

	
	
method getLdapLdifReaderException [line 804]

	

    

    

		Ldap_ldifReaderException getLdapLdifReaderException(
)
    

    


	
		Return the exception raised during processing the file





	
        
[ Top ]

  

  

	
	
method getWarningMessage [line 629]

	

    

    

		void getWarningMessage(
)
    

    


	
		



	
        
[ Top ]

  

  

	
	
method hasRaisedException [line 818]

	

    

    

		void hasRaisedException(
)
    

    


	
		



	
        
[ Top ]

  

  

	
	
method hasVersionNumber [line 603]

	

    

    

		true hasVersionNumber(
)
    

    


	
		Check if the ldif version is present in the ldif





Tags:





  

    return:  if a version line was found,false otherwise
  









	
        
[ Top ]

  

  

	
	
method nextLines [line 716]

	

    

    

		String[] nextLines(
)
    

    


	
		Get the lines of the next entry





Tags:





  

    return:  the lines (unfolded) of the next entry
  









	
        
[ Top ]

  

  

	
	
method readEntry [line 827]

	

    

    

		LdifEntry readEntry(
)
    

    


	
		Return a ldif entry object





Tags:





  

    return:  the entry object buid from the lines of the ldif file
  









	
        
[ Top ]

  

  

	
	
method setLdapLdifReaderException [line 790]

	

    

    

		void setLdapLdifReaderException(
Ldap_LdifReaderException
$ldifReaderException)
    

    


	
		Associate the ldif reader with a exception which occurs during  proceesing the file.

Easier to do exception if we had to switch to php5





	
        
Parameters:

    

    

          

        Ldap_LdifReaderException  
        $ldifReaderException  
        
      

        

    


        
[ Top ]

  

  

	
	
method _hasMoreEntries [line 765]

	

    

    

		boolean _hasMoreEntries(
)
    

    


	
		Private method to check if there is more entries in the file





Tags:





  

    return:  true if an entry was found, false otherwise.
  









	
        
[ Top ]

  

  

	
	
method _isBlankLine [line 638]

	

    

    

		bool _isBlankLine(
)
    

    


	
		Check if is the current line is a blank line.





Tags:





  

    return:  if it is a blank line,false otherwise.
  









	
        
[ Top ]

  

  

	
	
method _isCommentLine [line 673]

	

    

    

		bool _isCommentLine(
)
    

    


	
		Check if it's a ldif comment line.





Tags:





  

    return:  true if it's a comment line,false otherwise
  









	
        
[ Top ]

  

  

	
	
method _isDnLine [line 683]

	

    

    

		bool _isDnLine(
)
    

    


	
		Check if the current line is a line containing the distinguished  name of an entry.





Tags:





  

    return:  true if the line contains a dn line, false otherwise.
  









	
        
[ Top ]

  

  

	
	
method _ldifHasError [line 814]

	

    

    

		true _ldifHasError(
)
    

    


	
		Helper method which return the value  of the instance member $_error





Tags:





  

    return:  if an error was encountered, false otherwise
  









	
        
[ Top ]

  

  

	
	
method _LdifReader [line 648]

	

    

    

		void _LdifReader(
)
    

    


	
		Private constructor of the LDIFReader class.

Marked as private as we need to instantiate the class  by using other constructor with parameters  Use to initialize instance members.





	
        
[ Top ]

  






        

		    

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