Search engine hook base class for Oracle (ConText). More...

Inheritance diagram for SearchOracle:

[legend]

Collaboration diagram for SearchOracle:

[legend]

Public Member Functions
	queryMain ( $filteredTerm, $fulltext)
	Get the base part of the search query.

	queryRanking ( $filteredTerm, $fulltext)
	Does not do anything for generic search engine subclasses may define this though.

	update ( $id, $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)

	doSearchText ( $term)

	doSearchTitle ( $term)

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.

	getFeatureData ( $feature)
	Way to retrieve custom data set by setFeatureData or by the engine itself.

	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.

	searchArchiveTitle ( $term)
	Perform a title search in the article archive.

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

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

	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.

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

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	getSearchTypes ()
	Return the search engines we support.

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

static	parseNamespacePrefixes ( $query, $withAllKeyword=true, $withPrefixSearchExtractNamespaceHook=false)
	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.

Protected Member Functions
	doSearchTextInDB ( $term)
	Perform a full text search query and return a result set.

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

Protected Member Functions inherited from SearchDatabase
	extractNamespacePrefix ( $term)
	Extract the optional namespace prefix and set self::namespaces accordingly and return the query string.

	filter ( $text)
	Return a 'cleaned up' search string.

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

	completionSearchBackendOverfetch ( $search)
	Perform an overfetch of completion search results.

	doSearchArchiveTitle ( $term)
	Perform a title search in the article archive.

	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.

Private Member Functions
	escapeTerm ( $t)

	getIndexField ( $fulltext)
	Picks which field to index on, depending on what type of query.

	getQuery ( $filteredTerm, $fulltext)
	Construct the full SQL query to do the search.

	parseQuery ( $filteredText, $fulltext)
	Parse a user input search string, and return an SQL fragment to be used as part of a WHERE clause.

	queryLimit ( $sql)
	Return a LIMIT clause to limit results on the query.

	queryNamespaces ()
	Return a partial WHERE clause to limit the search to the given namespaces.

Private Attributes
	$reservedWords

Additional Inherited Members
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	DEFAULT_SORT = 'relevance'

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

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

Protected Attributes inherited from SearchDatabase
IDatabase	$db
	Replica database from which to read 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 Oracle (ConText).

Definition at line 33 of file SearchOracle.php.

Member Function Documentation

◆ doSearchTextInDB()

SearchOracle::doSearchTextInDB ( $term )

protected

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

Parameters

string $term Raw search term

Returns: SqlSearchResultSet

Reimplemented from SearchDatabase.

Definition at line 69 of file SearchOracle.php.

References $term, SearchDatabase\filter(), and getQuery().

◆ doSearchTitleInDB()

SearchOracle::doSearchTitleInDB ( $term )

protected

Perform a title-only search query and return a result set.

Parameters

string $term Raw search term

Returns: SqlSearchResultSet

Reimplemented from SearchDatabase.

Definition at line 84 of file SearchOracle.php.

References $term, SearchDatabase\filter(), and getQuery().

◆ escapeTerm()

SearchOracle::escapeTerm ( $t )

private

Definition at line 216 of file SearchOracle.php.

References $t.

Referenced by parseQuery().

◆ getIndexField()

SearchOracle::getIndexField ( $fulltext )

private

Picks which field to index on, depending on what type of query.

Parameters

bool $fulltext

Returns: string

Definition at line 150 of file SearchOracle.php.

Referenced by parseQuery().

◆ getQuery()

SearchOracle::getQuery	(	$filteredTerm,
		$fulltext
	)

private

Construct the full SQL query to do the search.

The guts shoulds be constructed in queryMain()

Parameters

string	$filteredTerm
bool	$fulltext

Returns: string

Definition at line 139 of file SearchOracle.php.

References queryLimit(), queryMain(), queryNamespaces(), and queryRanking().

Referenced by doSearchTextInDB(), and doSearchTitleInDB().

◆ legalSearchChars()

