Class searchengine_unindexmsg

Description

The SearchEngine unindex message class. This class allows you to remove an item from the SearchEngine index. You must know the unique ID that identifies the document.

Located in /search-lucene-defs.php (line 1192)

search
   |
   --searchengine_connection
      |
      --searchengine_msg
         |
         --searchengine_message
            |
            --searchengine_unindexmsg
Direct descendents
Class Description
 class searchengine_unindexer The SearchEngine unindexer class. This class allows you to remove an item from the SearchEngine index. You must know the unique ID that identifies the document.
 class searchengine_purgemsg The SearchEngine purge message class. This class allows you to remove all
Method Summary
 searchengine_unindexmsg searchengine_unindexmsg ([string $application = "?"], [string $host = ""], [string $port = ""])
 boolean send ([integer $timeoutsecs = ""])
 void unindex (string $id)
Variables
Methods
Constructor searchengine_unindexmsg (line 1202)

Constructor Make a new SearchEngine unindex message. This message is provided to allow you to delete an item from the SearchEngine index. It has a single method 'unindex' which takes the ID of the item to delete.

searchengine_unindexmsg searchengine_unindexmsg ([string $application = "?"], [string $host = ""], [string $port = ""])
  • string $application: Optional application specifier
  • string $host: Hostname or IP of SearchEngine server
  • string $port: Port of SearchEngine server
send (line 1222)

Send the message to SearchEngine, and then post-process the response for indication of a successful index operation.

  • return: True if everything was successful.
boolean send ([integer $timeoutsecs = ""])
  • integer $timeoutsecs: Override for timeout in seconds

Redefinition of:
searchengine_msg::send()
Sends the current message to SearchEngine, and checks for protocol errors in the received response.
unindex (line 1211)

Unindex the given document, as identified by the unique ID. If no errors arise, then the item will be removed from the SearchEngine index.

void unindex (string $id)
  • string $id: The ID to allow SearchEngine to identify the item to unindex

Inherited Methods

Inherited From searchengine_message

 searchengine_message::searchengine_message()
 searchengine_message::define_field()
 searchengine_message::set_first()
 searchengine_message::set_limit()
 searchengine_message::set_range()
 searchengine_message::set_returnfields()
 searchengine_message::set_sortorder()
 searchengine_message::set_stopwords()

Inherited From searchengine_msg

 searchengine_msg::searchengine_msg()
 searchengine_msg::add_field()
 searchengine_msg::add_xmltag()
 searchengine_msg::clear()
 searchengine_msg::send()
 searchengine_msg::set_application()
 searchengine_msg::set_domain()

Inherited From searchengine_connection

 searchengine_connection::searchengine_connection()
 searchengine_connection::send()
 searchengine_connection::set_host_and_port()
 searchengine_connection::set_timeout()

Inherited From search

 search::search()
 search::clear_daterange()
 search::clear_search()
 search::does_not_match()
 search::has_daterange()
 search::hitcount()
 search::initialise()
 search::match()
 search::may_match()
 search::must_match()
 search::reset_search()
 search::set_daterange()
 search::set_maxresults()
 search::set_skipresults()
 search::termcount()

Documentation generated by phpDocumentor 1.3.0RC3