phpBB API Documentation
Class

search_backend

class search_backend

searchbackend optional base class for search plugins providing simple caching based on ACM and functions to retrieve ignorewords and synonyms

Properties

$ignore_words
$match_synonym
$replace_synonym

Methods

search_backend($error)

get_ignore_words()

Retrieves a language dependend list of words that should be ignored by the search

get_synonyms()

Stores a list of synonyms that should be replaced in $this->matchsynonym and $this->replacesynonym and caches them

int obtain_ids($search_key, $result_count, $id_ary, $start, $per_page, $sort_dir)

Retrieves cached search results

save_ids($search_key, $keywords, $author_ary, $result_count, $id_ary, $start, $sort_dir)

Caches post/topic ids

destroy_cache($words, $authors = false)

Removes old entries from the search results table and removes searches with keywords that contain a word in $words.

Details

at line 38
public search_backend($error)

Parameters

$error

at line 47
public get_ignore_words()

Retrieves a language dependend list of words that should be ignored by the search

at line 69
public get_synonyms()

Stores a list of synonyms that should be replaced in $this->matchsynonym and $this->replacesynonym and caches them

at line 98
public int obtain_ids($search_key, $result_count, $id_ary, $start, $per_page, $sort_dir)

Retrieves cached search results

Parameters

$search_key
$result_count
$id_ary
$start
$per_page
$sort_dir

Return Value

int SEARCHRESULTNOTINCACHE or SEARCHRESULTINCACHE or SEARCHRESULT_INCOMPLETE

at line 158
public save_ids($search_key, $keywords, $author_ary, $result_count, $id_ary, $start, $sort_dir)

Caches post/topic ids

Parameters

$search_key
$keywords
$author_ary
$result_count
$id_ary
$start
$sort_dir

at line 267
public destroy_cache($words, $authors = false)

Removes old entries from the search results table and removes searches with keywords that contain a word in $words.

Parameters

$words
$authors