Initialises the fulltext_native search backend with min/max word length and makes sure the UTF-8 normalizer is loaded.

Parameters:

&$error - is passed by reference and should either be set to false on success or an error message on failure.

Returns a list of options for the ACP to display

Performs a search on an author's posts without caring about message contents. Depends on display specific params

Parameters:

type - contains either posts or topics depending on what should be searched for

firstpost_only - if true, only topic starting posts will be considered

sort_by_sql - contains SQL code for the ORDER BY part of a query

sort_key - is the key of $sort_by_sql for the selected sorting

sort_dir - is either a or d representing ASC and DESC

sort_days - specifies the maximum amount of days a post may be old

ex_fid_ary - specifies an array of forum ids which should not be searched

m_approve_fid_ary - specifies an array of forum ids in which the searcher is allowed to view unapproved posts

topic_id - is set to 0 or a topic id, if it is not 0 then only posts in this topic should be searched

author_ary - an array of author ids

author_name - specifies the author match, when ANONYMOUS is also a search-match

&$id_ary - passed by reference, to be filled with ids for the page specified by $start and $per_page, should be ordered

start - indicates the first index of the page

per_page - number of ids each page is supposed to contain

Returns:

total number of results

Clean up a text to remove non-alphanumeric characters

This method receives a UTF-8 string, normalizes and validates it, replaces all non-alphanumeric characters with strings then returns the result.

Any number of "allowed chars" can be passed as a UTF-8 string in NFC.

Parameters:

text - Text to split, in UTF-8 (not normalized or sanitized)

allowed_chars - String of special chars to allow

encoding - Text encoding

Returns:

Cleaned up text, only alphanumeric chars are left

Todo:

normalizer::cleanup being able to be used?

Deletes all words from the index

Updates wordlist and wordmatch tables when a message is posted or changed

Parameters:

mode - Contains the post mode: edit, post, reply, quote

post_id - The id of the post which is modified/created

&$message - New or updated post content

&$subject - New or updated post subject

poster_id - Post author's user id

forum_id - The id of the forum in which the post is located

Returns true if both FULLTEXT indexes exist

Removes entries from the wordmatch table for the specified post_ids

Returns an associative array containing information about the indexes

Performs a search on keywords depending on display specific params. You have to run split_keywords() first.

Parameters:

type - contains either posts or topics depending on what should be searched for

fields - contains either titleonly (topic titles should be searched), msgonly (only message bodies should be searched), firstpost (only subject and body of the first post should be searched) or all (all post bodies and subjects should be searched)

terms - is either 'all' (use query as entered, words without prefix should default to "have to be in field") or 'any' (ignore search query parts and just return all posts that contain any of the specified words)

sort_by_sql - contains SQL code for the ORDER BY part of a query

sort_key - is the key of $sort_by_sql for the selected sorting

sort_dir - is either a or d representing ASC and DESC

sort_days - specifies the maximum amount of days a post may be old

ex_fid_ary - specifies an array of forum ids which should not be searched

m_approve_fid_ary - specifies an array of forum ids in which the searcher is allowed to view unapproved posts

topic_id - is set to 0 or a topic id, if it is not 0 then only posts in this topic should be searched

author_ary - an array of author ids if the author should be ignored during the search the array is empty

author_name - specifies the author match, when ANONYMOUS is also a search-match

&$id_ary - passed by reference, to be filled with ids for the page specified by $start and $per_page, should be ordered

start - indicates the first index of the page

per_page - number of ids each page is supposed to contain

Returns:

total number of results

This function fills $this->search_query with the cleaned user search query.

If $terms is 'any' then the words will be extracted from the search query and combined with | inside brackets. They will afterwards be treated like an standard search query.

Then it analyses the query and fills the internal arrays $must_not_contain_ids, $must_contain_ids and $must_exclude_one_ids which are later used by keyword_search().

Parameters:

keywords - contains the search query string as entered by the user

terms - is either 'all' (use search query as entered, default words to 'must be contained in post') or 'any' (find all posts containing at least one of the given words)

Returns:

false if no valid keywords were found and otherwise true

Tidy up indexes: Tag 'common words' and remove words no longer referenced in the match table