Docs For Class JMediawikiUsers

JMediawikiUsers

Description

MediaWiki API Users class for the Joomla Platform.

since: 12.3

Located in /libraries/joomla/mediawiki/users.php (line 19)

JMediawikiObject
   |
   --JMediawikiUsers

Method Summary

object assignGroup (string $username, [array $add = null], [array $remove = null], [string $reason = null])

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])

object emailUser (string $target, [string $subject = null], [string $text = null], [boolean $ccme = null])

object getCurrentUserInfo ([array $uiprop = null])

object getToken (string $user, string $intoken)

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])

object getUserInfo (array $ususers, [array $usprop = null])

object login (string $lgname, string $lgpassword, [string $lgdomain = null])

object logout ()

object unBlockUserByID (int $id, [string $reason = null])

object unBlockUserByName (string $user, [string $reason = null])

Variables

Inherited Variables

Inherited from JMediawikiObject

JMediawikiObject::$client
JMediawikiObject::$options

Methods

assignGroup (line 364)

Method to assign a user to a group.

since: 12.3
access: public

object assignGroup (string $username, [array $add = null], [array $remove = null], [string $reason = null])

string $username: User name.
array $add: Add the user to these groups.
array $remove: Remove the user from these groups.
string $reason: Reason for the change.

blockUser (line 258)

Method to block a user.

since: 12.3
access: public

string $user: Username, IP address or IP range you want to block.
string $expiry: Relative expiry time, Default: never.
string $reason: Reason for block (optional).
boolean $anononly: Block anonymous users only.
boolean $nocreate: Prevent account creation.
boolean $autoblock: Automatically block the last used IP address, and any subsequent IP addresses they try to login from.
boolean $noemail: Prevent user from sending e-mail through the wiki.
boolean $hidename: Hide the username from the block log.
boolean $allowusertalk: Allow the user to edit their own talk page.
boolean $reblock: If the user is already blocked, overwrite the existing block.
boolean $watchuser: Watch the user/IP's user and talk pages.

emailUser (line 399)

Method to email a user.

since: 12.3
access: public

object emailUser (string $target, [string $subject = null], [string $text = null], [boolean $ccme = null])

string $target: User to send email to.
string $subject: Subject header.
string $text: Mail body.
boolean $ccme: Send a copy of this mail to me.

getCurrentUserInfo (line 131)

Method to get current user information.

since: 12.3
access: public

object getCurrentUserInfo ([array $uiprop = null])

array $uiprop: What pieces of information to include.

getToken (line 432)

Method to get access token.

since: 12.3
access: public

object getToken (string $user, string $intoken)

string $user: The User to get token.
string $intoken: The type of token.

getUserContribs (line 167)

Method to get user contributions.

since: 12.3
access: public

string $ucuser: The users to retrieve contributions for.
string $ucuserprefix: Retrieve contibutions for all users whose names begin with this value.
integer $uclimit: The users to retrieve contributions for.
string $ucstart: The start timestamp to return from.
string $ucend: The end timestamp to return to.
boolean $uccontinue: When more results are available, use this to continue.
string $ucdir: In which direction to enumerate.
array $ucnamespace: Only list contributions in these namespaces.
array $ucprop: Include additional pieces of information.
array $ucshow: Show only items that meet this criteria.
string $uctag: Only list revisions tagged with this tag.
string $uctoponly: Only list changes which are the latest revision

getUserInfo (line 103)

Method to get user information.

since: 12.3
access: public

object getUserInfo (array $ususers, [array $usprop = null])

array $ususers: A list of users to obtain the same information for.
array $usprop: What pieces of information to include.

Method to login and get authentication tokens.

since: 12.3
access: public

object login (string $lgname, string $lgpassword, [string $lgdomain = null])

string $lgname: User Name.
string $lgpassword: Password.
string $lgdomain: Domain (optional).

logout (line 80)

Method to logout and clear session data.

since: 12.3
access: public

object logout ()

unBlockUserByID (line 330)

Method to unblock a user.

since: 12.3
access: public

object unBlockUserByID (int $id, [string $reason = null])

int $id: Username, IP address or IP range you want to unblock.
string $reason: Reason for unblock (optional).

unBlockUserByName (line 299)

Method to unblock a user.

since: 12.3
access: public

object unBlockUserByName (string $user, [string $reason = null])

string $user: Username, IP address or IP range you want to unblock.
string $reason: Reason for unblock (optional).

Inherited Methods

Inherited From JMediawikiObject

JMediawikiObject::__construct()
JMediawikiObject::buildParameter()
JMediawikiObject::fetchUrl()
JMediawikiObject::validateResponse()

Documentation generated on Tue, 19 Nov 2013 15:16:40 +0100 by phpDocumentor 1.4.3