Class searchengine_utilitycmd

Description

The SearchEngine utility message class. Used for special SearchEngine operations.

Located in /search-utility-defs.php (line 67)

search
   |
   --searchengine_connection
      |
      --searchengine_msg
         |
         --searchengine_message
            |
            --searchengine_utilitymsg
               |
               --searchengine_utilitycmd
Method Summary
 searchengine_utilitycmd searchengine_utilitycmd ([string $utilitycmd = ""], [string $application = "?"], [string $host = ""], [string $port = ""])
 boolean execute ([integer $timeoutsecs = ""])
Variables
Methods
Constructor searchengine_utilitycmd (line 74)

Constructor

searchengine_utilitycmd searchengine_utilitycmd ([string $utilitycmd = ""], [string $application = "?"], [string $host = ""], [string $port = ""])
  • string $utilitycmd: Command for this utility message.
  • string $application: Optional application specifier
  • string $host: Hostname or IP of SearchEngine server
  • string $port: Port of SearchEngine server
execute (line 83)

Make SearchEngine execute the given utility command.

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

Inherited Methods

Inherited From searchengine_utilitymsg

 searchengine_utilitymsg::searchengine_utilitymsg()
 searchengine_utilitymsg::send()

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