Interface

search_api_interface

Simple Machines Forum (SMF)

Known implementers

custom_search , fulltext_search , search_api , standard_search

Open source code

Methods Summary
`public`	# `supportsMethod( string $methodName , array $query_params = array ( ) )` 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 access
`public`	# `isValid( )` Whether this method is valid for implementation or not access
`public`	# `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. access
`public`	# `prepareIndexes( string $word , array & $wordsSearch , array & $wordsExclude , bool $isExcluded )` Callback while preparing indexes for searching access
`public`	# `indexedWordQuery( array $words , array $search_data )` Search for indexed words. access
`public`	# `postCreated( array & $msgOptions , array & $topicOptions , array & $posterOptions )` Callback when a post is created see createPost() access
`public`	# `postModified( array & $msgOptions , array & $topicOptions , array & $posterOptions )` Callback when a post is modified see modifyPost() access
`public`	# `postRemoved( int $id_msg )` Callback when a post is removed access
`public`	# `topicsRemoved( array $topics )` Callback when a topic is removed access
`public`	# `topicsMoved( array $topics , int $board_to )` Callback when a topic is moved access
`public`	# `searchQuery( array $query_params , array $searchWords , array $excludedIndexWords , array & $participants , array & $searchArray )` Callback for actually performing the search query access