MediaWiki  master
UserRightsProxy Class Reference

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

Inheritance diagram for UserRightsProxy:
Collaboration diagram for UserRightsProxy:

Public Member Functions

 addGroup ( $group, $expiry=null)
 Replaces User::addGroup() More...
 
 equals (?UserIdentity $user)
 
Since
1.32
Parameters
UserIdentity | null$user
Returns
bool
More...
 
 getGroupMemberships ()
 Replaces User::getGroupMemberships() More...
 
 getGroups ()
 Replaces User::getUserGroups() More...
 
 getId ( $wikiId=self::LOCAL)
 
 getName ()
 Same as User::getName() More...
 
 getUserPage ()
 Same as User::getUserPage() More...
 
 getWikiId ()
 Returns the db Domain of the wiki the UserRightsProxy is associated with. More...
 
 invalidateCache ()
 Replaces User::touchUser() More...
 
 isAnon ()
 
 isRegistered ()
 
Since
1.34
Returns
bool True if user is registered on this wiki, i.e., has a user ID. False if user is anonymous or has no local account (which can happen when importing). This must be equivalent to getId() != 0 and is provided for code readability.
More...
 
 removeGroup ( $group)
 Replaces User::removeGroup() More...
 
 saveSettings ()
 
 setOption ( $option, $value)
 Replaces User::setOption() More...
 
- Public Member Functions inherited from MediaWiki\DAO\WikiAwareEntity
 assertWiki ( $wikiId)
 Throws if $wikiId is different from the return value of getWikiId(). 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
 
UserGroupManager $userGroupManager
 

Detailed Description

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

Definition at line 33 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 57 of file UserRightsProxy.php.

References $db, $dbDomain, $id, 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 232 of file UserRightsProxy.php.

◆ equals()

UserRightsProxy::equals ( ?UserIdentity  $user)

Since
1.32
Parameters
UserIdentity | null$user
Returns
bool

Implements MediaWiki\User\UserIdentity.

Definition at line 305 of file UserRightsProxy.php.

References MediaWiki\User\UserIdentity\getName(), and getName().

◆ 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 162 of file UserRightsProxy.php.

References $dbDomain, DB_PRIMARY, WikiMap\isCurrentWikiId(), and wfGetDB().

Referenced by newFromLookup().

◆ getGroupMemberships()

UserRightsProxy::getGroupMemberships ( )

Replaces User::getGroupMemberships()

Returns
UserGroupMembership[]
Since
1.29

Definition at line 221 of file UserRightsProxy.php.

◆ getGroups()

UserRightsProxy::getGroups ( )

Replaces User::getUserGroups()

Returns
string[]

Definition at line 211 of file UserRightsProxy.php.

◆ getId()

UserRightsProxy::getId (   $wikiId = self::LOCAL)
Parameters
string | false$wikiId
Returns
int

Implements MediaWiki\User\UserIdentity.

Definition at line 178 of file UserRightsProxy.php.

References $id.

Referenced by isRegistered().

◆ getName()

UserRightsProxy::getName ( )

Same as User::getName()

Returns
string

Implements MediaWiki\User\UserIdentity.

Definition at line 194 of file UserRightsProxy.php.

References $dbDomain.

Referenced by equals(), and getUserPage().

◆ getUserPage()

UserRightsProxy::getUserPage ( )

Same as User::getUserPage()

Returns
Title

Definition at line 203 of file UserRightsProxy.php.

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

◆ getWikiId()

UserRightsProxy::getWikiId ( )

Returns the db Domain of the wiki the UserRightsProxy is associated with.

Since
1.37
Returns
string

Implements MediaWiki\DAO\WikiAwareEntity.

Definition at line 325 of file UserRightsProxy.php.

References $dbDomain.

Referenced by isRegistered().

◆ invalidateCache()

UserRightsProxy::invalidateCache ( )

Replaces User::touchUser()

Definition at line 284 of file UserRightsProxy.php.

References $id, and User\purge().

Referenced by saveSettings().

◆ isAnon()

UserRightsProxy::isAnon ( )
Returns
bool

Definition at line 185 of file UserRightsProxy.php.

References isRegistered().

◆ isRegistered()

UserRightsProxy::isRegistered ( )

Since
1.34
Returns
bool True if user is registered on this wiki, i.e., has a user ID. False if user is anonymous or has no local account (which can happen when importing). This must be equivalent to getId() != 0 and is provided for code readability.

Implements MediaWiki\User\UserIdentity.

Definition at line 315 of file UserRightsProxy.php.

References getId(), and getWikiId().

Referenced by isAnon().

◆ 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 104 of file UserRightsProxy.php.

References $dbDomain, $id, and newFromLookup().

Referenced by whoIs().

◆ 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 127 of file UserRightsProxy.php.

References $db, $dbDomain, $wgSharedDB, $wgSharedTables, and getDB().

Referenced by newFromId(), and newFromName().

◆ 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 116 of file UserRightsProxy.php.

References $dbDomain, $name, and newFromLookup().

Referenced by UserrightsPage\fetchUser().

◆ removeGroup()

UserRightsProxy::removeGroup (   $group)

Replaces User::removeGroup()

Parameters
string$group
Returns
bool

Definition at line 247 of file UserRightsProxy.php.

◆ saveSettings()

UserRightsProxy::saveSettings ( )

Definition at line 263 of file UserRightsProxy.php.

References $id, and invalidateCache().

◆ setOption()

UserRightsProxy::setOption (   $option,
  $value 
)

Replaces User::setOption()

Parameters
string$option
mixed$value

Definition at line 259 of file UserRightsProxy.php.

◆ 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 74 of file UserRightsProxy.php.

References $dbDomain, and $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 87 of file UserRightsProxy.php.

References $dbDomain, $id, and newFromId().

Referenced by UserrightsPage\fetchUser().

Member Data Documentation

◆ $db

IDatabase UserRightsProxy::$db
private

Definition at line 37 of file UserRightsProxy.php.

Referenced by __construct(), and newFromLookup().

◆ $dbDomain

string UserRightsProxy::$dbDomain
private

◆ $id

int UserRightsProxy::$id
private

Definition at line 43 of file UserRightsProxy.php.

Referenced by __construct(), getId(), invalidateCache(), newFromId(), saveSettings(), and whoIs().

◆ $name

string UserRightsProxy::$name
private

Definition at line 41 of file UserRightsProxy.php.

Referenced by __construct(), and newFromName().

◆ $newOptions

array UserRightsProxy::$newOptions
private

Definition at line 45 of file UserRightsProxy.php.

◆ $userGroupManager

UserGroupManager UserRightsProxy::$userGroupManager
private

Definition at line 47 of file UserRightsProxy.php.


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