<?php
include_once '../doc-typo3-funcs.php';
$doxygen_vars = array( "title" => "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);
?>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<h1>tx_indexed_search_extparse Class Reference</h1><!-- doxytag: class="tx_indexed_search_extparse" --><a href="classtx__indexed__search__extparse-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#03b11751d3b7c7932c9636099380e22f">initParser</a> ($extension)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#6c7999dfdc13d3188d63085fb7c6c4ea">softInit</a> ($extension)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#b6e93a955bf2f737529d1e615d327712">searchTypeMediaTitle</a> ($extension)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#423bc2a451130a37ac96b89f7eae7605">isMultiplePageExtension</a> ($extension)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#ecd64ada0ac29b1ae5079df31cddaaa1">readFileContent</a> ($ext, $absFile, $cPKey)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#c249a5a5534b0ffb8db0ef31d552c9c6">fileContentParts</a> ($ext, $absFile)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#b410aa49a477e84b1ea78e5287a6a121">splitPdfInfo</a> ($pdfInfoArray)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#89b8bacb2ad8c39422fdc87e8db8e3b6">removeEndJunk</a> ($string)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#72c4e6ebab1832eeb7bcba1c2d59b585">getIcon</a> ($extension)</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="483c9c6b542bda541591959eff79aa7f"></a><!-- doxytag: member="tx_indexed_search_extparse::$pdf_mode" ref="483c9c6b542bda541591959eff79aa7f" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#483c9c6b542bda541591959eff79aa7f">$pdf_mode</a> = -20</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6ccbe78d9365a6ee9f26bb912588f804"></a><!-- doxytag: member="tx_indexed_search_extparse::$app" ref="6ccbe78d9365a6ee9f26bb912588f804" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#6ccbe78d9365a6ee9f26bb912588f804">$app</a> = array()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9f8cfdeeb28969198a9c77cf9b6737db"></a><!-- doxytag: member="tx_indexed_search_extparse::$ext2itemtype_map" ref="9f8cfdeeb28969198a9c77cf9b6737db" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#9f8cfdeeb28969198a9c77cf9b6737db">$ext2itemtype_map</a> = array()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c78b29692431ee5370e92344a5a0ca2d"></a><!-- doxytag: member="tx_indexed_search_extparse::$supportedExtensions" ref="c78b29692431ee5370e92344a5a0ca2d" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#c78b29692431ee5370e92344a5a0ca2d">$supportedExtensions</a> = array()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6d3172574bef5eefdba59078293f546"></a><!-- doxytag: member="tx_indexed_search_extparse::$pObj" ref="a6d3172574bef5eefdba59078293f546" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexed__search__extparse.html#a6d3172574bef5eefdba59078293f546">$pObj</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>
<p>
Definition at line <a class="el" href="class_8external__parser_8php-source.html#l00075">75</a> of file <a class="el" href="class_8external__parser_8php-source.html">class.external_parser.php</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c249a5a5534b0ffb8db0ef31d552c9c6"></a><!-- doxytag: member="tx_indexed_search_extparse::fileContentParts" ref="c249a5a5534b0ffb8db0ef31d552c9c6" args="($ext, $absFile)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">tx_indexed_search_extparse::fileContentParts </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>ext</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>absFile</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
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.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>File extension </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Absolute filename (must exist and be validated OK before calling function) </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>array Array of pointers to sections that the document should be divided into </dd></dl>
<p>
Definition at line <a class="el" href="class_8external__parser_8php-source.html#l00521">521</a> of file <a class="el" href="class_8external__parser_8php-source.html">class.external_parser.php</a>.
<p>
References <a class="el" href="class_8t3lib__div_8php-source.html#l00894">t3lib_div::intInRange()</a>, and <a class="el" href="class_8external__parser_8php-source.html#l00560">splitPdfInfo()</a>. </td>
</tr>
</table>
<a class="anchor" name="72c4e6ebab1832eeb7bcba1c2d59b585"></a><!-- doxytag: member="tx_indexed_search_extparse::getIcon" ref="72c4e6ebab1832eeb7bcba1c2d59b585" args="($extension)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">tx_indexed_search_extparse::getIcon </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>extension</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return icon for file extension<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>File extension, lowercase. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string Relative file reference, resolvable by <a class="el" href="classt3lib__div.html#ad5d27aeabb41e7f5ed6ddaf760de42a">t3lib_div::getFileAbsFileName()</a> </dd></dl>
<p>
Definition at line <a class="el" href="class_8external__parser_8php-source.html#l00606">606</a> of file <a class="el" href="class_8external__parser_8php-source.html">class.external_parser.php</a>. </td>
</tr>
</table>
<a class="anchor" name="03b11751d3b7c7932c9636099380e22f"></a><!-- doxytag: member="tx_indexed_search_extparse::initParser" ref="03b11751d3b7c7932c9636099380e22f" args="($extension)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">tx_indexed_search_extparse::initParser </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>extension</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Initialize external parser for parsing content.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>File extension </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>boolean Returns true if extension is supported/enabled, otherwise false. </dd></dl>
<p>
Definition at line <a class="el" href="class_8external__parser_8php-source.html#l00094">94</a> of file <a class="el" href="class_8external__parser_8php-source.html">class.external_parser.php</a>.
<p>
References <a class="el" href="class_8t3lib__div_8php-source.html#l00894">t3lib_div::intInRange()</a>, and <a class="el" href="incfile_8php-source.html#l00011">t3lib_div::trimExplode()</a>. </td>
</tr>
</table>
<a class="anchor" name="423bc2a451130a37ac96b89f7eae7605"></a><!-- doxytag: member="tx_indexed_search_extparse::isMultiplePageExtension" ref="423bc2a451130a37ac96b89f7eae7605" args="($extension)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">tx_indexed_search_extparse::isMultiplePageExtension </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>extension</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns true if the input extension (item_type) is a potentially a multi-page extension<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Extension / item_type string </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>boolean Return true if multi-page </dd></dl>
<p>
Definition at line <a class="el" href="class_8external__parser_8php-source.html#l00323">323</a> of file <a class="el" href="class_8external__parser_8php-source.html">class.external_parser.php</a>. </td>
</tr>
</table>
<a class="anchor" name="ecd64ada0ac29b1ae5079df31cddaaa1"></a><!-- doxytag: member="tx_indexed_search_extparse::readFileContent" ref="ecd64ada0ac29b1ae5079df31cddaaa1" args="($ext, $absFile, $cPKey)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">tx_indexed_search_extparse::readFileContent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>ext</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>absFile</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>cPKey</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Reads the content of an external file being indexed.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>File extension, eg. "pdf", "doc" etc. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Absolute filename of file (must exist and be validated OK before calling function) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Pointer to section (zero for all other than PDF which will have an indication of pages into which the document should be splitted.) </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>array Standard content array (title, description, keywords, body keys) </dd></dl>
<p>
Definition at line <a class="el" href="class_8external__parser_8php-source.html#l00354">354</a> of file <a class="el" href="class_8external__parser_8php-source.html">class.external_parser.php</a>.
<p>
References <a class="el" href="class_8external__parser_8php-source.html#l00579">removeEndJunk()</a>, <a class="el" href="class_8external__parser_8php-source.html#l00560">splitPdfInfo()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l03463">t3lib_div::tempnam()</a>, and <a class="el" href="class_8t3lib__div_8php-source.html#l01884">t3lib_div::xml2tree()</a>. </td>
</tr>
</table>
<a class="anchor" name="89b8bacb2ad8c39422fdc87e8db8e3b6"></a><!-- doxytag: member="tx_indexed_search_extparse::removeEndJunk" ref="89b8bacb2ad8c39422fdc87e8db8e3b6" args="($string)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">tx_indexed_search_extparse::removeEndJunk </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>string</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Removes some strange char(12) characters and line breaks that then to occur in the end of the string from external files.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>String to clean up </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string String </dd></dl>
<p>
Definition at line <a class="el" href="class_8external__parser_8php-source.html#l00579">579</a> of file <a class="el" href="class_8external__parser_8php-source.html">class.external_parser.php</a>.
<p>
Referenced by <a class="el" href="class_8external__parser_8php-source.html#l00354">readFileContent()</a>. </td>
</tr>
</table>
<a class="anchor" name="b6e93a955bf2f737529d1e615d327712"></a><!-- doxytag: member="tx_indexed_search_extparse::searchTypeMediaTitle" ref="b6e93a955bf2f737529d1e615d327712" args="($extension)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">tx_indexed_search_extparse::searchTypeMediaTitle </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>extension</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return title of entry in media type selector box.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>File extension </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string String with label value of entry in media type search selector box (frontend plugin). </dd></dl>
<p>
Definition at line <a class="el" href="class_8external__parser_8php-source.html#l00247">247</a> of file <a class="el" href="class_8external__parser_8php-source.html">class.external_parser.php</a>.
<p>
References <a class="el" href="incfile_8php-source.html#l00011">t3lib_div::trimExplode()</a>. </td>
</tr>
</table>
<a class="anchor" name="6c7999dfdc13d3188d63085fb7c6c4ea"></a><!-- doxytag: member="tx_indexed_search_extparse::softInit" ref="6c7999dfdc13d3188d63085fb7c6c4ea" args="($extension)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">tx_indexed_search_extparse::softInit </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>extension</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
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<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>File extension to initialize for. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>boolean Returns true if the extension is supported and enabled, otherwise false. </dd></dl>
<p>
Definition at line <a class="el" href="class_8external__parser_8php-source.html#l00214">214</a> of file <a class="el" href="class_8external__parser_8php-source.html">class.external_parser.php</a>. </td>
</tr>
</table>
<a class="anchor" name="b410aa49a477e84b1ea78e5287a6a121"></a><!-- doxytag: member="tx_indexed_search_extparse::splitPdfInfo" ref="b410aa49a477e84b1ea78e5287a6a121" args="($pdfInfoArray)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">tx_indexed_search_extparse::splitPdfInfo </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>pdfInfoArray</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Analysing PDF info into a useable format.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Array of PDF content, coming from the pdfinfo tool </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>array Result array private </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classtx__indexed__search__extparse.html#c249a5a5534b0ffb8db0ef31d552c9c6">fileContentParts()</a> </dd></dl>
<p>
Definition at line <a class="el" href="class_8external__parser_8php-source.html#l00560">560</a> of file <a class="el" href="class_8external__parser_8php-source.html">class.external_parser.php</a>.
<p>
Referenced by <a class="el" href="class_8external__parser_8php-source.html#l00521">fileContentParts()</a>, and <a class="el" href="class_8external__parser_8php-source.html#l00354">readFileContent()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li>typo3_src-4.0.1/typo3/sysext/indexed_search/<a class="el" href="class_8external__parser_8php-source.html">class.external_parser.php</a></ul>
<?php
include_once '../doc-typo3-funcs.php';
get_footer();
?>