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

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

	getDBName ()
	Accessor for $this->database.

	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 ( $database, $ignoreInvalidDB=false)
	Open a database connection to work on for the requested user.

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

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

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

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

Private Member Functions
	__construct ( $db, $database, $name, $id)

Static Private Member Functions
static	newFromLookup ( $database, $field, $value, $ignoreInvalidDB=false)

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,
		$database,
		$name,
		$id )

private

See also: newFromId(); newFromName()

Parameters

IDatabase	$db	Db connection
string	$database	Database name
string	$name	User name
int	$id	User ID

Definition at line 39 of file UserRightsProxy.php.

References $name.

Member Function Documentation

◆ addGroup()

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

Replaces User::addGroup()

Parameters

string	$group
string \| null	$expiry

Returns: bool

Definition at line 221 of file UserRightsProxy.php.

References wfTimestamp().

◆ getDB()

static UserRightsProxy::getDB	(		$database,
			$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	$database
bool	$ignoreInvalidDB	If true, don't check if $database is in $wgLocalDatabases

Returns: IDatabase|null If invalid selection

Definition at line 151 of file UserRightsProxy.php.

References $wgDBname, DB_MASTER, and wfGetDB().

Referenced by newFromLookup().

◆ getDBName()

UserRightsProxy::getDBName ( )

Accessor for $this->database.

Returns: string Database name

Definition at line 52 of file UserRightsProxy.php.

◆ getGroupMemberships()

UserRightsProxy::getGroupMemberships ( )

Replaces User::getGroupMemberships()

Returns: array

Since: 1.29

Definition at line 210 of file UserRightsProxy.php.

◆ getGroups()

UserRightsProxy::getGroups ( )

Replaces User::getUserGroups()

Returns: array

Definition at line 200 of file UserRightsProxy.php.

◆ getId()

UserRightsProxy::getId ( )

Returns: int

Definition at line 167 of file UserRightsProxy.php.

Referenced by isAnon().

◆ getName()

UserRightsProxy::getName ( )

Same as User::getName()

Returns: string

Definition at line 183 of file UserRightsProxy.php.

Referenced by getUserPage().

◆ getUserPage()

UserRightsProxy::getUserPage ( )

Same as User::getUserPage()

Returns: Title

Definition at line 192 of file UserRightsProxy.php.

References getName().

◆ invalidateCache()

UserRightsProxy::invalidateCache ( )

Replaces User::touchUser()

Definition at line 272 of file UserRightsProxy.php.

References User\purge().

Referenced by saveSettings().

◆ isAnon()

UserRightsProxy::isAnon ( )

Returns: bool

Definition at line 174 of file UserRightsProxy.php.

References getId().

◆ newFromId()

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

static

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

Parameters

string	$database	Database name
int	$id	User ID
bool	$ignoreInvalidDB	If true, don't check if $database is in $wgLocalDatabases

Returns: UserRightsProxy|null If doesn't exist

Definition at line 92 of file UserRightsProxy.php.

References newFromLookup().

Referenced by whoIs().

◆ newFromLookup()

static UserRightsProxy::newFromLookup	(	$database,
		$field,
		$value,
		$ignoreInvalidDB = false )

staticprivate

Parameters

string	$database
string	$field
string	$value
bool	$ignoreInvalidDB

Returns: null|UserRightsProxy

Definition at line 115 of file UserRightsProxy.php.

References $value, $wgSharedDB, $wgSharedTables, and getDB().

Referenced by newFromId(), and newFromName().

◆ newFromName()

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

static

Factory function; get a remote user entry by name.

Parameters

string	$database	Database name
string	$name	User name
bool	$ignoreInvalidDB	If true, don't check if $database is in $wgLocalDatabases

Returns: UserRightsProxy|null If doesn't exist

Definition at line 104 of file UserRightsProxy.php.

References newFromLookup().

Referenced by UserrightsPage\fetchUser().

◆ removeGroup()

UserRightsProxy::removeGroup ( $group )

Replaces User::removeGroup()

Parameters

string $group

Returns: bool

Definition at line 236 of file UserRightsProxy.php.

◆ saveSettings()

UserRightsProxy::saveSettings ( )

Definition at line 253 of file UserRightsProxy.php.

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

◆ setOption()

UserRightsProxy::setOption	(		$option,
			$value )

Replaces User::setOption()

Parameters

string	$option
mixed	$value

Definition at line 249 of file UserRightsProxy.php.

References $value.

◆ validDatabase()

static UserRightsProxy::validDatabase ( $database )

static

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

Parameters

string $database Database name

Returns: bool

Definition at line 62 of file UserRightsProxy.php.

References $wgLocalDatabases.

Referenced by UserrightsPage\fetchUser().

◆ whoIs()

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

static

Same as User::whoIs()

Parameters

string	$database	Database name
int	$id	User ID
bool	$ignoreInvalidDB	If true, don't check if $database is in $wgLocalDatabases

Returns: string User name or false if the user doesn't exist

Definition at line 75 of file UserRightsProxy.php.

References newFromId().

Referenced by UserrightsPage\fetchUser().

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

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addGroup()

◆ getDB()

◆ getDBName()

◆ getGroupMemberships()

◆ getGroups()

◆ getId()

◆ getName()

◆ getUserPage()

◆ invalidateCache()

◆ isAnon()

◆ newFromId()

◆ newFromLookup()

◆ newFromName()

◆ removeGroup()

◆ saveSettings()

◆ setOption()

◆ validDatabase()

◆ whoIs()