Unofficial SMF API Documentation

./Sources/ManageSearchEngines.php

SearchEngines

function SearchEngines(): void

Entry point for this section.

Integration hooks
integrate_manage_search_engines

ManageSearchEngineSettings

function ManageSearchEngineSettings(bool $return_config = false): void|array

This is really just the settings page.

Type Parameter Description
bool $return_config Whether to return the config_vars array (used for admin search)
Integration hooks
integrate_modify_search_engine_settings
integrate_save_search_engine_settings

ViewSpiders

function ViewSpiders(): void

View a list of all the spiders we know about.

list_getSpiders

function list_getSpiders(int $start, int $items_per_page, string $sort): array

Callback function for createList()

Type Parameter Description
int $start The item to start with (for pagination purposes)
int $items_per_page The number of items to show per page
string $sort A string indicating how to sort the results

list_getNumSpiders

function list_getNumSpiders(): int

Callback function for createList()

EditSpider

function EditSpider(): void

Here we can add, and edit, spider info!

SpiderCheck

function SpiderCheck(): int

Do we think the current user is a spider?

logSpider

function logSpider(): void

Log the spider presence online.

consolidateSpiderStats

function consolidateSpiderStats(): void

This function takes any unprocessed hits and turns them into stats.

SpiderLogs

function SpiderLogs(): void

See what spiders have been up to.

list_getSpiderLogs

function list_getSpiderLogs(int $start, int $items_per_page, string $sort): array

Callback function for createList()

Type Parameter Description
int $start The item to start with (for pagination purposes)
int $items_per_page How many items to show per page
string $sort A string indicating how to sort the results

list_getNumSpiderLogs

function list_getNumSpiderLogs(): int

Callback function for createList()

SpiderStats

function SpiderStats(): void

Show the spider statistics.

list_getSpiderStats

function list_getSpiderStats(int $start, int $items_per_page, string $sort): array

Callback function for createList() Get a list of spider stats from the log_spider table

Type Parameter Description
int $start The item to start with (for pagination purposes)
int $items_per_page The number of items to show per page
string $sort A string indicating how to sort the results

list_getNumSpiderStats

function list_getNumSpiderStats(): int

Callback function for createList() Get the number of spider stat rows from the log spider stats table

recacheSpiderNames

function recacheSpiderNames(): void

Recache spider names?

Suggest an edit to this page on GitHub