Class custom_search

Used for the "custom search index" option Class custom_search

search_api implements search_api_interface

custom_search

Package: SMF
Copyright: 2020 Simple Machines and individual contributors
License: BSD
Author: Simple Machines https://www.simplemachines.org
Located at Sources/SearchAPI-Custom.php

Methods summary
`public`	# `__construct( )` Constructor function Constructor function
`public boolean`	# `supportsMethod( string $methodName, array $query_params = null )` Check whether the specific search operation can be performed by this API. The operations are the functions listed in the interface, if not supported they need not be declared Check whether the specific search operation can be performed by this API. The operations are the functions listed in the interface, if not supported they need not be declared Parameters `$methodName` The method `$query_params` Any parameters for the query Returns boolean Whether or not the specified method is supported Overrides `search_api::supportsMethod()`
`public boolean`	# `isValid( )` Whether this method is valid for implementation or not Whether this method is valid for implementation or not Returns boolean Whether or not this method is valid Overrides `search_api::isValid()`
`public integer`	# `searchSort( string $a, string $b )` Callback function for usort used to sort the fulltext results. the order of sorting is: large words, small words, large words that are excluded from the search, small words that are excluded. Callback function for usort used to sort the fulltext results. the order of sorting is: large words, small words, large words that are excluded from the search, small words that are excluded. Parameters `$a` Word A `$b` Word B Returns integer An integer indicating how the words should be sorted Overrides `search_api::searchSort()`
`public`	# `prepareIndexes( string $word, array & $wordsSearch, array & $wordsExclude, boolean $isExcluded )` Callback while preparing indexes for searching Callback while preparing indexes for searching Parameters `$word` A word to index `$wordsSearch` Search words `$wordsExclude` Words to exclude `$isExcluded` Whether the specfied word should be excluded Overrides `search_api::prepareIndexes()`
`public mixed`	# `indexedWordQuery( array $words, array $search_data )` Search for indexed words. Search for indexed words. Parameters `$words` An array of words `$search_data` An array of search data Returns mixed Overrides `search_api::indexedWordQuery()`
`public`	# `postCreated( array & $msgOptions, array & $topicOptions, array & $posterOptions )` Callback when a post is created Callback when a post is created Parameters `$msgOptions` An array of post data `$topicOptions` An array of topic data `$posterOptions` An array of info about the person who made this post Overrides `search_api::postCreated()`
`public`	# `postModified( array & $msgOptions, array & $topicOptions, array & $posterOptions )` Callback when a post is modified Callback when a post is modified Parameters `$msgOptions` An array of post data `$topicOptions` An array of topic data `$posterOptions` An array of info about the person who made this post Overrides `search_api::postModified()`

Methods inherited from search_api
`postRemoved(), searchQuery(), topicsMoved(), topicsRemoved()`

Properties summary
`protected array`	`$indexSettings` Index settings Index settings	# `array()`
`protected array`	`$bannedWords` An array of banned words An array of banned words	# `array()`
`protected integer\|null`	`$min_word_length` Minimum word length (null for no minimum) Minimum word length (null for no minimum)	# `null`
`protected array`	`$supported_databases` Which databases support this method Which databases support this method	# `array('mysql', 'postgresql')`

Properties inherited from search_api
`$is_supported, $min_smf_version, $version_compatible`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class custom_search

Parameters

Returns

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Overrides

Parameters

Overrides