vBulletin 5.6.5 API

vB_Api_Search extends vB_Api

in package

• vBApi

vB_Api_Search

Tags

access

public

Table of Contents

FILTER_CHANNELAGE  = 'channelAge'

FILTER_DATEALL  = 'all'

FILTER_FOLLOW  = 'follow'

FILTER_FOLLOWING_ALL  = 'followAll'

FILTER_FOLLOWING_BOTH  = 'followBoth'

FILTER_FOLLOWING_CHANNEL  = 'followChannel'

FILTER_FOLLOWING_CONTENT  = 'followContent'

FILTER_FOLLOWING_USERS  = 'followMembers'

FILTER_LASTDAY  = 'lastDay'

FILTER_LASTMONTH  = 'lastMonth'

FILTER_LASTVISIT  = 'lastVisit'

FILTER_LASTWEEK  = 'lastWeek'

FILTER_LASTYEAR  = 'lastYear'

FILTER_MARKED_READ  = 'read'

FILTER_MARKED_UNREAD  = 'unread'

FILTER_SHOW_EVENT  = 'vBForum_Event'

FILTER_SHOW_GALLERY  = 'vBForum_Gallery'

FILTER_SHOW_LINK  = 'vBForum_Link'

FILTER_SHOW_POLL  = 'vBForum_Poll'

FILTER_SHOW_TEXT  = 'vBForum_Text'

FILTER_SHOW_VIDEO  = 'vBForum_Video'

FILTER_STARTER_ONLY  = 'starter_only'

FILTER_TOPICAGE  = 'topicAge'

FILTER_VIEW_ACTIVITY  = 'activity'

FILTER_VIEW_CONVERSATION_STREAM  = 'conversation_stream'

FILTER_VIEW_CONVERSATION_THREAD  = 'conversation_thread'

FILTER_VIEW_CONVERSATION_THREAD_SEARCH  = 'conversation_thread_search'

FILTER_VIEW_TOPIC  = 'topic'

IGNORE_CACHE  = alse

SEARCH_TYPE_SYSTEM  = 0

SEARCH_TYPE_USER  = 1

$cache_ttl_sec  : mixed

$channelCache  : mixed

$controller  : string

API Controller

$criteria  : mixed

$db  : vB_Database

Database object.

$disabled  : bool

Indicates whether the API was disabled

$disableFalseReturnOnly  : array<string|int, mixed>

Contains white listed methods which return a false response when API is disabled in special scenarios like forum closed, password expiry, ip ban and others.

$disableWhiteList  : array<string|int, mixed>

Contains white listed methods which act as normal when API is disabled no matter of special scenarios like forum closed, password expiry, ip ban and others.

$search_json  : mixed

$showFilterList  : mixed

$allbadwords  : mixed

$badwords  : mixed

$goodwords  : mixed

$instances  : mixed

$instancesRaw  : array<string|int, mixed>

We want API subclasses to access the instances only through getters

$vb4_input_mappings  : mixed

$wrappers  : mixed

__serialize()  : mixed

__sleep()  : mixed

__unserialize()  : mixed

__wakeup()  : mixed

callNamed()  : The

Call the given api function by name with a named arguments list.

checkApiState()  : mixed

This method checks whether the API method is enabled.

clearCache()  : mixed

Clears all previously loaded API objects.

get_all_bad_words()  : mixed

get_bad_words()  : mixed

get_good_words()  : mixed

getApiClassName()  : mixed

getCacheTTL()  : int

Returns the cache ttl in seconds

getChannels()  : array<string|int, mixed>

Returns the Channel structure

getChannelTopics()  : array<string|int, mixed>

Very similar to getInitialResults(), but meant for use by channeldisplay template & activity/get requests.

getForumChannels()  : mixed

getInfo()  : mixed

getInitialNodes()  : array<string|int, mixed>

Search for nodeids and returns the resultid as well as the page value

getInitialResults()  : array<string|int, mixed>

Search for nodes and returns the resultid as well as the page value

getMoreNodes()  : array<string|int, mixed>

Get the node_ids from a search resultId

getMoreResults()  : array<string|int, mixed>

Get the nodes from a search resultId

getPageNumber()  : int

Get the page number where the specified node is at on the node list.

getSearchableContentTypes()  : mixed

getSearchResult()  : int

Search for nodes

instance()  : vB_Api

Returns an instance of the API object which translates exceptions to an array Use this method for API clients.

instanceInternal()  : vB_Api

Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API

is_index_word()  : mixed

map_vb4_input_to_vb5()  : string

Returns vb5 api method name.

map_vb5_errors_to_vb4()  : mixed

Alters the error array in any way necessary to interface correctly with vb4.

map_vb5_output_to_vb4()  : mixed

Alters the output array in any way necessary to interface correctly with vb4.

__construct()  : mixed

checkHasAdminPermission()  : none

Determines if the calling user has the given admin permission, and if not throws an exception

checkHasPermission()  : none

Determines if the calling user has the given bitfield permission, and if not, throws a 'no_permission' exception.

checkIsLoggedIn()  : mixed

Determines if the calling user has the given admin permission, and if not throws an exception

getApiClass()  : mixed

getApiClassNameInternal()  : mixed

getChannelFromTree()  : mixed

This takes the channel tree produced by getChannels, finds the specified channel recursively, then returns that channel's sub tree. Used internally by getChannels.

getSearchResultsCriteria()  : int

Search for nodes

hasAdminPermission()  : bool

Determines if the calling user has the given admin permission

inDebugMode()  : mixed

isDisableFalseReturnOnly()  : bool

Checks if method returns false response only when API is disabled.

isWhiteListed()  : bool

Checks if method is white listed when API is disabled.

setController()  : mixed

Set controller

cms_vb4_to_vb5_method_mapping()  : mixed

computeDateLine()  : mixed

default_vb4_to_vb5_method_mapping()  : mixed

doFullCountQueryForTopics()  : mixed

flattenTree()  : mixed

getChannelTopicCount()  : mixed

getIgnoredUsersList()  : mixed

hasAdminPermissionInternal()  : mixed

Internal function to power the previous cover functions

json2criteria()  : mixed

remove_nulls()  : mixed

wrapLoggerIfNeeded()  : mixed

Wrap the api object with the log wrapper class if needed.

@param string|array $adminPermission The admin permission to check.  If an array