<?php
  include_once '../doc-typo3-funcs.php';
  $doxygen_vars = array(	"title" => "TYPO3 4.0.1: tx_indexedsearch_crawlerhook Class Reference",
				"datetime" => "Sat Dec 2 19:27:14 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&nbsp;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&nbsp;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>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</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&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul></div>
<h1>tx_indexedsearch_crawlerhook Class Reference</h1><!-- doxytag: class="tx_indexedsearch_crawlerhook" --><a href="classtx__indexedsearch__crawlerhook-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawlerhook.html#db629d861ef65d87aa21c72450e2b654">initMessage</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__indexedsearch__crawlerhook.html#73b24c6301b7fb197d1544457fcc4610">indexOperation</a> ($cfgRec, &amp;$session_data, $params, &amp;$pObj)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>

<p>

<p>
Definition at line <a class="el" href="class_8crawlerhook_8php-source.html#l00057">57</a> of file <a class="el" href="class_8crawlerhook_8php-source.html">class.crawlerhook.php</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="73b24c6301b7fb197d1544457fcc4610"></a><!-- doxytag: member="tx_indexedsearch_crawlerhook::indexOperation" ref="73b24c6301b7fb197d1544457fcc4610" args="($cfgRec, &amp;$session_data, $params, &amp;$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_crawlerhook::indexOperation           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</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>&amp;$&nbsp;</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>$&nbsp;</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>&amp;$&nbsp;</td>
          <td class="mdname" nowrap> <em>pObj</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This will do two things: 1) Carry out actual indexing of content (one or more items) 2) Add one or more new entries into the crawlers queue so we are called again (another instance) for further indexing in the session (optional of course, if all indexing is done, we add no new entries)<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>&nbsp;</td><td>Indexing Configuration Record (the record which holds the information that lead to this indexing session...) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>array</em>&nbsp;</td><td>Session data variable. Passed by reference. Changed content is saved and passed back upon next instance in the session. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>array</em>&nbsp;</td><td>Params array from the queue entry. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>object</em>&nbsp;</td><td>Grant Parent Object (from "crawler" extension) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>object</em>&nbsp;</td><td>Parent Object (from "indexed_search" 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_8crawlerhook_8php-source.html#l00080">80</a> of file <a class="el" href="class_8crawlerhook_8php-source.html">class.crawlerhook.php</a>.
<p>
References <a class="el" href="class_8t3lib__div_8php-source.html#l03984">t3lib_div::makeInstance()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="db629d861ef65d87aa21c72450e2b654"></a><!-- doxytag: member="tx_indexedsearch_crawlerhook::initMessage" ref="db629d861ef65d87aa21c72450e2b654" 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_crawlerhook::initMessage           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Function is called when an indexing session starts according to the time intervals set for the indexing configuration.<p>
<dl compact><dt><b>Returns:</b></dt><dd>string Return a text string for the first, initiating queue entry for the crawler. </dd></dl>

<p>
Definition at line <a class="el" href="class_8crawlerhook_8php-source.html#l00064">64</a> of file <a class="el" href="class_8crawlerhook_8php-source.html">class.crawlerhook.php</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/example/<a class="el" href="class_8crawlerhook_8php-source.html">class.crawlerhook.php</a></ul>
<?php
  include_once '../doc-typo3-funcs.php';
  get_footer();
?>