Search engine hook base class for Postgres. More...

Inheritance diagram for SearchPostgres:

[legend]

Collaboration diagram for SearchPostgres:

[legend]

Public Member Functions
	parseQuery ( $term)
	Transform the user's search string into a better form for tsearch2 Returns an SQL fragment consisting of quoted text to search for.

	searchQuery ( $term, $fulltext, $colname)
	Construct the full SQL query to do the search.

	searchText ( $term)
	Perform a full text search query and return a result set.

	searchTitle ( $term)
	Perform a full text search query via tsearch2 and return a result set.

	update ( $pageid, $title, $text)
	Create or update the search index record for the given page.

	updateTitle ( $id, $title)
	Update a search index record's title only.

Public Member Functions inherited from SearchDatabase
	__construct (IDatabase $db=null)
	Constructor.

Public Member Functions inherited from SearchEngine
	augmentSearchResults (SearchResultSet $resultSet)
	Augment search results with extra data.

	completionSearch ( $search)
	Perform a completion search.

	completionSearchWithVariants ( $search)
	Perform a completion search with variants.

	defaultPrefixSearch ( $search)
	Simple prefix search for subpages.

	delete ( $id, $title)
	Delete an indexed page Title should be pre-processed.

	extractTitles (SearchSuggestionSet $completionResults)
	Extract titles from completion results.

	getNearMatcher (Config $config)
	Get service class to finding near matches.

	getProfiles ( $profileType, User $user=null)
	Get a list of supported profiles.

	getSearchIndexFields ()
	Get fields for search index.

	getSort ()
	Get the sort direction of the search results.

	getTextFromContent (Title $t, Content $c=null)
	Get the raw text for updating the index from a content object Nicer search backends could possibly do something cooler than just returning raw text.

	getValidSorts ()
	Get the valid sort directions.

	makeSearchFieldMapping ( $name, $type)
	Create a search field definition.

	normalizeText ( $string)
	When overridden in derived class, performs database-specific conversions on text to be used for searching or updating search index.

	replacePrefixes ( $query)
	Parse some common prefixes: all (search everything) or namespace names and set the list of namespaces of this class accordingly.

	setFeatureData ( $feature, $data)
	Way to pass custom data for engines.

	setLimitOffset ( $limit, $offset=0)
	Set the maximum number of results to return and how many to skip before returning the first.

	setNamespaces ( $namespaces)
	Set which namespaces the search should include.

	setShowSuggestion ( $showSuggestion)
	Set whether the searcher should try to build a suggestion.

	setSort ( $sort)
	Set the sort direction of the search results.

	supports ( $feature)

	textAlreadyUpdatedForIndex ()
	If an implementation of SearchEngine handles all of its own text processing in getTextFromContent() and doesn't require SearchUpdate::updateText()'s rather silly handling, it should return true here instead.

	transformSearchTerm ( $term)
	Transform search term in cases when parts of the query came as different GET params (when supported), e.g.

Additional Inherited Members
Static Public Member Functions inherited from SearchEngine
static	create ( $type=null)
	Load up the appropriate search engine class for the currently active database backend, and return a configured instance.

static	defaultNamespaces ()
	An array of namespaces indexes to be searched by default.

static	getNearMatch ( $searchterm)
	If an exact title match can be found, or a very slightly close match, return the title.

static	getNearMatchResultSet ( $searchterm)
	Do a near match (see SearchEngine::getNearMatch) and wrap it into a SearchResultSet.

static	getOpenSearchTemplate ()
	Get OpenSearch suggestion template.

static	getSearchTypes ()
	Return the search engines we support.

static	legalSearchChars ( $type=self::CHARS_ALL)
	Get chars legal for search NOTE: usage as static is deprecated and preserved only as BC measure.

static	namespacesAsText ( $namespaces)
	Get a list of namespace names useful for showing in tooltips and preferences.

static	parseNamespacePrefixes ( $query)
	Parse some common prefixes: all (search everything) or namespace names.

static	searchableNamespaces ()
	Make a list of searchable namespaces and their canonical names.

static	userHighlightPrefs ()
	Find snippet highlight settings for all users.

