MediaWiki
1.33.0
|
Public Member Functions | |
getOption ( $oname, $defaultOverride=null, $ignoreHidden=false) | |
Get the user's current setting for a given option. More... | |
load ( $flags=null) | |
Load the user table data for this object from the source given by mFrom. More... | |
Public Member Functions inherited from User | |
__construct () | |
Lightweight constructor for an anonymous user. More... | |
__toString () | |
getMutableCacheKeys (WANObjectCache $cache) | |
isSafeToLoad () | |
Test if it's safe to load this User object. More... | |
loadFromId ( $flags=self::READ_NORMAL) | |
Load user table data, given mId has already been set. More... | |
isIPRange () | |
Is the user an IP range? More... | |
isValidPassword ( $password) | |
Is the input a valid password for this user? More... | |
getPasswordValidity ( $password) | |
Given unvalidated password input, return error message on failure. More... | |
checkPasswordValidity ( $password) | |
Check if this is a valid password for this user. More... | |
loadDefaults ( $name=false) | |
Set cached properties to default. More... | |
isItemLoaded ( $item, $all='all') | |
Return whether an item has been loaded. More... | |
trackBlockWithCookie () | |
Set the 'BlockID' cookie depending on block type and user authentication status. More... | |
loadFromDatabase ( $flags=self::READ_LATEST) | |
Load user and user_group data from the database. More... | |
addAutopromoteOnceGroups ( $event) | |
Add the user to the group if he/she meets given criteria. More... | |
clearInstanceCache ( $reloadFrom=false) | |
Clear various cached data stored in this object. More... | |
isDnsBlacklisted ( $ip, $checkWhitelist=false) | |
Whether the given IP is in a DNS blacklist. More... | |
inDnsBlacklist ( $ip, $bases) | |
Whether the given IP is in a given DNS blacklist. More... | |
isPingLimitable () | |
Is this user subject to rate limiting? More... | |
pingLimiter ( $action='edit', $incrBy=1) | |
Primitive rate limits: enforce maximum actions per time period to put a brake on flooding. More... | |
isBlocked ( $fromReplica=true) | |
Check if user is blocked. More... | |
getBlock ( $fromReplica=true) | |
Get the block affecting the user, or null if the user is not blocked. More... | |
isBlockedFrom ( $title, $fromReplica=false) | |
Check if user is blocked from editing a particular article. More... | |
blockedBy () | |
If user is blocked, return the name of the user who placed the block. More... | |
blockedFor () | |
If user is blocked, return the specified reason for the block. More... | |
getBlockId () | |
If user is blocked, return the ID for the block. More... | |
isBlockedGlobally ( $ip='') | |
Check if user is blocked on all wikis. More... | |
getGlobalBlock ( $ip='') | |
Check if user is blocked on all wikis. More... | |
isLocked () | |
Check if user account is locked. More... | |
isHidden () | |
Check if user account is hidden. More... | |
getId () | |
Get the user's ID. More... | |
setId ( $v) | |
Set the user and reload all fields according to a given ID. More... | |
getName () | |
Get the user name, or the IP of an anonymous user. More... | |
setName ( $str) | |
Set the user name. More... | |
getActorId (IDatabase $dbw=null) | |
Get the user's actor ID. More... | |
getTitleKey () | |
Get the user's name escaped by underscores. More... | |
getNewtalk () | |
Check if the user has new messages. More... | |
getNewMessageLinks () | |
Return the data needed to construct links for new talk page message alerts. More... | |
getNewMessageRevisionId () | |
Get the revision ID for the last talk page revision viewed by the talk page owner. More... | |
setNewtalk ( $val, $curRev=null) | |
Update the 'You have new messages!' status. More... | |
clearSharedCache ( $mode='changed') | |
Clear user data from memcached. More... | |
invalidateCache () | |
Immediately touch the user data cache for this account. More... | |
touch () | |
Update the "touched" timestamp for the user. More... | |
validateCache ( $timestamp) | |
Validate the cache for this account. More... | |
getTouched () | |
Get the user touched timestamp. More... | |
getDBTouched () | |
Get the user_touched timestamp field (time of last DB updates) More... | |
setPassword ( $str) | |
Set the password and reset the random token. More... | |
setInternalPassword ( $str) | |
Set the password and reset the random token unconditionally. More... | |
changeAuthenticationData (array $data) | |
Changes credentials of the user. More... | |
getToken ( $forceCreation=true) | |
Get the user's current token. More... | |
setToken ( $token=false) | |
Set the random token (used for persistent authentication) Called from loadDefaults() among other places. More... | |
setNewpassword ( $str, $throttle=true) | |
Set the password for a password reminder or new account email. More... | |
getEmail () | |
Get the user's e-mail address. More... | |
getEmailAuthenticationTimestamp () | |
Get the timestamp of the user's e-mail authentication. More... | |
setEmail ( $str) | |
Set the user's e-mail address. More... | |
setEmailWithConfirmation ( $str) | |
Set the user's e-mail address and a confirmation mail if needed. More... | |
getRealName () | |
Get the user's real name. More... | |
setRealName ( $str) | |
Set the user's real name. More... | |
getOptions ( $flags=0) | |
Get all user's options. More... | |
getBoolOption ( $oname) | |
Get the user's current setting for a given option, as a boolean value. More... | |
getIntOption ( $oname, $defaultOverride=0) | |
Get the user's current setting for a given option, as an integer value. More... | |
setOption ( $oname, $val) | |
Set the given option for a user. More... | |
getTokenFromOption ( $oname) | |
Get a token stored in the preferences (like the watchlist one), resetting it if it's empty (and saving changes). More... | |
resetTokenFromOption ( $oname) | |
Reset a token stored in the preferences (like the watchlist one). More... | |
getOptionKinds (IContextSource $context, $options=null) | |
Return an associative array mapping preferences keys to the kind of a preference they're used for. More... | |
resetOptions ( $resetKinds=[ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused'], IContextSource $context=null) | |
Reset certain (or all) options to the site defaults. More... | |
getDatePreference () | |
Get the user's preferred date format. More... | |
requiresHTTPS () | |
Determine based on the wiki configuration and the user's options, whether this user must be over HTTPS no matter what. More... | |
getStubThreshold () | |
Get the user preferred stub threshold. More... | |
getRights () | |
Get the permissions this user has. More... | |
getGroups () | |
Get the list of explicit group memberships this user has. More... | |
getGroupMemberships () | |
Get the list of explicit group memberships this user has, stored as UserGroupMembership objects. More... | |
getEffectiveGroups ( $recache=false) | |
Get the list of implicit group memberships this user has. More... | |
getAutomaticGroups ( $recache=false) | |
Get the list of implicit group memberships this user has. More... | |
getFormerGroups () | |
Returns the groups the user has belonged to. More... | |
getEditCount () | |
Get the user's edit count. More... | |
addGroup ( $group, $expiry=null) | |
Add the user to the given group. More... | |
removeGroup ( $group) | |
Remove the user from the given group. More... | |
isLoggedIn () | |
Get whether the user is logged in. More... | |
isAnon () | |
Get whether the user is anonymous. More... | |
isBot () | |
isAllowedAny () | |
Check if user is allowed to access a feature / make an action. More... | |
isAllowedAll () | |
isAllowed ( $action='') | |
Internal mechanics of testing a permission. More... | |
useRCPatrol () | |
Check whether to enable recent changes patrol features for this user. More... | |
useNPPatrol () | |
Check whether to enable new pages patrol features for this user. More... | |
useFilePatrol () | |
Check whether to enable new files patrol features for this user. More... | |
getRequest () | |
Get the WebRequest object to use with this object. More... | |
isWatched ( $title, $checkRights=self::CHECK_USER_RIGHTS) | |
Check the watched status of an article. More... | |
addWatch ( $title, $checkRights=self::CHECK_USER_RIGHTS) | |
Watch an article. More... | |
removeWatch ( $title, $checkRights=self::CHECK_USER_RIGHTS) | |
Stop watching an article. More... | |
clearNotification (&$title, $oldid=0) | |
Clear the user's notification timestamp for the given title. More... | |
clearAllNotifications () | |
Resets all of the given user's page-change notification timestamps. More... | |
getExperienceLevel () | |
Compute experienced level based on edit count and registration date. More... | |
setCookies ( $request=null, $secure=null, $rememberMe=false) | |
Persist this user's session (e.g. More... | |
logout () | |
Log this user out. More... | |
doLogout () | |
Clear the user's session, and reset the instance cache. More... | |
saveSettings () | |
Save this user's settings into the database. More... | |
idForName ( $flags=0) | |
If only this user's username is known, and it exists, return the user ID. More... | |
addToDatabase () | |
Add this existing user object to the database. More... | |
spreadAnyEditBlock () | |
If this user is logged-in and blocked, block any IP address they've successfully logged in from. More... | |
isBlockedFromCreateAccount () | |
Get whether the user is explicitly blocked from account creation. More... | |
isBlockedFromEmailuser () | |
Get whether the user is blocked from using Special:Emailuser. More... | |
isBlockedFromUpload () | |
Get whether the user is blocked from using Special:Upload. More... | |
isAllowedToCreateAccount () | |
Get whether the user is allowed to create an account. More... | |
getUserPage () | |
Get this user's personal page title. More... | |
getTalkPage () | |
Get this user's talk page title. More... | |
isNewbie () | |
Determine whether the user is a newbie. More... | |
checkPassword ( $password) | |
Check to see if the given clear-text password is one of the accepted passwords. More... | |
checkTemporaryPassword ( $plaintext) | |
Check if the given clear-text password matches the temporary password sent by e-mail for password reset operations. More... | |
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. More... | |
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. More... | |
matchEditToken ( $val, $salt='', $request=null, $maxage=null) | |
Check given value against the token value stored in the session. More... | |
matchEditTokenNoSuffix ( $val, $salt='', $request=null, $maxage=null) | |
Check given value against the token value stored in the session, ignoring the suffix. More... | |
sendConfirmationMail ( $type='created') | |
Generate a new e-mail confirmation token and send a confirmation/invalidation mail to the user's given address. More... | |
sendMail ( $subject, $body, $from=null, $replyto=null) | |
Send an e-mail to this user's account. More... | |
confirmEmail () | |
Mark the e-mail address confirmed. More... | |
invalidateEmail () | |
Invalidate the user's e-mail confirmation, and unauthenticate the e-mail address if it was already confirmed. More... | |
setEmailAuthenticationTimestamp ( $timestamp) | |
Set the e-mail authentication timestamp. More... | |
canSendEmail () | |
Is this user allowed to send e-mails within limits of current site configuration? More... | |
canReceiveEmail () | |
Is this user allowed to receive e-mails within limits of current site configuration? More... | |
isEmailConfirmed () | |
Is this user's e-mail address valid-looking and confirmed within limits of the current site configuration? More... | |
isEmailConfirmationPending () | |
Check whether there is an outstanding request for e-mail confirmation. More... | |
getRegistration () | |
Get the timestamp of account creation. More... | |
getFirstEditTimestamp () | |
Get the timestamp of the first edit. More... | |
getLatestEditTimestamp () | |
Get the timestamp of the latest edit. More... | |
changeableGroups () | |
Returns an array of groups that this user can add and remove. More... | |
incEditCount () | |
Schedule a deferred update to update the user's edit count. More... | |
setEditCountInternal ( $count) | |
This method should not be called outside User/UserEditCountUpdate. More... | |
initEditCountInternal () | |
Initialize user_editcount from data out of the revision table. More... | |
addNewUserLogEntry ( $action=false, $reason='') | |
Add a newuser log entry for this user. More... | |
addNewUserLogEntryAutoCreate () | |
Add an autocreate newuser log entry for this user Used by things like CentralAuth and perhaps other authplugins. More... | |
getInstanceForUpdate () | |
Get a new instance of this user that was loaded from the master via a locking read. More... | |
equals (UserIdentity $user) | |
Checks if two user objects point to the same user. More... | |
isAllowUsertalk () | |
Checks if usertalk is allowed. More... | |
Public Member Functions inherited from MediaWiki\User\UserIdentity | |
getActorId () | |
Public Attributes | |
$mDataLoaded | |
$ppfz_test | |
Public Attributes inherited from User | |
Block | $mBlock |
string | $mBlockedby |
string | $mEmail |
string | $mEmailAuthenticated |
$mFrom | |
String Initialization data source if mLoadedItems!==true. More... | |
bool | $mHideName |
int | $mId |
Cache variables. More... | |
string | $mName |
array | $mOptions |
$mOptionsLoaded | |
Bool Whether the cache variables have been loaded. More... | |
string | $mRealName |
array | $mRights |
string | $mTouched |
TS_MW timestamp from the DB. More... | |
const | CHECK_USER_RIGHTS = true |
const | GETOPTIONS_EXCLUDE_DEFAULTS = 1 |
Exclude user options that are set to their default value. More... | |
const | IGNORE_USER_RIGHTS = false |
const | INVALID_TOKEN = '*** INVALID ***' |
@const string An invalid value for user_token More... | |
const | TOKEN_LENGTH = 32 |
@const int Number of characters in user_token field. More... | |
const | VERSION = 13 |
@const int Serialized record version. More... | |
Public Attributes inherited from IDBAccessObject | |
const | READ_LOCKING = self::READ_LATEST | 2 |
Constants for object loading bitfield flags (higher => higher QoS) More... | |
const | READ_NONE = -1 |
Additional Inherited Members | |
Static Public Member Functions inherited from User | |
static | purge ( $wikiId, $userId) |
static | newFromName ( $name, $validate='valid') |
Static factory method for creation from username. More... | |
static | newFromId ( $id) |
Static factory method for creation from a given user ID. More... | |
static | newFromActorId ( $id) |
Static factory method for creation from a given actor ID. More... | |
static | newFromIdentity (UserIdentity $identity) |
Returns a User object corresponding to the given UserIdentity. More... | |
static | newFromAnyId ( $userId, $userName, $actorId) |
Static factory method for creation from an ID, name, and/or actor ID. More... | |
static | newFromConfirmationCode ( $code, $flags=0) |
Factory method to fetch whichever user has a given email confirmation code. More... | |
static | newFromSession (WebRequest $request=null) |
Create a new user object using data from session. More... | |
static | newFromRow ( $row, $data=null) |
Create a new user object from a user row. More... | |
static | newSystemUser ( $name, $options=[]) |
Static factory method for creation of a "system" user from username. More... | |
static | whoIs ( $id) |
Get the username corresponding to a given user ID. More... | |
static | whoIsReal ( $id) |
Get the real name of a user given their user ID. More... | |
static | idFromName ( $name, $flags=self::READ_NORMAL) |
Get database id given a user name. More... | |
static | resetIdByNameCache () |
Reset the cache used in idFromName(). More... | |
static | isIP ( $name) |
Does the string match an anonymous IP address? More... | |
static | isValidUserName ( $name) |
Is the input a valid username? More... | |
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. More... | |
static | findUsersByGroup ( $groups, $limit=5000, $after=null) |
Return the users who are members of the given group(s). More... | |
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. More... | |
static | getCanonicalName ( $name, $validate='valid') |
Given unvalidated user input, return a canonical username, or false if the username is invalid. More... | |
static | randomPassword () |
Return a random password. More... | |
static | resetGetDefaultOptionsForTestsOnly () |
Reset the process cache of default user options. More... | |
static | getDefaultOptions () |
Combine the language default options with any site-specific options and add the default language variants. More... | |
static | getDefaultOption ( $opt) |
Get a given default option value. More... | |
static | isLocallyBlockedProxy ( $ip) |
Check if an IP address is in the local proxy list. More... | |
static | listOptionKinds () |
Return a list of the types of user options currently returned by User::getOptionKinds(). More... | |
static | createNew ( $name, $params=[]) |
Add a user to the database, return the user object. More... | |
static | getGroupPermissions ( $groups) |
Get the permissions associated with a given list of groups. More... | |
static | getGroupsWithPermission ( $role) |
Get all the groups who have a given permission. More... | |
static | groupHasPermission ( $group, $role) |
Check, if the given group has the given permission. More... | |
static | isEveryoneAllowed ( $right) |
Check if all users may be assumed to have the given permission. More... | |
static | getAllGroups () |
Return the set of defined explicit groups. More... | |
static | getAllRights () |
Get a list of all available permissions. More... | |
static | getImplicitGroups () |
Get a list of implicit groups TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals. More... | |
static | getGroupPage ( $group) |
Get the title of a page describing a particular group. More... | |
static | makeGroupLinkHTML ( $group, $text='') |
Create a link to the group in HTML, if available; else return the group name. More... | |
static | makeGroupLinkWiki ( $group, $text='') |
Create a link to the group in Wikitext, if available; else return the group name. More... | |
static | changeableByGroup ( $group) |
Returns an array of the groups that a particular group can add/remove. More... | |
static | getRightDescription ( $right) |
Get the description of a given right. More... | |
static | getGrantName ( $grant) |
Get the name of a given grant. More... | |
static | selectFields () |
Return the list of user fields that should be selected to create a new user object. More... | |
static | getQueryInfo () |
Return the tables, fields, and join conditions to be selected to create a new user object. More... | |
static | newFatalPermissionDeniedStatus ( $permission) |
Factory function for fatal permission-denied errors. More... | |
Static Public Attributes inherited from User | |
static | $idCacheByName = [] |
Protected Member Functions inherited from User | |
getCacheKey (WANObjectCache $cache) | |
loadFromCache () | |
Load user data from shared cache, given mId has already been set. More... | |
setItemLoaded ( $item) | |
Set that an item has been loaded. More... | |
loadFromRow ( $row, $data=null) | |
Initialize this object from a row from the user table. More... | |
loadFromUserObject ( $user) | |
Load the data for this user object from another user object. More... | |
makeUpdateConditions (IDatabase $db, array $conditions) | |
Builds update conditions. More... | |
checkAndSetTouched () | |
Bump user_touched if it didn't change since this object was loaded. More... | |
getBlockFromCookieValue ( $blockCookieVal) | |
Try to load a Block from an ID given in a cookie value. More... | |
checkNewtalk ( $field, $id) | |
Internal uncached check for new messages. More... | |
updateNewtalk ( $field, $id, $curRev=null) | |
Add or update the new messages flag. More... | |
deleteNewtalk ( $field, $id) | |
Clear the new messages flag for the given user. More... | |
spreadBlock () | |
If this (non-anonymous) user is blocked, block the IP address they've successfully logged in from. More... | |
confirmationToken (&$expiration) | |
Generate, store, and return a new e-mail confirmation code. More... | |
confirmationTokenUrl ( $token) | |
Return a URL the user can use to confirm their email address. More... | |
invalidationTokenUrl ( $token) | |
Return a URL the user can use to invalidate their email address. More... | |
getTokenUrl ( $page, $token) | |
Internal function to format the e-mail validation/invalidation URLs. More... | |
loadOptions ( $data=null) | |
Load the user options either from cache, the database or an array. More... | |
saveOptions () | |
Saves the non-default options for this user, as previously set e.g. More... | |
Protected Attributes inherited from User | |
int null | $mActorId |
bool | $mAllowUsertalk |
string | $mBlockreason |
string | $mDatePreference |
int | $mEditCount |
array | $mEffectiveGroups |
string | $mEmailToken |
string | $mEmailTokenExpires |
array | $mFormerGroups |
Block | $mGlobalBlock |
UserGroupMembership[] | $mGroupMemberships |
Associative array of (group name => UserGroupMembership object) More... | |
string | $mHash |
array | $mImplicitGroups |
$mLoadedItems = [] | |
Array with already loaded items or true if all items have been loaded. More... | |
bool | $mLocked |
$mNewtalk | |
Lazy-initialized variables, invalidated with clearInstanceCache. More... | |
array | $mOptionOverrides |
string | $mQuickTouched |
TS_MW timestamp from cache. More... | |
string | $mRegistration |
string | $mToken |
int | $queryFlagsUsed = self::READ_NORMAL |
User::READ_* constant bitfield used to load data. More... | |
Static Protected Attributes inherited from User | |
static | $mAllRights = false |
String Cached results of getAllRights() More... | |
static | $mCacheVars |
Array of Strings List of member variables which are saved to the shared cache (memcached). More... | |
static | $mCoreRights |
Array of Strings Core rights. More... | |
Definition at line 239 of file preprocessorFuzzTest.php.
Get the user's current setting for a given option.
string | $oname | The option to check |
string | array | null | $defaultOverride | A default value returned if the option does not exist |
bool | $ignoreHidden | Whether to ignore the effects of $wgHiddenPrefs |
Reimplemented from User.
Definition at line 250 of file preprocessorFuzzTest.php.
PPFuzzUser::load | ( | $flags = null | ) |
Load the user table data for this object from the source given by mFrom.
int | $flags | User::READ_* constant bitfield |
Reimplemented from User.
Definition at line 242 of file preprocessorFuzzTest.php.
References User\loadDefaults().
PPFuzzUser::$mDataLoaded |
Definition at line 240 of file preprocessorFuzzTest.php.
PPFuzzUser::$ppfz_test |
Definition at line 240 of file preprocessorFuzzTest.php.