PHPXRef 0.7.1 : MediaWiki-1.24.0 : Detail view of UserRightsProxy.php

[Source view] [Print] [Project Stats]

Representation of an user on a other locally-hosted wiki. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size:	276 lines (7 kb)
Included or required:	0 times
Referenced:	1 time
Includes or requires:	0 files

Defines 1 class

UserRightsProxy:: (18 methods):
  __construct()
  getDBName()
  validDatabase()
  whoIs()
  newFromId()
  newFromName()
  newFromLookup()
  getDB()
  getId()
  isAnon()
  getName()
  getUserPage()
  getGroups()
  addGroup()
  removeGroup()
  setOption()
  saveSettings()
  invalidateCache()

Class: UserRightsProxy - X-Ref

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

__construct( $db, $database, $name, $id ) X-Ref

Constructor.

param: DatabaseBase $db Db connection
param: string $database Database name
param: string $name User name
param: int $id User ID

getDBName() X-Ref

Accessor for $this->database

return: string Database name

validDatabase( $database ) X-Ref

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

param: string $database Database name
return: bool

whoIs( $database, $id, $ignoreInvalidDB = false ) X-Ref

Same as User::whoIs()

param: string $database Database name
param: int $id User ID
param: bool $ignoreInvalidDB If true, don't check if $database is in $wgLocalDatabases
return: string User name or false if the user doesn't exist

newFromId( $database, $id, $ignoreInvalidDB = false ) X-Ref

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

param: string $database Database name
param: int $id User ID
param: bool $ignoreInvalidDB If true, don't check if $database is in $wgLocalDatabases
return: UserRightsProxy|null If doesn't exist

newFromName( $database, $name, $ignoreInvalidDB = false ) X-Ref

Factory function; get a remote user entry by name.

param: string $database Database name
param: string $name User name
param: bool $ignoreInvalidDB If true, don't check if $database is in $wgLocalDatabases
return: UserRightsProxy|null If doesn't exist

newFromLookup( $database, $field, $value, $ignoreInvalidDB = false ) X-Ref

param: string $database
param: string $field
param: string $value
param: bool $ignoreInvalidDB
return: null|UserRightsProxy

getDB( $database, $ignoreInvalidDB = false ) X-Ref

Open a database connection to work on for the requested user.
This may be a new connection to another database for remote users.

param: string $database
param: bool $ignoreInvalidDB If true, don't check if $database is in $wgLocalDatabases
return: DatabaseBase|null If invalid selection

getId() X-Ref

return: int

isAnon() X-Ref

return: bool

getName() X-Ref

Same as User::getName()

return: string

getUserPage() X-Ref

Same as User::getUserPage()

return: Title

getGroups() X-Ref

Replaces User::getUserGroups()

return: array

addGroup( $group ) X-Ref

Replaces User::addUserGroup()

param: string $group