static	userNamespaces ( $user)
	Extract default namespaces to search from the given user's settings, returning a list of index numbers.

Public Attributes inherited from SearchEngine
int[] null	$namespaces = [ NS_MAIN ]

string	$prefix = ''

const	CHARS_ALL = 1
	@const int flag for legalSearchChars: includes all chars allowed in a search query

const	CHARS_NO_SYNTAX = 2
	@const int flag for legalSearchChars: includes all chars allowed in a search term

const	COMPLETION_PROFILE_TYPE = 'completionSearchProfile'
	@const string profile type for completionSearch

const	FT_QUERY_INDEP_PROFILE_TYPE = 'fulltextQueryIndepProfile'
	@const string profile type for query independent ranking features

Protected Member Functions inherited from SearchDatabase
	filter ( $text)
	Return a 'cleaned up' search string.

Protected Member Functions inherited from SearchEngine
	completionSearchBackend ( $search)
	Perform a completion search.

	normalizeNamespaces ( $search)
	Makes search simple string if it was namespaced.

	processCompletionResults ( $search, SearchSuggestionSet $suggestions)
	Process completion search results.

	simplePrefixSearch ( $search)
	Call out to simple search backend.

Static Protected Member Functions inherited from SearchEngine
static	defaultNearMatcher ()
	Get near matcher for default SearchEngine.

Protected Attributes inherited from SearchDatabase
IDatabase	$db
	Slave database for reading from for results.

Protected Attributes inherited from SearchEngine
array	$features = []
	Feature values.

int	$limit = 10

int	$offset = 0

array string	$searchTerms = []

bool	$showSuggestion = true

Detailed Description

Search engine hook base class for Postgres.

Definition at line 31 of file SearchPostgres.php.

Member Function Documentation

◆ parseQuery()

SearchPostgres::parseQuery ( $term )

Transform the user's search string into a better form for tsearch2 Returns an SQL fragment consisting of quoted text to search for.

Parameters

string $term

Returns: string

Definition at line 64 of file SearchPostgres.php.

References $term, as, and wfDebug().

Referenced by searchQuery().

◆ searchQuery()

SearchPostgres::searchQuery	(	$term,
		$fulltext,
		$colname
	)

Construct the full SQL query to do the search.

Parameters

string	$term
string	$fulltext
string	$colname

Returns: string

Definition at line 128 of file SearchPostgres.php.

References SearchEngine\$namespaces, $query, $res, $term, are, as, e, namespaces, parseQuery(), used, and wfDebug().

Referenced by searchText(), and searchTitle().

◆ searchText()

SearchPostgres::searchText ( $term )

Perform a full text search query and return a result set.

If full text searches are not supported or disabled, return null. STUB

Parameters

string $term Raw search term

Returns: SearchResultSet|Status|null

Reimplemented from SearchEngine.

Definition at line 48 of file SearchPostgres.php.

References $term, and searchQuery().

◆ searchTitle()

SearchPostgres::searchTitle ( $term )

Perform a full text search query via tsearch2 and return a result set.

Currently searches a page's current title (page.page_title) and latest revision article text (pagecontent.old_text)

Parameters

string $term Raw search term

Returns: SqlSearchResultSet

Reimplemented from SearchEngine.

Definition at line 40 of file SearchPostgres.php.

References $term, and searchQuery().

◆ update()

SearchPostgres::update	(	$id,
		$title,
		$text
	)

Create or update the search index record for the given page.

Title and text should be pre-processed. STUB

Parameters

int	$id
string	$title
string	$text

Reimplemented from SearchEngine.

Definition at line 181 of file SearchPostgres.php.

◆ updateTitle()

SearchPostgres::updateTitle	(	$id,
		$title
	)

Update a search index record's title only.

Title should be pre-processed. STUB

Parameters

int	$id
string	$title

Reimplemented from SearchEngine.

Definition at line 190 of file SearchPostgres.php.

The documentation for this class was generated from the following file:

includes/search/SearchPostgres.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ parseQuery()

◆ searchQuery()

◆ searchText()

◆ searchTitle()

◆ update()

◆ updateTitle()