MediaWiki REL1_28
|
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time). More...
Public Member Functions | |
__construct () | |
Lightweight constructor for an anonymous user. | |
__toString () | |
isSafeToLoad () | |
Test if it's safe to load this User object. | |
load ( $flags=self::READ_NORMAL) | |
Load the user table data for this object from the source given by mFrom. | |
loadFromId ( $flags=self::READ_NORMAL) | |
Load user table data, given mId has already been set. | |
Static Public Member Functions | |
static | purge ( $wikiId, $userId) |
Public Attributes | |
Block | $mBlock |
string | $mBlockedby |
string | $mEmail |
string | $mEmailAuthenticated |
$mFrom | |
String Initialization data source if mLoadedItems!==true. | |
array | $mGroups |
bool | $mHideName |
int | $mId |
Cache variables. | |
string | $mName |
array | $mOptions |
$mOptionsLoaded | |
Bool Whether the cache variables have been loaded. | |
string | $mRealName |
array | $mRights |
string | $mTouched |
TS_MW timestamp from the DB. | |
const | CHECK_USER_RIGHTS = true |
const | EDIT_TOKEN_SUFFIX = EDIT_TOKEN_SUFFIX |
Global constant made accessible as class constants so that autoloader magic can be used. | |
const | GETOPTIONS_EXCLUDE_DEFAULTS = 1 |
Exclude user options that are set to their default value. | |
const | IGNORE_USER_RIGHTS = false |
const | INVALID_TOKEN = '*** INVALID ***' |
@const string An invalid value for user_token | |
const | TOKEN_LENGTH = 32 |
@const int Number of characters in user_token field. | |
const | VERSION = 10 |
@const int Serialized record version. | |
Public Attributes inherited from IDBAccessObject | |
const | READ_LOCKING = 3 |
Constants for object loading bitfield flags (higher => higher QoS) | |
const | READ_NONE = -1 |
Static Public Attributes | |
static | $idCacheByName = [] |
Protected Member Functions | |
getCacheKey (WANObjectCache $cache) | |
loadFromCache () | |
Load user data from shared cache, given mId has already been set. | |
Protected Attributes | |
bool | $mAllowUsertalk |
string | $mBlockreason |
string | $mDatePreference |
int | $mEditCount |
array | $mEffectiveGroups |
string | $mEmailToken |
string | $mEmailTokenExpires |
array | $mFormerGroups |
Block | $mGlobalBlock |
string | $mHash |
array | $mImplicitGroups |
$mLoadedItems = [] | |
Array with already loaded items or true if all items have been loaded. | |
bool | $mLocked |
$mNewtalk | |
Lazy-initialized variables, invalidated with clearInstanceCache. | |
array | $mOptionOverrides |
string | $mQuickTouched |
TS_MW timestamp from cache. | |
string | $mRegistration |
string | $mToken |
integer | $queryFlagsUsed = self::READ_NORMAL |
User::READ_* constant bitfield used to load data. | |
Static Protected Attributes | |
static | $mAllRights = false |
String Cached results of getAllRights() | |
static | $mCacheVars |
Array of Strings List of member variables which are saved to the shared cache (memcached). | |
static | $mCoreRights |
Array of Strings Core rights. | |
Private Attributes | |
Block | $mBlockedFromCreateAccount = false |
WebRequest | $mRequest |
newFrom*() static factory methods | |
isValidPassword ( $password) | |
Is the input a valid password for this user? | |
getPasswordValidity ( $password) | |
Given unvalidated password input, return error message on failure. | |
checkPasswordValidity ( $password, $purpose='login') | |
Check if this is a valid password for this user. | |
loadDefaults ( $name=false) | |
Set cached properties to default. | |
isItemLoaded ( $item, $all='all') | |
Return whether an item has been loaded. | |
loadFromDatabase ( $flags=self::READ_LATEST) | |
Load user and user_group data from the database. | |
addAutopromoteOnceGroups ( $event) | |
Add the user to the group if he/she meets given criteria. | |
clearInstanceCache ( $reloadFrom=false) | |
Clear various cached data stored in this object. | |
isDnsBlacklisted ( $ip, $checkWhitelist=false) | |
Whether the given IP is in a DNS blacklist. | |
inDnsBlacklist ( $ip, $bases) | |
Whether the given IP is in a given DNS blacklist. | |
isPingLimitable () | |
Is this user subject to rate limiting? | |
pingLimiter ( $action='edit', $incrBy=1) | |
Primitive rate limits: enforce maximum actions per time period to put a brake on flooding. | |
isBlocked ( $bFromSlave=true) | |
Check if user is blocked. | |
getBlock ( $bFromSlave=true) | |
Get the block affecting the user, or null if the user is not blocked. | |
isBlockedFrom ( $title, $bFromSlave=false) | |
Check if user is blocked from editing a particular article. | |
blockedBy () | |
If user is blocked, return the name of the user who placed the block. | |
blockedFor () | |
If user is blocked, return the specified reason for the block. | |
getBlockId () | |
If user is blocked, return the ID for the block. | |
isBlockedGlobally ( $ip='') | |
Check if user is blocked on all wikis. | |
getGlobalBlock ( $ip='') | |
Check if user is blocked on all wikis. | |
isLocked () | |
Check if user account is locked. | |
isHidden () | |
Check if user account is hidden. | |
getId () | |
Get the user's ID. | |
setId ( $v) | |
Set the user and reload all fields according to a given ID. | |
getName () | |
Get the user name, or the IP of an anonymous user. | |
setName ( $str) | |
Set the user name. | |
getTitleKey () | |
Get the user's name escaped by underscores. | |
getNewtalk () | |
Check if the user has new messages. | |
getNewMessageLinks () | |
Return the data needed to construct links for new talk page message alerts. | |
getNewMessageRevisionId () | |
Get the revision ID for the last talk page revision viewed by the talk page owner. | |
setNewtalk ( $val, $curRev=null) | |
Update the 'You have new messages!' status. | |
clearSharedCache ( $mode='changed') | |
Clear user data from memcached. | |
invalidateCache () | |
Immediately touch the user data cache for this account. | |
touch () | |
Update the "touched" timestamp for the user. | |
validateCache ( $timestamp) | |
Validate the cache for this account. | |
getTouched () | |
Get the user touched timestamp. | |
getDBTouched () | |
Get the user_touched timestamp field (time of last DB updates) | |
getPassword () | |
getTemporaryPassword () | |
setPassword ( $str) | |
Set the password and reset the random token. | |
setInternalPassword ( $str) | |
Set the password and reset the random token unconditionally. | |
changeAuthenticationData (array $data) | |
Changes credentials of the user. | |
getToken ( $forceCreation=true) | |
Get the user's current token. | |
setToken ( $token=false) | |
Set the random token (used for persistent authentication) Called from loadDefaults() among other places. | |
setNewpassword ( $str, $throttle=true) | |
Set the password for a password reminder or new account email. | |
isPasswordReminderThrottled () | |
Has password reminder email been sent within the last $wgPasswordReminderResendTime hours? | |
getEmail () | |
Get the user's e-mail address. | |
getEmailAuthenticationTimestamp () | |
Get the timestamp of the user's e-mail authentication. | |
setEmail ( $str) | |
Set the user's e-mail address. | |
setEmailWithConfirmation ( $str) | |
Set the user's e-mail address and a confirmation mail if needed. | |
getRealName () | |
Get the user's real name. | |
setRealName ( $str) | |
Set the user's real name. | |
getOption ( $oname, $defaultOverride=null, $ignoreHidden=false) | |
Get the user's current setting for a given option. | |
getOptions ( $flags=0) | |
Get all user's options. | |
getBoolOption ( $oname) | |
Get the user's current setting for a given option, as a boolean value. | |
getIntOption ( $oname, $defaultOverride=0) | |
Get the user's current setting for a given option, as an integer value. | |
setOption ( $oname, $val) | |
Set the given option for a user. | |
getTokenFromOption ( $oname) | |
Get a token stored in the preferences (like the watchlist one), resetting it if it's empty (and saving changes). | |
resetTokenFromOption ( $oname) | |
Reset a token stored in the preferences (like the watchlist one). | |
getOptionKinds (IContextSource $context, $options=null) | |
Return an associative array mapping preferences keys to the kind of a preference they're used for. | |
resetOptions ( $resetKinds=[ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused'], IContextSource $context=null) | |
Reset certain (or all) options to the site defaults. | |
getDatePreference () | |
Get the user's preferred date format. | |
requiresHTTPS () | |
Determine based on the wiki configuration and the user's options, whether this user must be over HTTPS no matter what. | |
getStubThreshold () | |
Get the user preferred stub threshold. | |
getRights () | |
Get the permissions this user has. | |
getGroups () | |
Get the list of explicit group memberships this user has. | |
getEffectiveGroups ( $recache=false) | |
Get the list of implicit group memberships this user has. | |
getAutomaticGroups ( $recache=false) | |
Get the list of implicit group memberships this user has. | |
getFormerGroups () | |
Returns the groups the user has belonged to. | |
getEditCount () | |
Get the user's edit count. | |
addGroup ( $group) | |
Add the user to the given group. | |
removeGroup ( $group) | |
Remove the user from the given group. | |
isLoggedIn () | |
Get whether the user is logged in. | |
isAnon () | |
Get whether the user is anonymous. | |
isBot () | |
isAllowedAny () | |
Check if user is allowed to access a feature / make an action. | |
isAllowedAll () | |
isAllowed ( $action='') | |
Internal mechanics of testing a permission. | |
useRCPatrol () | |
Check whether to enable recent changes patrol features for this user. | |
useNPPatrol () | |
Check whether to enable new pages patrol features for this user. | |
useFilePatrol () | |
Check whether to enable new files patrol features for this user. | |
getRequest () | |
Get the WebRequest object to use with this object. | |
isWatched ( $title, $checkRights=self::CHECK_USER_RIGHTS) | |
Check the watched status of an article. | |
addWatch ( $title, $checkRights=self::CHECK_USER_RIGHTS) | |
Watch an article. | |
removeWatch ( $title, $checkRights=self::CHECK_USER_RIGHTS) | |
Stop watching an article. | |
clearNotification (&$title, $oldid=0) | |
Clear the user's notification timestamp for the given title. | |
clearAllNotifications () | |
Resets all of the given user's page-change notification timestamps. | |
setCookies ( $request=null, $secure=null, $rememberMe=false) | |
Persist this user's session (e.g. | |
logout () | |
Log this user out. | |
doLogout () | |
Clear the user's session, and reset the instance cache. | |
saveSettings () | |
Save this user's settings into the database. | |
idForName ( $flags=0) | |
If only this user's username is known, and it exists, return the user ID. | |
addToDatabase () | |
Add this existing user object to the database. | |
spreadAnyEditBlock () | |
If this user is logged-in and blocked, block any IP address they've successfully logged in from. | |
isBlockedFromCreateAccount () | |
Get whether the user is explicitly blocked from account creation. | |
isBlockedFromEmailuser () | |
Get whether the user is blocked from using Special:Emailuser. | |
isAllowedToCreateAccount () | |
Get whether the user is allowed to create an account. | |
getUserPage () | |
Get this user's personal page title. | |
getTalkPage () | |
Get this user's talk page title. | |
isNewbie () | |
Determine whether the user is a newbie. | |
checkPassword ( $password) | |
Check to see if the given clear-text password is one of the accepted passwords. | |
checkTemporaryPassword ( $plaintext) | |
Check if the given clear-text password matches the temporary password sent by e-mail for password reset operations. | |
getEditTokenObject ( $salt='', $request=null) | |
Initialize (if necessary) and return a session token value which can be used in edit forms to show that the user's login credentials aren't being hijacked with a foreign form submission. | |
getEditToken ( $salt='', $request=null) | |
Initialize (if necessary) and return a session token value which can be used in edit forms to show that the user's login credentials aren't being hijacked with a foreign form submission. | |
matchEditToken ( $val, $salt='', $request=null, $maxage=null) | |
Check given value against the token value stored in the session. | |
matchEditTokenNoSuffix ( $val, $salt='', $request=null, $maxage=null) | |
Check given value against the token value stored in the session, ignoring the suffix. | |
sendConfirmationMail ( $type='created') | |
Generate a new e-mail confirmation token and send a confirmation/invalidation mail to the user's given address. | |
sendMail ( $subject, $body, $from=null, $replyto=null) | |
Send an e-mail to this user's account. | |
confirmEmail () | |
Mark the e-mail address confirmed. | |
invalidateEmail () | |
Invalidate the user's e-mail confirmation, and unauthenticate the e-mail address if it was already confirmed. | |
setEmailAuthenticationTimestamp ( $timestamp) | |
Set the e-mail authentication timestamp. | |
canSendEmail () | |
Is this user allowed to send e-mails within limits of current site configuration? | |
canReceiveEmail () | |
Is this user allowed to receive e-mails within limits of current site configuration? | |
isEmailConfirmed () | |
Is this user's e-mail address valid-looking and confirmed within limits of the current site configuration? | |
isEmailConfirmationPending () | |
Check whether there is an outstanding request for e-mail confirmation. | |
getRegistration () | |
Get the timestamp of account creation. | |
getFirstEditTimestamp () | |
Get the timestamp of the first edit. | |
changeableGroups () | |
Returns an array of groups that this user can add and remove. | |
incEditCount () | |
Deferred version of incEditCountImmediate() | |
incEditCountImmediate () | |
Increment the user's edit-count field. | |
addNewUserLogEntry ( $action=false, $reason='') | |
Add a newuser log entry for this user. | |
addNewUserLogEntryAutoCreate () | |
Add an autocreate newuser log entry for this user Used by things like CentralAuth and perhaps other authplugins. | |
getInstanceForUpdate () | |
Get a new instance of this user that was loaded from the master via a locking read. | |
equals (User $user) | |
Checks if two user objects point to the same user. | |
static | newFromName ( $name, $validate='valid') |
Static factory method for creation from username. | |
static | newFromId ( $id) |
Static factory method for creation from a given user ID. | |
static | newFromConfirmationCode ( $code, $flags=0) |
Factory method to fetch whichever user has a given email confirmation code. | |
static | newFromSession (WebRequest $request=null) |
Create a new user object using data from session. | |
static | newFromRow ( $row, $data=null) |
Create a new user object from a user row. | |
static | newSystemUser ( $name, $options=[]) |
Static factory method for creation of a "system" user from username. | |
static | whoIs ( $id) |
Get the username corresponding to a given user ID. | |
static | whoIsReal ( $id) |
Get the real name of a user given their user ID. | |
static | idFromName ( $name, $flags=self::READ_NORMAL) |
Get database id given a user name. | |
static | resetIdByNameCache () |
Reset the cache used in idFromName(). | |
static | isIP ( $name) |
Does the string match an anonymous IP address? | |
static | isValidUserName ( $name) |
Is the input a valid username? | |
static | isUsableName ( $name) |
Usernames which fail to pass this function will be blocked from user login and new account registrations, but may be used internally by batch processes. | |
static | findUsersByGroup ( $groups, $limit=5000, $after=null) |
Return the users who are members of the given group(s). | |
static | isCreatableName ( $name) |
Usernames which fail to pass this function will be blocked from new account registrations, but may be used internally either by batch processes or by user accounts which have already been created. | |
static | getCanonicalName ( $name, $validate='valid') |
Given unvalidated user input, return a canonical username, or false if the username is invalid. | |
static | edits ( $uid) |
Count the number of edits of a user. | |
static | randomPassword () |
Return a random password. | |
static | getDefaultOptions () |
Combine the language default options with any site-specific options and add the default language variants. | |
static | getDefaultOption ( $opt) |
Get a given default option value. | |
static | isLocallyBlockedProxy ( $ip) |
Check if an IP address is in the local proxy list. | |
static | listOptionKinds () |
Return a list of the types of user options currently returned by User::getOptionKinds(). | |
static | createNew ( $name, $params=[]) |
Add a user to the database, return the user object. | |
static | getEditTokenTimestamp ( $val) |
Get the embedded timestamp from a token. | |
static | getGroupPermissions ( $groups) |
Get the permissions associated with a given list of groups. | |
static | getGroupsWithPermission ( $role) |
Get all the groups who have a given permission. | |
static | groupHasPermission ( $group, $role) |
Check, if the given group has the given permission. | |
static | isEveryoneAllowed ( $right) |
Check if all users may be assumed to have the given permission. | |
static | getGroupName ( $group) |
Get the localized descriptive name for a group, if it exists. | |
static | getGroupMember ( $group, $username='#') |
Get the localized descriptive name for a member of a group, if it exists. | |
static | getAllGroups () |
Return the set of defined explicit groups. | |
static | getAllRights () |
Get a list of all available permissions. | |
static | getImplicitGroups () |
Get a list of implicit groups. | |
static | getGroupPage ( $group) |
Get the title of a page describing a particular group. | |
static | makeGroupLinkHTML ( $group, $text='') |
Create a link to the group in HTML, if available; else return the group name. | |
static | makeGroupLinkWiki ( $group, $text='') |
Create a link to the group in Wikitext, if available; else return the group name. | |
static | changeableByGroup ( $group) |
Returns an array of the groups that a particular group can add/remove. | |
static | getRightDescription ( $right) |
Get the description of a given right. | |
static | crypt ( $password, $salt=false) |
Make a new-style password hash. | |
static | comparePasswords ( $hash, $password, $userId=false) |
Compare a password hash with a plain-text password. | |
static | getPasswordFactory () |
Lazily instantiate and return a factory object for making passwords. | |
static | passwordChangeInputAttribs () |
Provide an array of HTML5 attributes to put on an input element intended for the user to enter a new password. | |
static | selectFields () |
Return the list of user fields that should be selected to create a new user object. | |
static | newFatalPermissionDeniedStatus ( $permission) |
Factory function for fatal permission-denied errors. | |
setItemLoaded ( $item) | |
Set that an item has been loaded. | |
loadFromRow ( $row, $data=null) | |
Initialize this object from a row from the user table. | |
loadFromUserObject ( $user) | |
Load the data for this user object from another user object. | |
makeUpdateConditions (Database $db, array $conditions) | |
Builds update conditions. | |
checkAndSetTouched () | |
Bump user_touched if it didn't change since this object was loaded. | |
checkNewtalk ( $field, $id) | |
Internal uncached check for new messages. | |
updateNewtalk ( $field, $id, $curRev=null) | |
Add or update the new messages flag. | |
deleteNewtalk ( $field, $id) | |
Clear the new messages flag for the given user. | |
setCookie ( $name, $value, $exp=0, $secure=null, $params=[], $request=null) | |
Set a cookie on the user's client. | |
clearCookie ( $name, $secure=null, $params=[]) | |
Clear a cookie on the user's client. | |
setExtendedLoginCookie ( $name, $value, $secure) | |
Set an extended login cookie on the user's client. | |
spreadBlock () | |
If this (non-anonymous) user is blocked, block the IP address they've successfully logged in from. | |
confirmationToken (&$expiration) | |
Generate, store, and return a new e-mail confirmation code. | |
confirmationTokenUrl ( $token) | |
Return a URL the user can use to confirm their email address. | |
invalidationTokenUrl ( $token) | |
Return a URL the user can use to invalidate their email address. | |
getTokenUrl ( $page, $token) | |
Internal function to format the e-mail validation/invalidation URLs. | |
initEditCount ( $add=0) | |
Initialize user_editcount from data out of the revision table. | |
loadOptions ( $data=null) | |
Load the user options either from cache, the database or an array. | |
saveOptions () | |
Saves the non-default options for this user, as previously set e.g. | |
loadFromSession () | |
Load user data from the session. | |
loadGroups () | |
Load the groups from the database if they aren't already loaded. | |
getBlockedStatus ( $bFromSlave=true) | |
Get blocking information. | |
newTouchedTimestamp () | |
Generate a current or new-future timestamp to be stored in the user_touched field when we update things. | |
setPasswordInternal ( $str) | |
Actually set the password and such. | |
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Client classes use the getXXX() functions to access these fields. These functions do all the work of determining whether the user is logged in, whether the requested option can be satisfied from cookies or whether a database query is needed. Most of the settings needed for rendering normal pages are set in the cookie to minimize use of the database.
User::__construct | ( | ) |
Lightweight constructor for an anonymous user.
Use the User::newFrom* factory functions for other kinds of users.
Definition at line 316 of file User.php.
References clearInstanceCache().
User::addAutopromoteOnceGroups | ( | $event | ) |
Add the user to the group if he/she meets given criteria.
Contrary to autopromotion by \ref $wgAutopromote, the group will be possible to remove manually via Special:UserRights. In such case it will not be re-added automatically. The user will also not lose the group if they no longer meet the criteria.
string | $event | Key in $wgAutopromoteOnce (each one has groups/criteria) |
Definition at line 1392 of file User.php.
References $wgAutopromoteOnceLogInRC, addGroup(), as, checkAndSetTouched(), Autopromote\getAutopromoteOnceGroups(), getGroups(), getId(), getUserPage(), global, and wfReadOnly().
User::addGroup | ( | $group | ) |
Add the user to the given group.
This takes immediate effect.
string | $group | Name of the group to add |
Definition at line 3300 of file User.php.
References DB_MASTER, getEffectiveGroups(), getId(), invalidateCache(), load, loadGroups(), and wfGetDB().
Referenced by addAutopromoteOnceGroups(), and UserTest\testUserGetRightsHooks().
User::addNewUserLogEntry | ( | $action = false , |
|
$reason = '' |
|||
) |
Add a newuser log entry for this user.
Before 1.19 the return value was always true.
string | bool | $action | Account creation type.
|
string | $reason | User supplied reason |
Definition at line 5099 of file User.php.
Referenced by addNewUserLogEntryAutoCreate().
User::addNewUserLogEntryAutoCreate | ( | ) |
Add an autocreate newuser log entry for this user Used by things like CentralAuth and perhaps other authplugins.
Consider calling addNewUserLogEntry() directly instead.
Definition at line 5111 of file User.php.
References addNewUserLogEntry().
User::addToDatabase | ( | ) |
Add this existing user object to the database.
If the user already exists, a fatal status object is returned, and the user object is initialised with the data from the database.
Previously, this function generated a DB error due to a key conflict if the user already existed. Many extension callers use this function in code along the lines of:
$user = User::newFromName( $name ); if ( !$user->isLoggedIn() ) { $user->addToDatabase(); } // do something with $user...
However, this was vulnerable to a race condition (bug 16020). By initialising the user object if the user exists, we aim to support this calling sequence as far as possible.
Note that if the user exists, this function will acquire a write lock, so it is still advisable to make the call conditional on isLoggedIn(), and to commit the transaction after calling.
MWException |
Definition at line 4015 of file User.php.
References clearInstanceCache(), DB_MASTER, load, loadFromDatabase(), newTouchedTimestamp(), saveOptions(), setToken(), and wfGetDB().
User::addWatch | ( | $title, | |
$checkRights = self::CHECK_USER_RIGHTS |
|||
) |
Watch an article.
Title | $title | Title of the article to look at |
bool | $checkRights | Whether to check 'viewmywatchlist'/'editmywatchlist' rights. Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS. |
Definition at line 3521 of file User.php.
References $title, invalidateCache(), and isAllowed().
User::blockedBy | ( | ) |
If user is blocked, return the name of the user who placed the block.
Definition at line 1977 of file User.php.
References getBlockedStatus().
Referenced by SpecialBlock\checkUnblockSelf().
User::blockedFor | ( | ) |
If user is blocked, return the specified reason for the block.
Definition at line 1986 of file User.php.
References getBlockedStatus().
User::canReceiveEmail | ( | ) |
Is this user allowed to receive e-mails within limits of current site configuration?
Definition at line 4486 of file User.php.
References getOption(), and isEmailConfirmed().
User::canSendEmail | ( | ) |
Is this user allowed to send e-mails within limits of current site configuration?
Definition at line 4471 of file User.php.
References $wgEnableEmail, $wgEnableUserEmail, global, isAllowed(), and isEmailConfirmed().
|
static |
Returns an array of the groups that a particular group can add/remove.
string | $group | The group to check for whether it can add/remove |
Definition at line 4823 of file User.php.
References $value, $wgAddGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf, $wgRemoveGroups, as, getAllGroups(), and global.
Referenced by changeableGroups().
User::changeableGroups | ( | ) |
Returns an array of groups that this user can add and remove.
Definition at line 4896 of file User.php.
References as, changeableByGroup(), getAllGroups(), getEffectiveGroups(), and isAllowed().
User::changeAuthenticationData | ( | array | $data | ) |
Changes credentials of the user.
This is a convenience wrapper around AuthManager::changeAuthenticationData. Note that this can return a status that isOK() but not isGood() on certain types of failures, e.g. when no provider handled the change.
array | $data | A set of authentication data in fieldname => value format. This is the same data you would pass the changeauthenticationdata API - 'username', 'password' etc. |
Definition at line 2544 of file User.php.
References $req, $status, and as.
Referenced by setPasswordInternal().
|
protected |
Bump user_touched if it didn't change since this object was loaded.
On success, the mTouched field is updated. The user serialization cache is always cleared.
Definition at line 1460 of file User.php.
References $success, clearSharedCache(), DB_MASTER, load, newTouchedTimestamp(), and wfGetDB().
Referenced by addAutopromoteOnceGroups(), and UserTest\testCheckAndSetTouched().
|
protected |
Internal uncached check for new messages.
string | $field | 'user_ip' for anonymous users, 'user_id' otherwise |
string | int | $id | User's IP address for anonymous users, User ID otherwise |
Definition at line 2240 of file User.php.
References $dbr, DB_REPLICA, and wfGetDB().
Referenced by getNewtalk().
User::checkPassword | ( | $password | ) |
Check to see if the given clear-text password is one of the accepted passwords.
string | $password | User password |
Definition at line 4180 of file User.php.
References $res.
Referenced by checkTemporaryPassword().
User::checkPasswordValidity | ( | $password, | |
$purpose = 'login' |
|||
) |
Check if this is a valid password for this user.
Create a Status object based on the password's validity. The Status should be set to fatal if the user should not be allowed to log in, and should have any errors that would block changing the password.
If the return value of this is not OK, the password should not be checked. If the return value is not Good, the password can be checked, but the user should not be able to set their password to this.
string | $password | Desired password |
string | $purpose | one of 'login', 'create', 'reset' |
Definition at line 1006 of file User.php.
References $status, $wgPasswordPolicy, and global.
Referenced by getPasswordValidity(), and UserTest\testCheckPasswordValidity().
User::checkTemporaryPassword | ( | $plaintext | ) |
Check if the given clear-text password matches the temporary password sent by e-mail for password reset operations.
string | $plaintext |
Definition at line 4213 of file User.php.
References checkPassword().
User::clearAllNotifications | ( | ) |
Resets all of the given user's page-change notification timestamps.
If e-notif e-mails are on, they will receive notification mails on the next change of any watched page.
Definition at line 3621 of file User.php.
References $lbFactory, $wgShowUpdatedMarker, $wgUpdateRowsPerQuery, $wgUseEnotif, as, DB_MASTER, getId(), global, isAllowed(), setNewtalk(), use, wfGetDB(), and wfReadOnly().
|
protected |
Clear a cookie on the user's client.
string | $name | Name of the cookie to clear |
bool | $secure | true: Force setting the secure attribute when setting the cookie false: Force NOT setting the secure attribute when setting the cookie null (default): Use the default ($wgCookieSecure) to set the secure attribute |
array | $params | Array of options sent passed to WebResponse::setcookie() |
Definition at line 3724 of file User.php.
References $name, $params, setCookie(), and wfDeprecated().
User::clearInstanceCache | ( | $reloadFrom = false | ) |
Clear various cached data stored in this object.
The cache of the user table data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
bool | string | $reloadFrom | Reload user and user_groups table data from a given source. May be "name", "id", "defaults", "session", or false for no reload. |
Definition at line 1498 of file User.php.
Referenced by __construct(), addToDatabase(), doLogout(), and setId().
User::clearNotification | ( | & | $title, |
$oldid = 0 |
|||
) |
Clear the user's notification timestamp for the given title.
If e-notif e-mails are on, they will receive notification mails on the next change of the page if it's watched etc.
Title | $title | Title of the article to look at |
int | $oldid | The revision id being viewed. If not given or 0, latest revision is assumed. |
Definition at line 3555 of file User.php.
References $title, $wgShowUpdatedMarker, $wgUseEnotif, getName(), getNewtalk(), global, isAllowed(), isAnon(), Revision\newFromId(), NS_USER_TALK, setNewtalk(), use, and wfReadOnly().
User::clearSharedCache | ( | $mode = 'changed' | ) |
Clear user data from memcached.
Use after applying updates to the database; caller's responsibility to update user_touched if appropriate.
Called implicitly from invalidateCache() and saveSettings().
string | $mode | Use 'refresh' to clear now; otherwise before DB commit |
Definition at line 2353 of file User.php.
References $cache, DB_MASTER, getCacheKey(), getId(), use, and wfGetDB().
Referenced by checkAndSetTouched(), invalidateCache(), and saveSettings().
|
static |
Compare a password hash with a plain-text password.
Requires the user ID if there's a chance that the hash is an old-style hash.
string | $hash | Password hash |
string | $password | Plain-text password to compare |
string | bool | $userId | User ID for old-style password salt |
Definition at line 5059 of file User.php.
References $wgPasswordSalt, RequestContext\getMain(), global, and wfDeprecated().
|
protected |
Generate, store, and return a new e-mail confirmation code.
A hash (unsalted, since it's used as a key) is stored.
string | &$expiration | Accepts the expiration time |
Definition at line 4371 of file User.php.
References $wgUserEmailConfirmationTokenExpiry, MWCryptRand\generateHex(), global, load, TS_MW, and wfTimestamp().
Referenced by sendConfirmationMail().
|
protected |
Return a URL the user can use to confirm their email address.
string | $token | Accepts the email confirmation token |
Definition at line 4389 of file User.php.
References getTokenUrl().
Referenced by sendConfirmationMail().
User::confirmEmail | ( | ) |
Mark the e-mail address confirmed.
Definition at line 4429 of file User.php.
References isEmailConfirmed(), setEmailAuthenticationTimestamp(), and wfTimestampNow().
|
static |
Add a user to the database, return the user object.
string | $name | Username to add |
array | $params | Array of Strings Non-default parameters to save to the database as user_* fields:
|
Definition at line 3944 of file User.php.
References $name, $params, $user, $value, array(), as, DB_MASTER, newFromId(), wfDeprecated(), and wfGetDB().
|
static |
Make a new-style password hash.
string | $password | Plain-text password |
bool | string | $salt | Optional salt, may be random or the user ID. If unspecified or false, will generate one automatically |
Definition at line 5040 of file User.php.
References RequestContext\getMain(), and wfDeprecated().
|
protected |
Clear the new messages flag for the given user.
string | $field | 'user_ip' for anonymous users, 'user_id' otherwise |
string | int | $id | User's IP address for anonymous users, User ID otherwise |
Definition at line 2280 of file User.php.
References DB_MASTER, wfDebug(), and wfGetDB().
Referenced by setNewtalk().
User::doLogout | ( | ) |
Clear the user's session, and reset the instance cache.
Definition at line 3811 of file User.php.
References clearInstanceCache(), and getRequest().
Referenced by logout().
|
static |
Count the number of edits of a user.
int | $uid | User ID to check |
Definition at line 1105 of file User.php.
References $user, and wfDeprecated().
User::equals | ( | User | $user | ) |
|
static |
Return the users who are members of the given group(s).
In case of multiple groups, users who are members of at least one of them are returned.
string | array | $groups | A single group name or an array of group names |
int | $limit | Max number of users to return. The actual limit will never exceed 5000 records; larger values are ignored. |
int | $after | ID the user to start after |
Definition at line 888 of file User.php.
References $dbr, $limit, array(), DB_REPLICA, UserArray\newFromIDs(), and wfGetDB().
|
static |
Return the set of defined explicit groups.
The implicit groups (by default *, 'user' and 'autoconfirmed') are not included, as they are defined automatically, not in the database.
Definition at line 4717 of file User.php.
References $wgGroupPermissions, $wgRevokePermissions, and global.
Referenced by changeableByGroup(), and changeableGroups().
|
static |
Get a list of all available permissions.
Definition at line 4729 of file User.php.
References $wgAvailableRights, and global.
User::getAutomaticGroups | ( | $recache = false | ) |
Get the list of implicit group memberships this user has.
This includes 'user' if logged in, '*' for all accounts, and autopromoted groups
bool | $recache | Whether to avoid the cache |
Definition at line 3217 of file User.php.
References Autopromote\getAutopromoteGroups(), and getId().
Referenced by getEffectiveGroups().
User::getBlock | ( | $bFromSlave = true | ) |
Get the block affecting the user, or null if the user is not blocked.
bool | $bFromSlave | Whether to check the replica DB instead of the master |
Definition at line 1944 of file User.php.
References getBlockedStatus().
Referenced by isBlocked().
|
private |
Get blocking information.
bool | $bFromSlave | Whether to check the replica DB first. To improve performance, non-critical checks are done against replica DBs. Check when actually saving should be done against master. |
Definition at line 1578 of file User.php.
References $wgApplyIpBlocksToXff, $wgProxyWhitelist, $wgUser, Block\chooseBlock(), Block\getBlocksForIPList(), getName(), getRequest(), global, isAllowed(), isAnon(), isDnsBlacklisted(), load, Block\newFromTarget(), IP\sanitizeIP(), Block\setBlocker(), text, wfDebug(), and wfMessage().
Referenced by blockedBy(), blockedFor(), getBlock(), getBlockId(), isBlockedFromCreateAccount(), isBlockedFromEmailuser(), and isHidden().
User::getBlockId | ( | ) |
If user is blocked, return the ID for the block.
Definition at line 1995 of file User.php.
References false, and getBlockedStatus().
User::getBoolOption | ( | $oname | ) |
Get the user's current setting for a given option, as a boolean value.
string | $oname | The option to check |
Definition at line 2825 of file User.php.
References getOption().
Referenced by requiresHTTPS().
|
protected |
WANObjectCache | $cache |
Definition at line 462 of file User.php.
References $cache, and wfWikiID().
Referenced by clearSharedCache(), and loadFromCache().
|
static |
Given unvalidated user input, return a canonical username, or false if the username is invalid.
string | $name | User input |
string | bool | $validate | Type of validation to use:
|
InvalidArgumentException |
Definition at line 1046 of file User.php.
References $name, $t, $wgContLang, false, global, isCreatableName(), isUsableName(), isValidUserName(), and NS_USER.
User::getDatePreference | ( | ) |
User::getDBTouched | ( | ) |
Get the user_touched timestamp field (time of last DB updates)
Definition at line 2442 of file User.php.
References load.
Referenced by UserTest\testCheckAndSetTouched().
|
static |
|
static |
Combine the language default options with any site-specific options and add the default language variants.
Definition at line 1523 of file User.php.
References LanguageConverter\$languagesWithVariants, $wgContLang, $wgDefaultSkin, $wgDefaultUserOptions, $wgNamespacesToBeSearchedDefault, as, boolean(), global, and Skin\normalizeKey().
User::getEditCount | ( | ) |
Get the user's edit count.
Definition at line 3270 of file User.php.
References $count, $dbr, DB_REPLICA, getId(), initEditCount(), and wfGetDB().
Referenced by incEditCountImmediate(), loadFromDatabase(), UserTest\testGetEditCount(), and UserTest\testGetEditCountForAnons().
User::getEditToken | ( | $salt = '' , |
|
$request = null |
|||
) |
Initialize (if necessary) and return a session token value which can be used in edit forms to show that the user's login credentials aren't being hijacked with a foreign form submission.
The $salt for 'edit' and 'csrf' tokens is the default (empty string).
string | array | $salt | Array of Strings Optional function-specific data for hashing |
WebRequest | null | $request | WebRequest object to use or null to use $wgRequest |
Definition at line 4253 of file User.php.
References $request, and getEditTokenObject().
User::getEditTokenObject | ( | $salt = '' , |
|
$request = null |
|||
) |
Initialize (if necessary) and return a session token value which can be used in edit forms to show that the user's login credentials aren't being hijacked with a foreign form submission.
string | array | $salt | Array of Strings Optional function-specific data for hashing |
WebRequest | null | $request | WebRequest object to use or null to use $wgRequest |
Definition at line 4229 of file User.php.
References $request, getRequest(), and isAnon().
Referenced by getEditToken(), and matchEditToken().
|
static |
Get the embedded timestamp from a token.
string | $val | Input token |
Definition at line 4263 of file User.php.
References wfDeprecated().
User::getEffectiveGroups | ( | $recache = false | ) |
Get the list of implicit group memberships this user has.
This includes all explicit groups, plus 'user' if logged in, '*' for all accounts, and autopromoted groups
bool | $recache | Whether to avoid the cache |
Definition at line 3196 of file User.php.
References getAutomaticGroups(), and getGroups().
Referenced by addGroup(), changeableGroups(), getRights(), and removeGroup().
User::getEmail | ( | ) |
Get the user's e-mail address.
Definition at line 2647 of file User.php.
References load.
Referenced by setEmailWithConfirmation().
User::getEmailAuthenticationTimestamp | ( | ) |
Get the timestamp of the user's e-mail authentication.
Definition at line 2657 of file User.php.
References load.
Referenced by isEmailConfirmed().
User::getFirstEditTimestamp | ( | ) |
Get the timestamp of the first edit.
Definition at line 4553 of file User.php.
References $dbr, $time, DB_REPLICA, getId(), TS_MW, wfGetDB(), and wfTimestamp().
User::getFormerGroups | ( | ) |
Returns the groups the user has belonged to.
The user may still belong to the returned groups. Compare with getGroups().
The function will not return groups the user had belonged to before MW 1.17
Definition at line 3246 of file User.php.
References $res, as, DB_MASTER, DB_REPLICA, load, and wfGetDB().
User::getGlobalBlock | ( | $ip = '' | ) |
Check if user is blocked on all wikis.
Do not use for actual edit permission checks! This is intended for quick UI checks.
string | $ip | IP address, uses current client if none given |
FatalError | |
MWException |
Definition at line 2022 of file User.php.
References getName(), getRequest(), IP\isIPAddress(), and Block\setTarget().
Referenced by isBlockedGlobally().
|
static |
Get the localized descriptive name for a member of a group, if it exists.
string | $group | Internal group name |
string | $username | Username for gender (since 1.19) |
Definition at line 4706 of file User.php.
References $username, and wfMessage().
|
static |
Get the localized descriptive name for a group, if it exists.
string | $group | Internal group name |
Definition at line 4694 of file User.php.
References wfMessage().
|
static |
Get the title of a page describing a particular group.
string | $group | Internal group name |
Definition at line 4762 of file User.php.
References $title, and wfMessage().
|
static |
Get the permissions associated with a given list of groups.
array | $groups | Array of Strings List of internal group names |
Definition at line 4575 of file User.php.
References $wgGroupPermissions, $wgRevokePermissions, as, and global.
User::getGroups | ( | ) |
Get the list of explicit group memberships this user has.
The implicit * and user groups are not included.
Definition at line 3183 of file User.php.
References load, and loadGroups().
Referenced by addAutopromoteOnceGroups(), getEffectiveGroups(), isBot(), and pingLimiter().
|
static |
Get all the groups who have a given permission.
string | $role | Role to check |
Definition at line 4602 of file User.php.
References $wgGroupPermissions, as, and global.
Referenced by newFatalPermissionDeniedStatus().
User::getId | ( | ) |
Get the user's ID.
Definition at line 2083 of file User.php.
References isIP(), isItemLoaded(), and load.
Referenced by addAutopromoteOnceGroups(), addGroup(), MediaWiki\Auth\AuthManager\beginAccountCreation(), EmailNotification\canSendUserTalkEmail(), SpecialBlock\checkUnblockSelf(), clearAllNotifications(), clearSharedCache(), ApiBlock\execute(), ApiUnblock\execute(), PasswordReset\execute(), getAutomaticGroups(), Block\getBy(), Block\getDatabaseArray(), getEditCount(), getFirstEditTimestamp(), getInstanceForUpdate(), getNewMessageLinks(), SpecialEmailUser\getTarget(), getTokenFromOption(), RequestContext\importScopedSession(), incEditCountImmediate(), initEditCount(), isLoggedIn(), loadFromSession(), loadOptions(), EmailNotification\notifyOnPageChange(), pingLimiter(), removeGroup(), saveOptions(), setNewtalk(), TestUser\setPasswordForUser(), UserTest\testEquals(), UserTest\testGetId(), UserTest\testIncEditCount(), and touch().
|
static |
Get a list of implicit groups.
Definition at line 4746 of file User.php.
References $wgImplicitGroups, and global.
User::getInstanceForUpdate | ( | ) |
Get a new instance of this user that was loaded from the master via a locking read.
Use this instead of the main context User when updating that user. This avoids races where that user was loaded from a replica DB or even the master but without proper locks.
User::getIntOption | ( | $oname, | |
$defaultOverride = 0 |
|||
) |
Get the user's current setting for a given option, as an integer value.
string | $oname | The option to check |
int | $defaultOverride | A default value returned if the option does not exist |
Definition at line 2837 of file User.php.
References getOption().
Referenced by getStubThreshold().
User::getName | ( | ) |
Get the user name, or the IP of an anonymous user.
Definition at line 2108 of file User.php.
References getRequest(), isItemLoaded(), load, and IP\sanitizeIP().
Referenced by MediaWiki\Session\UserInfo\__construct(), __toString(), EmailNotification\actuallyNotifyOnPageChange(), MediaWiki\Auth\AuthManager\beginAccountCreation(), CentralIdLookup\centralIdFromLocalUser(), SpecialBlock\checkUnblockSelf(), clearNotification(), equals(), ApiUnblock\execute(), PasswordReset\execute(), getBlockedStatus(), Block\getByName(), getGlobalBlock(), getNewMessageLinks(), getNewtalk(), getTitleKey(), getUserPage(), idForName(), isBlockedFrom(), loadFromSession(), EmailNotification\notifyOnPageChange(), Block\parseTarget(), sendConfirmationMail(), setEmailWithConfirmation(), setNewtalk(), setPasswordInternal(), spreadBlock(), UserTest\testCheckPasswordValidity(), UserTest\testEquals(), UserTest\testOptions(), and CreditsAction\userLink().
User::getNewMessageLinks | ( | ) |
Return the data needed to construct links for new talk page message alerts.
If there are new messages, this will return an associative array with the following data: wiki: The database name of the wiki link: Root-relative link to the user's talk page rev: The last talk page revision that the user has seen or null. This is useful for building diff links. If there are no new messages, it returns an empty array.
Definition at line 2190 of file User.php.
References $dbr, $rev, $timestamp, DB_REPLICA, getId(), getName(), getNewtalk(), getTalkPage(), isAnon(), Revision\loadFromTimestamp(), wfGetDB(), and wfWikiID().
Referenced by getNewMessageRevisionId().
User::getNewMessageRevisionId | ( | ) |
Get the revision ID for the last talk page revision viewed by the talk page owner.
Definition at line 2213 of file User.php.
References getNewMessageLinks(), and wfWikiID().
User::getNewtalk | ( | ) |
Check if the user has new messages.
Definition at line 2152 of file User.php.
References $wgDisableAnonTalk, checkNewtalk(), getName(), global, load, and page.
Referenced by clearNotification(), and getNewMessageLinks().
User::getOption | ( | $oname, | |
$defaultOverride = null , |
|||
$ignoreHidden = false |
|||
) |
Get the user's current setting for a given option.
string | $oname | The option to check |
string | $defaultOverride | A default value returned if the option does not exist |
bool | $ignoreHidden | Whether to ignore the effects of $wgHiddenPrefs |
Reimplemented in PPFuzzUser.
Definition at line 2766 of file User.php.
References $wgHiddenPrefs, global, and loadOptions().
Referenced by canReceiveEmail(), getBoolOption(), getDatePreference(), getIntOption(), RequestContext\getLanguage(), getTokenFromOption(), and UserTest\testOptions().
User::getOptionKinds | ( | IContextSource | $context, |
$options = null |
|||
) |
Return an associative array mapping preferences keys to the kind of a preference they're used for.
Different kinds are handled differently when setting or reading preferences.
See User::listOptionKinds for the list of valid option types that can be provided.
IContextSource | $context | |
array | $options | Assoc. array with options keys to check as keys. Defaults to $this->mOptions. |
Definition at line 2959 of file User.php.
References $context, $name, $options, $value, as, HTMLFormField\flattenOptions(), Preferences\getPreferences(), Preferences\getSaveBlacklist(), and loadOptions().
Referenced by resetOptions().
User::getOptions | ( | $flags = 0 | ) |
Get all user's options.
int | $flags | Bitwise combination of: User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set to the default value. (Since 1.25) |
Definition at line 2794 of file User.php.
References $flags, $options, $wgHiddenPrefs, as, global, and loadOptions().
User::getPassword | ( | ) |
|
static |
Lazily instantiate and return a factory object for making passwords.
Definition at line 5254 of file User.php.
References $ret, RequestContext\getMain(), and wfDeprecated().
User::getPasswordValidity | ( | $password | ) |
Given unvalidated password input, return error message on failure.
string | $password | Desired password |
Definition at line 969 of file User.php.
References $messages, as, and checkPasswordValidity().
Referenced by isValidPassword(), and UserTest\testCheckPasswordValidity().
User::getRealName | ( | ) |
Get the user's real name.
Definition at line 2739 of file User.php.
References isItemLoaded(), and load.
Referenced by CreditsAction\userLink().
User::getRegistration | ( | ) |
User::getRequest | ( | ) |
Get the WebRequest object to use with this object.
Definition at line 3490 of file User.php.
References $wgRequest, and global.
Referenced by doLogout(), PasswordReset\execute(), getBlockedStatus(), getEditTokenObject(), getGlobalBlock(), getName(), getRights(), isBlockedFromCreateAccount(), isPingLimitable(), loadFromSession(), pingLimiter(), requiresHTTPS(), sendConfirmationMail(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendNewAccountEmail(), setCookie(), setCookies(), setEmailWithConfirmation(), and spreadBlock().
|
static |
Get the description of a given right.
string | $right | Right to query |
Definition at line 5025 of file User.php.
References wfMessage().
User::getRights | ( | ) |
Get the permissions this user has.
Definition at line 3142 of file User.php.
References getEffectiveGroups(), RequestContext\getMain(), getRequest(), and isLoggedIn().
Referenced by isAllowed(), and UserTest\testUserGetRightsHooks().
User::getStubThreshold | ( | ) |
Get the user preferred stub threshold.
Definition at line 3127 of file User.php.
References $wgMaxArticleSize, article, getIntOption(), global, and in.
Referenced by MediaWiki\Linker\LinkRendererFactory\createForUser().
User::getTalkPage | ( | ) |
Get this user's talk page title.
Definition at line 4160 of file User.php.
References $title, and getUserPage().
Referenced by getNewMessageLinks().
User::getTemporaryPassword | ( | ) |
User::getTitleKey | ( | ) |
User::getToken | ( | $forceCreation = true | ) |
Get the user's current token.
bool | $forceCreation | Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility). |
Definition at line 2571 of file User.php.
References $ret, $wgAuthenticationTokenVersion, MWCryptRand\generateHex(), global, MWCryptHash\hmac(), load, and setToken().
Referenced by getTokenFromOption(), and loadFromSession().
User::getTokenFromOption | ( | $oname | ) |
Get a token stored in the preferences (like the watchlist one), resetting it if it's empty (and saving changes).
string | $oname | The option name to retrieve the token from |
Definition at line 2874 of file User.php.
References $wgHiddenPrefs, getId(), getOption(), getToken(), and global.
|
protected |
Internal function to format the e-mail validation/invalidation URLs.
This uses a quickie hack to use the hardcoded English names of the Special: pages, for ASCII safety.
string | $page | Special page |
string | $token | Token |
Definition at line 4416 of file User.php.
References $title, and NS_MAIN.
Referenced by confirmationTokenUrl(), and invalidationTokenUrl().
User::getTouched | ( | ) |
Get the user touched timestamp.
Use this value only to validate caches via inequalities such as in the case of HTTP If-Modified-Since response logic
Definition at line 2420 of file User.php.
References $cache, load, TS_MW, wfMemcKey(), and wfTimestamp().
Referenced by validateCache().
User::getUserPage | ( | ) |
Get this user's personal page title.
Definition at line 4151 of file User.php.
References getName(), and NS_USER.
Referenced by addAutopromoteOnceGroups(), Block\getPermissionsError(), getTalkPage(), and saveSettings().
|
static |
Check, if the given group has the given permission.
If you're wanting to check whether all users have a permission, use User::isEveryoneAllowed() instead. That properly checks if it's revoked from anyone.
string | $group | Group to check |
string | $role | Role to check |
Definition at line 4625 of file User.php.
References $wgGroupPermissions, $wgRevokePermissions, and global.
User::idForName | ( | $flags = 0 | ) |
|
static |
Get database id given a user name.
string | $name | Username |
integer | $flags | User::READ_* constant bitfield |
Definition at line 728 of file User.php.
References $flags, $name, $options, $s, DBAccessObjectUtils\getDBOptions(), list, NS_USER, and wfGetDB().
User::incEditCount | ( | ) |
Deferred version of incEditCountImmediate()
Definition at line 4935 of file User.php.
References DB_MASTER, incEditCountImmediate(), and wfGetDB().
Referenced by UserTest\testGetEditCount(), UserTest\testGetEditCountForAnons(), and UserTest\testIncEditCount().
User::incEditCountImmediate | ( | ) |
Increment the user's edit-count field.
Will have no effect for anonymous users.
Definition at line 4949 of file User.php.
References $dbr, DB_MASTER, DB_REPLICA, getEditCount(), getId(), initEditCount(), invalidateCache(), isAnon(), and wfGetDB().
Referenced by incEditCount().
User::inDnsBlacklist | ( | $ip, | |
$bases | |||
) |
Whether the given IP is in a given DNS blacklist.
string | $ip | IP to check |
string | array | $bases | Array of Strings: URL of the DNS blacklist |
Definition at line 1692 of file User.php.
References $base, array(), as, IP\isIPv4(), and wfDebugLog().
Referenced by isDnsBlacklisted().
|
protected |
Initialize user_editcount from data out of the revision table.
int | $add | Edits to add to the count from the revision table |
Definition at line 4996 of file User.php.
References $count, $dbr, DB_MASTER, DB_REPLICA, getId(), and wfGetDB().
Referenced by getEditCount(), and incEditCountImmediate().
User::invalidateCache | ( | ) |
Immediately touch the user data cache for this account.
Calls touch() and removes account data from memcached
Definition at line 2377 of file User.php.
References clearSharedCache(), and touch().
Referenced by addGroup(), addWatch(), incEditCountImmediate(), removeGroup(), removeWatch(), and setNewtalk().
User::invalidateEmail | ( | ) |
Invalidate the user's e-mail confirmation, and unauthenticate the e-mail address if it was already confirmed.
Definition at line 4446 of file User.php.
References load, and setEmailAuthenticationTimestamp().
Referenced by setEmail().
|
protected |
Return a URL the user can use to invalidate their email address.
string | $token | Accepts the email confirmation token |
Definition at line 4398 of file User.php.
References getTokenUrl().
Referenced by sendConfirmationMail().
User::isAllowed | ( | $action = '' | ) |
Internal mechanics of testing a permission.
string | $action |
Definition at line 3443 of file User.php.
References getRights().
Referenced by EmailNotification\actuallyNotifyOnPageChange(), addWatch(), canSendEmail(), changeableGroups(), SpecialBlock\checkUnblockSelf(), clearAllNotifications(), clearNotification(), WikiPage\commitRollback(), getBlockedStatus(), isAllowedAll(), isAllowedAny(), isAllowedToCreateAccount(), isBlockedFromCreateAccount(), isBot(), isNewbie(), isPingLimitable(), EmailNotification\notifyOnPageChange(), Block\prevents(), and removeWatch().
User::isAllowedAll | ( | ) |
string | ... Permissions to test |
Definition at line 3428 of file User.php.
References as, and isAllowed().
User::isAllowedAny | ( | ) |
Check if user is allowed to access a feature / make an action.
string | ... Permissions to test |
Definition at line 3413 of file User.php.
References as, and isAllowed().
Referenced by WikiPage\commitRollback(), useFilePatrol(), useNPPatrol(), and useRCPatrol().
User::isAllowedToCreateAccount | ( | ) |
Get whether the user is allowed to create an account.
Definition at line 4142 of file User.php.
References isAllowed(), and isBlockedFromCreateAccount().
User::isAnon | ( | ) |
Get whether the user is anonymous.
Definition at line 3388 of file User.php.
References isLoggedIn().
Referenced by MediaWiki\Session\UserInfo\__construct(), clearNotification(), getBlockedStatus(), getEditTokenObject(), getNewMessageLinks(), getRegistration(), incEditCountImmediate(), isEmailConfirmed(), CreditsAction\link(), MediaWiki\Session\UserInfo\newFromId(), setNewtalk(), and UserTest\testLoggedIn().
User::isBlocked | ( | $bFromSlave = true | ) |
Check if user is blocked.
bool | $bFromSlave | Whether to check the replica DB instead of the master. Hacked from false due to horrible probs on site. |
Definition at line 1934 of file User.php.
References getBlock().
Referenced by Action\checkCanExecute(), FormSpecialPage\checkExecutePermissions(), SpecialBlock\checkUnblockSelf(), isBlockedFrom(), and spreadAnyEditBlock().
User::isBlockedFrom | ( | $title, | |
$bFromSlave = false |
|||
) |
Check if user is blocked from editing a particular article.
Title | $title | Title to check |
bool | $bFromSlave | Whether to check the replica DB instead of the master |
Definition at line 1956 of file User.php.
References $title, $wgBlockAllowsUTEdit, false, getName(), global, isBlocked(), NS_USER_TALK, and wfDebug().
User::isBlockedFromCreateAccount | ( | ) |
Get whether the user is explicitly blocked from account creation.
Definition at line 4111 of file User.php.
References getBlockedStatus(), getRequest(), isAllowed(), Block\newFromTarget(), and Block\prevents().
Referenced by MediaWiki\Auth\AuthManager\checkAccountCreatePermissions(), and isAllowedToCreateAccount().
User::isBlockedFromEmailuser | ( | ) |
Get whether the user is blocked from using Special:Emailuser.
Definition at line 4133 of file User.php.
References getBlockedStatus().
User::isBlockedGlobally | ( | $ip = '' | ) |
Check if user is blocked on all wikis.
Do not use for actual edit permission checks! This is intended for quick UI checks.
string | $ip | IP address, uses current client if none given |
Definition at line 2008 of file User.php.
References getGlobalBlock().
User::isBot | ( | ) |
Definition at line 3396 of file User.php.
References getGroups(), and isAllowed().
|
static |
Usernames which fail to pass this function will be blocked from new account registrations, but may be used internally either by batch processes or by user accounts which have already been created.
Additional blacklisting may be added here rather than in isValidUserName() to avoid disrupting existing accounts.
string | $name | String to match |
Definition at line 928 of file User.php.
References $name, $wgInvalidUsernameCharacters, global, and wfDebugLog().
Referenced by getCanonicalName().
User::isDnsBlacklisted | ( | $ip, | |
$checkWhitelist = false |
|||
) |
Whether the given IP is in a DNS blacklist.
string | $ip | IP to check |
bool | $checkWhitelist | Whether to check the whitelist first |
Definition at line 1671 of file User.php.
References $wgDnsBlacklistUrls, $wgEnableDnsBlacklist, $wgProxyWhitelist, global, and inDnsBlacklist().
Referenced by MediaWiki\Auth\AuthManager\checkAccountCreatePermissions(), and getBlockedStatus().
User::isEmailConfirmationPending | ( | ) |
Check whether there is an outstanding request for e-mail confirmation.
Definition at line 4524 of file User.php.
References $wgEmailAuthentication, global, isEmailConfirmed(), and wfTimestamp().
User::isEmailConfirmed | ( | ) |
Is this user's e-mail address valid-looking and confirmed within limits of the current site configuration?
Definition at line 4500 of file User.php.
References $wgEmailAuthentication, getEmailAuthenticationTimestamp(), global, isAnon(), and load.
Referenced by canReceiveEmail(), canSendEmail(), confirmEmail(), and isEmailConfirmationPending().
|
static |
Check if all users may be assumed to have the given permission.
We generally assume so if the right is granted to '*' and isn't revoked on any group. It doesn't attempt to take grants or other extension limitations on rights into account in the general case, though, as that would require it to always return false and defeat the purpose. Specifically, session-based rights restrictions (such as OAuth or bot passwords) are applied based on the current session.
string | $right | Right to check |
Definition at line 4645 of file User.php.
References $cache, $wgGroupPermissions, $wgRevokePermissions, as, and global.
User::isHidden | ( | ) |
Check if user account is hidden.
Definition at line 2066 of file User.php.
References getBlockedStatus().
|
static |
Does the string match an anonymous IP address?
This function exists for username validation, in order to reject usernames which are similar in form to IP addresses. Strings such as 300.300.300.300 will return true because it looks like an IP address, despite not being strictly valid.
We match "\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.xxx" as an anonymous IP address because the usemod software would "cloak" anonymous IP addresses like this, if we allowed accounts like this to be created new users could get the old edits of these anonymous users.
string | $name | Name to match |
Definition at line 788 of file User.php.
References $name, and IP\isIPv6().
Referenced by getId(), and isValidUserName().
User::isItemLoaded | ( | $item, | |
$all = 'all' |
|||
) |
Return whether an item has been loaded.
string | $item | Item to check. Current possibilities:
|
string | $all | 'all' to check if the whole object has been loaded or any other string to check if only the item is available (e.g. for optimisation) |
Definition at line 1168 of file User.php.
References true.
Referenced by getId(), getName(), and getRealName().
|
static |
User::isLocked | ( | ) |
User::isLoggedIn | ( | ) |
Get whether the user is logged in.
Definition at line 3380 of file User.php.
References getId().
Referenced by getRights(), isAnon(), spreadAnyEditBlock(), UserTest\testCheckAndSetTouched(), and UserTest\testLoggedIn().
User::isNewbie | ( | ) |
Determine whether the user is a newbie.
Newbies are either anonymous IPs, or the most recently created accounts.
Definition at line 4170 of file User.php.
References isAllowed().
Referenced by pingLimiter().
User::isPasswordReminderThrottled | ( | ) |
Has password reminder email been sent within the last $wgPasswordReminderResendTime hours?
User::isPingLimitable | ( | ) |
Is this user subject to rate limiting?
Definition at line 1769 of file User.php.
References $wgRateLimitsExcludedIPs, getRequest(), global, and isAllowed().
Referenced by pingLimiter().
User::isSafeToLoad | ( | ) |
Test if it's safe to load this User object.
You should typically check this before using $wgUser or RequestContext::getUser in a method that might be called before the system has been fully initialized. If the object is unsafe, you should use an anonymous user: \code $user = $wgUser->isSafeToLoad() ? $wgUser : new User; \endcode
Definition at line 341 of file User.php.
References $wgFullyInitialised, and global.
|
static |
Usernames which fail to pass this function will be blocked from user login and new account registrations, but may be used internally by batch processes.
If an account already exists in this form, login will be blocked by a failure to pass this function.
string | $name | Name to match |
Definition at line 853 of file User.php.
References $name, $wgReservedUsernames, as, global, and wfMessage().
Referenced by getCanonicalName().
User::isValidPassword | ( | $password | ) |
Is the input a valid password for this user?
string | $password | Desired password |
Definition at line 958 of file User.php.
References getPasswordValidity().
Referenced by UserTest\testCheckPasswordValidity().
|
static |
Is the input a valid username?
Checks if the input is a valid username, we don't want an empty string, an IP address, anything that contains slashes (would mess up subpages), is longer than the maximum allowed username size or doesn't begin with a capital letter.
string | $name | Name to match |
Definition at line 804 of file User.php.
References $name, $wgContLang, $wgMaxNameChars, and(), global, isIP(), and use.
Referenced by getCanonicalName().
User::isWatched | ( | $title, | |
$checkRights = self::CHECK_USER_RIGHTS |
|||
) |
Check the watched status of an article.
Title | $title | Title of the article to look at |
bool | $checkRights | Whether to check 'viewmywatchlist'/'editmywatchlist' rights. Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS. |
Definition at line 3507 of file User.php.
References $title.
|
static |
Return a list of the types of user options currently returned by User::getOptionKinds().
Currently, the option kinds are:
The API (and possibly others) use this function to determine the possible option types for validation purposes, so make sure to update this when a new option kind is added.
User::load | ( | $flags = self::READ_NORMAL | ) |
Load the user table data for this object from the source given by mFrom.
integer | $flags | User::READ_* constant bitfield |
Definition at line 358 of file User.php.
References $flags, $wgFullyInitialised, global, loadDefaults(), loadFromId(), loadFromSession(), and wfGetLB().
Referenced by RequestContext\importScopedSession(), MediaWiki\Session\UserInfo\newFromId(), LanguageConverterTest\testGetPreferredVariantUserOption(), and LanguageConverterTest\testGetPreferredVariantUserOptionForForeignLanguage().
User::loadDefaults | ( | $name = false | ) |
Set cached properties to default.
string | bool | $name |
Definition at line 1130 of file User.php.
References $name, pages, TS_MW, and wfTimestamp().
Referenced by load(), PPFuzzUser\load(), loadFromDatabase(), and loadFromId().
|
protected |
Load user data from shared cache, given mId has already been set.
Definition at line 472 of file User.php.
References $cache, $name, array(), as, DB_REPLICA, getCacheKey(), loadFromDatabase(), loadGroups(), loadOptions(), TS_UNIX, use, wfDebug(), wfGetDB(), and wfTimestamp().
Referenced by loadFromId().
User::loadFromDatabase | ( | $flags = self::READ_LATEST | ) |
Load user and user_group data from the database.
$this->mId must be set, this is how the user is identified.
integer | $flags | User::READ_* constant bitfield |
Definition at line 1220 of file User.php.
References $flags, $options, $s, DBAccessObjectUtils\getDBOptions(), getEditCount(), list, loadDefaults(), loadFromRow(), and wfGetDB().
Referenced by addToDatabase(), loadFromCache(), and loadFromId().
User::loadFromId | ( | $flags = self::READ_NORMAL | ) |
Load user table data, given mId has already been set.
integer | $flags | User::READ_* constant bitfield |
Definition at line 421 of file User.php.
References $flags, DBAccessObjectUtils\hasFlags(), loadDefaults(), loadFromCache(), and loadFromDatabase().
Referenced by load().
|
protected |
Initialize this object from a row from the user table.
stdClass | $row | Row from the user table to load. |
array | $data | Further user data to load into the object |
user_groups Array with groups out of the user_groups table user_properties Array with properties out of the user_properties table
Definition at line 1267 of file User.php.
References loadOptions(), setItemLoaded(), TS_MW, wfTimestamp(), and wfTimestampOrNull().
Referenced by loadFromDatabase().
|
private |
Load user data from the session.
Definition at line 1189 of file User.php.
References $user, getId(), getName(), getRequest(), getToken(), and loadFromUserObject().
Referenced by load().
|
protected |
|
private |
Load the groups from the database if they aren't already loaded.
Definition at line 1362 of file User.php.
References $res, as, DB_MASTER, DB_REPLICA, and wfGetDB().
Referenced by addGroup(), getGroups(), loadFromCache(), and removeGroup().
|
protected |
Load the user options either from cache, the database or an array.
array | $data | Rows for the current user out of the user_properties table |
Definition at line 5122 of file User.php.
References $dbr, $property, $res, $value, $wgContLang, as, DB_MASTER, DB_REPLICA, getId(), global, load, wfDebug(), and wfGetDB().
Referenced by getOption(), getOptionKinds(), getOptions(), loadFromCache(), loadFromRow(), saveOptions(), and setOption().
User::logout | ( | ) |
|
static |
Create a link to the group in HTML, if available; else return the group name.
string | $group | Internal name of the group |
string | $text | The text of the link |
Definition at line 4781 of file User.php.
References $title, and Linker\link().
|
static |
Builds update conditions.
Additional conditions may be added to $conditions to protected against race conditions using a compare-and-set (CAS) mechanism based on comparing $this->mTouched with the user_touched field.
Database | $db | |
array | $conditions | WHERE conditions for use with Database::update |
Definition at line 1442 of file User.php.
References Database\timestamp().
User::matchEditToken | ( | $val, | |
$salt = '' , |
|||
$request = null , |
|||
$maxage = null |
|||
) |
Check given value against the token value stored in the session.
A match should confirm that the form was submitted from the user's own login session, not a form submission from a third-party site.
string | $val | Input value to compare |
string | $salt | Optional function-specific data for hashing |
WebRequest | null | $request | Object to use or null to use $wgRequest |
int | $maxage | Fail tokens older than this, in seconds |
Definition at line 4280 of file User.php.
References $request, and getEditTokenObject().
Referenced by matchEditTokenNoSuffix().
User::matchEditTokenNoSuffix | ( | $val, | |
$salt = '' , |
|||
$request = null , |
|||
$maxage = null |
|||
) |
Check given value against the token value stored in the session, ignoring the suffix.
string | $val | Input value to compare |
string | $salt | Optional function-specific data for hashing |
WebRequest | null | $request | Object to use or null to use $wgRequest |
int | $maxage | Fail tokens older than this, in seconds |
Definition at line 4294 of file User.php.
References $request, and matchEditToken().
|
static |
|
static |
Factory method to fetch whichever user has a given email confirmation code.
This code is generated when an account is created or its e-mail address has changed.
If the code is invalid or has expired, returns NULL.
string | $code | Confirmation code |
int | $flags | User::READ_* bitfield |
Definition at line 567 of file User.php.
References $code, $flags, DB_MASTER, DB_REPLICA, newFromId(), and wfGetDB().
|
static |
Static factory method for creation from a given user ID.
int | $id | Valid user ID |
Definition at line 548 of file User.php.
References setItemLoaded().
Referenced by createNew(), and newFromConfirmationCode().
|
static |
Static factory method for creation from username.
This is slightly less efficient than newFromId(), so use newFromId() if you have both an ID and a name handy.
string | $name | Username, validated by Title::newFromText() |
string | bool | $validate | Validate username. Takes the same parameters as User::getCanonicalName(), except that true is accepted as an alias for 'valid', for BC. |
Definition at line 525 of file User.php.
References $name.
|
static |
Create a new user object from a user row.
The row should have the following fields from the user table in it:
stdClass | $row | A row from the user table |
array | $data | Further data to load into the object (see User::loadFromRow for valid keys) |
Definition at line 612 of file User.php.
References $user.
|
static |
|
static |
Static factory method for creation of a "system" user from username.
A "system" user is an account that's used to attribute logged actions taken by MediaWiki itself, as opposed to a bot or human user. Examples might include the 'Maintenance script' or 'Conversion script' accounts used by various scripts in the maintenance/ directory or accounts such as 'MediaWiki message delivery' used by the MassMessage extension.
This can optionally create the user if it doesn't exist, and "steal" the account if it does exist.
"Stealing" an existing user is intended to make it impossible for normal authentication processes to use the account, effectively disabling the account for normal use:
string | $name | Username |
array | $options | Options are:
|
Definition at line 653 of file User.php.
References $name, $options, $user, DB_MASTER, and wfGetDB().
|
private |
Generate a current or new-future timestamp to be stored in the user_touched field when we update things.
Definition at line 2332 of file User.php.
References $time, $wgClockSkewFudge, global, TS_MW, TS_UNIX, and wfTimestamp().
Referenced by addToDatabase(), checkAndSetTouched(), and saveSettings().
|
static |
Provide an array of HTML5 attributes to put on an input element intended for the user to enter a new password.
This may include required, title, and/or pattern, depending on $wgMinimalPasswordLength.
Do not use this when asking the user to enter his current password! Regardless of configuration, users may have invalid passwords for whatever reason (e.g., they were set before requirements were tightened up). Only use it when asking for a new password, like on account creation or ResetPass.
Obviously, you still need to do server-side checking.
NOTE: A combination of bugs in various browsers means that this function actually just returns array() unconditionally at the moment. May as well keep it around for when the browser bugs get fixed, though.
Definition at line 5285 of file User.php.
References $ret, $wgMinimalPasswordLength, and global.
User::pingLimiter | ( | $action = 'edit' , |
|
$incrBy = 1 |
|||
) |
Primitive rate limits: enforce maximum actions per time period to put a brake on flooding.
The method generates both a generic profiling point and a per action one (suffix being "-$action".
string | $action | Action to enforce; 'edit' if unspecified |
int | $incrBy | Positive amount to increment counter by [defaults to 1] |
Definition at line 1794 of file User.php.
References $cache, $count, $incrBy, $keys, $limit, $summary, $wgRateLimits, as, getGroups(), getId(), getRequest(), IP\getSubnet(), global, isNewbie(), isPingLimitable(), list, wfDebug(), wfDebugLog(), and wfMemcKey().
Referenced by PasswordReset\execute().
|
static |
|
static |
Return a random password.
Definition at line 1117 of file User.php.
References $wgMinimalPasswordLength, and global.
User::removeGroup | ( | $group | ) |
Remove the user from the given group.
This takes immediate effect.
string | $group | Name of the group to remove |
Definition at line 3340 of file User.php.
References DB_MASTER, getEffectiveGroups(), getId(), invalidateCache(), load, loadGroups(), and wfGetDB().
User::removeWatch | ( | $title, | |
$checkRights = self::CHECK_USER_RIGHTS |
|||
) |
Stop watching an article.
Title | $title | Title of the article to look at |
bool | $checkRights | Whether to check 'viewmywatchlist'/'editmywatchlist' rights. Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS. |
Definition at line 3538 of file User.php.
References $title, invalidateCache(), and isAllowed().
User::requiresHTTPS | ( | ) |
Determine based on the wiki configuration and the user's options, whether this user must be over HTTPS no matter what.
Definition at line 3108 of file User.php.
References $wgSecureLogin, getBoolOption(), getRequest(), global, and wfCanIPUseHTTPS().
|
static |
User::resetOptions | ( | $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ] , |
|
IContextSource | $context = null |
||
) |
Reset certain (or all) options to the site defaults.
The optional parameter determines which kinds of preferences will be reset. Supported values are everything that can be reported by getOptionKinds() and 'all', which forces a reset of all preferences and overrides everything else.
array | string | $resetKinds | Which kinds of preferences to reset. Defaults to array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ) for backwards-compatibility. |
IContextSource | null | $context | Context source used when $resetKinds does not contain 'all', passed to getOptionKinds(). Defaults to RequestContext::getMain() when null. |
Definition at line 3043 of file User.php.
References $context, $value, as, RequestContext\getMain(), getOptionKinds(), and load.
User::resetTokenFromOption | ( | $oname | ) |
Reset a token stored in the preferences (like the watchlist one).
Does not save user's preferences (similarly to setOption()).
string | $oname | The option name to reset the token in |
Definition at line 2902 of file User.php.
References $wgHiddenPrefs, MWCryptRand\generateHex(), global, and setOption().
|
protected |
Saves the non-default options for this user, as previously set e.g.
via setOption(), in the database's "user_properties" (preferences) table. Usually used via saveSettings().
Definition at line 5188 of file User.php.
References $res, $value, as, DB_MASTER, getId(), loadOptions(), and wfGetDB().
Referenced by addToDatabase(), and saveSettings().
User::saveSettings | ( | ) |
Save this user's settings into the database.
Definition at line 3847 of file User.php.
References $from, clearSharedCache(), DB_MASTER, getUserPage(), load, newTouchedTimestamp(), saveOptions(), wfGetDB(), and wfReadOnly().
Referenced by MediaWiki\Session\SessionBackend\save(), sendConfirmationMail(), and UserTest\testOptions().
|
static |
User::sendConfirmationMail | ( | $type = 'created' | ) |
Generate a new e-mail confirmation token and send a confirmation/invalidation mail to the user's given address.
string | $type | Message to send, either "created", "changed" or "set" |
Definition at line 4306 of file User.php.
References $type, $wgLang, confirmationToken(), confirmationTokenUrl(), getName(), getRequest(), global, invalidationTokenUrl(), saveSettings(), sendMail(), text, and wfMessage().
Referenced by setEmailWithConfirmation().
User::sendMail | ( | $subject, | |
$body, | |||
$from = null , |
|||
$replyto = null |
|||
) |
Send an e-mail to this user's account.
Does not check for confirmed status or validity.
string | $subject | Message subject |
string | $body | Message body |
User | null | $from | Optional sending user; if unspecified, default $wgPasswordSender will be used. |
string | $replyto | Reply-To address |
Definition at line 4345 of file User.php.
References $from, $wgPasswordSender, global, MailAddress\newFromUser(), UserMailer\send(), text, and wfMessage().
Referenced by sendConfirmationMail(), and setEmailWithConfirmation().
|
protected |
Set a cookie on the user's client.
Wrapper for WebResponse::setCookie
string | $name | Name of the cookie to set |
string | $value | Value to set |
int | $exp | Expiration time, as a UNIX time value; if 0 or not specified, use the default $wgCookieExpiration |
bool | $secure | true: Force setting the secure attribute when setting the cookie false: Force NOT setting the secure attribute when setting the cookie null (default): Use the default ($wgCookieSecure) to set the secure attribute |
array | $params | Array of options sent passed to WebResponse::setcookie() |
WebRequest | null | $request | WebRequest object to use; $wgRequest will be used if null is passed. |
Definition at line 3703 of file User.php.
References $name, $params, $request, $value, getRequest(), and wfDeprecated().
Referenced by clearCookie(), and setExtendedLoginCookie().
User::setCookies | ( | $request = null , |
|
$secure = null , |
|||
$rememberMe = false |
|||
) |
Persist this user's session (e.g.
set cookies)
WebRequest | null | $request | WebRequest object to use; $wgRequest will be used if null is passed. |
bool | $secure | Whether to force secure/insecure cookies or use default |
bool | $rememberMe | Whether to add a Token cookie for elongated sessions |
Definition at line 3765 of file User.php.
References $request, ContextSource\getRequest(), getRequest(), and load.
User::setEmail | ( | $str | ) |
Set the user's e-mail address.
string | $str | New e-mail address |
Definition at line 2667 of file User.php.
References invalidateEmail(), and load.
Referenced by PreferencesTest\__construct(), and setEmailWithConfirmation().
User::setEmailAuthenticationTimestamp | ( | $timestamp | ) |
Set the e-mail authentication timestamp.
string | $timestamp | TS_MW timestamp |
Definition at line 4460 of file User.php.
References $timestamp, and load.
Referenced by confirmEmail(), and invalidateEmail().
User::setEmailWithConfirmation | ( | $str | ) |
Set the user's e-mail address and a confirmation mail if needed.
string | $str | New e-mail address |
Definition at line 2684 of file User.php.
References $type, $wgEmailAuthentication, $wgEnableEmail, getEmail(), getName(), getRequest(), global, sendConfirmationMail(), sendMail(), setEmail(), text, and wfMessage().
|
protected |
Set an extended login cookie on the user's client.
The expiry of the cookie is controlled by the $wgExtendedLoginCookieExpiration configuration variable.
string | $name | Name of the cookie to set |
string | $value | Value to set |
bool | $secure | true: Force setting the secure attribute when setting the cookie false: Force NOT setting the secure attribute when setting the cookie null (default): Use the default ($wgCookieSecure) to set the secure attribute |
Definition at line 3744 of file User.php.
References $name, $value, $wgCookieExpiration, $wgExtendedLoginCookieExpiration, global, setCookie(), and wfDeprecated().
User::setId | ( | $v | ) |
Set the user and reload all fields according to a given ID.
int | $v | User ID to reload |
Definition at line 2099 of file User.php.
References clearInstanceCache().
User::setInternalPassword | ( | $str | ) |
Set the password and reset the random token unconditionally.
string | null | $str | New password to set or null to set an invalid password hash meaning that the user will not be able to log in through the web interface. |
Definition at line 2494 of file User.php.
References setPasswordInternal().
|
protected |
Set that an item has been loaded.
string | $item |
Definition at line 1178 of file User.php.
Referenced by loadFromRow(), and newFromId().
User::setName | ( | $str | ) |
Set the user name.
This does not reload fields from the database according to the given name. Rather, it is used to create a temporary "nonexistent user" for later addition to the database. It can also be used to set the IP address for an anonymous user to something other than the current remote IP.
string | $str | New user name to set |
Definition at line 2135 of file User.php.
References load.
Referenced by MediaWiki\Auth\AuthManager\continueAccountCreation().
User::setNewpassword | ( | $str, | |
$throttle = true |
|||
) |
Set the password for a password reminder or new account email.
string | $str | New password to set or null to set an invalid password hash meaning that the user will not be able to use it |
bool | $throttle | If true, reset the throttle timestamp to the present |
User::setNewtalk | ( | $val, | |
$curRev = null |
|||
) |
Update the 'You have new messages!' status.
bool | $val | Whether the user has new messages |
Revision | $curRev | New, as yet unseen revision of the user talk page. Ignored if null or !$val. |
Definition at line 2300 of file User.php.
References deleteNewtalk(), getId(), getName(), invalidateCache(), isAnon(), load, updateNewtalk(), and wfReadOnly().
Referenced by clearAllNotifications(), and clearNotification().
User::setOption | ( | $oname, | |
$val | |||
) |
Set the given option for a user.
You need to call saveSettings() to actually write to the database.
string | $oname | The option to set |
mixed | $val | New value to set |
Definition at line 2853 of file User.php.
References loadOptions().
Referenced by resetTokenFromOption(), setPasswordInternal(), and UserTest\testOptions().
User::setPassword | ( | $str | ) |
Set the password and reset the random token.
Calls through to authentication plugin if necessary; will have no effect if the auth plugin refuses to pass the change through or if the legal password checks fail.
As a special case, setting the password to null wipes it, so the account cannot be logged in until a new password is set, for instance via e-mail.
string | $str | New password to set |
PasswordError | On failure |
Definition at line 2482 of file User.php.
References setPasswordInternal().
|
private |
Actually set the password and such.
string | null | $str | New password to set or null to set an invalid password hash meaning that the user will not be able to log in through the web interface. |
Definition at line 2506 of file User.php.
References $status, changeAuthenticationData(), getName(), and setOption().
Referenced by setInternalPassword(), and setPassword().
User::setRealName | ( | $str | ) |
User::setToken | ( | $token = false | ) |
Set the random token (used for persistent authentication) Called from loadDefaults() among other places.
string | bool | $token | If specified, set the token to this value |
Definition at line 2609 of file User.php.
References MWCryptRand\generateHex(), and load.
Referenced by addToDatabase(), and getToken().
User::spreadAnyEditBlock | ( | ) |
If this user is logged-in and blocked, block any IP address they've successfully logged in from.
Definition at line 4079 of file User.php.
References isBlocked(), isLoggedIn(), and spreadBlock().
|
protected |
If this (non-anonymous) user is blocked, block the IP address they've successfully logged in from.
Definition at line 4092 of file User.php.
References getName(), getRequest(), load, Block\newFromTarget(), and wfDebug().
Referenced by spreadAnyEditBlock().
User::touch | ( | ) |
Update the "touched" timestamp for the user.
This is useful on various login/logout events when making sure that a browser or proxy that has multiple tenants does not suffer cache pollution where the new user sees the old users content. The value of getTouched() is checked when determining 304 vs 200 responses. Unlike invalidateCache(), this preserves the User object cache and avoids database writes.
Definition at line 2394 of file User.php.
References getId(), and wfMemcKey().
Referenced by invalidateCache().
|
protected |
Add or update the new messages flag.
string | $field | 'user_ip' for anonymous users, 'user_id' otherwise |
string | int | $id | User's IP address for anonymous users, User ID otherwise |
Revision | null | $curRev | New, as yet unseen revision of the user talk page. Ignored if null. |
Definition at line 2255 of file User.php.
References DB_MASTER, wfDebug(), and wfGetDB().
Referenced by setNewtalk().
User::useFilePatrol | ( | ) |
Check whether to enable new files patrol features for this user.
Definition at line 3477 of file User.php.
References $wgUseFilePatrol, $wgUseRCPatrol, global, and isAllowedAny().
User::useNPPatrol | ( | ) |
Check whether to enable new pages patrol features for this user.
Definition at line 3465 of file User.php.
References $wgUseNPPatrol, $wgUseRCPatrol, global, and isAllowedAny().
User::useRCPatrol | ( | ) |
Check whether to enable recent changes patrol features for this user.
Definition at line 3456 of file User.php.
References $wgUseRCPatrol, global, and isAllowedAny().
User::validateCache | ( | $timestamp | ) |
Validate the cache for this account.
string | $timestamp | A timestamp in TS_MW format |
Definition at line 2408 of file User.php.
References $timestamp, and getTouched().
|
static |
Get the username corresponding to a given user ID.
int | $id | User ID |
Definition at line 708 of file User.php.
References UserCache\singleton().
|
static |
Get the real name of a user given their user ID.
int | $id | User ID |
Definition at line 718 of file User.php.
References UserCache\singleton().
|
staticprotected |
|
staticprotected |
Array of Strings List of member variables which are saved to the shared cache (memcached).
Any operation which changes the corresponding database fields must call a cache-clearing function.
|
staticprotected |
Array of Strings Core rights.
Each of these should have a corresponding message of the form "right-$right".
User::$mFrom |
String Initialization data source if mLoadedItems!==true.
May be one of:
Use the User::newFrom*() family of functions to set this.
|
protected |
|
protected |
User::$mOptionsLoaded |
|
protected |
|
private |
|
protected |
const User::EDIT_TOKEN_SUFFIX = EDIT_TOKEN_SUFFIX |
Global constant made accessible as class constants so that autoloader magic can be used.
const User::GETOPTIONS_EXCLUDE_DEFAULTS = 1 |
const User::INVALID_TOKEN = '*** INVALID ***' |
const User::TOKEN_LENGTH = 32 |
const User::VERSION = 10 |