1. interface
  2. phpbb
  3. \
  4. search
  5. \
  6. backend
  7. \
  8. search_backend_interface

search_backend_interface

interface search_backend_interface

Methods

string
get_name()

Returns the name of this search backend to be displayed to administrators

bool
is_available()

Returns if the search engine is available

string|false
init()

Method executed when a search backend is set from acp.

string
get_search_query()

Returns the search_query

array
get_common_words()

Returns the common_words array

array|false
get_word_length()

Returns the word_length array

bool
split_keywords(string $keywords, string $terms)

Splits keywords entered by a user into an array of words stored in $this->split_words This function fills $this->search_query with the cleaned user search query

bool|int
keyword_search(string $type, string $fields, string $terms, array $sort_by_sql, string $sort_key, string $sort_dir, string $sort_days, array $ex_fid_ary, string $post_visibility, int $topic_id, array $author_ary, string $author_name, array $id_ary, int $start, int $per_page)

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

bool|int
author_search(string $type, bool $firstpost_only, array $sort_by_sql, string $sort_key, string $sort_dir, string $sort_days, array $ex_fid_ary, string $post_visibility, int $topic_id, array $author_ary, string $author_name, array $id_ary, int $start, int $per_page)

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

bool
supports_phrase_search()

Returns if phrase search is supported or not

index(string $mode, int $post_id, string $message, string $subject, int $poster_id, int $forum_id)

Updates wordlist and wordmatch tables when a message is posted or changed Destroys cached search results, that contained one of the new words in a post so the results won't be outdated

void
index_remove(array $post_ids, array $author_ids, array $forum_ids)

Destroy cached results, that might be outdated after deleting a post

void
tidy()

Destroy old cache entries

array|null
create_index(int $post_counter = 0)

Create fulltext index

array|null
delete_index(int $post_counter = 0)

Drop fulltext index

bool
index_created()

Returns true if both FULLTEXT indexes exist

array|false
index_stats()

Returns an associative array containing information about the indexes

array
get_acp_options()

Display various options that can be configured for the backend from the acp

string
get_type()

Gets backend class

Details

at line 23
string get_name()

Returns the name of this search backend to be displayed to administrators

Return Value

string

Name

at line 30
bool is_available()

Returns if the search engine is available

Return Value

bool

at line 39
string|false init()

Method executed when a search backend is set from acp.

Checks permissions and paths, if everything is correct it generates the config file

Return Value

string|false

False if everything was ok or string with error message

at line 46
string get_search_query()

Returns the search_query

Return Value

string

search query

at line 53
array get_common_words()

Returns the common_words array

Return Value

array

common words that are ignored by search backend

at line 60
array|false get_word_length()

Returns the word_length array

Return Value

array|false

min and max word length for searching

at line 78
bool split_keywords(string $keywords, string $terms)

Splits keywords entered by a user into an array of words stored in $this->split_words 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

string $keywords

contains the search query string as entered by the user
string $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)

Return Value

bool

false if no valid keywords were found and otherwise true

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

Parameters

string $type

contains either posts or topics depending on what should be searched for
string $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)
string $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)
array $sort_by_sql

contains SQL code for the ORDER BY part of a query
string $sort_key

is the key of $sort_by_sql for the selected sorting
string $sort_dir

is either a or d representing ASC and DESC
string $sort_days

specifies the maximum amount of days a post may be old
array $ex_fid_ary

specifies an array of forum ids which should not be searched
string $post_visibility

specifies which types of posts the user can view in which forums
int $topic_id

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

an array of author ids if the author should be ignored during the search the array is empty
string $author_name

specifies the author match, when ANONYMOUS is also a search-match
array $id_ary

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

indicates the first index of the page
int $per_page

number of ids each page is supposed to contain

Return Value

bool|int

total number of results

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

Parameters

string $type

contains either posts or topics depending on what should be searched for
bool $firstpost_only

if true, only topic starting posts will be considered
array $sort_by_sql

contains SQL code for the ORDER BY part of a query
string $sort_key

is the key of $sort_by_sql for the selected sorting
string $sort_dir

is either a or d representing ASC and DESC
string $sort_days

specifies the maximum amount of days a post may be old
array $ex_fid_ary

specifies an array of forum ids which should not be searched
string $post_visibility

specifies which types of posts the user can view in which forums
int $topic_id

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

an array of author ids
string $author_name

specifies the author match, when ANONYMOUS is also a search-match
array $id_ary

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

indicates the first index of the page
int $per_page

number of ids each page is supposed to contain

Return Value

bool|int

total number of results

Returns if phrase search is supported or not

Return Value

bool

at line 141
index(string $mode, int $post_id, string $message, string $subject, int $poster_id, int $forum_id)

Updates wordlist and wordmatch tables when a message is posted or changed Destroys cached search results, that contained one of the new words in a post so the results won't be outdated

Parameters

string $mode

contains the post mode: edit, post, reply, quote ...
int $post_id

contains the post id of the post to index
string $message

contains the post text of the post
string $subject

contains the subject of the post to index
int $poster_id

contains the user id of the poster
int $forum_id

contains the forum id of parent forum of the post

at line 151
void index_remove(array $post_ids, array $author_ids, array $forum_ids)

Destroy cached results, that might be outdated after deleting a post

Parameters

array $post_ids
array $author_ids
array $forum_ids

Return Value

void

at line 158
void tidy()

Destroy old cache entries

Return Value

void

at line 166
array|null create_index(int $post_counter = 0)

Create fulltext index

Parameters

int $post_counter

Return Value

array|null

array with current status or null if finished

at line 174
array|null delete_index(int $post_counter = 0)

Drop fulltext index

Parameters

int $post_counter

Return Value

array|null

array with current status or null if finished

at line 181
bool index_created()

Returns true if both FULLTEXT indexes exist

Return Value

bool

at line 188
array|false index_stats()

Returns an associative array containing information about the indexes

Return Value

array|false

Language string of error false otherwise

at line 195
array get_acp_options()

Display various options that can be configured for the backend from the acp

Return Value

array

array containing template and config variables

at line 202
string get_type()

Gets backend class

Return Value

string