\JMediawikiUsers

MediaWiki API Users class for the Joomla Platform.

Synopsis

class JMediawikiUsers extends JMediawikiObject {

• // Inherited members from JMediawikiObject
• protected JRegistry  $options;
• protected JMediawikiHttp  $client;
• // methods
• public  login()
• public  logout()
• public  getUserInfo()
• public  getCurrentUserInfo()
• public  getUserContribs()
• public  blockUser()
• public  unBlockUserByName()
• public  unBlockUserByID()
• public  assignGroup()
• public  emailUser()
• public  getToken()
• // Inherited methods from JMediawikiObject
• public void __construct()
• protected string fetchUrl()
• public string buildParameter()
• public Object validateResponse()
}


Hierarchy

Extends

• JMediawikiObject

Tasks

Tasks

Line	Task
85	clear internal data as well
339	$data doesn't seem to be used!

Members

protected

• $client — JMediawikiHttp
• $options — JRegistry

Methods

public

• assignGroup() — Method to assign a user to a group.
• blockUser() — Method to block a user.
• emailUser() — Method to email a user.
• getCurrentUserInfo() — Method to get current user information.
• getToken() — Method to get access token.
• getUserContribs() — Method to get user contributions.
• getUserInfo() — Method to get user information.
• login() — Method to login and get authentication tokens.
• logout() — Method to logout and clear session data.
• unBlockUserByID() — Method to unblock a user.
• unBlockUserByName() — Method to unblock a user.

Inherited from JMediawikiObject

protected

• fetchUrl() — Method to build and return a full request URL for the request.

public

• buildParameter() — Method to build request parameters from a string array.
• validateResponse() — Method to validate response for errors