Class lucene_unindexmsg

Description

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

Located in /lucene-defs.php (line 1164)

search
   |
   --lucene_connection
      |
      --lucene_msg
         |
         --lucene_message
            |
            --lucene_unindexmsg
Method Summary
 lucene_unindexmsg lucene_unindexmsg ([string $application = "?"], [string $host = ""], [string $port = ""])
 void unindex (string $id)
Variables
Methods
Constructor lucene_unindexmsg (line 1174)

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

lucene_unindexmsg lucene_unindexmsg ([string $application = "?"], [string $host = ""], [string $port = ""])
  • string $application: Optional application specifier
  • string $host: Hostname or IP of Lucene server
  • string $port: Port of Lucene server
unindex (line 1183)

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

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

Inherited Methods

Inherited From lucene_message

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

Inherited From lucene_msg

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

Inherited From lucene_connection

 lucene_connection::lucene_connection()
 lucene_connection::send()
 lucene_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