<?php include_once '../doc-typo3-funcs.php'; $doxygen_vars = array( "title" => "TYPO3 4.0.1: tx_indexedsearch_crawler Class Reference", "datetime" => "Sat Dec 2 19:27:13 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_indexedsearch_crawler Class Reference</h1><!-- doxytag: class="tx_indexedsearch_crawler" --><a href="classtx__indexedsearch__crawler-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__indexedsearch__crawler.html#57e9cd720061a984f764c90765cef90a">crawler_init</a> (&$pObj)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#c966adda9b46805b70b38ec6baa4e21b">crawler_execute</a> ($params, &$pObj)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#3215be741b8bd41b72bde3e88b27a026">crawler_execute_type1</a> ($cfgRec, &$session_data, $params, &$pObj)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#77dc5642c9c39808d88036194aef0251">crawler_execute_type2</a> ($cfgRec, &$session_data, $params, &$pObj)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#263362bc0a355f64c8fa2e7596e93d68">crawler_execute_type3</a> ($cfgRec, &$session_data, $params, &$pObj)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#c79a66d98f2dcc54aa28daaa0cba7c52">crawler_execute_type4</a> ($cfgRec, &$session_data, $params, &$pObj)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#1e642fccab680ef183c01e9b673ac0cf">cleanUpOldRunningConfigurations</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#f3377f94a99939a539a5c8a7fb0d40c7">checkUrl</a> ($url, $urlLog, $baseUrl)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#c70e049a191fb76fe4538b8b38976a58">indexExtUrl</a> ($url, $pageId, $rl, $cfgUid, $setId)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#e82b316daaa8120b425e4b12981047e9">indexSingleRecord</a> ($r, $cfgRec, $rl=NULL)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#4a681b26dd04d22c6a323025dbbaef2d">loadIndexerClass</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#1a47398a34d9ea7434185dc178ae2b00">getUidRootLineForClosestTemplate</a> ($id)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#c132bd12ba9e935fa69b1d9ba98a47bd">generateNextIndexingTime</a> ($cfgRec)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#550206fd30f54f9dad59e60b4b768759">checkDeniedSuburls</a> ($url, $url_deny)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#8b3eedf5852bb64cb80c1e5db2c9bb5b">addQueueEntryForHook</a> ($cfgRec, $title)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#492b9bd895ffce741e30cb9eee579023">processDatamap_afterDatabaseOperations</a> ($status, $table, $id, $fieldArray, &$pObj)</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="1151dca03a277d44f98e6226b19f0ba9"></a><!-- doxytag: member="tx_indexedsearch_crawler::$secondsPerExternalUrl" ref="1151dca03a277d44f98e6226b19f0ba9" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#1151dca03a277d44f98e6226b19f0ba9">$secondsPerExternalUrl</a> = 3</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71fc3dae0c72e6972232722bddb439de"></a><!-- doxytag: member="tx_indexedsearch_crawler::$instanceCounter" ref="71fc3dae0c72e6972232722bddb439de" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#71fc3dae0c72e6972232722bddb439de">$instanceCounter</a> = 0</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7e0c990a06f076b286db24c326f7366"></a><!-- doxytag: member="tx_indexedsearch_crawler::$callBack" ref="a7e0c990a06f076b286db24c326f7366" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawler.html#a7e0c990a06f076b286db24c326f7366">$callBack</a> = 'EXT:indexed_search/class.crawler.php:&<a class="el" href="classtx__indexedsearch__crawler.html">tx_indexedsearch_crawler</a>'</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <p> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00087">87</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>.<hr><h2>Member Function Documentation</h2> <a class="anchor" name="8b3eedf5852bb64cb80c1e5db2c9bb5b"></a><!-- doxytag: member="tx_indexedsearch_crawler::addQueueEntryForHook" ref="8b3eedf5852bb64cb80c1e5db2c9bb5b" args="($cfgRec, $title)" --><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_indexedsearch_crawler::addQueueEntryForHook </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>cfgRec</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>title</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> Adding entry in queue for Hook<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>Configuration record </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Title/URL </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00798">798</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. </td> </tr> </table> <a class="anchor" name="550206fd30f54f9dad59e60b4b768759"></a><!-- doxytag: member="tx_indexedsearch_crawler::checkDeniedSuburls" ref="550206fd30f54f9dad59e60b4b768759" args="($url, $url_deny)" --><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_indexedsearch_crawler::checkDeniedSuburls </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>url</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>url_deny</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> Checks if $url has any of the URls in the $url_deny "list" in it and if so, returns true.<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>URL to test </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>String where URLs are separated by line-breaks; If any of these strings is the first part of $url, the function returns TRUE (to indicate denial of decend) </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>boolean TRUE if there is a matching URL (hence, do not index!) </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00778">778</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8t3lib__div_8php-source.html#l01132">t3lib_div::isFirstPartOfStr()</a>, and <a class="el" href="incfile_8php-source.html#l00011">t3lib_div::trimExplode()</a>. <p> Referenced by <a class="el" href="class_8crawler_8php-source.html#l00414">crawler_execute_type3()</a>. </td> </tr> </table> <a class="anchor" name="f3377f94a99939a539a5c8a7fb0d40c7"></a><!-- doxytag: member="tx_indexedsearch_crawler::checkUrl" ref="f3377f94a99939a539a5c8a7fb0d40c7" args="($url, $urlLog, $baseUrl)" --><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_indexedsearch_crawler::checkUrl </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>url</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>urlLog</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>baseUrl</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> Check if an input URL are allowed to be indexed. Depends on whether it is already present in the url log.<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>URL string to check </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Array of already indexed URLs (input url is looked up here and must not exist already) </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Base URL of the indexing process (input URL must be "inside" the base URL!) </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string Returls the URL if OK, otherwise false </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00579">579</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8t3lib__div_8php-source.html#l01132">t3lib_div::isFirstPartOfStr()</a>. <p> Referenced by <a class="el" href="class_8crawler_8php-source.html#l00414">crawler_execute_type3()</a>. </td> </tr> </table> <a class="anchor" name="1e642fccab680ef183c01e9b673ac0cf"></a><!-- doxytag: member="tx_indexedsearch_crawler::cleanUpOldRunningConfigurations" ref="1e642fccab680ef183c01e9b673ac0cf" args="()" --><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_indexedsearch_crawler::cleanUpOldRunningConfigurations </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </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> Look up all old index configurations which are finished and needs to be reset and done<p> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00513">513</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8t3lib__befunc_8php-source.html#l00204">t3lib_BEfunc::deleteClause()</a>. <p> Referenced by <a class="el" href="class_8crawler_8php-source.html#l00106">crawler_init()</a>. </td> </tr> </table> <a class="anchor" name="c966adda9b46805b70b38ec6baa4e21b"></a><!-- doxytag: member="tx_indexedsearch_crawler::crawler_execute" ref="c966adda9b46805b70b38ec6baa4e21b" args="($params, &$pObj)" --><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_indexedsearch_crawler::crawler_execute </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>params</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>pObj</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> Call back function for execution of a log element<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>Params from log element. Must contain $params['indexConfigUid'] </td></tr> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>Parent object (tx_crawler lib) </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>array Result array </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00219">219</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8crawler_8php-source.html#l00285">crawler_execute_type1()</a>, <a class="el" href="class_8crawler_8php-source.html#l00345">crawler_execute_type2()</a>, <a class="el" href="class_8crawler_8php-source.html#l00414">crawler_execute_type3()</a>, <a class="el" href="class_8crawler_8php-source.html#l00458">crawler_execute_type4()</a>, and <a class="el" href="class_8t3lib__div_8php-source.html#l03926">t3lib_div::getUserObj()</a>. </td> </tr> </table> <a class="anchor" name="3215be741b8bd41b72bde3e88b27a026"></a><!-- doxytag: member="tx_indexedsearch_crawler::crawler_execute_type1" ref="3215be741b8bd41b72bde3e88b27a026" args="($cfgRec, &$session_data, $params, &$pObj)" --><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_indexedsearch_crawler::crawler_execute_type1 </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>cfgRec</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>session_data</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>params</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>pObj</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> Indexing records from a table<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>Indexing Configuration Record </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Session data for the indexing session spread over multiple instances of the script. Passed by reference so changes hereto will be saved for the next call! </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Parameters from the log queue. </td></tr> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>Parent object (from "crawler" extension!) </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00285">285</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8t3lib__befunc_8php-source.html#l00204">t3lib_BEfunc::deleteClause()</a>, <a class="el" href="class_8crawler_8php-source.html#l00706">getUidRootLineForClosestTemplate()</a>, <a class="el" href="class_8crawler_8php-source.html#l00645">indexSingleRecord()</a>, and <a class="el" href="class_8t3lib__div_8php-source.html#l00894">t3lib_div::intInRange()</a>. <p> Referenced by <a class="el" href="class_8crawler_8php-source.html#l00219">crawler_execute()</a>. </td> </tr> </table> <a class="anchor" name="77dc5642c9c39808d88036194aef0251"></a><!-- doxytag: member="tx_indexedsearch_crawler::crawler_execute_type2" ref="77dc5642c9c39808d88036194aef0251" args="($cfgRec, &$session_data, $params, &$pObj)" --><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_indexedsearch_crawler::crawler_execute_type2 </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>cfgRec</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>session_data</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>params</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>pObj</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> Indexing files from fileadmin<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>Indexing Configuration Record </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Session data for the indexing session spread over multiple instances of the script. Passed by reference so changes hereto will be saved for the next call! </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Parameters from the log queue. </td></tr> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>Parent object (from "crawler" extension!) </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00345">345</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8t3lib__div_8php-source.html#l02535">t3lib_div::get_dirs()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l02614">t3lib_div::getAllFilesAndFoldersInPath()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l03310">t3lib_div::getFileAbsFileName()</a>, <a class="el" href="class_8crawler_8php-source.html#l00706">getUidRootLineForClosestTemplate()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l03357">t3lib_div::isAbsPath()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l03368">t3lib_div::isAllowedAbsPath()</a>, <a class="el" href="class_8crawler_8php-source.html#l00694">loadIndexerClass()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l03984">t3lib_div::makeInstance()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l02637">t3lib_div::removePrefixPathFromList()</a>, and <a class="el" href="incfile_8php-source.html#l00011">t3lib_div::trimExplode()</a>. <p> Referenced by <a class="el" href="class_8crawler_8php-source.html#l00219">crawler_execute()</a>. </td> </tr> </table> <a class="anchor" name="263362bc0a355f64c8fa2e7596e93d68"></a><!-- doxytag: member="tx_indexedsearch_crawler::crawler_execute_type3" ref="263362bc0a355f64c8fa2e7596e93d68" args="($cfgRec, &$session_data, $params, &$pObj)" --><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_indexedsearch_crawler::crawler_execute_type3 </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>cfgRec</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>session_data</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>params</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>pObj</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> Indexing External URLs<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>Indexing Configuration Record </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Session data for the indexing session spread over multiple instances of the script. Passed by reference so changes hereto will be saved for the next call! </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Parameters from the log queue. </td></tr> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>Parent object (from "crawler" extension!) </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00414">414</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8crawler_8php-source.html#l00778">checkDeniedSuburls()</a>, <a class="el" href="class_8crawler_8php-source.html#l00579">checkUrl()</a>, <a class="el" href="class_8crawler_8php-source.html#l00706">getUidRootLineForClosestTemplate()</a>, and <a class="el" href="class_8crawler_8php-source.html#l00602">indexExtUrl()</a>. <p> Referenced by <a class="el" href="class_8crawler_8php-source.html#l00219">crawler_execute()</a>. </td> </tr> </table> <a class="anchor" name="c79a66d98f2dcc54aa28daaa0cba7c52"></a><!-- doxytag: member="tx_indexedsearch_crawler::crawler_execute_type4" ref="c79a66d98f2dcc54aa28daaa0cba7c52" args="($cfgRec, &$session_data, $params, &$pObj)" --><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_indexedsearch_crawler::crawler_execute_type4 </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>cfgRec</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>session_data</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>params</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>pObj</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> Page tree indexing type<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>Indexing Configuration Record </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Session data for the indexing session spread over multiple instances of the script. Passed by reference so changes hereto will be saved for the next call! </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Parameters from the log queue. </td></tr> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>Parent object (from "crawler" extension!) </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00458">458</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8t3lib__befunc_8php-source.html#l00204">t3lib_BEfunc::deleteClause()</a>, and <a class="el" href="class_8t3lib__befunc_8php-source.html#l00227">t3lib_BEfunc::getRecord()</a>. <p> Referenced by <a class="el" href="class_8crawler_8php-source.html#l00219">crawler_execute()</a>. </td> </tr> </table> <a class="anchor" name="57e9cd720061a984f764c90765cef90a"></a><!-- doxytag: member="tx_indexedsearch_crawler::crawler_init" ref="57e9cd720061a984f764c90765cef90a" args="(&$pObj)" --><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_indexedsearch_crawler::crawler_init </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">&$ </td> <td class="mdname1" valign="top" nowrap> <em>pObj</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> Initialization of crawler hook. This function is asked for each instance of the crawler and we must check if something is timed to happen and if so put entry(s) in the crawlers log to start processing. In reality we select indexing configurations and evaluate if any of them needs to run.<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>object</em> </td><td>Parent object (tx_crawler lib) </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00106">106</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8crawler_8php-source.html#l00513">cleanUpOldRunningConfigurations()</a>, <a class="el" href="class_8t3lib__befunc_8php-source.html#l00204">t3lib_BEfunc::deleteClause()</a>, <a class="el" href="class_8crawler_8php-source.html#l00739">generateNextIndexingTime()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l03926">t3lib_div::getUserObj()</a>, and <a class="el" href="class_8t3lib__div_8php-source.html#l00954">t3lib_div::md5int()</a>. </td> </tr> </table> <a class="anchor" name="c132bd12ba9e935fa69b1d9ba98a47bd"></a><!-- doxytag: member="tx_indexedsearch_crawler::generateNextIndexingTime" ref="c132bd12ba9e935fa69b1d9ba98a47bd" args="($cfgRec)" --><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_indexedsearch_crawler::generateNextIndexingTime </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname1" valign="top" nowrap> <em>cfgRec</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> Generate the unix time stamp for next visit.<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>Index configuration record </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>integer The next time stamp </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00739">739</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8t3lib__div_8php-source.html#l00894">t3lib_div::intInRange()</a>. <p> Referenced by <a class="el" href="class_8crawler_8php-source.html#l00106">crawler_init()</a>. </td> </tr> </table> <a class="anchor" name="1a47398a34d9ea7434185dc178ae2b00"></a><!-- doxytag: member="tx_indexedsearch_crawler::getUidRootLineForClosestTemplate" ref="1a47398a34d9ea7434185dc178ae2b00" args="($id)" --><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_indexedsearch_crawler::getUidRootLineForClosestTemplate </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname1" valign="top" nowrap> <em>id</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> Get rootline for closest TypoScript template root. Algorithm same as used in Web > Template, Object browser<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>integer</em> </td><td>The page id to traverse rootline back from </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>array Array where the root lines uid values are found. </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00706">706</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8t3lib__div_8php-source.html#l03984">t3lib_div::makeInstance()</a>. <p> Referenced by <a class="el" href="class_8crawler_8php-source.html#l00285">crawler_execute_type1()</a>, <a class="el" href="class_8crawler_8php-source.html#l00345">crawler_execute_type2()</a>, <a class="el" href="class_8crawler_8php-source.html#l00414">crawler_execute_type3()</a>, and <a class="el" href="class_8crawler_8php-source.html#l00645">indexSingleRecord()</a>. </td> </tr> </table> <a class="anchor" name="c70e049a191fb76fe4538b8b38976a58"></a><!-- doxytag: member="tx_indexedsearch_crawler::indexExtUrl" ref="c70e049a191fb76fe4538b8b38976a58" args="($url, $pageId, $rl, $cfgUid, $setId)" --><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_indexedsearch_crawler::indexExtUrl </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>url</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>pageId</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>rl</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>cfgUid</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>setId</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> Indexing External URL<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>URL, <a href="http://....">http://....</a> </td></tr> <tr><td valign="top"></td><td valign="top"><em>integer</em> </td><td>Page id to relate indexing to. </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Rootline array to relate indexing to </td></tr> <tr><td valign="top"></td><td valign="top"><em>integer</em> </td><td>Configuration UID </td></tr> <tr><td valign="top"></td><td valign="top"><em>integer</em> </td><td>Set ID value </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>array URLs found on this page </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00602">602</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8t3lib__div_8php-source.html#l01286">t3lib_div::htmlspecialchars_decode()</a>, <a class="el" href="class_8crawler_8php-source.html#l00694">loadIndexerClass()</a>, and <a class="el" href="class_8t3lib__div_8php-source.html#l03984">t3lib_div::makeInstance()</a>. <p> Referenced by <a class="el" href="class_8crawler_8php-source.html#l00414">crawler_execute_type3()</a>. </td> </tr> </table> <a class="anchor" name="e82b316daaa8120b425e4b12981047e9"></a><!-- doxytag: member="tx_indexedsearch_crawler::indexSingleRecord" ref="e82b316daaa8120b425e4b12981047e9" args="($r, $cfgRec, $rl=NULL)" --><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_indexedsearch_crawler::indexSingleRecord </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>r</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>cfgRec</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>rl</em> = <code>NULL</code></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> Indexing Single Record<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>Record to index </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Configuration Record </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Rootline array to relate indexing to </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00645">645</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8crawler_8php-source.html#l00706">getUidRootLineForClosestTemplate()</a>, <a class="el" href="class_8crawler_8php-source.html#l00694">loadIndexerClass()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l03984">t3lib_div::makeInstance()</a>, and <a class="el" href="incfile_8php-source.html#l00011">t3lib_div::trimExplode()</a>. <p> Referenced by <a class="el" href="class_8crawler_8php-source.html#l00285">crawler_execute_type1()</a>, and <a class="el" href="class_8crawler_8php-source.html#l00830">processDatamap_afterDatabaseOperations()</a>. </td> </tr> </table> <a class="anchor" name="4a681b26dd04d22c6a323025dbbaef2d"></a><!-- doxytag: member="tx_indexedsearch_crawler::loadIndexerClass" ref="4a681b26dd04d22c6a323025dbbaef2d" args="()" --><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_indexedsearch_crawler::loadIndexerClass </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </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> Include indexer class.<p> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00694">694</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8t3lib__extmgm_8php-source.html#l00147">t3lib_extMgm::extPath()</a>. <p> Referenced by <a class="el" href="class_8crawler_8php-source.html#l00345">crawler_execute_type2()</a>, <a class="el" href="class_8crawler_8php-source.html#l00602">indexExtUrl()</a>, and <a class="el" href="class_8crawler_8php-source.html#l00645">indexSingleRecord()</a>. </td> </tr> </table> <a class="anchor" name="492b9bd895ffce741e30cb9eee579023"></a><!-- doxytag: member="tx_indexedsearch_crawler::processDatamap_afterDatabaseOperations" ref="492b9bd895ffce741e30cb9eee579023" args="($status, $table, $id, $fieldArray, &$pObj)" --><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_indexedsearch_crawler::processDatamap_afterDatabaseOperations </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>status</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>table</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>id</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>fieldArray</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>pObj</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> TCEmain hook function for on-the-fly indexing of database records<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>Status "new" or "update" </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Table name </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Record ID. If new record its a string pointing to index inside t3lib_tcemain::substNEWwithIDs </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Field array of updated fields in the operation </td></tr> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>Reference to tcemain calling object </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="class_8crawler_8php-source.html#l00830">830</a> of file <a class="el" href="class_8crawler_8php-source.html">class.crawler.php</a>. <p> References <a class="el" href="class_8t3lib__befunc_8php-source.html#l00204">t3lib_BEfunc::deleteClause()</a>, <a class="el" href="class_8t3lib__befunc_8php-source.html#l00227">t3lib_BEfunc::getRecord()</a>, and <a class="el" href="class_8crawler_8php-source.html#l00645">indexSingleRecord()</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_8crawler_8php-source.html">class.crawler.php</a></ul> <?php include_once '../doc-typo3-funcs.php'; get_footer(); ?>