Mediawiki

Class for interacting with a MediaWiki server instance.

property-read Sites

MediaWiki API object for sites.

MediaWiki API object for pages.

MediaWiki API object for users.

MediaWiki API object for links.

MediaWiki API object for categories.

MediaWiki API object for images.

MediaWiki API object for search.

since

1.0

package

Joomla Framework

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry options = null, \Joomla\Mediawiki\Http client = null) : 
since

1.0

Arguments

options

Registry|nullMediaWiki options array.

client

Http|nullThe HTTP client object.

Response

mixed

__get

Magic method to lazily create API objects

__get( name) : \Joomla\Mediawiki\AbstractMediawikiObject
since

1.0

throws

InvalidArgumentException

Arguments

name

stringName of property to retrieve

Response

AbstractMediawikiObjectMediaWiki API object (users, reviews, etc).

getOption

Get an option from the Mediawiki instance.

getOption( key) : 
since

1.0

Arguments

key

stringThe name of the option to get.

Response

mixedThe option value.

setOption

Set an option for the Mediawiki instance.

setOption( key,  value) : \Joomla\Mediawiki\Mediawiki
since

1.0

Arguments

key

stringThe name of the option to set.

value

mixedThe option value to set.

Response

MediawikiThis object for method chaining.

Properties

sites

MediaWiki API object for Site.

since

1.0

Type(s)

Sites

pages

MediaWiki API object for pages.

since

1.0

Type(s)

Pages

users

MediaWiki API object for users.

since

1.0

Type(s)

Users

categories

MediaWiki API object for categories.

since

1.0

Type(s)

Categories

images

MediaWiki API object for images.

since

1.0

Type(s)

Images

options

Options for the MediaWiki object.

since

1.0

Type(s)

Registry

client

The HTTP client object to use in sending HTTP requests.

since

1.0

Type(s)

Http