| [ Index ] |
PHP Cross Reference of phpBB-3.2.11-deutsch |
[Source view] [Print] [Project Stats]
This file is part of the phpBB Forum Software package.
| Copyright: | (c) phpBB Limited |
| License: | GNU General Public License, version 2 (GPL-2.0) |
| File Size: | 1192 lines (39 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
fulltext_postgres:: (20 methods):
__construct()
get_name()
get_search_query()
get_common_words()
get_word_length()
supports_phrase_search()
init()
split_keywords()
split_message()
keyword_search()
author_search()
index()
index_remove()
tidy()
create_index()
delete_index()
index_created()
index_stats()
get_stats()
acp()
Class: fulltext_postgres - X-Ref
Fulltext search for PostgreSQL| __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user, $phpbb_dispatcher) X-Ref |
| Constructor Creates a new \phpbb\search\fulltext_postgres, which is used as a search backend param: string|bool $error Any error that occurs is passed on through this reference variable otherwise false param: string $phpbb_root_path Relative path to phpBB root param: string $phpEx PHP file extension param: \phpbb\auth\auth $auth Auth object param: \phpbb\config\config $config Config object param: \phpbb\db\driver\driver_interface Database object param: \phpbb\user $user User object param: \phpbb\event\dispatcher_interface $phpbb_dispatcher Event dispatcher object |
| get_name() X-Ref |
| Returns the name of this search backend to be displayed to administrators return: string Name |
| get_search_query() X-Ref |
| Returns the search_query return: string search query |
| get_common_words() X-Ref |
| Returns the common_words array return: array common words that are ignored by search backend |
| get_word_length() X-Ref |
| Returns the word_length array return: array min and max word length for searching |
| supports_phrase_search() X-Ref |
| Returns if phrase search is supported or not return: bool |
| init() X-Ref |
| Checks for correct PostgreSQL version and stores min/max word length in the config return: string|bool Language key of the error/incompatiblity occurred |
| split_keywords(&$keywords, $terms) X-Ref |
| 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 param: string &$keywords Contains the keyword as entered by the user param: string $terms is either 'all' or 'any' return: bool false if no valid keywords were found and otherwise true |
| split_message($text) X-Ref |
| Turns text into an array of words param: string $text contains post text/subject |
| keyword_search($type, $fields, $terms, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $post_visibility, $topic_id, $author_ary, $author_name, &$id_ary, &$start, $per_page) X-Ref |
| Performs a search on keywords depending on display specific params. You have to run split_keywords() first param: string $type contains either posts or topics depending on what should be searched for param: 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) param: 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) param: array $sort_by_sql contains SQL code for the ORDER BY part of a query param: string $sort_key is the key of $sort_by_sql for the selected sorting param: string $sort_dir is either a or d representing ASC and DESC param: string $sort_days specifies the maximum amount of days a post may be old param: array $ex_fid_ary specifies an array of forum ids which should not be searched param: string $post_visibility specifies which types of posts the user can view in which forums param: 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 param: array $author_ary an array of author ids if the author should be ignored during the search the array is empty param: string $author_name specifies the author match, when ANONYMOUS is also a search-match param: array &$id_ary passed by reference, to be filled with ids for the page specified by $start and $per_page, should be ordered param: int $start indicates the first index of the page param: int $per_page number of ids each page is supposed to contain return: boolean|int total number of results |
| author_search($type, $firstpost_only, $sort_by_sql, $sort_key, $sort_dir, $sort_days, $ex_fid_ary, $post_visibility, $topic_id, $author_ary, $author_name, &$id_ary, &$start, $per_page) X-Ref |
| Performs a search on an author's posts without caring about message contents. Depends on display specific params param: string $type contains either posts or topics depending on what should be searched for param: boolean $firstpost_only if true, only topic starting posts will be considered param: array $sort_by_sql contains SQL code for the ORDER BY part of a query param: string $sort_key is the key of $sort_by_sql for the selected sorting param: string $sort_dir is either a or d representing ASC and DESC param: string $sort_days specifies the maximum amount of days a post may be old param: array $ex_fid_ary specifies an array of forum ids which should not be searched param: string $post_visibility specifies which types of posts the user can view in which forums param: 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 param: array $author_ary an array of author ids param: string $author_name specifies the author match, when ANONYMOUS is also a search-match param: array &$id_ary passed by reference, to be filled with ids for the page specified by $start and $per_page, should be ordered param: int $start indicates the first index of the page param: int $per_page number of ids each page is supposed to contain return: boolean|int total number of results |
| index($mode, $post_id, &$message, &$subject, $poster_id, $forum_id) X-Ref |
| Destroys cached search results, that contained one of the new words in a post so the results won't be outdated param: string $mode contains the post mode: edit, post, reply, quote ... param: int $post_id contains the post id of the post to index param: string $message contains the post text of the post param: string $subject contains the subject of the post to index param: int $poster_id contains the user id of the poster param: int $forum_id contains the forum id of parent forum of the post |
| index_remove($post_ids, $author_ids, $forum_ids) X-Ref |
| Destroy cached results, that might be outdated after deleting a post |
| tidy() X-Ref |
| Destroy old cache entries |
| create_index($acp_module, $u_action) X-Ref |
| Create fulltext index return: string|bool error string is returned incase of errors otherwise false |
| delete_index($acp_module, $u_action) X-Ref |
| Drop fulltext index return: string|bool error string is returned incase of errors otherwise false |
| index_created() X-Ref |
| Returns true if both FULLTEXT indexes exist |
| index_stats() X-Ref |
| Returns an associative array containing information about the indexes |
| get_stats() X-Ref |
| Computes the stats and store them in the $this->stats associative array |
| acp() X-Ref |
| Display various options that can be configured for the backend from the acp return: associative array containing template and config variables |
| Generated: Wed Nov 11 20:33:01 2020 | Cross-referenced by PHPXref 0.7.1 |