Docs For Class JMediawikiObject

JMediawikiObject

Description

MediaWiki API object class for the Joomla Platform.

abstract:
since: 12.3

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

Direct descendents

Class	Description
JMediawikiCategories	MediaWiki API Categories class for the Joomla Platform.
JMediawikiImages	MediaWiki API Images class for the Joomla Platform.
JMediawikiLinks	MediaWiki API Links class for the Joomla Platform.
JMediawikiPages	MediaWiki API Pages class for the Joomla Platform.
JMediawikiSearch	MediaWiki API Search class for the Joomla Platform.
JMediawikiSites	MediaWiki API Sites class for the Joomla Platform.
JMediawikiUsers	MediaWiki API Users class for the Joomla Platform.

Variable Summary

JMediawikiHttp $client

JRegistry $options

Method Summary

JMediawikiObject __construct ([JRegistry $options = null], [JMediawikiHttp $client = null])

string buildParameter (array $params)

string fetchUrl (string $path)

Object validateResponse (JHttpresponse $response)

Variables

JMediawikiHttp $client (line 32)

var: The HTTP client object to use in sending HTTP requests.
since: 12.3
access: protected

JRegistry $options (line 26)

var: Options for the MediaWiki object.
since: 12.3
access: protected

Methods

Constructor __construct (line 42)

Constructor.

since: 12.3
access: public

JMediawikiObject __construct ([JRegistry $options = null], [JMediawikiHttp $client = null])

JRegistry $options: Mediawiki options object.
JMediawikiHttp $client: The HTTP client object.

buildParameter (line 86)

Method to build request parameters from a string array.

return: request parameter
since: 12.3
access: public

string buildParameter (array $params)

array $params: string array that contains the parameters

fetchUrl (line 57)

Method to build and return a full request URL for the request.

return: The request URL.
since: 12.3
access: protected

string fetchUrl (string $path)

string $path: URL to inflect

validateResponse (line 112)

Method to validate response for errors

since: 12.3
access: public

Object validateResponse (JHttpresponse $response)

JHttpresponse $response: reponse from the mediawiki server

Documentation generated on Tue, 19 Nov 2013 15:09:42 +0100 by phpDocumentor 1.4.3