MediaWiki  master
UserRightsProxy Class Reference

Cut-down copy of User interface for local-interwiki-database user rights manipulation. More...

Collaboration diagram for UserRightsProxy:

Public Member Functions

 addGroup ( $group, $expiry=null)
 Replaces User::addGroup() More...
 
 getGroupMemberships ()
 Replaces User::getGroupMemberships() More...
 
 getGroups ()
 Replaces User::getUserGroups() More...
 
 getId ()
 
 getName ()
 Same as User::getName() More...
 
 getUserPage ()
 Same as User::getUserPage() More...
 
 invalidateCache ()
 Replaces User::touchUser() More...
 
 isAnon ()
 
 removeGroup ( $group)
 Replaces User::removeGroup() More...
 
 saveSettings ()
 
 setOption ( $option, $value)
 Replaces User::setOption() More...
 

Static Public Member Functions

static getDB ( $dbDomain, $ignoreInvalidDB=false)
 Open a database connection to work on for the requested user. More...
 
static newFromId ( $dbDomain, $id, $ignoreInvalidDB=false)
 Factory function; get a remote user entry by ID number. More...
 
static newFromName ( $dbDomain, $name, $ignoreInvalidDB=false)
 Factory function; get a remote user entry by name. More...
 
static validDatabase ( $dbDomain)
 Confirm the selected database name is a valid local interwiki database name. More...
 
static whoIs ( $dbDomain, $id, $ignoreInvalidDB=false)
 Same as User::whoIs() More...
 

Private Member Functions

 __construct ( $db, $dbDomain, $name, $id)
 

Static Private Member Functions

static newFromLookup ( $dbDomain, $field, $value, $ignoreInvalidDB=false)
 

Private Attributes

IDatabase $db
 
string $dbDomain
 
int $id
 
string $name
 
array $newOptions
 

Detailed Description

Cut-down copy of User interface for local-interwiki-database user rights manipulation.

Definition at line 29 of file UserRightsProxy.php.

Constructor & Destructor Documentation

◆ __construct()

UserRightsProxy::__construct (   $db,
  $dbDomain,
  $name,
  $id 
)
private
See also
newFromId()
newFromName()
Parameters
IDatabase$dbDb connection
string$dbDomainDatabase name
string$nameUser name
int$idUser ID

Definition at line 49 of file UserRightsProxy.php.

References $db, $dbDomain, $name, and name.

Member Function Documentation

◆ addGroup()

UserRightsProxy::addGroup (   $group,
  $expiry = null 
)

Replaces User::addGroup()

Parameters
string$group
string | null$expiry
Returns
bool

Definition at line 220 of file UserRightsProxy.php.

References wfTimestamp().

◆ getDB()

static UserRightsProxy::getDB (   $dbDomain,
  $ignoreInvalidDB = false 
)
static

Open a database connection to work on for the requested user.

This may be a new connection to another database for remote users.

Parameters
string$dbDomain
bool$ignoreInvalidDBIf true, don't check if $dbDomain is in $wgLocalDatabases
Returns
IDatabase|null If invalid selection

Definition at line 151 of file UserRightsProxy.php.

References DB_MASTER, WikiMap\isCurrentWikiId(), null, and wfGetDB().

◆ getGroupMemberships()

UserRightsProxy::getGroupMemberships ( )

Replaces User::getGroupMemberships()

Returns
array
Since
1.29

Definition at line 209 of file UserRightsProxy.php.

References UserGroupMembership\getMembershipsForUser().

◆ getGroups()

UserRightsProxy::getGroups ( )

Replaces User::getUserGroups()

Returns
array

Definition at line 199 of file UserRightsProxy.php.

◆ getId()

UserRightsProxy::getId ( )
Returns
int

Definition at line 166 of file UserRightsProxy.php.

References $id.

Referenced by isAnon().

◆ getName()

UserRightsProxy::getName ( )

Same as User::getName()

Returns
string

Definition at line 182 of file UserRightsProxy.php.

References $dbDomain, and name.

Referenced by getUserPage().

◆ getUserPage()

UserRightsProxy::getUserPage ( )

Same as User::getUserPage()

Returns
Title

