JMediawikiUsers
class JMediawikiUsers extends JMediawikiObject
MediaWiki API Users class for the Joomla Platform.
Methods
from JMediawikiObject
string
buildParameter(
array $params)
Method to build request parameters from a string array.
from JMediawikiObject
Object
validateResponse(
JHttpresponse $response)
Method to validate response for errors
from JMediawikiObject
object
login(
string $lgname,
string $lgpassword,
string $lgdomain = null)
Method to login and get authentication tokens.
object
logout()
Method to logout and clear session data.
object
getUserInfo(
array $ususers,
array $usprop = null)
Method to get user information.
object
getCurrentUserInfo(
array $uiprop = null)
Method to get current user information.
object
getUserContribs(
string $ucuser = null,
string $ucuserprefix = null,
integer $uclimit = null,
string $ucstart = null,
string $ucend = null,
boolean $uccontinue = null,
string $ucdir = null,
array $ucnamespace = null,
array $ucprop = null,
array $ucshow = null,
string $uctag = null,
string $uctoponly = null)
Method to get user contributions.
object
blockUser(
string $user,
string $expiry = null,
string $reason = null,
boolean $anononly = null,
boolean $nocreate = null,
boolean $autoblock = null,
boolean $noemail = null,
boolean $hidename = null,
boolean $allowusertalk = null,
boolean $reblock = null,
boolean $watchuser = null)
Method to block a user.
object
unBlockUserByName(
string $user,
string $reason = null)
Method to unblock a user.
object
unBlockUserById(
int $id,
string $reason = null)
Method to unblock a user.
object
assignGroup(
string $username,
array $add = null,
array $remove = null,
string $reason = null)
Method to assign a user to a group.
object
emailUser(
string $target,
string $subject = null,
string $text = null,
boolean $ccme = null)
Method to email a user.
object
getToken(
string $user,
string $intoken)
Method to get access token.
Details
object
login(
string $lgname,
string $lgpassword,
string $lgdomain = null)
Method to login and get authentication tokens.
object
getUserContribs(
string $ucuser = null,
string $ucuserprefix = null,
integer $uclimit = null,
string $ucstart = null,
string $ucend = null,
boolean $uccontinue = null,
string $ucdir = null,
array $ucnamespace = null,
array $ucprop = null,
array $ucshow = null,
string $uctag = null,
string $uctoponly = null)
Method to get user contributions.
object
blockUser(
string $user,
string $expiry = null,
string $reason = null,
boolean $anononly = null,
boolean $nocreate = null,
boolean $autoblock = null,
boolean $noemail = null,
boolean $hidename = null,
boolean $allowusertalk = null,
boolean $reblock = null,
boolean $watchuser = null)
Method to block a user.
object
assignGroup(
string $username,
array $add = null,
array $remove = null,
string $reason = null)
Method to assign a user to a group.