static SearchOracle::legalSearchChars ( $type = self::CHARS_ALL )

static

Get chars legal for search NOTE: usage as static is deprecated and preserved only as BC measure.

Parameters

int $type type of search chars (see self::CHARS_ALL and self::CHARS_NO_SYNTAX). Defaults to CHARS_ALL

Returns: string

Reimplemented from SearchEngine.

Definition at line 270 of file SearchOracle.php.

References $type.

Referenced by parseQuery().

◆ parseQuery()

SearchOracle::parseQuery	(	$filteredText,
		$fulltext
	)

private

Parse a user input search string, and return an SQL fragment to be used as part of a WHERE clause.

Parameters

string	$filteredText
bool	$fulltext

Returns: string

Definition at line 177 of file SearchOracle.php.

References $t, as, escapeTerm(), getIndexField(), and legalSearchChars().

Referenced by queryMain().

◆ queryLimit()

SearchOracle::queryLimit ( $sql )

private

Return a LIMIT clause to limit results on the query.

Parameters

string $sql

Returns: string

Definition at line 116 of file SearchOracle.php.

Referenced by getQuery().

◆ queryMain()

SearchOracle::queryMain	(	$filteredTerm,
		$fulltext
	)

Get the base part of the search query.

Parameters

string	$filteredTerm
bool	$fulltext

Returns: string

Definition at line 161 of file SearchOracle.php.

References parseQuery().

Referenced by getQuery().

◆ queryNamespaces()

SearchOracle::queryNamespaces ( )

private

Return a partial WHERE clause to limit the search to the given namespaces.

Returns: string

Definition at line 97 of file SearchOracle.php.

References SearchEngine\$namespaces, and namespaces.

Referenced by getQuery().

◆ queryRanking()

SearchOracle::queryRanking	(	$filteredTerm,
		$fulltext
	)

Does not do anything for generic search engine subclasses may define this though.

Parameters

string	$filteredTerm
bool	$fulltext

Returns: string

Definition at line 128 of file SearchOracle.php.

Referenced by getQuery().

◆ update()

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

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

Title and text should be pre-processed.

Parameters

int	$id
string	$title
string	$text

Reimplemented from SearchEngine.

Definition at line 232 of file SearchOracle.php.

References $title, DB_MASTER, and wfGetDB().

◆ updateTitle()

SearchOracle::updateTitle	(	$id,
		$title
	)

Update a search index record's title only.

Title should be pre-processed.

Parameters

int	$id
string	$title

Reimplemented from SearchEngine.

Definition at line 260 of file SearchOracle.php.

References $title, DB_MASTER, and wfGetDB().

Member Data Documentation

◆ $reservedWords

SearchOracle::$reservedWords

private

Initial value:

= [
        'ABOUT' => 1,
        'ACCUM' => 1,
        'AND' => 1,
        'BT' => 1,
        'BTG' => 1,
        'BTI' => 1,
        'BTP' => 1,
        'FUZZY' => 1,
        'HASPATH' => 1,
        'INPATH' => 1,
        'MINUS' => 1,
        'NEAR' => 1,
        'NOT' => 1,
        'NT' => 1,
        'NTG' => 1,
        'NTI' => 1,
        'NTP' => 1,
        'OR' => 1,
        'PT' => 1,
        'RT' => 1,
        'SQE' => 1,
        'SYN' => 1,
        'TR' => 1,
        'TRSYN' => 1,
        'TT' => 1,
        'WITHIN' => 1,
    ]

Definition at line 34 of file SearchOracle.php.

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

includes/search/SearchOracle.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ doSearchTextInDB()

◆ doSearchTitleInDB()

◆ escapeTerm()

◆ getIndexField()

◆ getQuery()

◆ legalSearchChars()

◆ parseQuery()

◆ queryLimit()

◆ queryMain()

◆ queryNamespaces()

◆ queryRanking()

◆ update()

◆ updateTitle()

Member Data Documentation

◆ $reservedWords