Definition at line 191 of file UserRightsProxy.php.

References getName(), Title\makeTitle(), and NS_USER.

◆ invalidateCache()

UserRightsProxy::invalidateCache ( )

Replaces User::touchUser()

Definition at line 271 of file UserRightsProxy.php.

References $id, User\purge(), and use.

Referenced by saveSettings().

◆ isAnon()

UserRightsProxy::isAnon ( )
Returns
bool

Definition at line 173 of file UserRightsProxy.php.

References getId().

◆ newFromId()

static UserRightsProxy::newFromId (   $dbDomain,
  $id,
  $ignoreInvalidDB = false 
)
static

Factory function; get a remote user entry by ID number.

Parameters
string$dbDomainDatabase name
int$idUser ID
bool$ignoreInvalidDBIf true, don't check if $dbDomain is in $wgLocalDatabases
Returns
UserRightsProxy|null If doesn't exist

Definition at line 93 of file UserRightsProxy.php.

◆ newFromLookup()

static UserRightsProxy::newFromLookup (   $dbDomain,
  $field,
  $value,
  $ignoreInvalidDB = false 
)
staticprivate
Parameters
string$dbDomain
string$field
string$value
bool$ignoreInvalidDB
Returns
null|UserRightsProxy

Definition at line 116 of file UserRightsProxy.php.

References $value, $wgSharedDB, $wgSharedTables, and null.

◆ newFromName()

static UserRightsProxy::newFromName (   $dbDomain,
  $name,
  $ignoreInvalidDB = false 
)
static

Factory function; get a remote user entry by name.

Parameters
string$dbDomainDatabase name
string$nameUser name
bool$ignoreInvalidDBIf true, don't check if $dbDomain is in $wgLocalDatabases
Returns
UserRightsProxy|null If doesn't exist

Definition at line 105 of file UserRightsProxy.php.

Referenced by UserrightsPage\fetchUser().

◆ removeGroup()

UserRightsProxy::removeGroup (   $group)

Replaces User::removeGroup()

Parameters
string$group
Returns
bool

Definition at line 235 of file UserRightsProxy.php.

References UserGroupMembership\getMembership().

◆ saveSettings()

UserRightsProxy::saveSettings ( )

Definition at line 252 of file UserRightsProxy.php.

References $id, $rows, $value, as, and invalidateCache().

◆ setOption()

UserRightsProxy::setOption (   $option,
  $value 
)

Replaces User::setOption()

Parameters
string$option
mixed$value

Definition at line 248 of file UserRightsProxy.php.

References $value.

◆ validDatabase()

static UserRightsProxy::validDatabase (   $dbDomain)
static

Confirm the selected database name is a valid local interwiki database name.

Parameters
string$dbDomainDatabase name
Returns
bool

Definition at line 63 of file UserRightsProxy.php.

References $wgLocalDatabases.

Referenced by UserrightsPage\fetchUser().

◆ whoIs()

static UserRightsProxy::whoIs (   $dbDomain,
  $id,
  $ignoreInvalidDB = false 
)
static

Same as User::whoIs()

Parameters
string$dbDomainDatabase name
int$idUser ID
bool$ignoreInvalidDBIf true, don't check if $dbDomain is in $wgLocalDatabases
Returns
string User name or false if the user doesn't exist

Definition at line 76 of file UserRightsProxy.php.

References $user.

Referenced by UserrightsPage\fetchUser().

Member Data Documentation

◆ $db

IDatabase UserRightsProxy::$db
private

Definition at line 31 of file UserRightsProxy.php.

Referenced by __construct().

◆ $dbDomain

string UserRightsProxy::$dbDomain
private

Definition at line 33 of file UserRightsProxy.php.

Referenced by __construct(), and getName().

◆ $id

int UserRightsProxy::$id
private

Definition at line 37 of file UserRightsProxy.php.

Referenced by getId(), invalidateCache(), and saveSettings().

◆ $name

string UserRightsProxy::$name
private

Definition at line 35 of file UserRightsProxy.php.

Referenced by __construct().

◆ $newOptions

array UserRightsProxy::$newOptions
private

Definition at line 39 of file UserRightsProxy.php.


The documentation for this class was generated from the following file: