public
object
|
#
login( string $lgname, string $lgpassword, string $lgdomain = null )
Method to login and get authentication tokens.
Method to login and get authentication tokens.
Parameters
- $lgname
string - $lgname User Name.- $lgpassword
string - $lgpassword Password.- $lgdomain
string - $lgdomain Domain (optional). Returns
object
Since
12.3
|
public
object
|
#
logout( )
Method to logout and clear session data.
Method to logout and clear session data.
Returns
object
Since
12.3
|
public
object
|
#
getUserInfo( array $ususers, array $usprop = null )
Method to get user information.
Method to get user information.
Parameters
- $ususers
array - $ususers A list of users to obtain the same information for.- $usprop
array - $usprop What pieces of information to include. Returns
object
Since
12.3
|
public
object
|
#
getCurrentUserInfo( array $uiprop = null )
Method to get current user information.
Method to get current user information.
Parameters
- $uiprop
array - $uiprop What pieces of information to include. Returns
object
Since
12.3
|
public
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.
Method to get user contributions.
Parameters
- $ucuser
string - $ucuser The users to retrieve contributions for.- $ucuserprefix
string - $ucuserprefix Retrieve contibutions for all users whose names begin with this
value.- $uclimit
integer - $uclimit The users to retrieve contributions for.- $ucstart
string - $ucstart The start timestamp to return from.- $ucend
string - $ucend The end timestamp to return to.- $uccontinue
boolean - $uccontinue When more results are available, use this to continue.- $ucdir
string - $ucdir In which direction to enumerate.- $ucnamespace
array - $ucnamespace Only list contributions in these namespaces.- $ucprop
array - $ucprop Include additional pieces of information.- $ucshow
array - $ucshow Show only items that meet this criteria.- $uctag
string - $uctag Only list revisions tagged with this tag.- $uctoponly
string - $uctoponly Only list changes which are the latest revision Returns
object
Since
12.3
|
public
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.
Parameters
- $user
string - $user Username, IP address or IP range you want to block.- $expiry
string - $expiry Relative expiry time, Default: never.- $reason
string - $reason Reason for block (optional).- $anononly
boolean - $anononly Block anonymous users only.- $nocreate
boolean - $nocreate Prevent account creation.- $autoblock
boolean - $autoblock Automatically block the last used IP address, and any subsequent IP
addresses they try to login from.- $noemail
boolean - $noemail Prevent user from sending email through the wiki.- $hidename
boolean - $hidename Hide the username from the block log.- $allowusertalk
boolean - $allowusertalk Allow the user to edit their own talk page.- $reblock
boolean - $reblock If the user is already blocked, overwrite the existing block.- $watchuser
boolean - $watchuser Watch the user/IP's user and talk pages. Returns
object
Since
12.3
|
public
object
|
#
unBlockUserByName( string $user, string $reason = null )
Method to unblock a user.
Method to unblock a user.
Parameters
- $user
string - $user Username, IP address or IP range you want to unblock.- $reason
string - $reason Reason for unblock (optional). Returns
object
Since
12.3
|
public
object
|
#
unBlockUserById( integer $id, string $reason = null )
Method to unblock a user.
Method to unblock a user.
Parameters
- $id
integer - $id Username, IP address or IP range you want to unblock.- $reason
string - $reason Reason for unblock (optional). Returns
object
Since
12.3
|
public
object
|
#
assignGroup( string $username, array $add = null, array $remove = null, string $reason = null )
Method to assign a user to a group.
Method to assign a user to a group.
Parameters
- $username
string - $username User name.- $add
array - $add Add the user to these groups.- $remove
array - $remove Remove the user from these groups.- $reason
string - $reason Reason for the change. Returns
object
Since
12.3
|
public
object
|
#
emailUser( string $target, string $subject = null, string $text = null, boolean $ccme = null )
Method to email a user.
Parameters
- $target
string - $target User to send email to.- $subject
string - $subject Subject header.- $text
string - $text Mail body.- $ccme
boolean - $ccme Send a copy of this mail to me. Returns
object
Since
12.3
|
public
object
|
#
getToken( string $user, string $intoken )
Method to get access token.
Method to get access token.
Parameters
- $user
string - $user The User to get token.- $intoken
string - $intoken The type of token. Returns
object
Since
12.3
|
JMediawikiUsers