SearchFileParser Class Reference
[Search]
Abstract class to extract search text from a given file.
More...
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 23 of file SearchFileParser.inc.php.
Member Function Documentation
| SearchFileParser.close | ( | ) |
Close the file.
Reimplemented in SearchHelperParser.
Definition at line 67 of file SearchFileParser.inc.php.
| SearchFileParser.doRead | ( | ) |
Read from the file pointer.
- Returns:
- string
Reimplemented in SearchHTMLParser.
Definition at line 86 of file SearchFileParser.inc.php.
Referenced by read().
| & SearchFileParser.fromFile | ( | &$ | file | ) |
Create a text parser for an article file.
- Parameters:
-
$file ArticleFile
- Returns:
- SearchFileParser
Definition at line 100 of file SearchFileParser.inc.php.
References fromFileType(), and getFilePath().
Referenced by ArticleSearchIndex.updateFileIndex().
| & SearchFileParser.fromFileType | ( | $ | type, | |
| $ | path | |||
| ) |
Create a text parser for a file.
- Parameters:
-
$type string $path string
Definition at line 110 of file SearchFileParser.inc.php.
References SearchFileParser().
Referenced by fromFile().
| SearchFileParser.getFilePath | ( | ) |
Return the path to the file.
- Returns:
- string
Definition at line 43 of file SearchFileParser.inc.php.
Referenced by fromFile(), and SearchHelperParser.open().
| SearchFileParser.open | ( | ) |
Open the file.
- Returns:
- boolean
Reimplemented in SearchHelperParser.
Definition at line 59 of file SearchFileParser.inc.php.
| SearchFileParser.read | ( | ) |
Read and return the next block/line of text.
- Returns:
- string (false on EOF)
Definition at line 75 of file SearchFileParser.inc.php.
References doRead().
| SearchFileParser.SearchFileParser | ( | $ | filePath | ) |
Constructor.
- Parameters:
-
$filePath string
Definition at line 35 of file SearchFileParser.inc.php.
Referenced by fromFileType().
| SearchFileParser.setFilePath | ( | $ | filePath | ) |
Change the file path.
- Parameters:
-
$filePath string
Definition at line 51 of file SearchFileParser.inc.php.
The documentation for this class was generated from the following file:
- classes/search/SearchFileParser.inc.php
