Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
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$usernameUser name.
array$addAdd the user to these groups.
array$removeRemove the user from these groups.
string$reasonReason 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$userUsername, IP address or IP range you want to block.
string$expiryRelative expiry time, Default: never.
string$reasonReason for block (optional).
boolean$anononlyBlock anonymous users only.
boolean$nocreatePrevent account creation.
boolean$autoblockAutomatically block the last used IP address, and any subsequent IP addresses they try to login from.
boolean$noemailPrevent user from sending email through the wiki.
boolean$hidenameHide the username from the block log.
boolean$allowusertalkAllow the user to edit their own talk page.
boolean$reblockIf the user is already blocked, overwrite the existing block.
boolean$watchuserWatch 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$targetUser to send email to.
string$subjectSubject header.
string$textMail body.
boolean$ccmeSend 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$uipropWhat 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$userThe User to get token.
string$intokenThe 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$ucuserThe users to retrieve contributions for.
string$ucuserprefixRetrieve contibutions for all users whose names begin with this value.
integer$uclimitThe users to retrieve contributions for.
string$ucstartThe start timestamp to return from.
string$ucendThe end timestamp to return to.
boolean$uccontinueWhen more results are available, use this to continue.
string$ucdirIn which direction to enumerate.
array$ucnamespaceOnly list contributions in these namespaces.
array$ucpropInclude additional pieces of information.
array$ucshowShow only items that meet this criteria.
string$uctagOnly list revisions tagged with this tag.
string$uctoponlyOnly 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$ususersA list of users to obtain the same information for.
array$uspropWhat 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$lgnameUser Name.
string$lgpasswordPassword.
string$lgdomainDomain (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$idUsername, IP address or IP range you want to unblock.
string$reasonReason 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$userUsername, IP address or IP range you want to unblock.
string$reasonReason 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 :