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

Inheritance diagram for UserRightsProxy:

[legend]

Collaboration diagram for UserRightsProxy:

[legend]

Public Member Functions

addGroup ( $group, $expiry=null)

Replaces User::addGroup()

equals (?UserIdentity $user)

Since: 1.32

Parameters

UserIdentity | null $user

Returns: bool

getGroupMemberships ()

Replaces User::getGroupMemberships()

getGroups ()

Replaces User::getUserGroups()

getId ( $wikiId=self::LOCAL)

getName ()

Same as User::getName()

getUserPage ()

Same as User::getUserPage()

getWikiId ()

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

invalidateCache ()

Replaces User::touchUser()

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.

removeGroup ( $group)

Replaces User::removeGroup()

saveSettings ()

setOption ( $option, $value)

Replaces User::setOption()

Public Member Functions inherited from MediaWiki\DAO\WikiAwareEntity

assertWiki ( $wikiId)

Throws if $wikiId is different from the return value of getWikiId().

Static Public Member Functions
static	getDB ( $dbDomain, $ignoreInvalidDB=false)
	Open a database connection to work on for the requested user.

static	newFromId ( $dbDomain, $id, $ignoreInvalidDB=false)
	Factory function; get a remote user entry by ID number.

static	newFromName ( $dbDomain, $name, $ignoreInvalidDB=false)
	Factory function; get a remote user entry by name.

static	validDatabase ( $dbDomain)
	Confirm the selected database name is a valid local interwiki database name.

static	whoIs ( $dbDomain, $id, $ignoreInvalidDB=false)
	Same as User::whoIs()

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	$db	Db connection
string	$dbDomain	Database name
string	$name	User name
int	$id	User 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.

◆ 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	$ignoreInvalidDB	If 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, and wfGetDB().

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

◆ getName()

UserRightsProxy::getName ( )

Same as User::getName()

Returns: string

Implements MediaWiki\User\UserIdentity.

Definition at line 194 of file UserRightsProxy.php.

◆ getUserPage()

UserRightsProxy::getUserPage ( )

Same as User::getUserPage()

Returns: Title

Definition at line 203 of file UserRightsProxy.php.

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

◆ invalidateCache()

UserRightsProxy::invalidateCache ( )

Replaces User::touchUser()

Definition at line 284 of file UserRightsProxy.php.

References User\purge().

◆ isAnon()

UserRightsProxy::isAnon ( )

Returns: bool

Definition at line 185 of file UserRightsProxy.php.

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

◆ newFromId()

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

static

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

Parameters

string	$dbDomain	Database name
int	$id	User ID
bool	$ignoreInvalidDB	If 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	$dbDomain	Database name
string	$name	User name
bool	$ignoreInvalidDB	If 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.

◆ 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 $dbDomain Database 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	$dbDomain	Database name
int	$id	User ID
bool	$ignoreInvalidDB	If 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

Definition at line 39 of file UserRightsProxy.php.

Referenced by __construct(), getDB(), newFromId(), newFromLookup(), newFromName(), validDatabase(), and whoIs().

◆ $id

int UserRightsProxy::$id

private

Definition at line 43 of file UserRightsProxy.php.

Referenced by __construct(), newFromId(), 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:

includes/user/UserRightsProxy.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addGroup()

◆ equals()

◆ getDB()

◆ getGroupMemberships()

◆ getGroups()

◆ getId()

◆ getName()

◆ getUserPage()

◆ getWikiId()

◆ invalidateCache()

◆ isAnon()

◆ isRegistered()

◆ newFromId()

◆ newFromLookup()

◆ newFromName()

◆ removeGroup()

◆ saveSettings()

◆ setOption()

◆ validDatabase()

◆ whoIs()

Member Data Documentation

◆ $db

◆ $dbDomain

◆ $id

◆ $name

◆ $newOptions

◆ $userGroupManager