silverorange Code


Site.SiteNateGoSearchIndexer
/Site/SiteNateGoSearchIndexer.php at line 18

Class SiteNateGoSearchIndexer

SwatObject
└─SiteObject
└─SiteApplication
└─SiteCommandLineApplication
└─SiteSearchIndexer
└─SiteNateGoSearchIndexer

public class SiteNateGoSearchIndexer
extends SiteSearchIndexer

Site search indexer application for NateGoSearch

This indexer indexes articles by default. Subclasses may change how and what gets indexed.

Copyright:
2006-2007 silverorange
License:
http://www.gnu.org/copyleft/lesser.html LGPL License 2.1

Field Summary
protected mixed

$clear_cache

Whether or not the search cache should be cleared after indexing.

Fields inherited from Site.SiteSearchIndexer
db
Fields inherited from Site.SiteCommandLineApplication
VERBOSITY_ALL, VERBOSITY_ERRORS, VERBOSITY_NONE, arguments, documentation, lock_file, title, verbosity
Fields inherited from Site.SiteApplication
VAR_COOKIE, VAR_ENV, VAR_FILES, VAR_GET, VAR_POST, VAR_REQUEST, VAR_SERVER, VAR_SESSION, default_time_zone, id, locale, modules, modules_by_provides
Constructor Summary

SiteNateGoSearchIndexer(mixed id, mixed config_filename, mixed title, mixed documentation)

Method Summary
protected void

checkQueue()

Checks to see if the search queue has any entries.

protected void

clearCache()

Clears cached search results.

protected string

getCustomWordList()

Get the custom word list.

protected void

index()

Indexes documents.

protected void

indexArticles()

Indexes articles.

void

queue()

Repopulates the entire search queue.

protected void

queueArticles()

Repopulates the articles queue.

void

run()

Run the application.

Methods inherited from Site.SiteSearchIndexer
configure, getDefaultModuleList
Methods inherited from Site.SiteCommandLineApplication
addCommandLineArgument, debug, displayArgumentUsage, displayUsage, error, getLockFilename, getScriptDirectory, lock, output, parseCommandLineArguments, setApplicationDirectory, setVerbosity, terminate, unlock
Methods inherited from Site.SiteApplication
addConfigDefinitions, addDefaultModule, addDefaultModules, addModule, configure, configureErrorHandling, getCountry, getDefaultModuleList, getInstance, getInstanceId, getLocale, getModule, hasModule, initModules, initVar, postInitConfigure, run

Field Detail

/Site/SiteNateGoSearchIndexer.php at line 27

clear_cache

protected mixed $clear_cache = false

Whether or not the search cache should be cleared after indexing

See Also:
SiteNateGoSearchIndexer::checkQueue()

Constructor Detail

/Site/SiteNateGoSearchIndexer.php at line 32

SiteNateGoSearchIndexer

public SiteNateGoSearchIndexer(mixed id, mixed config_filename, mixed title, mixed documentation)

Method Detail

/Site/SiteNateGoSearchIndexer.php at line 81

checkQueue

protected void checkQueue()

Checks to see if the search queue has any entries

If the queue has entries, cached search results are cleared at the end of teh idexing process.


/Site/SiteNateGoSearchIndexer.php at line 115

clearCache

protected void clearCache()

Clears cached search results


/Site/SiteNateGoSearchIndexer.php at line 229

getCustomWordList

protected string getCustomWordList()

Get the custom word list

Get the custom word list that is used by this fulltext search engine.

Returns:
the path to the custom word list

/Site/SiteNateGoSearchIndexer.php at line 104

index

protected void index()

Indexes documents

Subclasses should override this method to add or remove additional indexed tables.


/Site/SiteNateGoSearchIndexer.php at line 166

indexArticles

protected void indexArticles()

Indexes articles

Articles are visible if they are enabled. Articles may not be shown in the menu but are still visible. Articles also have an explicit searchable field.


/Site/SiteNateGoSearchIndexer.php at line 50

queue

public void queue()

Repopulates the entire search queue


/Site/SiteNateGoSearchIndexer.php at line 133

queueArticles

protected void queueArticles()

Repopulates the articles queue


/Site/SiteNateGoSearchIndexer.php at line 58

run

public void run()

Run the application.


silverorange Code