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

Collaboration diagram for UserRightsProxy:

[legend]

Public Member Functions
	addGroup ( $group, $expiry=null)
	Replaces User::addGroup()

	getGroupMemberships ()
	Replaces User::getGroupMemberships()

	getGroups ()
	Replaces User::getUserGroups()

	getId ()

	getName ()
	Same as User::getName()

	getUserPage ()
	Same as User::getUserPage()

	invalidateCache ()
	Replaces User::touchUser()

	isAnon ()

	removeGroup ( $group)
	Replaces User::removeGroup()

	saveSettings ()

	setOption ( $option, $value)
	Replaces User::setOption()

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 32 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 54 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 233 of file UserRightsProxy.php.

References getId(), 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	$ignoreInvalidDB	If true, don't check if $dbDomain is in $wgLocalDatabases

Returns: IDatabase|null If invalid selection

Definition at line 159 of file UserRightsProxy.php.

References $dbDomain, DB_MASTER, and wfGetDB().

◆ getGroupMemberships()

UserRightsProxy::getGroupMemberships ( )

Replaces User::getGroupMemberships()

Returns: array

Since: 1.29

Definition at line 217 of file UserRightsProxy.php.

References getId(), and getName().

◆ getGroups()

UserRightsProxy::getGroups ( )

Replaces User::getUserGroups()

Returns: array

Definition at line 207 of file UserRightsProxy.php.

◆ getId()

UserRightsProxy::getId ( )

Returns: int

Definition at line 174 of file UserRightsProxy.php.

References $id.

Referenced by addGroup(), getGroupMemberships(), isAnon(), and removeGroup().

◆ getName()

UserRightsProxy::getName ( )

Same as User::getName()

Returns: string

Definition at line 190 of file UserRightsProxy.php.

References $dbDomain.

Referenced by addGroup(), getGroupMemberships(), getUserPage(), and removeGroup().

◆ getUserPage()

UserRightsProxy::getUserPage ( )

Same as User::getUserPage()

Returns: Title

Definition at line 199 of file UserRightsProxy.php.

References getName(), and NS_USER.

◆ invalidateCache()

UserRightsProxy::invalidateCache ( )

Replaces User::touchUser()

Definition at line 289 of file UserRightsProxy.php.

References $id, and User\purge().

Referenced by saveSettings().

◆ isAnon()

UserRightsProxy::isAnon ( )

Returns: bool

Definition at line 181 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	$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 101 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 124 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 113 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 250 of file UserRightsProxy.php.

References getId(), and getName().

◆ saveSettings()

UserRightsProxy::saveSettings ( )

Definition at line 268 of file UserRightsProxy.php.

References $id, and invalidateCache().

◆ setOption()

UserRightsProxy::setOption	(	$option,
		$value
	)

Replaces User::setOption()

Parameters

string	$option
mixed	$value

Definition at line 264 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 71 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 84 of file UserRightsProxy.php.

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

Referenced by UserrightsPage\fetchUser().

Member Data Documentation

◆ $db

IDatabase UserRightsProxy::$db

private

Definition at line 34 of file UserRightsProxy.php.

Referenced by __construct(), and newFromLookup().

◆ $dbDomain

string UserRightsProxy::$dbDomain

private

Definition at line 36 of file UserRightsProxy.php.

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

◆ $id

int UserRightsProxy::$id

private

Definition at line 40 of file UserRightsProxy.php.

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

◆ $name

string UserRightsProxy::$name

private

Definition at line 38 of file UserRightsProxy.php.

Referenced by __construct(), and newFromName().

◆ $newOptions

array UserRightsProxy::$newOptions

private

Definition at line 42 of file UserRightsProxy.php.

◆ $userGroupManager

UserGroupManager UserRightsProxy::$userGroupManager

private

Definition at line 44 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()

◆ getDB()

◆ getGroupMemberships()

◆ getGroups()

◆ getId()

◆ getName()

◆ getUserPage()

◆ invalidateCache()

◆ isAnon()

◆ newFromId()

◆ newFromLookup()

◆ newFromName()

◆ removeGroup()

◆ saveSettings()

◆ setOption()

◆ validDatabase()

◆ whoIs()

Member Data Documentation

◆ $db

◆ $dbDomain

◆ $id

◆ $name

◆ $newOptions

◆ $userGroupManager