Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
SearchFileParser Class Reference
Inheritance diagram for SearchFileParser:
SearchHelperParser SearchHTMLParser

Public Member Functions

 close ()
 
 doRead ()
 
fromFile (&$file)
 
fromFileType ($type, $path)
 
 getFilePath ()
 
 open ()
 
 read ()
 
 SearchFileParser ($filePath)
 
 setFilePath ($filePath)
 

Detailed Description

Abstract class to extract search text from a given file.

Definition at line 21 of file SearchFileParser.inc.php.

Member Function Documentation

SearchFileParser::close ( )

Close the file.

Definition at line 65 of file SearchFileParser.inc.php.

SearchFileParser::doRead ( )

Read from the file pointer.

Returns
string

Definition at line 84 of file SearchFileParser.inc.php.

Referenced by read().

& SearchFileParser::fromFile ( $file)

Create a text parser for a file.

Parameters
$file[Article|Paper]File
Returns
SearchFileParser

Definition at line 98 of file SearchFileParser.inc.php.

References fromFileType().

Referenced by ArticleSearchIndex\articleFileChanged(), and OAIMetadataFormat_NLM\toXml().

& SearchFileParser::fromFileType (   $type,
  $path 
)

Create a text parser for a file.

Parameters
$typestring
$pathstring

Definition at line 108 of file SearchFileParser.inc.php.

References SearchFileParser().

Referenced by fromFile().

SearchFileParser::getFilePath ( )

Return the path to the file.

Returns
string

Definition at line 41 of file SearchFileParser.inc.php.

SearchFileParser::open ( )

Open the file.

Returns
boolean

Definition at line 57 of file SearchFileParser.inc.php.

SearchFileParser::read ( )

Read and return the next block/line of text.

Returns
string (false on EOF)

Definition at line 73 of file SearchFileParser.inc.php.

References doRead().

SearchFileParser::SearchFileParser (   $filePath)

Constructor.

Parameters
$filePathstring

Definition at line 33 of file SearchFileParser.inc.php.

Referenced by fromFileType().

SearchFileParser::setFilePath (   $filePath)

Change the file path.

Parameters
$filePathstring

Definition at line 49 of file SearchFileParser.inc.php.


The documentation for this class was generated from the following file: