Docs For Class JMediawikiSearch

Description

MediaWiki API Search class for the Joomla Platform.

since: 12.3

Located in /libraries/joomla/mediawiki/search.php (line 19)

JMediawikiObject
   |
   --JMediawikiSearch

Method Summary

object openSearch (string $search, [integer $limit = null], [array $namespace = null], [string $suggest = null], [string $format = null])

object search (string $srsearch, [array $srnamespace = null], [string $srwhat = null], [array $srinfo = null], [array $srprop = null], [boolean $srredirects = null], [integer $sroffest = null], [integer $srlimit = null])

Variables

Inherited Variables

Inherited from JMediawikiObject

JMediawikiObject::$client
JMediawikiObject::$options

Methods

openSearch (line 103)

Method to search the wiki using opensearch protocol.

since: 12.3
access: public

object openSearch (string $search, [integer $limit = null], [array $namespace = null], [string $suggest = null], [string $format = null])

string $search: Search string.
integer $limit: Maximum amount of results to return.
array $namespace: Namespaces to search.
string $suggest: Do nothing if $wgEnableOpenSearchSuggest is false.
string $format: Output format.

search (line 38)

Method to perform a full text search.

since: 12.3
access: public

object search (string $srsearch, [array $srnamespace = null], [string $srwhat = null], [array $srinfo = null], [array $srprop = null], [boolean $srredirects = null], [integer $sroffest = null], [integer $srlimit = null])

string $srsearch: Search for all page titles (or content) that has this value.
array $srnamespace: The namespace(s) to enumerate.
string $srwhat: Search inside the text or titles.
array $srinfo: What metadata to return.
array $srprop: What properties to return.
boolean $srredirects: Include redirect pages in the search.
integer $sroffest: Use this value to continue paging.
integer $srlimit: How many total pages to return.

Inherited Methods

Inherited From JMediawikiObject

JMediawikiObject::__construct()
JMediawikiObject::buildParameter()
JMediawikiObject::fetchUrl()
JMediawikiObject::validateResponse()