UserRightsProxy Class Reference

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

List of all members.

Public Member Functions
	addGroup ($group)
	Replaces User::addUserGroup()
	getDBName ()
	Accessor for $this->database.
	getGroups ()
	Replaces User::getUserGroups()
	getId ()
	getName ()
	Same as User::getName()
	getUserPage ()
	Same as User::getUserPage()
	invalidateCache ()
	Replaces User::touchUser()
	isAnon ()
	removeGroup ($group)
	Replaces User::removeUserGroup()
	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)
	Constructor.
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 27 of file UserRightsProxy.php.

---

Constructor & Destructor Documentation

UserRightsProxy::__construct	(	$	db,
		$	database,
		$	name,
		$	id
	)		[private]

Constructor.

See also:

newFromId()

newFromName()

Parameters:

DatabaseBase	$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, array(), database, and name.

---

Member Function Documentation

UserRightsProxy::addGroup

(

$

group

)

Replaces User::addUserGroup()

Parameters:

string

$group

Definition at line 215 of file UserRightsProxy.php.

References array().

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:

DatabaseBase|null If invalid selection

Definition at line 150 of file UserRightsProxy.php.

References $wgDBname, array(), global, and wfGetDB().

Referenced by newFromLookup().

UserRightsProxy::getDBName

(

)

Accessor for $this->database.

Returns:

string Database name

Definition at line 52 of file UserRightsProxy.php.

References database.

UserRightsProxy::getGroups

(

)

Replaces User::getUserGroups()

Returns:

array

Definition at line 199 of file UserRightsProxy.php.

References $res, array(), and as.

UserRightsProxy::getId

(

)

Returns:

int

Definition at line 166 of file UserRightsProxy.php.

Referenced by isAnon().

UserRightsProxy::getName

(

)

Same as User::getName()

Returns:

string

Definition at line 182 of file UserRightsProxy.php.

References database, and name.

Referenced by getUserPage().

UserRightsProxy::getUserPage

(

)

Same as User::getUserPage()

Returns:

Title

Definition at line 191 of file UserRightsProxy.php.

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

UserRightsProxy::invalidateCache

(

)

Replaces User::touchUser()

Definition at line 266 of file UserRightsProxy.php.

References $key, $wgMemc, array(), database, global, and wfForeignMemcKey().

Referenced by saveSettings().

UserRightsProxy::isAnon

(

)

Returns:

bool

Definition at line 173 of file UserRightsProxy.php.

References getId().

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().

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

Parameters:

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

Returns:

null|UserRightsProxy

Definition at line 115 of file UserRightsProxy.php.

References $value, array(), getDB(), and global.

Referenced by newFromId(), and 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 $name, and newFromLookup().

Referenced by UserrightsPage\fetchUser().

UserRightsProxy::removeGroup

(

$

group

)

Replaces User::removeUserGroup()

Parameters:

string

$group

Definition at line 229 of file UserRightsProxy.php.

References array().

UserRightsProxy::saveSettings

(

)

Definition at line 247 of file UserRightsProxy.php.

References $value, array(), as, and invalidateCache().

UserRightsProxy::setOption	(	$	option,
		$	value
	)

Replaces User::setOption()

Parameters:

string	$option
mixed	$value

Definition at line 243 of file UserRightsProxy.php.

References $value.

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

Referenced by UserrightsPage\fetchUser().

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 $user, and newFromId().

Referenced by UserrightsPage\fetchUser().

---

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

• includes/UserRightsProxy.php