MediaWiki  REL1_22
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:
$dbDatabaseBase: db connection
string$databasedatabase name
string$nameuser name
$idInteger: user ID

Definition at line 39 of file UserRightsProxy.php.

References $name, array(), database, and name.


Member Function Documentation

Replaces User::addUserGroup()

Definition at line 203 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:
$databaseString
$ignoreInvalidDBBoolean: if true, don't check if $database is in $wgLocalDatabases
Returns:
DatabaseBase or null if invalid selection

Definition at line 139 of file UserRightsProxy.php.

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

Referenced by newFromLookup().

Accessor for $this->database.

Returns:
String: database name

Definition at line 52 of file UserRightsProxy.php.

References database.

Replaces User::getUserGroups()

Returns:
array

Definition at line 188 of file UserRightsProxy.php.

References $res, array(), and as.

Returns:
int

Definition at line 155 of file UserRightsProxy.php.

References id.

Referenced by isAnon().

Same as User::getName()

Returns:
String

Definition at line 171 of file UserRightsProxy.php.

References database, and name.

Referenced by getUserPage().

Same as User::getUserPage()

Returns:
Title object

Definition at line 180 of file UserRightsProxy.php.

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

Replaces User::touchUser()

Definition at line 251 of file UserRightsProxy.php.

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

Referenced by saveSettings().

Returns:
bool

Definition at line 162 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$databasedatabase name
$idInteger: user ID
$ignoreInvalidDBBoolean: if true, don't check if $database is in $wgLocalDatabases
Returns:
UserRightsProxy or 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:
$database
$field
$value
$ignoreInvalidDBbool
Returns:
null|UserRightsProxy

Definition at line 115 of file UserRightsProxy.php.

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

Referenced by newFromId(), and newFromName().

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

Factory function; get a remote user entry by name.

Parameters:
string$databasedatabase name
string$nameuser name
$ignoreInvalidDBBoolean: if true, don't check if $database is in $wgLocalDatabases
Returns:
UserRightsProxy or null if doesn't exist

Definition at line 104 of file UserRightsProxy.php.

References $name, and newFromLookup().

Referenced by UserrightsPage\fetchUser().

Replaces User::removeUserGroup()

Definition at line 216 of file UserRightsProxy.php.

References array().

Definition at line 232 of file UserRightsProxy.php.

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

UserRightsProxy::setOption ( option,
value 
)

Replaces User::setOption()

Definition at line 228 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$databasedatabase name
Returns:
Boolean

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$databasedatabase name
$idInteger: user ID
$ignoreInvalidDBBoolean: 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: