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

Class: FileReader

Source Location: /lib/ldif_functions.php

Class Overview

Reader
   |
   --FileReader

Helper base class to read file.


Methods


Child classes:

LdifReader
Main parser of the ldif file

Inherited Methods

Class: Reader

Reader::fetchEntryArray()
Return the current entry as an array
Reader::fetchEntryObject()
Return the current entry as an object
Reader::fetchEntryRaw()
Return the entry as it is.
Reader::getCurrentLines()
Returns the lines that generated the Ldif Entry.
Reader::getLdapLdifReaderException()
Return the exception raised during processing the file
Reader::getWarningMessage()
Reader::hasRaisedException()
Reader::hasVersionNumber()
Check if the ldif version is present in the ldif
Reader::nextLines()
Get the lines of the next entry
Reader::readEntry()
Return a ldif entry object
Reader::setLdapLdifReaderException()
Associate the ldif reader with a exception which occurs during proceesing the file.
Reader::_hasMoreEntries()
Private method to check if there is more entries in the file
Reader::_isBlankLine()
Check if is the current line is a blank line.
Reader::_isCommentLine()
Check if it's a ldif comment line.
Reader::_isDnLine()
Check if the current line is a line containing the distinguished name of an entry.
Reader::_ldifHasError()
Helper method which return the value of the instance member $_error
Reader::_LdifReader()
Private constructor of the LDIFReader class.

Class Details

[line 856]
Helper base class to read file.



[ Top ]


Class Methods


constructor FileReader [line 864]

FileReader FileReader( $path2File $path2File)

Constructor of the FileReader class



Parameters:

$path2File   $path2File  

[ Top ]

method close [line 895]

void close( )

Close the handler



[ Top ]

method eof [line 873]

bool eof( )

Returns true if we reached the end of the file.



Tags:

return:  true if it's the end of file, false otherwise.


[ Top ]

method _nextLine [line 880]

void _nextLine( )

Helper method to switch to the next line



[ Top ]


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