The SearchEngine message class. This class extends its parent class searchengine_msg and adds some higher level methods for adding groups of fields to the message.
Located in /search-lucene-defs.php (line 612)
search | --searchengine_connection | --searchengine_msg | --searchengine_message
Class | 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. |
![]() |
The SearchEngine index message class. This class inherits all the functionality of the searchengine_connection, searchengine_msg and searchengine_message classes. It adds indexing-specific methods. |
![]() |
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. |
![]() |
The SearchEngine utility message class. Used for special SearchEngine operations. |
Response object which will parse XML content
Inherited from searchengine_msg
searchengine_msg::$built
searchengine_msg::$error_msg
searchengine_msg::$fieldset
searchengine_msg::$type
searchengine_msg::$xmltags
Inherited from searchengine_connection
searchengine_connection::$connected
searchengine_connection::$enabled
searchengine_connection::$host
searchengine_connection::$message
searchengine_connection::$port
searchengine_connection::$responsebuf
searchengine_connection::$sockfp
searchengine_connection::$timeoutsecs
searchengine_connection::$timer
Inherited from search
search::$date_end
search::$date_fieldname
search::$date_start
search::$executed
search::$hit
search::$max_results
search::$query
search::$searchterm
search::$skip_results
search::$title
Constructor This is a more complex class which builds on the basic searchengine_msg class to provide some higher level methods for adding fields in specific ways to support CONTROL, QUERY and INDEX message types.
Define a field. We supply the name of the field, it's type (Text, Date or Id), and whether it should be stored by SearchEngine for later retreival in queries. For example you would not store the raw document/content as this is usually stored elsewhere.
We also cater for fields which might not need to be indexed. These would be fields of data you just want to return with the document, if found in a query, but not search on. An example might be a field containing the path to the physical document on disk. For these fields you would then specify NOT_INDEXED for the $indexed parameter. These fields MUST be stored, so we make the rule: if the field is NOT_INDEXED then it must be STORED (this will be forced). In the normal course of events, fields will be defined to be both stored and indexed. The exception is the special "Text" field associated with an item "Body", which is indexed, but never stored. This method adds the field settings directly via the add_field() method.
Specify query offset field 'First'. This sets the offset for the returned results. For example, if this was set to 3, and SearchEngine found 20 hits, then results would be sent back from the 3rd hit onwards.
Specify query limit field. This sets the maximum number of results that SearchEngine should return.
Specify a range on a field for querying. We specify the name of a field
which is used to select articles within the given limits, and the limits themeselves. Either limit may be passed as nullstring which indicates no limit on that side. Any dates must be passed as standard Unix timestamps (seconds since 1970). Notes: This method can be called multiple times to define additional ranges for different field names. This method adds the field setting directly via the add_field() method.
Specify the fields you want returned from SearchEngine.
Fields should be in a comma-separated list of field names. Each field name can have the field type included in the form 'Foo:Date', where 'Date' is the type in this instance. In fact, since 'Text' is the default filed type, 'Date' is probably the only one you need to use as the current implementation stands. This method adds the field setting directly via the add_field() method.
Specify the fields you want query results to be ordered by.
Fields should be in a comma-separated list of field names. Each field name can have the field type included in the form 'Foo:Date', where 'Date' is the type in this instance. In fact, since 'Text' is the default filed type, 'Date' is probably the only one you need to use as the current implementation stands. Note that sort field specification is a special case, where the syntax can be 'Foo:Date:Desc' or 'Foo:Desc' indicating the sort on the given field should be done in descending order.
Supply a stopword list to SearchEngine.
This method adds the field setting directly via the add_field() method.
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