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

Inheritance diagram for SearchOracle:

[legend]

Collaboration diagram for SearchOracle:

[legend]

Public Member Functions
	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.

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

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

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

	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.

	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)

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.

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

Private Member Functions
	escapeTerm ( $t)

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

Definition at line 31 of file SearchOracle.php.

Member Function Documentation

◆ escapeTerm()

SearchOracle::escapeTerm ( $t )

private

Definition at line 214 of file SearchOracle.php.

References $t, and $wgContLang.

Referenced by parseQuery().

◆ getIndexField()

SearchOracle::getIndexField ( $fulltext )

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

Parameters

bool $fulltext

Returns: string

Definition at line 148 of file SearchOracle.php.

Referenced by parseQuery().

◆ getQuery()

SearchOracle::getQuery	(		$filteredTerm,
			$fulltext )

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 137 of file SearchOracle.php.

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

Referenced by searchText(), and searchTitle().

◆ 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 269 of file SearchOracle.php.

References $type.

Referenced by parseQuery().

◆ parseQuery()

SearchOracle::parseQuery	(		$filteredText,
			$fulltext )

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 175 of file SearchOracle.php.

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

Referenced by queryMain().

◆ queryLimit()

SearchOracle::queryLimit ( $sql )

Return a LIMIT clause to limit results on the query.

Parameters

string $sql

Returns: string

Definition at line 114 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 159 of file SearchOracle.php.

References parseQuery().

Referenced by getQuery().

◆ queryNamespaces()

SearchOracle::queryNamespaces ( )

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

Returns: string

Definition at line 95 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 126 of file SearchOracle.php.

Referenced by getQuery().

◆ searchText()

SearchOracle::searchText ( $term )

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

Parameters

string $term Raw search term

Returns: SqlSearchResultSet

Reimplemented from SearchEngine.

Definition at line 67 of file SearchOracle.php.

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

◆ searchTitle()

SearchOracle::searchTitle ( $term )

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

Parameters

string $term Raw search term

Returns: SqlSearchResultSet

Reimplemented from SearchEngine.

Definition at line 82 of file SearchOracle.php.

References $term, SearchDatabase\filter(), and 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 231 of file SearchOracle.php.

References 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 259 of file SearchOracle.php.

References 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 32 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

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ escapeTerm()

◆ getIndexField()

◆ getQuery()

◆ legalSearchChars()

◆ parseQuery()

◆ queryLimit()

◆ queryMain()

◆ queryNamespaces()

◆ queryRanking()

◆ searchText()

◆ searchTitle()

◆ update()

◆ updateTitle()

Member Data Documentation

◆ $reservedWords