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

Inheritance diagram for SearchPostgres:

Collaboration diagram for SearchPostgres:

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. More...

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

	searchText ($term)

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

	update ($pageid, $title, $text)

	updateTitle ($id, $title)

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

Public Member Functions inherited from SearchEngine
	completionSearch ($search)
	Perform a completion search. More...

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

	defaultPrefixSearch ($search)
	Simple prefix search for subpages. More...

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

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

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

	getProfiles ($profileType)
	Get a list of supported profiles. More...

	getSearchIndexFields ()
	Get fields for search index. More...

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

	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. More...

	getValidSorts ()
	Get the valid sort directions. More...

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

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

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

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

	searchTitle ($term)
	Perform a title-only search query and return a result set. More...

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

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

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

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

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

	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. More...

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

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

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

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. More...

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

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

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

static	getOpenSearchTemplate ()
	Get OpenSearch suggestion template. More...

static	getSearchTypes ()
	Return the search engines we support. More...

static	legalSearchChars ()
	Get chars legal for search. More...

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

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

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

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

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

string	$prefix = ''

const	COMPLETION_PROFILE_TYPE = 'completionSearchProfile'
	string profile type for completionSearch More...

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

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

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

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

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

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

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

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

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

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

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().

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().

SearchPostgres::searchText ( $term )

Definition at line 48 of file SearchPostgres.php.

References $term, and searchQuery().

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

Definition at line 40 of file SearchPostgres.php.

References $term, and searchQuery().

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

Definition at line 181 of file SearchPostgres.php.

SearchPostgres::updateTitle	(	$id,
		$title
	)

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