File/search-utility-defs.php

Description
Classes
Class Description
 class searchengine_purger The lucene purge message class. This class allows you to remove all
 class searchengine_utilitycmd The SearchEngine utility message class. Used for special SearchEngine operations.
Functions
searchengine_backup (line 113)

Function to make a backup of the SearchEngine index. This would commonly be used after a batch of items have been successfully optimized (which indicates a sound index).

  • return: True if the operation was successful.
boolean searchengine_backup ([string $application = "?"], [string $host = ""], [string $port = ""])
  • string $application: Application name/domain name for searching in
  • string $host: Hostname or IP of SearchEngine server
  • string $port: Port of SearchEngine server
searchengine_documentcount (line 163)

Function to acquire the SearchEngine index codument count. This is similar to the healthcheck function, since it uses the same utility command, but it just returns the numeric result that the command goes and acquires as part of testing whether the server is alive.

  • return: The number of documents, else FALSE if server is dead.
mixed searchengine_documentcount ([string $application = "?"], [string $host = ""], [string $port = ""])
  • string $application: Application name/domain name for searching in
  • string $host: Hostname or IP of SearchEngine server
  • string $port: Port of SearchEngine server
searchengine_healthcheck (line 146)

Function to check the SearchEngine index for 'health'. This determines that the search engine server is alive, and can access the number of documents in its index (which is what it goes and does).

  • return: True if the index is healthy.
boolean searchengine_healthcheck ([string $application = "?"], [string $host = ""], [string $port = ""])
  • string $application: Application name/domain name for searching in
  • string $host: Hostname or IP of SearchEngine server
  • string $port: Port of SearchEngine server
searchengine_optimize (line 97)

Function to optimize the SearchEngine index. This would commonly be used after a batch of items have been indexed.

  • return: True if the operation was successful.
boolean searchengine_optimize ([string $application = "?"], [string $host = ""], [string $port = ""])
  • string $application: Application name/domain name for searching in
  • string $host: Hostname or IP of SearchEngine server
  • string $port: Port of SearchEngine server
searchengine_purge (line 130)

Function to purge the SearchEngine index of all indexes to documents. Yes, I'll repeat that - it DELETES ALL DOCUMENTS FROM THE INDEX, permanently, finito, shazam, ba-boom, as in "Omigod did I *really* mean to do that!?".

I guess I don't have to warn you to be careful with this, do I?

  • return: True if the purging operation was successful.
boolean searchengine_purge ([string $application = "?"], [string $host = ""], [string $port = ""])
  • string $application: Application name/domain name for searching in
  • string $host: Hostname or IP of SearchEngine server
  • string $port: Port of SearchEngine server

Documentation generated by phpDocumentor 1.3.0RC3