Class searchengine_querymsg

Description

The SearchEngine query message class. This class inherits all the functionality of the searchengine_connection, searchengine_msg and searchengine_message classes. It adds query-specific methods for searching.

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

search
   |
   --searchengine_connection
      |
      --searchengine_msg
         |
         --searchengine_message
            |
            --searchengine_querymsg
Direct descendents
Class Description
 class searchengine_search The SearchEngine search class
Variable Summary
Method Summary
 searchengine_querymsg searchengine_querymsg ([string $application = "?"], [string $host = ""], [string $port = ""])
 void send ([integer $timeoutsecs = ""])
 void set_query (string $query)
Variables
Methods
Constructor searchengine_querymsg (line 1025)

Constructor Make a new SearchEngine query message. You can specify the application to use here, and also an optional query string to send.

searchengine_querymsg searchengine_querymsg ([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 1049)

Send the message to SearchEngine, and then post-process the response for

query hits. The hitcount is extracted, followed by the hits, which may comprise multiple fields. A hit is thus defined as an array of fields, and each hit is put into a single container array called 'hit', which is a property of the parent class 'search'.

void 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.
set_query (line 1035)

Set the query for this message. There can be only one query defined.

This method can be called repeatedly, and each time it is called the new value will replace the old one.

void set_query (string $query)
  • string $query: The query to submit to SearchEngine.

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