Docs For Class JMediawiki

JMediawiki

Description

Joomla Platform class for interacting with a Mediawiki server instance.

property-read: JMediawikiSites $sites: MediaWiki API object for sites.
property-read: JMediawikiPages $pages: MediaWiki API object for pages.
property-read: JMediawikiUsers $users: MediaWiki API object for users.
property-read: JMediawikiLinks $links: MediaWiki API object for links.
property-read: JMediawikiCategories $categories: MediaWiki API object for categories.
property-read: JMediawikiImages $images: MediaWiki API object for images.
property-read: JMediawikiSearch $search: MediaWiki API object for search.
since: 12.3

Located in /libraries/joomla/mediawiki/mediawiki.php (line 27)

Variable Summary

JMediawikiCategories $categories

JMediawikiHttp $client

JMediawikiImages $images

JMediawikiLinks $links

JRegistry $options

JMediawikiPages $pages

JMediawikiSearch $search

JMediawikiSites $sites

JMediawikiUsers $users

Method Summary

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

mixed getOption (string $key)

JMediawiki setOption (string $key, mixed $value)

JMediaWikiObject __get (string $name)

Variables

JMediawikiCategories $categories (line 69)

var: MediaWiki API object for categories.
since: 12.3
access: protected

JMediawikiHttp $client (line 39)

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

JMediawikiImages $images (line 75)

var: MediaWiki API object for images.
since: 12.3
access: protected

JMediawikiLinks $links (line 63)

var: MediaWiki API object for links.
since: 12.3
access: protected

JRegistry $options (line 33)

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

JMediawikiPages $pages (line 51)

var: MediaWiki API object for pages.
since: 12.1
access: protected

JMediawikiSearch $search (line 81)

var: MediaWiki API object for search.
since: 12.1
access: protected

JMediawikiSites $sites (line 45)

var: MediaWiki API object for Site.
since: 12.3
access: protected

JMediawikiUsers $users (line 57)

var: MediaWiki API object for users.
since: 12.3
access: protected

Methods

Constructor __construct (line 91)

Constructor.

since: 12.3
access: public

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

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

getOption (line 143)

Get an option from the JMediawiki instance.

return: The option value.
since: 12.3
access: public

mixed getOption (string $key)

string $key: The name of the option to get.

setOption (line 158)

Set an option for the JMediawiki instance.

return: This object for method chaining.
since: 12.3
access: public

JMediawiki setOption (string $key, mixed $value)

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

__get (line 107)

Magic method to lazily create API objects

return: MediaWiki API object (users, reviews, etc).
since: 12.3
throws: InvalidArgumentException
access: public

JMediaWikiObject __get (string $name)

string $name: Name of property to retrieve

Documentation generated on Tue, 19 Nov 2013 15:07:44 +0100 by phpDocumentor 1.4.3