1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: <?php
/**
* Simple Machines Forum (SMF)
*
* @package SMF
* @author Simple Machines https://www.simplemachines.org
* @copyright 2020 Simple Machines and individual contributors
* @license https://www.simplemachines.org/about/smf/license.php BSD
*
* @version 2.1 RC2
*/
/**
* Interface search_api_interface
*/
interface search_api_interface
{
/**
* 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
* @param string $methodName The method
* @param array $query_params Any parameters for the query
* @return boolean Whether or not the specified method is supported
*/
public function supportsMethod($methodName, $query_params = array());
/**
* Whether this method is valid for implementation or not
*
* @access public
* @return bool Whether or not this method is valid
*/
public function isValid();
/**
* 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
* @param string $a Word A
* @param string $b Word B
* @return int An integer indicating how the words should be sorted
*/
public function searchSort($a, $b);
/**
* Callback while preparing indexes for searching
*
* @access public
* @param string $word A word to index
* @param array $wordsSearch Search words
* @param array $wordsExclude Words to exclude
* @param bool $isExcluded Whether the specfied word should be excluded
*/
public function prepareIndexes($word, array &$wordsSearch, array &$wordsExclude, $isExcluded);
/**
* Search for indexed words.
*
* @access public
* @param array $words An array of words
* @param array $search_data An array of search data
* @return mixed
*/
public function indexedWordQuery(array $words, array $search_data);
/**
* Callback when a post is created
*
* @see createPost()
*
* @access public
* @param array $msgOptions An array of post data
* @param array $topicOptions An array of topic data
* @param array $posterOptions An array of info about the person who made this post
* @return void
*/
public function postCreated(array &$msgOptions, array &$topicOptions, array &$posterOptions);
/**
* Callback when a post is modified
*
* @see modifyPost()
*
* @access public
* @param array $msgOptions An array of post data
* @param array $topicOptions An array of topic data
* @param array $posterOptions An array of info about the person who made this post
* @return void
*/
public function postModified(array &$msgOptions, array &$topicOptions, array &$posterOptions);
/**
* Callback when a post is removed
*
* @access public
* @param int $id_msg The ID of the post that was removed
* @return void
*/
public function postRemoved($id_msg);
/**
* Callback when a topic is removed
*
* @access public
* @param array $topics The ID(s) of the removed topic(s)
* @return void
*/
public function topicsRemoved(array $topics);
/**
* Callback when a topic is moved
*
* @access public
* @param array $topics The ID(s) of the moved topic(s)
* @param int $board_to The board that the topics were moved to
* @return void
*/
public function topicsMoved(array $topics, $board_to);
/**
* Callback for actually performing the search query
*
* @access public
* @param array $query_params An array of parameters for the query
* @param array $searchWords The words that were searched for
* @param array $excludedIndexWords Indexed words that should be excluded
* @param array $participants
* @param array $searchArray
* @return mixed
*/
public function searchQuery(array $query_params, array $searchWords, array $excludedIndexWords, array &$participants, array &$searchArray);
}
/**
* Class search_api
*/
abstract class search_api implements search_api_interface
{
/**
* @var string The maximum SMF version that this will work with.
*/
public $version_compatible = '2.1.999';
/**
* @var string The minimum SMF version that this will work with.
*/
public $min_smf_version = '2.1 RC1';
/**
* @var bool Whether or not it's supported
*/
public $is_supported = true;
/**
* {@inheritDoc}
*/
public function supportsMethod($methodName, $query_params = null)
{
switch ($methodName)
{
case 'postRemoved':
return true;
break;
// All other methods, too bad dunno you.
default:
return false;
break;
}
}
/**
* {@inheritDoc}
*/
public function isValid()
{
}
/**
* {@inheritDoc}
*/
public function searchSort($a, $b)
{
}
/**
* {@inheritDoc}
*/
public function prepareIndexes($word, array &$wordsSearch, array &$wordsExclude, $isExcluded)
{
}
/**
* {@inheritDoc}
*/
public function indexedWordQuery(array $words, array $search_data)
{
}
/**
* {@inheritDoc}
*/
public function postCreated(array &$msgOptions, array &$topicOptions, array &$posterOptions)
{
}
/**
* {@inheritDoc}
*/
public function postModified(array &$msgOptions, array &$topicOptions, array &$posterOptions)
{
}
/**
* {@inheritDoc}
*/
public function postRemoved($id_msg)
{
global $smcFunc;
$result = $smcFunc['db_query']('', '
SELECT DISTINCT id_search
FROM {db_prefix}log_search_results
WHERE id_msg = {int:id_msg}',
array(
'id_msg' => $id_msg,
)
);
$id_searchs = array();
while ($row = $smcFunc['db_fetch_assoc']($result))
$id_searchs[] = $row['id_search'];
if (count($id_searchs) < 1)
return;
$smcFunc['db_query']('', '
DELETE FROM {db_prefix}log_search_results
WHERE id_search in ({array_int:id_searchs})',
array(
'id_searchs' => $id_searchs,
)
);
$smcFunc['db_query']('', '
DELETE FROM {db_prefix}log_search_topics
WHERE id_search in ({array_int:id_searchs})',
array(
'id_searchs' => $id_searchs,
)
);
$smcFunc['db_query']('', '
DELETE FROM {db_prefix}log_search_messages
WHERE id_search in ({array_int:id_searchs})',
array(
'id_searchs' => $id_searchs,
)
);
}
/**
* {@inheritDoc}
*/
public function topicsRemoved(array $topics)
{
}
/**
* {@inheritDoc}
*/
public function topicsMoved(array $topics, $board_to)
{
}
/**
* {@inheritDoc}
*/
public function searchQuery(array $query_params, array $searchWords, array $excludedIndexWords, array &$participants, array &$searchArray)
{
}
}
?>