JMediawiki

class JMediawiki

Joomla Platform class for interacting with a Mediawiki server instance.

Methods

__construct( Registry $options = null, JMediawikiHttp $client = null)

Constructor.

JMediaWikiObject
__get( string $name)

Magic method to lazily create API objects

mixed
getOption( string $key)

Get an option from the JMediawiki instance.

JMediawiki
setOption( string $key, mixed $value)

Set an option for the JMediawiki instance.

Details

__construct( Registry $options = null, JMediawikiHttp $client = null)

Constructor.

Parameters

Registry $options MediaWiki options object.
JMediawikiHttp $client The HTTP client object.

JMediaWikiObject __get( string $name)

Magic method to lazily create API objects

Parameters

string $name Name of property to retrieve

Return Value

JMediaWikiObject MediaWiki API object (users, reviews, etc).

Exceptions

InvalidArgumentException

mixed getOption( string $key)

Get an option from the JMediawiki instance.

Parameters

string $key The name of the option to get.

Return Value

mixed The option value.

JMediawiki setOption( string $key, mixed $value)

Set an option for the JMediawiki instance.

Parameters

string $key The name of the option to set.
mixed $value The option value to set.

Return Value

JMediawiki This object for method chaining.