1. class
  2. phpbb
  3. \
  4. search
  5. \
  6. fulltext_postgres

fulltext_postgres

class fulltext_postgres extends base

Fulltext search for PostgreSQL

Properties

$ignore_words from  base
$match_synonym from  base
$replace_synonym from  base
protected array $stats

Associative array holding index stats
protected array $split_words

Holds the words entered by user, obtained by splitting the entered query on whitespace
protected string $tsearch_query

Stores the tsearch query
$phrase_search

True if phrase search is supported.
protected config $config

Config object
protected driver_interface $db

Database connection
protected dispatcher_interface $phpbb_dispatcher

phpBB event dispatcher object
protected user $user

User object
protected string $search_query

Contains tidied search query.
protected array $common_words

Contains common words.
protected array $word_length

Associative array stores the min and max word length to be searched

Methods

search_backend($error)

No description

from  base
int
obtain_ids(string $search_key, int $result_count, array $id_ary, int $start, int $per_page, string $sort_dir)

Retrieves cached search results

from  base
null
save_ids(string $search_key, string $keywords, array $author_ary, int $result_count, array $id_ary, int $start, string $sort_dir)

Caches post/topic ids

from  base
destroy_cache($words, $authors = false)

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

from  base
__construct(string|bool $error, string $phpbb_root_path, string $phpEx, auth $auth, config $config, driver_interface $db, user $user, dispatcher_interface $phpbb_dispatcher)

Constructor Creates a new \phpbb\search\fulltext_postgres, which is used as a search backend

string
get_name()

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

string
get_search_query()

Returns the search_query

array
get_common_words()

Returns the common_words array

array
get_word_length()

Returns the word_length array

bool
supports_phrase_search()

Returns if phrase search is supported or not

string|bool
init()

Checks for correct PostgreSQL version and stores min/max word length in the config

bool
split_keywords(string $keywords, string $terms)

Splits keywords entered by a user into an array of words stored in $this->split_words Stores the tidied search query in $this->search_query

split_message(string $text)

Turns text into an array of words

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

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

Destroys cached search results, that contained one of the new words in a post so the results won't be outdated

index_remove($post_ids, $author_ids, $forum_ids)

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

tidy()

Destroy old cache entries

string|bool
create_index($acp_module, $u_action)

Create fulltext index

string|bool
delete_index($acp_module, $u_action)

Drop fulltext index

index_created()

Returns true if both FULLTEXT indexes exist

index_stats()

Returns an associative array containing information about the indexes

get_stats()

Computes the stats and store them in the $this->stats associative array

associative
acp()

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

Details

in base at line 33
search_backend($error)

No description

Parameters

$error

in base at line 51
int obtain_ids(string $search_key, int $result_count, array $id_ary, int $start, int $per_page, string $sort_dir)

Retrieves cached search results

Parameters

string $search_key

an md5 string generated from all the passed search options to identify the results
int $result_count

will contain the number of all results for the search (not only for the current page)
array $id_ary

is filled with the ids belonging to the requested page that are stored in the cache
int $start

indicates the first index of the page
int $per_page

number of ids each page is supposed to contain
string $sort_dir

is either a or d representing ASC and DESC

Return Value

int

SEARCH_RESULT_NOT_IN_CACHE or SEARCH_RESULT_IN_CACHE or SEARCH_RESULT_INCOMPLETE

in base at line 132
null save_ids(string $search_key, string $keywords, array $author_ary, int $result_count, array $id_ary, int $start, string $sort_dir)

Caches post/topic ids

Parameters

string $search_key

an md5 string generated from all the passed search options to identify the results
string $keywords

contains the keywords as entered by the user
array $author_ary

an array of author ids, if the author should be ignored during the search the array is empty
int $result_count

contains the number of all results for the search (not only for the current page)
array $id_ary

contains a list of post or topic ids that shall be cached, the first element must have the absolute index $start in the result set.
int $start

indicates the first index of the page
string $sort_dir

is either a or d representing ASC and DESC

Return Value

null

in base at line 241
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

at line 103
__construct(string|bool $error, string $phpbb_root_path, string $phpEx, auth $auth, config $config, driver_interface $db, user $user, dispatcher_interface $phpbb_dispatcher)

Constructor Creates a new \phpbb\search\fulltext_postgres, which is used as a search backend

Parameters

string|bool $error

Any error that occurs is passed on through this reference variable otherwise false
string $phpbb_root_path

Relative path to phpBB root
string $phpEx

PHP file extension
auth $auth

Auth object
config $config

Config object
driver_interface $db

Database object
user $user

User object
dispatcher_interface $phpbb_dispatcher

Event dispatcher object

at line 128
string get_name()

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

Return Value

string Name

at line 138
string get_search_query()

Returns the search_query

Return Value

string

search query

at line 148
array get_common_words()

Returns the common_words array

Return Value

array

common words that are ignored by search backend

at line 158
array get_word_length()

Returns the word_length array

Return Value

array

min and max word length for searching

Returns if phrase search is supported or not

Return Value

bool

at line 178
string|bool init()

Checks for correct PostgreSQL version and stores min/max word length in the config

Return Value

string|bool

Language key of the error/incompatibility occurred

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

Splits keywords entered by a user into an array of words stored in $this->split_words Stores the tidied search query in $this->search_query

Parameters

string $keywords

Contains the keyword as entered by the user
string $terms

is either 'all' or 'any'

Return Value

bool

false if no valid keywords were found and otherwise true

at line 287
split_message(string $text)

Turns text into an array of words

Parameters

string $text

contains post text/subject

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

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

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 933
index_remove($post_ids, $author_ids, $forum_ids)

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

Parameters

$post_ids
$author_ids
$forum_ids

at line 941
tidy()

Destroy old cache entries

at line 954
string|bool create_index($acp_module, $u_action)

Create fulltext index

Parameters

$acp_module
$u_action

Return Value

string|bool

error string is returned incase of errors otherwise false

at line 1015
string|bool delete_index($acp_module, $u_action)

Drop fulltext index

Parameters

$acp_module
$u_action

Return Value

string|bool

error string is returned incase of errors otherwise false

at line 1074
index_created()

Returns true if both FULLTEXT indexes exist

at line 1087
index_stats()

Returns an associative array containing information about the indexes

at line 1102
protected get_stats()

Computes the stats and store them in the $this->stats associative array

at line 1147
associative acp()

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

Return Value

associative

array containing template and config variables