"TYPO3 4.0.1: tx_indexed_search_extparse Class Reference", "datetime" => "Sat Dec 2 19:27:11 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

tx_indexed_search_extparse Class Reference

List of all members.

Public Member Functions

 initParser ($extension)
 softInit ($extension)
 searchTypeMediaTitle ($extension)
 isMultiplePageExtension ($extension)
 readFileContent ($ext, $absFile, $cPKey)
 fileContentParts ($ext, $absFile)
 splitPdfInfo ($pdfInfoArray)
 removeEndJunk ($string)
 getIcon ($extension)

Public Attributes

 $pdf_mode = -20
 $app = array()
 $ext2itemtype_map = array()
 $supportedExtensions = array()
 $pObj

Detailed Description

Definition at line 75 of file class.external_parser.php.


Member Function Documentation

tx_indexed_search_extparse::fileContentParts ext,
absFile
 

Creates an array with pointers to divisions of document. ONLY for PDF files at this point. All other types will have an array with a single element with the value "0" (zero) coming back.

Parameters:
string File extension
string Absolute filename (must exist and be validated OK before calling function)
Returns:
array Array of pointers to sections that the document should be divided into

Definition at line 521 of file class.external_parser.php.

References t3lib_div::intInRange(), and splitPdfInfo().

tx_indexed_search_extparse::getIcon extension  ) 
 

Return icon for file extension

Parameters:
string File extension, lowercase.
Returns:
string Relative file reference, resolvable by t3lib_div::getFileAbsFileName()

Definition at line 606 of file class.external_parser.php.

tx_indexed_search_extparse::initParser extension  ) 
 

Initialize external parser for parsing content.

Parameters:
string File extension
Returns:
boolean Returns true if extension is supported/enabled, otherwise false.

Definition at line 94 of file class.external_parser.php.

References t3lib_div::intInRange(), and t3lib_div::trimExplode().

tx_indexed_search_extparse::isMultiplePageExtension extension  ) 
 

Returns true if the input extension (item_type) is a potentially a multi-page extension

Parameters:
string Extension / item_type string
Returns:
boolean Return true if multi-page

Definition at line 323 of file class.external_parser.php.

tx_indexed_search_extparse::readFileContent ext,
absFile,
cPKey
 

Reads the content of an external file being indexed.

Parameters:
string File extension, eg. "pdf", "doc" etc.
string Absolute filename of file (must exist and be validated OK before calling function)
string Pointer to section (zero for all other than PDF which will have an indication of pages into which the document should be splitted.)
Returns:
array Standard content array (title, description, keywords, body keys)

Definition at line 354 of file class.external_parser.php.

References removeEndJunk(), splitPdfInfo(), t3lib_div::tempnam(), and t3lib_div::xml2tree().

tx_indexed_search_extparse::removeEndJunk string  ) 
 

Removes some strange char(12) characters and line breaks that then to occur in the end of the string from external files.

Parameters:
string String to clean up
Returns:
string String

Definition at line 579 of file class.external_parser.php.

Referenced by readFileContent().

tx_indexed_search_extparse::searchTypeMediaTitle extension  ) 
 

Return title of entry in media type selector box.

Parameters:
string File extension
Returns:
string String with label value of entry in media type search selector box (frontend plugin).

Definition at line 247 of file class.external_parser.php.

References t3lib_div::trimExplode().

tx_indexed_search_extparse::softInit extension  ) 
 

Initialize external parser for backend modules Doesn't evaluate if parser is configured right - more like returning POSSIBLE supported extensions (for showing icons etc) in backend and frontend plugin

Parameters:
string File extension to initialize for.
Returns:
boolean Returns true if the extension is supported and enabled, otherwise false.

Definition at line 214 of file class.external_parser.php.

tx_indexed_search_extparse::splitPdfInfo pdfInfoArray  ) 
 

Analysing PDF info into a useable format.

Parameters:
array Array of PDF content, coming from the pdfinfo tool
Returns:
array Result array private
See also:
fileContentParts()

Definition at line 560 of file class.external_parser.php.

Referenced by fileContentParts(), and readFileContent().


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