TYPO3\CMS\IndexedSearch\Example\CrawlerHook Class Reference

Public Member Functions
	initMessage ()
	indexOperation ($cfgRec, &$session_data, $params, &$pObj)

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Index search crawler hook example

Author

Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om Index search crawler hook example

Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

Definition at line 26 of file CrawlerHook.php.

Member Function Documentation

indexOperation()

TYPO3\CMS\IndexedSearch\Example\CrawlerHook::indexOperation	(		$cfgRec,
		&	$session_data,
			$params,
		&	$pObj
	)

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)

Parameters

array	Indexing Configuration Record (the record which holds the information that lead to this indexing session...)
array	Session data variable. Passed by reference. Changed content is saved and passed back upon next instance in the session.
array	Params array from the queue entry.
object	Grant Parent Object (from "crawler" extension)
object	Parent Object (from "indexed_search" extension)

Returns

void

Todo:

Define visibility

Definition at line 51 of file CrawlerHook.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

initMessage()

TYPO3\CMS\IndexedSearch\Example\CrawlerHook::initMessage

(

)

Function is called when an indexing session starts according to the time intervals set for the indexing configuration.

Returns

string Return a text string for the first, initiating queue entry for the crawler.

Todo:

Define visibility

Definition at line 34 of file CrawlerHook.php.