Class search_api

search_api implements search_api_interface

Direct known subclasses

custom_search, fulltext_search, standard_search

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

Methods summary
`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 Implementation of `search_api_interface::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 Implementation of `search_api_interface::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 Implementation of `search_api_interface::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 Implementation of `search_api_interface::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 Implementation of `search_api_interface::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 Implementation of `search_api_interface::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 Implementation of `search_api_interface::postModified()`
`public`	# `postRemoved( integer $id_msg )` Callback when a post is removed Callback when a post is removed Parameters `$id_msg` The ID of the post that was removed Implementation of `search_api_interface::postRemoved()`
`public`	# `topicsRemoved( array $topics )` Callback when a topic is removed Callback when a topic is removed Parameters `$topics` The ID(s) of the removed topic(s) Implementation of `search_api_interface::topicsRemoved()`
`public`	# `topicsMoved( array $topics, integer $board_to )` Callback when a topic is moved Callback when a topic is moved Parameters `$topics` The ID(s) of the moved topic(s) `$board_to` The board that the topics were moved to Implementation of `search_api_interface::topicsMoved()`
`public mixed`	# `searchQuery( array $query_params, array $searchWords, array $excludedIndexWords, array & $participants, array & $searchArray )` Callback for actually performing the search query Callback for actually performing the search query Parameters `$query_params` An array of parameters for the query `$searchWords` The words that were searched for `$excludedIndexWords` Indexed words that should be excluded `$participants` `$searchArray` Returns mixed Implementation of `search_api_interface::searchQuery()`

Properties summary
`public string`	`$version_compatible` The maximum SMF version that this will work with. The maximum SMF version that this will work with.	# `'2.1.999'`
`public string`	`$min_smf_version` The minimum SMF version that this will work with. The minimum SMF version that this will work with.	# `'2.1 RC1'`
`public boolean`	`$is_supported` Whether or not it's supported Whether or not it's supported	# `true`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class search_api

Direct known subclasses

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Returns

Implementation of