Class JMediawiki

Joomla Platform class for interacting with a Mediawiki server instance.

Package: Joomla\Platform\MediaWiki
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Located at joomla/mediawiki/mediawiki.php

Methods summary

`public`	# `__construct( Joomla\Registry\Registry $options = null, JMediawikiHttp $client = null )` Constructor. Constructor. Parameters `$options` `Joomla\Registry\Registry` - $options MediaWiki options object. `$client` `JMediawikiHttp` - $client The HTTP client object. Since 12.3
`public JMediaWikiObject`	# `__get( string $name )` Magic method to lazily create API objects Magic method to lazily create API objects Parameters `$name` `string` - $name Name of property to retrieve Returns `JMediaWikiObject` - MediaWiki API object (users, reviews, etc). Throws `InvalidArgumentException` Since 12.3
`public mixed`	# `getOption( string $key )` Get an option from the JMediawiki instance. Get an option from the JMediawiki instance. Parameters `$key` `string` - $key The name of the option to get. Returns `mixed` - The option value. Since 12.3
`public JMediawiki`	# `setOption( string $key, mixed $value )` Set an option for the JMediawiki instance. Set an option for the JMediawiki instance. Parameters `$key` `string` - $key The name of the option to set. `$value` `mixed` - $value The option value to set. Returns `JMediawiki` - This object for method chaining. Since 12.3

`protected Joomla\Registry\Registry`	`$options`	# Options for the MediaWiki object. Options for the MediaWiki object. Since 12.1
`protected JMediawikiHttp`	`$client`	# The HTTP client object to use in sending HTTP requests. The HTTP client object to use in sending HTTP requests. Since 12.3
`protected JMediawikiSites`	`$sites`	# MediaWiki API object for Site. MediaWiki API object for Site. Since 12.3
`protected JMediawikiPages`	`$pages`	# MediaWiki API object for pages. MediaWiki API object for pages. Since 12.1
`protected JMediawikiUsers`	`$users`	# MediaWiki API object for users. MediaWiki API object for users. Since 12.3
`protected JMediawikiLinks`	`$links`	# MediaWiki API object for links. MediaWiki API object for links. Since 12.3
`protected JMediawikiCategories`	`$categories`	# MediaWiki API object for categories. MediaWiki API object for categories. Since 12.3
`protected JMediawikiImages`	`$images`	# MediaWiki API object for images. MediaWiki API object for images. Since 12.3
`protected JMediawikiSearch`	`$search`	# MediaWiki API object for search. MediaWiki API object for search. Since 12.1

`public read-only JMediawikiSites`	`$sites`	# MediaWiki API object for sites. MediaWiki API object for sites.
`public read-only JMediawikiPages`	`$pages`	# MediaWiki API object for pages. MediaWiki API object for pages.
`public read-only JMediawikiUsers`	`$users`	# MediaWiki API object for users. MediaWiki API object for users.
`public read-only JMediawikiLinks`	`$links`	# MediaWiki API object for links. MediaWiki API object for links.
`public read-only JMediawikiCategories`	`$categories`	# MediaWiki API object for categories. MediaWiki API object for categories.
`public read-only JMediawikiImages`	`$images`	# MediaWiki API object for images. MediaWiki API object for images.
`public read-only JMediawikiSearch`	`$search`	# MediaWiki API object for search. MediaWiki API object for search.