JMediawiki

Joomla Platform class for interacting with a Mediawiki server instance.

property-read

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

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.

__get

Magic method to lazily create API objects

__get(string $name) : \JMediaWikiObject
since

3.1.4

throws

\InvalidArgumentException

Arguments

$name

stringName of property to retrieve

Response

\JMediaWikiObjectMediaWiki API object (users, reviews, etc).

getOption

Get an option from the JMediawiki instance.

getOption(string $key) : mixed
since

3.1.4

Arguments

$key

stringThe name of the option to get.

Response

mixedThe option value.

setOption

Set an option for the JMediawiki instance.

setOption(string $key, mixed $value) : \JMediawiki
since

3.1.4

Arguments

$key

stringThe name of the option to set.

$value

mixedThe option value to set.

Response

\JMediawikiThis object for method chaining.

Properties

options

Options for the MediaWiki object.

since

3.0.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

since

3.1.4

Type(s)

\JMediawikiHttp

sites

MediaWiki API object for Site.

since

3.1.4

Type(s)

\JMediawikiSites

pages

MediaWiki API object for pages.

since

3.0.0

Type(s)

\JMediawikiPages

users

MediaWiki API object for users.

since

3.1.4

Type(s)

\JMediawikiUsers

categories

MediaWiki API object for categories.

since

3.1.4

Type(s)

\JMediawikiCategories

images

MediaWiki API object for images.

since

3.1.4

Type(s)

\JMediawikiImages

sites

MediaWiki API object for sites.

Type(s)

\JMediawikiSites

pages

MediaWiki API object for pages.

Type(s)

\JMediawikiPages

users

MediaWiki API object for users.

Type(s)

\JMediawikiUsers

categories

MediaWiki API object for categories.

Type(s)

\JMediawikiCategories

images

MediaWiki API object for images.

Type(s)

\JMediawikiImages