Docs For Class FinderIndexerParser

FinderIndexerParser

Description

Parser base class for the Finder indexer package.

abstract:
since: 2.5

Located in /administrator/components/com_finder/helpers/indexer/parser.php (line 19)

Direct descendents

Class	Description
FinderIndexerParserHtml	HTML Parser class for the Finder indexer package.
FinderIndexerParserRtf	RTF Parser class for the Finder indexer package.
FinderIndexerParserTxt	Text Parser class for the Finder indexer package.

Method Summary

static FinderIndexerParser getInstance (string $format)

string parse (string $input)

string process (string $input)

Methods

static getInstance (line 31)

Method to get a parser, creating it if necessary.

return: A FinderIndexerParser instance.
throws: Exception on invalid parser.
since: 2.5
access: public

static FinderIndexerParser getInstance (string $format)

string $format: The type of parser to load.

parse (line 80)

Method to parse input and extract the plain text. Because this method is called from both inside and outside the indexer, it needs to be able to batch out its parsing functionality to deal with the inefficiencies of regular expressions. We will parse recursively in 2KB chunks.

return: The plain text input.
since: 2.5
access: public

string parse (string $input)

string $input: The input to parse.

process (line 131)

Method to process input and extract the plain text.

return: The plain text input.
abstract:
since: 2.5
access: protected

string process (string $input)

string $input: The input to process.

Redefined in descendants as:

FinderIndexerParserHtml::process() : Method to process HTML input and extract the plain text.
FinderIndexerParserRtf::process() : Method to process RTF input and extract the plain text.
FinderIndexerParserTxt::process() : Method to process Text input and extract the plain text.

Documentation generated on Tue, 19 Nov 2013 15:10:18 +0100 by phpDocumentor 1.4.3