JMediawikiSearch
Extends \JMediawikiObjectMediaWiki API Search class for the Joomla Platform.
| since |
3.1.4 |
|---|---|
| package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JMediawikiHttp $client = null)
| since |
3.1.4 |
|---|
Arguments
- $options
\Joomla\Registry\RegistryMediawiki options object.- $client
\JMediawikiHttpThe HTTP client object.
buildParameter
Method to build request parameters from a string array.
buildParameter(array $params) : string
| since |
3.1.4 |
|---|
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 |
3.1.4 |
|---|
Arguments
- $path
stringURL to inflect
Response
stringThe request URL.
openSearch
Method to search the wiki using opensearch protocol.
openSearch(string $search, integer $limit = null, array $namespace = null, string $suggest = null, string $format = null) : object
| since |
3.1.4 |
|---|
Arguments
- $search
stringSearch string.- $limit
integerMaximum 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, boolean $srredirects = null, integer $sroffest = null, integer $srlimit = null) : object
| since |
3.1.4 |
|---|
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
booleanInclude redirect pages in the search.- $sroffest
integerUse this value to continue paging.- $srlimit
integerHow many total pages to return.
Response
object
validateResponse
Method to validate response for errors
validateResponse(\JHttpresponse $response) : Object
| since |
3.1.4 |
|---|---|
| throws |
|
Arguments
- $response
\JHttpresponsereponse from the mediawiki server
Response
Object
Properties
client
The HTTP client object to use in sending HTTP requests.