[search] element index

Package indexes

All elements
a b c d e f h i l m n o p q r s t u v w x
a
top
Variable $application
fileindexer::$application in search-fileindex-defs.php
Application we are indexing for
Method add_field
searchengine_msg::add_field() in search-lucene-defs.php
Add a field to the fieldset.
Method add_field
lucene_msg::add_field() in lucene-defs.php
Add a field to the fieldset.
Method add_xmltag
searchengine_msg::add_xmltag() in search-lucene-defs.php
Add a new XML tag object to this SearchEngine message. We usually just
Method add_xmltag
lucene_msg::add_xmltag() in lucene-defs.php
Add a new XML tag object to this Lucene message
b
top
Variable $built
searchengine_msg::$built in search-lucene-defs.php
True if message has been built
Variable $built
lucene_msg::$built in lucene-defs.php
True if message has been built
c
top
Variable $connected
True if we are connected to socket
Variable $connected
searchengine_connection::$connected in search-lucene-defs.php
True if we are connected to socket
Method clear
searchengine_msg::clear() in search-lucene-defs.php
Clear all data/fields, leaving type definition alone.
Method clear
lucene_msg::clear() in lucene-defs.php
Clear all data/fields, leaving type definition alone.
Method clear_daterange
search::clear_daterange() in search-defs.php
Clear the date range for the search. Makes sure that the search will not be filtered by a date restriction.
Method clear_search
search::clear_search() in search-defs.php
Clear the search terms and any stored hits.
d
top
Variable $date_end
search::$date_end in search-defs.php
End date range for search (false means undefined). This
Variable $date_fieldname
search::$date_fieldname in search-defs.php
Name of the field to which daterange should be applied
Variable $date_start
search::$date_start in search-defs.php
Start date range for search (false means undefined). This
Page dbsearch-defs.php
dbsearch-defs.php in dbsearch-defs.php
Class db_search
db_search in dbsearch-defs.php
DB Search class This class inherits the functionality of the generic 'search' class. It extends it to implement a database search.
Method db_search
db_search::db_search() in dbsearch-defs.php
Constructor
Constant DEFAULT_FIELD
DEFAULT_FIELD in lucene-defs.php
The name of the field Lucene should assume if none specified
Constant DEFAULT_FIELDTYPE
DEFAULT_FIELDTYPE in lucene-defs.php
Default type of field: 'Text', 'Date', 'Id'
Method define_field
searchengine_message::define_field() in search-lucene-defs.php
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.
Method define_field
fileindexer::define_field() in search-fileindex-defs.php
Define a field. We supply the name of the field, it's type (Text, Date or Id), and whether it should be stored by the search engine for later retreival in queries. For example you would not store the raw document/content as this is usually stored elsewhere.
Method define_field
Define a field. We supply the name of the field, it's type (Text, Date or Id), and whether it should be stored by Lucene for later retreival in queries. For example you would not store the raw document/content as this is usually stored elsewhere.
Method does_not_match
search::does_not_match() in search-defs.php
Define a search term which the search must not match to succeed.
Method does_not_matchfield
Add search term: must not match a field value.
Method does_not_matchfield
Add search term: must not match a field value.
e
top
Variable $enabled
searchengine_connection::$enabled in search-lucene-defs.php
Whether SearchEngine is enabled..
Variable $enabled
lucene_connection::$enabled in lucene-defs.php
Whether Lucene is enabled..
Variable $error_msg
searchengine_msg::$error_msg in search-lucene-defs.php
Error message if any error occurred
Variable $error_msg
lucene_msg::$error_msg in lucene-defs.php
Error message if any error occurred
Variable $executed
search::$executed in search-defs.php
Whether we have run a query
Method execute
swish_search::execute() in swish-defs.php
Execute the swish++ search
Method execute
searchengine_search::execute() in search-query-defs.php
Execute the search Here we execute a SearchEngine search, overriding the method in the parent class. This involves building the query string, sending it to the SearchEngine server, and receiving the search results back.
Method execute
searchengine_purger::execute() in search-utility-defs.php
Make SearchEngine purge the index.
Method execute
searchengine_utilitycmd::execute() in search-utility-defs.php
Make SearchEngine execute the given utility command.
Method execute
searchengine_unindexer::execute() in search-index-defs.php
Unindex the given document, as identified by the unique ID. If no errors arise, then the item will be removed from the SearchEngine index.
Method execute
lucene_search::execute() in lucene-defs.php
Execute the search Here we execute a lucene search, overriding the method in the parent class. This involves building the query string, sending it to the Lucene server, and receiving the search results back.
Method execute
searchengine_indexer::execute() in search-index-defs.php
Make SearchEngine execute the indexing funtion for the document.
Method execute
db_search::execute() in dbsearch-defs.php
Execute the search Execute the database query search and store any hits.
f
top
Variable $fields
hit::$fields in search-defs.php
Array of fieldname/value pairs - info returned by the search
Variable $fieldset
searchengine_msg::$fieldset in search-lucene-defs.php
Object containing SearchEngine fields
Variable $fieldset
lucene_msg::$fieldset in lucene-defs.php
Object containing lucene fields
Variable $field_definitions
fileindexer::$field_definitions in search-fileindex-defs.php
Index fields definitions array. Contains definitions
Method fieldlist
db_search::fieldlist() in dbsearch-defs.php
Define search fields list
Method fileindexer
fileindexer::fileindexer() in search-fileindex-defs.php
Constructor
Class fileindexer
fileindexer in search-fileindex-defs.php
The file indexer class.
Method from
db_search::from() in dbsearch-defs.php
Define search table FROM list
h
top
Variable $hit
search::$hit in search-defs.php
Array of hits returned. Each element of this array is
Variable $host
lucene_connection::$host in lucene-defs.php
HOST running the Lucene query server
Variable $host
searchengine_connection::$host in search-lucene-defs.php
HOST running the SearchEngine query server
Variable $host
fileindexer::$host in search-fileindex-defs.php
Host to connect to
Method has_daterange
search::has_daterange() in search-defs.php
Return true if at least one of our dates is set.
Method hit
hit::hit() in search-defs.php
Constructor Create a new search hit.
Class hit
hit in search-defs.php
The search hit class Something to contain a search hit which is defined as an array of information. The format of this array is entirely up to the search being performed, and is not enforced here.
Method hitcount
search::hitcount() in search-defs.php
Return count of hits present in this search.
i
top
Variable $id
term::$id in search-defs.php
ID field provided for optional application use
Variable $idoffset
fileindexer::$idoffset in search-fileindex-defs.php
ID generation offset
Variable $idprefix
fileindexer::$idprefix in search-fileindex-defs.php
ID generation prefix
Variable $idsource
fileindexer::$idsource in search-fileindex-defs.php
ID generation source
Variable $indexed
searchengine_indexmsg::$indexed in search-lucene-defs.php
Indication that the indexing was successful
Variable $indexed
lucene_indexmsg::$indexed in lucene-defs.php
Indication that the indexing was successful
Variable $indexfields
fileindexer::$indexfields in search-fileindex-defs.php
Fields for indexing. This is an array of fieldname/value
Variable $ixid
fileindexer::$ixid in search-fileindex-defs.php
The index ID
Constant ID_FROM_FILENAME
ID_FROM_FILENAME in lucene-defs.php
Mode of index ID generation is by full filename (incl. extension)
Constant ID_FROM_INC
ID_FROM_INC in lucene-defs.php
Mode of index ID generation is by incrementing integer
Constant ID_FROM_NAME
ID_FROM_NAME in lucene-defs.php
Mode of index ID generation is by filename stripped of path and extension
Constant ID_FROM_PATH
ID_FROM_PATH in lucene-defs.php
Mode of index ID generation is by full path to file
Method id_generate
fileindexer::id_generate() in search-fileindex-defs.php
Set the source for ID generation. Since we are indexing a bunch of files, the ID's have to be generated on demand inside the loop. So we provide for various ways here, and you can extend this class to provide more if required.
Constant INDEXED
INDEXED in lucene-defs.php
Used to indicate that a field should be indexed by Lucene
Method index_content
Index the given content against the given ID. This automatically
Method index_content
searchengine_indexmsg::index_content() in search-lucene-defs.php
Index the given content against the given ID. This automatically
Method index_field
fileindexer::index_field() in search-fileindex-defs.php
Supply field content for indexing. This causes the search engine to take the given fieldname and index the given value against it.
Method index_field
Supply field content for indexing. This causes Lucene to take the given fieldname and index the given value against it. NB: we silently ignore the request for nullstring, since these cause Lucene indexing to throw an exception, and indexing will fail.
Method index_field
searchengine_indexmsg::index_field() in search-lucene-defs.php
Supply field content for indexing. This causes SearchEngine to take the given fieldname and index the given value against it. NB: we silently ignore the request for nullstring, since these cause SearchEngine indexing to throw an exception, and indexing will fail.
Method index_file
fileindexer::index_file() in search-fileindex-defs.php
Index a file located at the given path, using given ID.
Method index_tree
fileindexer::index_tree() in search-fileindex-defs.php
Index a tree of files starting at the path given. We index these in one of four modes, which determines how we generate the ID for each item: 'ID_FROM_INC' mode uses an incremental counter starting at 1. If $prefix holds a number, the counter will start at this number instead of one.
Method initialise
search::initialise() in search-defs.php
Initialise everything about the search.
l
top
Method limit
db_search::limit() in dbsearch-defs.php
Define search LIMIT clause
Page lucene-defs.php
lucene-defs.php in lucene-defs.php
Page lucene-fileindex-defs.php
lucene-fileindex-defs.php in lucene-fileindex-defs.php
Function lucene_backup
lucene_backup() in lucene-defs.php
Function to make a backup of the Lucene index. This would commonly
Method lucene_connection
Constructor - Lucene connection
Class lucene_connection
lucene_connection in lucene-defs.php
The lucene connection class
Class lucene_indexmsg
lucene_indexmsg in lucene-defs.php
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.
Method lucene_indexmsg
Constructor Make a new Lucene index message.
Method 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.
Class lucene_message
lucene_message in lucene-defs.php
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.
Method lucene_msg
lucene_msg::lucene_msg() in lucene-defs.php
Constructor
Class lucene_msg
lucene_msg in lucene-defs.php
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.
Function lucene_optimize
lucene_optimize() in lucene-defs.php
Function to optimize the Lucene index. This would commonly be used after a batch of items have been indexed.
Function lucene_purge
lucene_purge() in lucene-defs.php
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!?".
Method lucene_purgemsg
Constructor Make a new Lucene purge message. This message is provided to allow you to delete all items from the Lucene index.
Class lucene_purgemsg
lucene_purgemsg in lucene-defs.php
The lucene purge message class. This class allows you to remove all
Method 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.
Class lucene_querymsg
lucene_querymsg in lucene-defs.php
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.
Class lucene_search
lucene_search in lucene-defs.php
The lucene search class
Method lucene_search
Constructor
Class lucene_unindexmsg
lucene_unindexmsg in lucene-defs.php
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.
Method 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.
Class lucene_utilitymsg
lucene_utilitymsg in lucene-defs.php
The lucene utility message class. Used for special Lucene operations.
Method lucene_utilitymsg
Constructor
m
top
Variable $max_results
search::$max_results in search-defs.php
Maximum results to return in query
Variable $message
lucene_connection::$message in lucene-defs.php
The message waiting to be sent
Variable $message
searchengine_connection::$message in search-lucene-defs.php
The message waiting to be sent
Variable $metascan
fileindexer::$metascan in search-fileindex-defs.php
Scan for meta tags as fields in file content. Recommended.
Variable $meta_fields
fileindexer::$meta_fields in search-fileindex-defs.php
Meta fields definitions array. Contains definitions
Method match
lucene_search::match() in lucene-defs.php
Add a new search term to match. Search terms can be a single word or compound patterns, Each time one of these is added, it has an operator associated with it - whether this term is a "may have" (OR), or a "must have" (AND) term.
Method match
searchengine_search::match() in search-query-defs.php
Add a new search term to match. Search terms can be a single word or compound patterns, Each time one of these is added, it has an operator associated with it - whether this term is a "may have" (OR), or a "must have" (AND) term.
Method match
search::match() in search-defs.php
Add a new search term to match. Search terms can be a single word or compound patterns, Each time one of these is added, it has an operator associated with it - whether this term is a "may have" (OR), or a "must have" (AND) term.
Method matchfield
searchengine_search::matchfield() in search-query-defs.php
Add search term to match a field value.
Method matchfield
lucene_search::matchfield() in lucene-defs.php
Add search term to match a field value.
Method matchrange
searchengine_search::matchrange() in search-query-defs.php
Add search term to match a field value range.
Method matchrange
lucene_search::matchrange() in lucene-defs.php
Add search term to match a field value range.
Method may_match
search::may_match() in search-defs.php
Define a search term which the search may or may not match.
Method may_matchfield
Add search term: may match a field value.
Method may_matchfield
searchengine_search::may_matchfield() in search-query-defs.php
Add search term: may match a field value.
Method meta_field
fileindexer::meta_field() in search-fileindex-defs.php
Define a field as a meta tag. This ensures that the field will be picked up from the file meta tags, if present. If it is not listed here then it will be ignored.
Constant META_TAG_FIELDS
META_TAG_FIELDS in lucene-defs.php
Indicates index fields come from meta tag extraction
Method must_match
search::must_match() in search-defs.php
Define a search term which the search must match to succeed.
Method must_matchfield
Add search term: must match a field value.
Method must_matchfield
Add search term: must match a field value.
n
top
Variable $nice_msecs
fileindexer::$nice_msecs in search-fileindex-defs.php
Number of milli-seconds to wait nicely between indexing calls.
Method noscantags
fileindexer::noscantags() in search-fileindex-defs.php
Flag that we should NOT do a tag scan on the content of the files.
Constant NOT_INDEXED
NOT_INDEXED in lucene-defs.php
Used to indicate that a field should NOT be indexed by Lucene
Constant NOT_STORED
NOT_STORED in lucene-defs.php
Used to indicate that a field should NOT be stored by Lucene
o
top
Variable $operator
term::$operator in search-defs.php
Join operator, one of: 'AND', 'OR', 'NOT', 'AND NOT'
Method orderby
db_search::orderby() in dbsearch-defs.php
Define search ORDER BY clause
p
top
Variable $port
searchengine_connection::$port in search-lucene-defs.php
PORT that the server is listening on
Variable $port
fileindexer::$port in search-fileindex-defs.php
Port to connect to
Variable $port
lucene_connection::$port in lucene-defs.php
PORT that the server is listening on
q
top
Variable $query
search::$query in search-defs.php
Query string container
r
top
Variable $response
searchengine_message::$response in search-lucene-defs.php
Response object which will parse XML content
Variable $response
lucene_message::$response in lucene-defs.php
Response object which will parse XML content
Variable $responsebuf
searchengine_connection::$responsebuf in search-lucene-defs.php
Raw response content we receive back from the SearchEngine server
Variable $responsebuf
Raw response content we receive back from the Lucene server
Method rawquery
searchengine_search::rawquery() in search-query-defs.php
Define the query text directly, without recourse to any of this class's
Method reset_search
search::reset_search() in search-defs.php
Reset search to null query and not executed status.
s
top
Variable $searchdir
swish_search::$searchdir in swish-defs.php
Directory to do the search from
Variable $searchindex
swish_search::$searchindex in swish-defs.php
Name of index file to use (defaults to 'swish++.index')
Variable $searchquery
db_search::$searchquery in dbsearch-defs.php
The query which runs the search
Variable $searchterm
search::$searchterm in search-defs.php
Array of search terms to match
Variable $serialno
lucene_indexmsg::$serialno in lucene-defs.php
A unique handle to identify the index
Variable $serialno
searchengine_indexmsg::$serialno in search-lucene-defs.php
A unique handle to identify the index
Variable $skip_results
search::$skip_results in search-defs.php
No. of results to skip in query (for paging)
Variable $sockfp
lucene_connection::$sockfp in lucene-defs.php
Socket file pointer
Variable $sockfp
searchengine_connection::$sockfp in search-lucene-defs.php
Socket file pointer
Variable $sort_limit_exceeded
Set to true if sort limit was exceeded in query
Variable $sort_limit_exceeded
Set to true if sort limit was exceeded in query
Variable $sort_memory_exceeded
Set to true if Lucene blew its memory trying to sort
Variable $sort_memory_exceeded
Set to true if SearchEngine blew its memory trying to sort
Method scantags
fileindexer::scantags() in search-fileindex-defs.php
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.
Class search
search in search-defs.php
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.
Method search
search::search() in search-defs.php
Constructor Create a new search.
Page search-defs.php
search-defs.php in search-defs.php
Page search-fileindex-defs.php
search-fileindex-defs.php in search-fileindex-defs.php
Page search-index-defs.php
search-index-defs.php in search-index-defs.php
Page search-lucene-defs.php
search-lucene-defs.php in search-lucene-defs.php
Page search-query-defs.php
search-query-defs.php in search-query-defs.php
Page search-utility-defs.php
search-utility-defs.php in search-utility-defs.php
Function searchengine_backup
searchengine_backup() in search-utility-defs.php
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).
Method 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.
Class searchengine_connection
searchengine_connection in search-lucene-defs.php
The SearchEngine connection class
Function searchengine_documentcount
searchengine_documentcount() in search-utility-defs.php
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.
Function searchengine_healthcheck
searchengine_healthcheck() in search-utility-defs.php
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).
Class searchengine_indexer
searchengine_indexer in search-index-defs.php
The indexer class. This class inherits all the functionality of the searchengine_connection, searchengine_msg and searchengine_message classes. It adds indexing-specific methods.
Method searchengine_indexer
Constructor Make a new SearchEngine indexer.
Method searchengine_indexmsg
Constructor Make a new SearchEngine index message.
Class searchengine_indexmsg
searchengine_indexmsg in search-lucene-defs.php
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.
Method 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.
Class searchengine_message
searchengine_message in search-lucene-defs.php
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.
Method searchengine_msg
searchengine_msg::searchengine_msg() in search-lucene-defs.php
Constructor
Class searchengine_msg
searchengine_msg in search-lucene-defs.php
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.
Function searchengine_optimize
searchengine_optimize() in search-utility-defs.php
Function to optimize the SearchEngine index. This would commonly be used after a batch of items have been indexed.
Function searchengine_purge
searchengine_purge() in search-utility-defs.php
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!?".
Class searchengine_purgemsg
searchengine_purgemsg in search-lucene-defs.php
The SearchEngine purge message class. This class allows you to remove all
Method 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.
Class searchengine_purger
searchengine_purger in search-utility-defs.php
The lucene purge message class. This class allows you to remove all
Method searchengine_purger
Constructor Make a new SearchEngine index purger. This message is provided to allow you to delete all items from the SearchEngine index.
Class searchengine_querymsg
searchengine_querymsg in search-lucene-defs.php
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.
Method 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.
Class searchengine_search
searchengine_search in search-query-defs.php
The SearchEngine search class
Method searchengine_search
Constructor
Method 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.
Class searchengine_unindexer
searchengine_unindexer in search-index-defs.php
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.
Class searchengine_unindexmsg
searchengine_unindexmsg in search-lucene-defs.php
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.
Method 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.
Method searchengine_utilitycmd
Constructor
Class searchengine_utilitycmd
searchengine_utilitycmd in search-utility-defs.php
The SearchEngine utility message class. Used for special SearchEngine operations.
Method searchengine_utilitymsg
Constructor
Class searchengine_utilitymsg
searchengine_utilitymsg in search-lucene-defs.php
The SearchEngine utility message class. Used for special SearchEngine operations.
Method send
searchengine_msg::send() in search-lucene-defs.php
Sends the current message to SearchEngine, and checks for protocol errors in the received response.
Method send
lucene_utilitymsg::send() in lucene-defs.php
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.
Method send
searchengine_unindexmsg::send() in search-lucene-defs.php
Send the message to SearchEngine, and then post-process the response for indication of a successful index operation.
Method send
searchengine_querymsg::send() in search-lucene-defs.php
Send the message to SearchEngine, and then post-process the response for
Method send
lucene_querymsg::send() in lucene-defs.php
Send the message to Lucene, and then post-process the response for
Method send
searchengine_utilitymsg::send() in search-lucene-defs.php
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.
Method send
searchengine_connection::send() in search-lucene-defs.php
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.
Method send
lucene_connection::send() in lucene-defs.php
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.
Method send
searchengine_indexmsg::send() in search-lucene-defs.php
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.
Method send
lucene_msg::send() in lucene-defs.php
Sends the current message to Lucene, and checks for protocol errors in the received response.
Method send
lucene_indexmsg::send() in lucene-defs.php
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.
Method set_application
searchengine_msg::set_application() in search-lucene-defs.php
Specify the application. The application is the name of a configuration
Method set_application
Specify the application. The application is the name of a configuration
Method set_daterange
search::set_daterange() in search-defs.php
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.
Method set_domain
searchengine_msg::set_domain() in search-lucene-defs.php
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.
Method set_domain
lucene_msg::set_domain() in lucene-defs.php
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.
Method set_first
searchengine_message::set_first() in search-lucene-defs.php
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.
Method set_first
lucene_message::set_first() in lucene-defs.php
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.
Method set_host_and_port
Sets the search engine host and port for the connection
Method set_limit
lucene_message::set_limit() in lucene-defs.php
Specify query limit field. This sets the maximum number of results that Lucene should return.
Method set_limit
searchengine_message::set_limit() in search-lucene-defs.php
Specify query limit field. This sets the maximum number of results that SearchEngine should return.
Method set_maxresults
search::set_maxresults() in search-defs.php
Set maximum results Sets the maximum results to return from the search.
Method set_query
searchengine_querymsg::set_query() in search-lucene-defs.php
Set the query for this message. There can be only one query defined.
Method set_query
lucene_querymsg::set_query() in lucene-defs.php
Set the query for this message. There can be only one query defined.
Method set_range
searchengine_message::set_range() in search-lucene-defs.php
Specify a range on a field for querying. We specify the name of a field
Method set_range
lucene_message::set_range() in lucene-defs.php
Specify a range on a field for querying. We specify the name of a field
Method set_returnfields
Specify the fields you want returned from Lucene.
Method set_returnfields
Specify the fields you want returned from SearchEngine.
Method set_searchdir
Set search directory Set the root directory to go to and search from.
Method 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'.
Method set_searchquery
db_search::set_searchquery() in dbsearch-defs.php
Define the search query object
Method set_skipresults
search::set_skipresults() in search-defs.php
Set skip results
Method set_sortorder
Specify the fields you want query results to be ordered by.
Method set_sortorder
searchengine_message::set_sortorder() in search-lucene-defs.php
Specify the fields you want query results to be ordered by.
Method set_stopwords
Supply a stopword list to lucene.
Method set_stopwords
searchengine_message::set_stopwords() in search-lucene-defs.php
Supply a stopword list to SearchEngine.
Method set_timeout
Set the socket timeout. Deals with the special case of setting the socket to non-blocking mode (zero timeout)..
Method set_timeout
searchengine_connection::set_timeout() in search-lucene-defs.php
Set the socket timeout. Deals with the special case of setting the socket to non-blocking mode (zero timeout)..
Constant SOCK_FOREVER
SOCK_FOREVER in lucene-defs.php
Wait on socket forever (well, 24hrs is that, more or less)
Constant SOCK_NO_WAIT
SOCK_NO_WAIT in lucene-defs.php
Do not wait on socket receive, return immediately
Constant SOCK_RETRIES
SOCK_RETRIES in lucene-defs.php
Times to retry timed-out socket sends/receives
Constant STORED
STORED in lucene-defs.php
Used to indicate that a field should be stored by Lucene
Page swish-defs.php
swish-defs.php in swish-defs.php
Class swish_search
swish_search in swish-defs.php
The swish search class
Method swish_search
Constructor
t
top
Variable $text
term::$text in search-defs.php
The text of this search term
Variable $timeoutsecs
searchengine_connection::$timeoutsecs in search-lucene-defs.php
Timeout for send in seconds
Variable $timeoutsecs
fileindexer::$timeoutsecs in search-fileindex-defs.php
Timeout for indexing commands in seconds (can usually leave
Variable $timeoutsecs
Timeout for send in seconds
Variable $timer
lucene_connection::$timer in lucene-defs.php
An execution timer
Variable $timer
searchengine_connection::$timer in search-lucene-defs.php
An execution timer
Variable $timer
fileindexer::$timer in search-fileindex-defs.php
Indexing execution timer
Variable $title
search::$title in search-defs.php
Title for heading of output
Variable $type
searchengine_msg::$type in search-lucene-defs.php
Type/name of this message
Variable $type
lucene_msg::$type in lucene-defs.php
Type/name of this message
Method term
term::term() in search-defs.php
Constructor Create a new search term.
Class term
term in search-defs.php
The search term class Something to contain a search term. A search term is basically a string of one or more words to match, together with the operator to apply with the match.
Method termcount
search::termcount() in search-defs.php
Return count of searchterms present in this search.
u
top
Method unindex
searchengine_unindexmsg::unindex() in search-lucene-defs.php
Unindex the given document, as identified by the unique ID. If no errors arise, then the item will be removed from the SearchEngine index.
Method unindex
lucene_unindexmsg::unindex() in lucene-defs.php
Unindex the given document, as identified by the unique ID. If no errors arise, then the item will be removed from the Lucene index.
v
top
Variable $valid
term::$valid in search-defs.php
True if this term is deemed valid
w
top
Method where
db_search::where() in dbsearch-defs.php
Define search WHERE clause
x
top
Variable $xmltags
searchengine_msg::$xmltags in search-lucene-defs.php
Array containing XML tags
Variable $xmltags
lucene_msg::$xmltags in lucene-defs.php
Array containing XML tags
a b c d e f h i l m n o p q r s t u v w x