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(array options = null, \Joomla\Mediawiki\Http client = null) : mixed
| since |
1.0 |
|---|
Arguments
- options
arrayMediaWiki options array.- client
\Joomla\Mediawiki\HttpThe HTTP client object.
Response
mixed
__get
Magic method to lazily create API objects
__get(string name) : \Joomla\Mediawiki\AbstractMediawikiObject
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- name
stringName of property to retrieve
Response
\Joomla\Mediawiki\AbstractMediawikiObjectMediaWiki API object (users, reviews, etc).
getOption
Get an option from the Mediawiki instance.
getOption(string key) : mixed
| 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(string key, mixed value) : \Joomla\Mediawiki\Mediawiki
| since |
1.0 |
|---|
Arguments
- key
stringThe name of the option to set.- value
mixedThe option value to set.
Response
\Joomla\Mediawiki\MediawikiThis object for method chaining.
Properties
options
Options for the MediaWiki object.
| since |
1.0 |
|---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
| since |
1.0 |
|---|
Type(s)
\Joomla\Mediawiki\Http
sites
MediaWiki API object for Site.
| since |
1.0 |
|---|
Type(s)
\Joomla\Mediawiki\Sites
pages
MediaWiki API object for pages.
| since |
1.0 |
|---|
Type(s)
\Joomla\Mediawiki\Pages
users
MediaWiki API object for users.
| since |
1.0 |
|---|
Type(s)
\Joomla\Mediawiki\Users
links
MediaWiki API object for links.
| since |
1.0 |
|---|
Type(s)
\Joomla\Mediawiki\Links
categories
MediaWiki API object for categories.
| since |
1.0 |
|---|
Type(s)
\Joomla\Mediawiki\Categories
images
MediaWiki API object for images.
| since |
1.0 |
|---|
Type(s)
\Joomla\Mediawiki\Images
search
MediaWiki API object for search.
| since |
1.0 |
|---|
Type(s)
\Joomla\Mediawiki\Search
sites
MediaWiki API object for sites.
Type(s)
\Joomla\Mediawiki\Sites
pages
MediaWiki API object for pages.
Type(s)
\Joomla\Mediawiki\Pages
users
MediaWiki API object for users.
Type(s)
\Joomla\Mediawiki\Users
links
MediaWiki API object for links.
Type(s)
\Joomla\Mediawiki\Links
categories
MediaWiki API object for categories.
Type(s)
\Joomla\Mediawiki\Categories
images
MediaWiki API object for images.
Type(s)
\Joomla\Mediawiki\Images
search
MediaWiki API object for search.
Type(s)
\Joomla\Mediawiki\Search