Search
Extends AbstractMediawikiObjectMediaWiki API Search class.
| since |
1.0 |
|---|---|
| package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Mediawiki\Http client = null) : mixed
| since |
1.0 |
|---|
Arguments
- options
\Joomla\Registry\RegistryMediawiki options object.- client
\Joomla\Mediawiki\HttpThe HTTP client object.
Response
mixed
buildParameter
Method to build request parameters from a string array.
buildParameter(array params) : string
| since |
1.0 |
|---|
Arguments
- params
arraystring array that contains the parameters
Response
stringrequest parameter
fetchUrl
Method to build and return a full request URL for the request.
fetchUrl(string path) : string
| since |
1.0 |
|---|
Arguments
- path
stringURL to inflect
Response
stringThe request URL.
openSearch
Method to search the wiki using opensearch protocol.
openSearch(string search, int limit = null, array namespace = null, string suggest = null, string format = null) : object
| since |
1.0 |
|---|
Arguments
- search
stringSearch string.- limit
intMaximum amount of results to return.- namespace
arrayNamespaces to search.- suggest
stringDo nothing if $wgEnableOpenSearchSuggest is false.- format
stringOutput format.
Response
object
search
Method to perform a full text search.
search(string srsearch, array srnamespace = null, string srwhat = null, array srinfo = null, array srprop = null, bool srredirects = null, int sroffest = null, int srlimit = null) : object
| since |
1.0 |
|---|
Arguments
- srsearch
stringSearch for all page titles (or content) that has this value.- srnamespace
arrayThe namespace(s) to enumerate.- srwhat
stringSearch inside the text or titles.- srinfo
arrayWhat metadata to return.- srprop
arrayWhat properties to return.- srredirects
boolInclude redirect pages in the search.- sroffest
intUse this value to continue paging.- srlimit
intHow many total pages to return.
Response
object
validateResponse
Method to validate response for errors
validateResponse(\Joomla\Http\Response response) : \SimpleXMLElement
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- response
\Joomla\Http\ResponseThe response from the mediawiki server.
Response
\SimpleXMLElement
Properties
options
Options for the Mediawiki object.
| since |
1.0 |
|---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
| since |
1.0 |
|---|
Type(s)
\Joomla\Mediawiki\Http