Référence de la classe JMediawikiUsers

Graphe d'héritage de JMediawikiUsers:

Fonctions membres publiques
	login ($lgname, $lgpassword, $lgdomain=null)
	logout ()
	getUserInfo (array $ususers, array $usprop=null)
	getCurrentUserInfo (array $uiprop=null)
	getUserContribs ($ucuser=null, $ucuserprefix=null, $uclimit=null, $ucstart=null, $ucend=null, $uccontinue=null, $ucdir=null, array $ucnamespace=null, array $ucprop=null, array $ucshow=null, $uctag=null, $uctoponly=null)
	blockUser ($user, $expiry=null, $reason=null, $anononly=null, $nocreate=null, $autoblock=null, $noemail=null, $hidename=null, $allowusertalk=null, $reblock=null, $watchuser=null)
	unBlockUserByName ($user, $reason=null)
	unBlockUserById ($id, $reason=null)
	assignGroup ($username, $add=null, $remove=null, $reason=null)
	emailUser ($target, $subject=null, $text=null, $ccme=null)
	getToken ($user, $intoken)
Fonctions membres publiques hérités de JMediawikiObject
	__construct (Registry $options=null, JMediawikiHttp $client=null)
	buildParameter (array $params)
	validateResponse ($response)

Membres hérités additionnels
Fonctions membres protégées hérités de JMediawikiObject
	fetchUrl ($path)
Attributs protégés hérités de JMediawikiObject
	$options
	$client

Description détaillée

MediaWiki API Users class for the Joomla Platform.

Depuis

3.1.4

Documentation des fonctions membres

assignGroup()

assignGroup	(		$username,
			$add = null,
			$remove = null,
			$reason = null
	)

Method to assign a user to a group.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $data, et $path.

blockUser()

blockUser	(		$user,
			$expiry = null,
			$reason = null,
			$anononly = null,
			$nocreate = null,
			$autoblock = null,
			$noemail = null,
			$hidename = null,
			$allowusertalk = null,
			$reblock = null,
			$watchuser = null
	)

Method to block a user.

Paramètres

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 email 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.

Renvoie

object

Depuis

3.1.4

Références $data, $path, et $user.

emailUser()

emailUser	(		$target,
			$subject = null,
			$text = null,
			$ccme = null
	)

Method to email a user.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $data, $path, $subject, $target, et $text.

getCurrentUserInfo()

getCurrentUserInfo

(

array

$uiprop = null

)

Method to get current user information.

Paramètres

array

$uiprop

What pieces of information to include.

Renvoie

object

Depuis

3.1.4

Références $path.

getToken()

getToken	(		$user,
			$intoken
	)

Method to get access token.

Paramètres

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

Renvoie

object

Depuis

3.1.4

Références $path, $user, et null.

getUserContribs()

getUserContribs	(		$ucuser = null,
			$ucuserprefix = null,
			$uclimit = null,
			$ucstart = null,
			$ucend = null,
			$uccontinue = null,
			$ucdir = null,
		array	$ucnamespace = null,
		array	$ucprop = null,
		array	$ucshow = null,
			$uctag = null,
			$uctoponly = null
	)

Method to get user contributions.

Paramètres

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

Renvoie

object

Depuis

3.1.4

Références $path.

getUserInfo()

getUserInfo	(	array	$ususers,
		array	$usprop = null
	)

Method to get user information.

Paramètres

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

Renvoie

object

Depuis

3.1.4

Références $path.

login()

login	(		$lgname,
			$lgpassword,
			$lgdomain = null
	)

Method to login and get authentication tokens.

Paramètres

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

Renvoie

object

Depuis

3.1.4

Références $path, et null.

logout()

logout

(

)

Method to logout and clear session data.

Renvoie

object

Depuis

3.1.4

Références $path.

unBlockUserById()

unBlockUserById	(		$id,
			$reason = null
	)

Method to unblock a user.

Paramètres

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

Renvoie

object

Depuis

3.1.4

Références $data, $id, et $path.

unBlockUserByName()

unBlockUserByName	(		$user,
			$reason = null
	)

Method to unblock a user.

Paramètres

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

Renvoie

object

Depuis

3.1.4

Références $data, $path, et $user.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• libraries/joomla/mediawiki/users.php