Open Journal Systems  3.3.0
SearchHelperParser Class Reference
Inheritance diagram for SearchHelperParser:
SearchFileParser

Public Member Functions

 __construct ($type, $filePath)
 
 close ()
 
 open ()
 
- Public Member Functions inherited from SearchFileParser
 __construct ($filePath)
 
 doRead ()
 
 getFilePath ()
 
 read ()
 
 setFilePath ($filePath)
 

Data Fields

 $type
 
- Data Fields inherited from SearchFileParser
 $filePath
 
 $fp
 

Additional Inherited Members

- Static Public Member Functions inherited from SearchFileParser
static fromFile ($file)
 
static fromFileType ($type, $path)
 

Detailed Description

Class to extract text from a file using an external helper program.

Definition at line 19 of file SearchHelperParser.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SearchHelperParser::__construct (   $type,
  $filePath 
)

Definition at line 27 of file SearchHelperParser.inc.php.

References SearchFileParser\$filePath, and $type.

Member Function Documentation

◆ close()

SearchHelperParser::close ( )

Close the file.

Reimplemented from SearchFileParser.

Definition at line 44 of file SearchHelperParser.inc.php.

◆ open()

SearchHelperParser::open ( )

Open the file.

Returns
boolean

Reimplemented from SearchFileParser.

Definition at line 32 of file SearchHelperParser.inc.php.

References SearchFileParser\getFilePath(), and Config\getVar().

Field Documentation

◆ $type

string SearchHelperParser::$type

Type should match an index[$type] setting in the "search" section of config.inc.php

Definition at line 25 of file SearchHelperParser.inc.php.

Referenced by __construct().


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