-
limit
-
Define search LIMIT clause
-
lucene-defs.php
-
-
lucene-fileindex-defs.php
-
-
lucene_backup
-
Function to make a backup of the Lucene index. This would commonly
-
lucene_connection
-
Constructor - Lucene connection
-
lucene_connection
-
The lucene connection class
-
lucene_indexmsg
-
The lucene index message class. This class inherits all the functionality of the lucene_connection, lucene_msg and lucene_message classes. It adds indexing-specific methods.
-
lucene_indexmsg
-
Constructor Make a new Lucene index message.
-
lucene_message
-
Constructor This is a more complex class which builds on the basic lucene_msg class to provide some higher level methods for adding fields in specific ways to support CONTROL, QUERY and INDEX message types.
-
lucene_message
-
The lucene message class. This class extends its parent class lucene_msg and adds some higher level methods for adding groups of fields to the message.
-
lucene_msg
-
Constructor
-
lucene_msg
-
The lucene msg class. This is a raw class which holds the basic message fields and data and knows how to build them into a full message for sending to the lucene server.
-
lucene_optimize
-
Function to optimize the Lucene index. This would commonly be used after a batch of items have been indexed.
-
lucene_purge
-
Function to purge the Lucene index of all indexes to documents. Yes, I'll repeat that - it DELETES ALL DOCUMENTS FROM THE INDEX, permanently, finito, shazam, ba-boom, as in "Omigod did I *really* mean to do that!?".
-
lucene_purgemsg
-
Constructor Make a new Lucene purge message. This message is provided to allow you to delete all items from the Lucene index.
-
lucene_purgemsg
-
The lucene purge message class. This class allows you to remove all
-
lucene_querymsg
-
Constructor Make a new Lucene query message. You can specify the application to use here, and also an optional query string to send.
-
lucene_querymsg
-
The lucene query message class. This class inherits all the functionality of the lucene_connection, lucene_msg and lucene_message classes. It adds query-specific methods for searching.
-
lucene_search
-
The lucene search class
-
lucene_search
-
Constructor
-
lucene_unindexmsg
-
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.
-
lucene_unindexmsg
-
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_utilitymsg
-
The lucene utility message class. Used for special Lucene operations.
-
lucene_utilitymsg
-
Constructor
-
$searchdir
-
Directory to do the search from
-
$searchindex
-
Name of index file to use (defaults to 'swish++.index')
-
$searchquery
-
The query which runs the search
-
$searchterm
-
Array of search terms to match
-
$serialno
-
A unique handle to identify the index
-
$serialno
-
A unique handle to identify the index
-
$skip_results
-
No. of results to skip in query (for paging)
-
$sockfp
-
Socket file pointer
-
$sockfp
-
Socket file pointer
-
$sort_limit_exceeded
-
Set to true if sort limit was exceeded in query
-
$sort_limit_exceeded
-
Set to true if sort limit was exceeded in query
-
$sort_memory_exceeded
-
Set to true if Lucene blew its memory trying to sort
-
$sort_memory_exceeded
-
Set to true if SearchEngine blew its memory trying to sort
-
scantags
-
Flag that we should do a tag scan on the content of the files to try and extract fields to index. Note that any tags thus found will only be used if the field name has been defined with the method define_field(); This causes both the <title> tag and <meta> tags to be considered.
-
search
-
The search class is an object which can be assigned search terms, can execute a search, and can contain search hits having executed a seach.
-
search
-
Constructor Create a new search.
-
search-defs.php
-
-
search-fileindex-defs.php
-
-
search-index-defs.php
-
-
search-lucene-defs.php
-
-
search-query-defs.php
-
-
search-utility-defs.php
-
-
searchengine_backup
-
Function to make a backup of the SearchEngine index. This would commonly be used after a batch of items have been successfully optimized (which indicates a sound index).
-
searchengine_connection
-
Constructor - SearchEngine connection. Normally this will just be called with no host/port, and the object is just initialised ready for the call to send(). If called with host/port, then the connection is fired up immediately.
-
searchengine_connection
-
The SearchEngine connection class
-
searchengine_documentcount
-
Function to acquire the SearchEngine index codument count. This is similar to the healthcheck function, since it uses the same utility command, but it just returns the numeric result that the command goes and acquires as part of testing whether the server is alive.
-
searchengine_healthcheck
-
Function to check the SearchEngine index for 'health'. This determines that the search engine server is alive, and can access the number of documents in its index (which is what it goes and does).
-
searchengine_indexer
-
The indexer class. This class inherits all the functionality of the searchengine_connection, searchengine_msg and searchengine_message classes. It adds indexing-specific methods.
-
searchengine_indexer
-
Constructor Make a new SearchEngine indexer.
-
searchengine_indexmsg
-
Constructor Make a new SearchEngine index message.
-
searchengine_indexmsg
-
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.
-
searchengine_message
-
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.
-
searchengine_message
-
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.
-
searchengine_msg
-
Constructor
-
searchengine_msg
-
The SearchEngine msg class. This is a raw class which holds the basic message fields and data and knows how to build them into a full message for sending to the SearchEngine server.
-
searchengine_optimize
-
Function to optimize the SearchEngine index. This would commonly be used after a batch of items have been indexed.
-
searchengine_purge
-
Function to purge the SearchEngine index of all indexes to documents. Yes, I'll repeat that - it DELETES ALL DOCUMENTS FROM THE INDEX, permanently, finito, shazam, ba-boom, as in "Omigod did I *really* mean to do that!?".
-
searchengine_purgemsg
-
The SearchEngine purge message class. This class allows you to remove all
-
searchengine_purgemsg
-
Constructor Make a new SearchEngine purge message. This message is provided to allow you to delete all items from the SearchEngine index. It is just a special case of the unindex message.
-
searchengine_purger
-
The lucene purge message class. This class allows you to remove all
-
searchengine_purger
-
Constructor Make a new SearchEngine index purger. This message is provided to allow you to delete all items from the SearchEngine index.
-
searchengine_querymsg
-
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.
-
searchengine_querymsg
-
Constructor Make a new SearchEngine query message. You can specify the application to use here, and also an optional query string to send.
-
searchengine_search
-
The SearchEngine search class
-
searchengine_search
-
Constructor
-
searchengine_unindexer
-
Constructor Make a new SearchEngine unindexer. This 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_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.
-
searchengine_unindexmsg
-
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.
-
searchengine_unindexmsg
-
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_utilitycmd
-
Constructor
-
searchengine_utilitycmd
-
The SearchEngine utility message class. Used for special SearchEngine operations.
-
searchengine_utilitymsg
-
Constructor
-
searchengine_utilitymsg
-
The SearchEngine utility message class. Used for special SearchEngine operations.
-
send
-
Sends the current message to SearchEngine, and checks for protocol errors in the received response.
-
send
-
Send the message to Lucene, and then post-process the response for indication of a successful utility operation. We expect to receive a response back from Lucene which has nothing much it, unless there has been an error.
-
send
-
Send the message to SearchEngine, and then post-process the response for indication of a successful index operation.
-
send
-
Send the message to SearchEngine, and then post-process the response for
-
send
-
Send the message to Lucene, and then post-process the response for
-
send
-
Send the message to SearchEngine, and then post-process the response for indication of a successful utility operation. We expect to receive a response back from SearchEngine which has nothing much it, unless there has been an error.
-
send
-
Sends a message to the SearchEngine server, and receives the response. We operate on the understanding that every time we send something to SearchEngine we expect a response. Since this method already calls the recieve() method, there is no need to call it from your application.
-
send
-
Sends a message to the Lucene server, and receives the response. We operate on the understanding that every time we send something to Lucene we expect a response. Since this method already calls the recieve() method, there is no need to call it from your application.
-
send
-
Send the message to SearchEngine, and then post-process the response for indication of a successful index operation. We expect to receive a response back from SearchEngine which has our serialno in it. This method returns True if the indexing was successful, else False.
-
send
-
Sends the current message to Lucene, and checks for protocol errors in the received response.
-
send
-
Send the message to Lucene, and then post-process the response for indication of a successful index operation. We expect to receive a response back from Lucene which has our serialno in it. This method returns True if the indexing was successful, else False.
-
set_application
-
Specify the application. The application is the name of a configuration
-
set_application
-
Specify the application. The application is the name of a configuration
-
set_daterange
-
Set date range Set the date range for the search. This is just recording the given date information for use by child classes of this one. We do not even care what the format of the dates is. They are just stored.
-
set_domain
-
Specify a domain. A domain is an identifier which groups indexed objects internally to SearchEngine. This allows searches on multiple archives of documents in a single SearchEngine installation.
-
set_domain
-
Specify a domain. A domain is an identifier which groups indexed objects internally to Lucene. This allows searches on multiple archives of documents in a single Lucene installation.
-
set_first
-
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.
-
set_first
-
Specify query offset field 'First'. This sets the offset for the returned results. For example, if this was set to 3, and Lucene found 20 hits, then results would be sent back from the 3rd hit onwards.
-
set_host_and_port
-
Sets the search engine host and port for the connection
-
set_limit
-
Specify query limit field. This sets the maximum number of results that Lucene should return.
-
set_limit
-
Specify query limit field. This sets the maximum number of results that SearchEngine should return.
-
set_maxresults
-
Set maximum results Sets the maximum results to return from the search.
-
set_query
-
Set the query for this message. There can be only one query defined.
-
set_query
-
Set the query for this message. There can be only one query defined.
-
set_range
-
Specify a range on a field for querying. We specify the name of a field
-
set_range
-
Specify a range on a field for querying. We specify the name of a field
-
set_returnfields
-
Specify the fields you want returned from Lucene.
-
set_returnfields
-
Specify the fields you want returned from SearchEngine.
-
set_searchdir
-
Set search directory Set the root directory to go to and search from.
-
set_searchindex
-
Set search index filename Defines the index filename to use for searching. If no filename is specified in the constructor (@see swish_search()) or via this method, then the default is used: 'swish++.index'.
-
set_searchquery
-
Define the search query object
-
set_skipresults
-
Set skip results
-
set_sortorder
-
Specify the fields you want query results to be ordered by.
-
set_sortorder
-
Specify the fields you want query results to be ordered by.
-
set_stopwords
-
Supply a stopword list to lucene.
-
set_stopwords
-
Supply a stopword list to SearchEngine.
-
set_timeout
-
Set the socket timeout. Deals with the special case of setting the socket to non-blocking mode (zero timeout)..
-
set_timeout
-
Set the socket timeout. Deals with the special case of setting the socket to non-blocking mode (zero timeout)..
-
SOCK_FOREVER
-
Wait on socket forever (well, 24hrs is that, more or less)
-
SOCK_NO_WAIT
-
Do not wait on socket receive, return immediately
-
SOCK_RETRIES
-
Times to retry timed-out socket sends/receives
-
STORED
-
Used to indicate that a field should be stored by Lucene
-
swish-defs.php
-
-
swish_search
-
The swish search class
-
swish_search
-
Constructor