*/
/**
- * \type{\int} Number of characters in user_token field.
+ * \int Number of characters in user_token field.
* @ingroup Constants
*/
define( 'USER_TOKEN_LENGTH', 32 );
/**
- * \type{\int} Serialized record version.
+ * \int Serialized record version.
* @ingroup Constants
*/
define( 'MW_USER_VERSION', 6 );
/**
- * \type{\string} Some punctuation to prevent editing from broken text-mangling proxies.
+ * \string Some punctuation to prevent editing from broken text-mangling proxies.
* @ingroup Constants
*/
define( 'EDIT_TOKEN_SUFFIX', '+\\' );
'userrights',
);
/**
- * \type{\string} Cached results of getAllRights()
+ * \string Cached results of getAllRights()
*/
static $mAllRights = false;
//@}
/**
- * \type{\bool} Whether the cache variables have been loaded.
+ * \bool Whether the cache variables have been loaded.
*/
var $mDataLoaded, $mAuthLoaded;
/**
- * \type{\string} Initialization data source if mDataLoaded==false. May be one of:
+ * \string Initialization data source if mDataLoaded==false. May be one of:
* - 'defaults' anonymous user initialised from class defaults
* - 'name' initialise from mName
* - 'id' initialise from mId
/**
* Load user table data, given mId has already been set.
- * @return \type{\bool} false if the ID does not exist, true otherwise
+ * @return \bool false if the ID does not exist, true otherwise
* @private
*/
function loadFromId() {
* This is slightly less efficient than newFromId(), so use newFromId() if
* you have both an ID and a name handy.
*
- * @param $name \type{\string} Username, validated by Title::newFromText()
- * @param $validate \type{\mixed} Validate username. Takes the same parameters as
+ * @param $name \string Username, validated by Title::newFromText()
+ * @param $validate \mixed Validate username. Takes the same parameters as
* User::getCanonicalName(), except that true is accepted as an alias
* for 'valid', for BC.
*
/**
* Static factory method for creation from a given user ID.
*
- * @param $id \type{\int} Valid user ID
+ * @param $id \int Valid user ID
* @return \type{User} The corresponding User object
*/
static function newFromId( $id ) {
*
* If the code is invalid or has expired, returns NULL.
*
- * @param $code \type{\string} Confirmation code
+ * @param $code \string Confirmation code
* @return \type{User}
*/
static function newFromConfirmationCode( $code ) {
/**
* Get the username corresponding to a given user ID
- * @param $id \type{\int} %User ID
- * @return \type{\string} The corresponding username
+ * @param $id \int User ID
+ * @return \string The corresponding username
*/
static function whoIs( $id ) {
$dbr = wfGetDB( DB_SLAVE );
/**
* Get the real name of a user given their user ID
*
- * @param $id \type{\int} %User ID
- * @return \type{\string} The corresponding user's real name
+ * @param $id \int User ID
+ * @return \string The corresponding user's real name
*/
static function whoIsReal( $id ) {
$dbr = wfGetDB( DB_SLAVE );
/**
* Get database id given a user name
- * @param $name \type{\string} Username
- * @return \twotypes{\int,\null} The corresponding user's ID, or null if user is nonexistent
+ * @param $name \string Username
+ * @return \2types{\int,\null} The corresponding user's ID, or null if user is nonexistent
* @static
*/
static function idFromName( $name ) {
* addresses like this, if we allowed accounts like this to be created
* new users could get the old edits of these anonymous users.
*
- * @param $name \type{\string} String to match
- * @return \type{\bool} True or false
+ * @param $name \string String to match
+ * @return \bool True or false
*/
static function isIP( $name ) {
return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP::isIPv6($name);
* is longer than the maximum allowed username size or doesn't begin with
* a capital letter.
*
- * @param $name \type{\string} String to match
- * @return \type{\bool} True or false
+ * @param $name \string String to match
+ * @return \bool True or false
*/
static function isValidUserName( $name ) {
global $wgContLang, $wgMaxNameChars;
* If an account already exists in this form, login will be blocked
* by a failure to pass this function.
*
- * @param $name \type{\string} String to match
- * @return \type{\bool} True or false
+ * @param $name \string String to match
+ * @return \bool True or false
*/
static function isUsableName( $name ) {
global $wgReservedUsernames;
* rather than in isValidUserName() to avoid disrupting
* existing accounts.
*
- * @param $name \type{\string} String to match
- * @return \type{\bool} True or false
+ * @param $name \string String to match
+ * @return \bool True or false
*/
static function isCreatableName( $name ) {
return
/**
* Is the input a valid password for this user?
*
- * @param $password \type{\string} Desired password
- * @return \type{\bool} True or false
+ * @param $password \string Desired password
+ * @return \bool True or false
*/
function isValidPassword( $password ) {
global $wgMinimalPasswordLength, $wgContLang;
*
* @todo Check for RFC 2822 compilance (bug 959)
*
- * @param $addr \type{\string} E-mail address
- * @return \type{\bool} True or false
+ * @param $addr \string E-mail address
+ * @return \bool True or false
*/
public static function isValidEmailAddr( $addr ) {
$result = null;
/**
* Given unvalidated user input, return a canonical username, or false if
* the username is invalid.
- * @param $name \type{\string} User input
- * @param $validate \twotypes{\string,\bool} Type of validation to use:
+ * @param $name \string User input
+ * @param $validate \2types{\string,\bool} Type of validation to use:
* - false No validation
* - 'valid' Valid for batch processes
* - 'usable' Valid for batch processes and login
* Count the number of edits of a user
* @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
*
- * @param $uid \type{\int} %User ID to check
- * @return \type{\int} The user's edit count
+ * @param $uid \int User ID to check
+ * @return \int The user's edit count
*/
static function edits( $uid ) {
wfProfileIn( __METHOD__ );
* Return a random password. Sourced from mt_rand, so it's not particularly secure.
* @todo hash random numbers to improve security, like generateToken()
*
- * @return \type{\string} New random password
+ * @return \string New random password
*/
static function randomPassword() {
global $wgMinimalPasswordLength;
/**
* Load user data from the session or login cookie. If there are no valid
* credentials, initialises the user as an anonymous user.
- * @return \type{\bool} True if the user is logged in, false otherwise.
+ * @return \bool True if the user is logged in, false otherwise.
*/
private function loadFromSession() {
global $wgMemc, $wgCookiePrefix;
* Load user and user_group data from the database.
* $this::mId must be set, this is how the user is identified.
*
- * @return \type{\bool} True if the user exists, false if the user is anonymous
+ * @return \bool True if the user exists, false if the user is anonymous
* @private
*/
function loadFromDatabase() {
/**
* Clear various cached data stored in this object.
- * @param $reloadFrom \type{\string} Reload user and user_groups table data from a
+ * @param $reloadFrom \string Reload user and user_groups table data from a
* given source. May be "name", "id", "defaults", "session", or false for
* no reload.
*/
/**
* Get a given default option value.
*
- * @param $opt \type{\string} Name of option to retrieve
- * @return \type{\string} Default option value
+ * @param $opt \string Name of option to retrieve
+ * @return \string Default option value
*/
public static function getDefaultOption( $opt ) {
$defOpts = self::getDefaultOptions();
/**
* Get blocking information
* @private
- * @param $bFromSlave \type{\bool} Whether to check the slave database first. To
+ * @param $bFromSlave \bool Whether to check the slave database first. To
* improve performance, non-critical checks are done
* against slaves. Check when actually saving should be
* done against master.
/**
* Whether the given IP is in the SORBS blacklist.
*
- * @param $ip \type{\string} IP to check
- * @return \type{\bool} True if blacklisted
+ * @param $ip \string IP to check
+ * @return \bool True if blacklisted.
*/
function inSorbsBlacklist( $ip ) {
global $wgEnableSorbs, $wgSorbsUrl;
/**
* Whether the given IP is in a given DNS blacklist.
*
- * @param $ip \type{\string} IP to check
- * @param $base \type{\string} URL of the DNS blacklist
- * @return \type{\bool} True if blacklisted
+ * @param $ip \string IP to check
+ * @param $base \string URL of the DNS blacklist
+ * @return \bool True if blacklisted.
*/
function inDnsBlacklist( $ip, $base ) {
wfProfileIn( __METHOD__ );
/**
* Is this user subject to rate limiting?
*
- * @return \type{\bool} True if rate limited
+ * @return \bool True if rate limited
*/
public function isPingLimitable() {
global $wgRateLimitsExcludedGroups;
* @note When using a shared cache like memcached, IP-address
* last-hit counters will be shared across wikis.
*
- * @param $action \type{\string} Action to enforce; 'edit' if unspecified
- * @return \type{\bool} True if a rate limiter was tripped
+ * @param $action \string Action to enforce; 'edit' if unspecified
+ * @return \bool True if a rate limiter was tripped
*/
function pingLimiter( $action='edit' ) {
/**
* Check if user is blocked
*
- * @param $bFromSlave \type{\bool} Whether to check the slave database instead of the master
- * @return \type{\bool} True if blocked, false otherwise
+ * @param $bFromSlave \bool Whether to check the slave database instead of the master
+ * @return \bool True if blocked, false otherwise
*/
function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
wfDebug( "User::isBlocked: enter\n" );
/**
* Check if user is blocked from editing a particular article
*
- * @param $title \type{\string} Title to check
- * @param $bFromSlave \type{\bool} Whether to check the slave database instead of the master
- * @return \type{\bool} True if blocked, false otherwise
+ * @param $title \string Title to check
+ * @param $bFromSlave \bool Whether to check the slave database instead of the master
+ * @return \bool True if blocked, false otherwise
*/
function isBlockedFrom( $title, $bFromSlave = false ) {
global $wgBlockAllowsUTEdit;
/**
* If user is blocked, return the name of the user who placed the block
- * @return \type{\string} name of blocker
+ * @return \string name of blocker
*/
function blockedBy() {
$this->getBlockedStatus();
/**
* If user is blocked, return the specified reason for the block
- * @return \type{\string} Blocking reason
+ * @return \string Blocking reason
*/
function blockedFor() {
$this->getBlockedStatus();
/**
* Get the user's ID.
- * @return \type{\int} The user's ID; 0 if the user is anonymous or nonexistent
+ * @return \int The user's ID; 0 if the user is anonymous or nonexistent
*/
function getId() {
if( $this->mId === null and $this->mName !== null
/**
* Set the user and reload all fields according to a given ID
- * @param $v \type{\int} %User ID to reload
+ * @param $v \int User ID to reload
*/
function setId( $v ) {
$this->mId = $v;
/**
* Get the user name, or the IP of an anonymous user
- * @return \type{\string} User's name or IP address
+ * @return \string User's name or IP address
*/
function getName() {
if ( !$this->mDataLoaded && $this->mFrom == 'name' ) {
*
* @note User::newFromName() has rougly the same function, when the named user
* does not exist.
- * @param $str \type{\string} New user name to set
+ * @param $str \string New user name to set
*/
function setName( $str ) {
$this->load();
/**
* Get the user's name escaped by underscores.
- * @return \type{\string} Username escaped by underscores
+ * @return \string Username escaped by underscores.
*/
function getTitleKey() {
return str_replace( ' ', '_', $this->getName() );
/**
* Check if the user has new messages.
- * @return \type{\bool} True if the user has new messages
+ * @return \bool True if the user has new messages
*/
function getNewtalk() {
$this->load();
* Internal uncached check for new messages
*
* @see getNewtalk()
- * @param $field \type{\string} 'user_ip' for anonymous users, 'user_id' otherwise
- * @param $id \twotypes{\string,\int} User's IP address for anonymous users, %User ID otherwise
- * @param $fromMaster \type{\bool} true to fetch from the master, false for a slave
- * @return \type{\bool} True if the user has new messages
+ * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
+ * @param $id \2types{\string,\int} User's IP address for anonymous users, User ID otherwise
+ * @param $fromMaster \bool true to fetch from the master, false for a slave
+ * @return \bool True if the user has new messages
* @private
*/
function checkNewtalk( $field, $id, $fromMaster = false ) {
/**
* Add or update the new messages flag
- * @param $field \type{\string} 'user_ip' for anonymous users, 'user_id' otherwise
- * @param $id \twotypes{string,\int} User's IP address for anonymous users, %User ID otherwise
- * @return \type{\bool} True if successful, false otherwise
+ * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
+ * @param $id \2types{\string,\int} User's IP address for anonymous users, User ID otherwise
+ * @return \bool True if successful, false otherwise
* @private
*/
function updateNewtalk( $field, $id ) {
/**
* Clear the new messages flag for the given user
- * @param $field \type{\string} 'user_ip' for anonymous users, 'user_id' otherwise
- * @param $id \twotypes{\string,\int} User's IP address for anonymous users, %User ID otherwise
- * @return \type{\bool} True if successful, false otherwise
+ * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
+ * @param $id \2types{\string,\int} User's IP address for anonymous users, User ID otherwise
+ * @return \bool True if successful, false otherwise
* @private
*/
function deleteNewtalk( $field, $id ) {
/**
* Update the 'You have new messages!' status.
- * @param $val \type{\bool} Whether the user has new messages
+ * @param $val \bool Whether the user has new messages
*/
function setNewtalk( $val ) {
if( wfReadOnly() ) {
/**
* Generate a current or new-future timestamp to be stored in the
* user_touched field when we update things.
- * @return \type{\string} Timestamp in TS_MW format
+ * @return \string Timestamp in TS_MW format
*/
private static function newTouchedTimestamp() {
global $wgClockSkewFudge;
/**
* Validate the cache for this account.
- * @param $timestamp \type{\string} A timestamp in TS_MW format
+ * @param $timestamp \string A timestamp in TS_MW format
*/
function validateCache( $timestamp ) {
$this->load();
* wipes it, so the account cannot be logged in until
* a new password is set, for instance via e-mail.
*
- * @param $str \type{\string} New password to set
+ * @param $str \string New password to set
* @throws PasswordError on failure
*/
function setPassword( $str ) {
/**
* Set the password and reset the random token unconditionally.
*
- * @param $str \type{\string} New password to set
+ * @param $str \string New password to set
*/
function setInternalPassword( $str ) {
$this->load();
/**
* Get the user's current token.
- * @return \type{\string} Token
+ * @return \string Token
*/
function getToken() {
$this->load();
* Set the random token (used for persistent authentication)
* Called from loadDefaults() among other places.
*
- * @param $token \type{\string} If specified, set the token to this value
+ * @param $token \string If specified, set the token to this value
* @private
*/
function setToken( $token = false ) {
/**
* Set the cookie password
*
- * @param $str \type{\string} New cookie password
+ * @param $str \string New cookie password
* @private
*/
function setCookiePassword( $str ) {
/**
* Set the password for a password reminder or new account email
*
- * @param $str \type{\string} New password to set
- * @param $throttle \type{\bool} If true, reset the throttle timestamp to the present
+ * @param $str \string New password to set
+ * @param $throttle \bool If true, reset the throttle timestamp to the present
*/
function setNewpassword( $str, $throttle = true ) {
$this->load();
/**
* Has password reminder email been sent within the last
* $wgPasswordReminderResendTime hours?
- * @return \type{\bool} True or false
+ * @return \bool True or false
*/
function isPasswordReminderThrottled() {
global $wgPasswordReminderResendTime;
/**
* Get the user's e-mail address
- * @return \type{\string} User's e-mail address
+ * @return \string User's email address
*/
function getEmail() {
$this->load();
/**
* Get the timestamp of the user's e-mail authentication
- * @return \type{\string} TS_MW timestamp
+ * @return \string TS_MW timestamp
*/
function getEmailAuthenticationTimestamp() {
$this->load();
/**
* Set the user's e-mail address
- * @param $str \type{\string} New e-mail address
+ * @param $str \string New e-mail address
*/
function setEmail( $str ) {
$this->load();
/**
* Get the user's real name
- * @return \type{\string} User's real name
+ * @return \string User's real name
*/
function getRealName() {
$this->load();
/**
* Set the user's real name
- * @param $str \type{\string} New real name
+ * @param $str \string New real name
*/
function setRealName( $str ) {
$this->load();
/**
* Get the user's current setting for a given option.
*
- * @param $oname \type{\string} The option to check
- * @param $defaultOverride \type{\string} A default value returned if the option does not exist
- * @return \type{\string} User's current value for the option
+ * @param $oname \string The option to check
+ * @param $defaultOverride \string A default value returned if the option does not exist
+ * @return \string User's current value for the option
* @see getBoolOption()
* @see getIntOption()
*/
/**
* Get the user's current setting for a given option, as a boolean value.
*
- * @param $oname \type{\string} The option to check
- * @return \type{\bool} User's current value for the option
+ * @param $oname \string The option to check
+ * @return \bool User's current value for the option
* @see getOption()
*/
function getBoolOption( $oname ) {
/**
* Get the user's current setting for a given option, as a boolean value.
*
- * @param $oname \type{\string} The option to check
- * @param $defaultOverride \type{\int} A default value returned if the option does not exist
- * @return \type{\int} User's current value for the option
+ * @param $oname \string The option to check
+ * @param $defaultOverride \int A default value returned if the option does not exist
+ * @return \int User's current value for the option
* @see getOption()
*/
function getIntOption( $oname, $defaultOverride=0 ) {
/**
* Set the given option for a user.
*
- * @param $oname \type{\string} The option to set
- * @param $val \type{\mixed} New value to set
+ * @param $oname \string The option to set
+ * @param $val \mixed New value to set
*/
function setOption( $oname, $val ) {
$this->load();
/**
* Get the user's preferred date format.
- * @return \type{\string} User's preferred date format
+ * @return \string User's preferred date format
*/
function getDatePreference() {
// Important migration for old data rows
* 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
- *
- * @param $recache \type{\bool} Whether to avoid the cache
+ * @param $recache \bool Whether to avoid the cache
* @return \type{\arrayof{\string}} Array of internal group names
*/
function getEffectiveGroups( $recache = false ) {
/**
* Get the user's edit count.
- * @return \type{\int} User's edit count
+ * @return \int User'e edit count
*/
function getEditCount() {
if ($this->mId) {
/**
* Add the user to the given group.
* This takes immediate effect.
- * @param $group \type{\string} Name of the group to add
+ * @param $group \string Name of the group to add
*/
function addGroup( $group ) {
$dbw = wfGetDB( DB_MASTER );
/**
* Remove the user from the given group.
* This takes immediate effect.
- * @param $group \type{\string} Name of the group to remove
+ * @param $group \string Name of the group to remove
*/
function removeGroup( $group ) {
$this->load();
/**
* Get whether the user is logged in
- * @return \type{\bool} True or false
+ * @return \bool True or false
*/
function isLoggedIn() {
return $this->getID() != 0;
/**
* Get whether the user is anonymous
- * @return \type{\bool} True or false
+ * @return \bool True or false
*/
function isAnon() {
return !$this->isLoggedIn();
/**
* Get whether the user is a bot
- * @return \type{\bool} True or false
+ * @return \bool True or false
* @deprecated
*/
function isBot() {
/**
* Check if user is allowed to access a feature / make an action
- * @param $action \type{\string} action to be checked
- * @return \type{\bool} True if action is allowed, else false
+ * @param $action \string action to be checked
+ * @return \bool True if action is allowed, else false
*/
function isAllowed($action='') {
if ( $action === '' )
/**
* Check whether to enable recent changes patrol features for this user
- * @return \type{\bool} True or false
+ * @return \bool True or false
*/
public function useRCPatrol() {
global $wgUseRCPatrol;
/**
* Check whether to enable new pages patrol features for this user
- * @return \type{\bool} True or false
+ * @return \bool True or false
*/
public function useNPPatrol() {
global $wgUseRCPatrol, $wgUseNPPatrol;
/**
* Check the watched status of an article.
* @param $title \type{Title} Title of the article to look at
- * @return \type{\bool} True if article is watched
+ * @return \bool True if article is watched
*/
function isWatched( $title ) {
$wl = WatchedItem::fromUserTitle( $this, $title );
* If e-notif e-mails are on, they will receive notification mails on
* the next change of any watched page.
*
- * @param $currentUser \type{\int} %User ID
+ * @param $currentUser \int User ID
*/
function clearAllNotifications( $currentUser ) {
global $wgUseEnotif, $wgShowUpdatedMarker;
/**
* Encode this user's options as a string
- * @return \type{\string} Encoded options
+ * @return \string Encoded options
* @private
*/
function encodeOptions() {
/**
* Set this user's options from an encoded string
- * @param $str \type{\string} Encoded options to import
+ * @param $str \string Encoded options to import
* @private
*/
function decodeOptions( $str ) {
/**
* Set a cookie on the user's client. Wrapper for
* WebResponse::setCookie
+ * @param $name \string Name of the cookie to set
+ * @param $name \string Value to set
+ * @param $name \int Expiration time, as a UNIX time value;
+ * if 0 or not specified, use the default $wgCookieExpiration
*/
protected function setCookie( $name, $value, $exp=0 ) {
global $wgRequest;
/**
* Clear a cookie on the user's client
- * @param $name \type{\string} Name of the cookie to clear
+ * @param $name \string Name of the cookie to clear
*/
protected function clearCookie( $name ) {
$this->setCookie( $name, '', time() - 86400 );
/**
* Add a user to the database, return the user object
*
- * @param $name \type{\string} Username to add
+ * @param $name \string Username to add
* @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
* - password The user's password. Password logins will be disabled if this is omitted.
* - newpassword A temporary password mailed to the user
* which will give them a chance to modify this key based on their own
* settings.
*
- * @return \type{\string} Page rendering hash
+ * @return \string Page rendering hash
*/
function getPageRenderingHash() {
global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
/**
* Get whether the user is explicitly blocked from account creation.
- * @return \type{\bool} True if blocked
+ * @return \bool True if blocked
*/
function isBlockedFromCreateAccount() {
$this->getBlockedStatus();
/**
* Get whether the user is blocked from using Special:Emailuser.
- * @return \type{\bool} True if blocked
+ * @return \bool True if blocked
*/
function isBlockedFromEmailuser() {
$this->getBlockedStatus();
/**
* Get whether the user is allowed to create an account.
- * @return \type{\bool} True if allowed
+ * @return \bool True if allowed
*/
function isAllowedToCreateAccount() {
return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
/**
* Get the maximum valid user ID.
- * @return \type{\int} %User ID
+ * @return \int User ID
* @static
*/
function getMaxID() {
/**
* Determine whether the user is a newbie. Newbies are either
* anonymous IPs, or the most recently created accounts.
- * @return \type{\bool} True if the user is a newbie
+ * @return \bool True if the user is a newbie
*/
function isNewbie() {
return !$this->isAllowed( 'autoconfirmed' );
* Is the user active? We check to see if they've made at least
* X number of edits in the last Y days.
*
- * @return \type{\bool} True if the user is active, false if not.
+ * @return \bool True if the user is active, false if not.
*/
public function isActiveEditor() {
global $wgActiveUserEditCount, $wgActiveUserDays;
/**
* Check to see if the given clear-text password is one of the accepted passwords
- * @param $password \type{\string} user password.
- * @return \type{\bool} True if the given password is correct, otherwise False.
+ * @param $password \string user password.
+ * @return \bool True if the given password is correct, otherwise False.
*/
function checkPassword( $password ) {
global $wgAuth;
/**
* Check if the given clear-text password matches the temporary password
* sent by e-mail for password reset operations.
- * @return \type{\bool} True if matches, false otherwise
+ * @return \bool True if matches, false otherwise
*/
function checkTemporaryPassword( $plaintext ) {
return self::comparePasswords( $this->mNewpassword, $plaintext, $this->getId() );
* login credentials aren't being hijacked with a foreign form
* submission.
*
- * @param $salt \twotypes{\string,\arrayof{\string}} Optional function-specific data for hashing
- * @return \type{\string} The new edit token
+ * @param $salt \2types{\string,\arrayof{\string}} Optional function-specific data for hashing
+ * @return \string The new edit token
*/
function editToken( $salt = '' ) {
if ( $this->isAnon() ) {
/**
* Generate a looking random token for various uses.
*
- * @param $salt \type{\string} Optional salt value
- * @return \type{\string} The new random token
+ * @param $salt \string Optional salt value
+ * @return \string The new random token
*/
function generateToken( $salt = '' ) {
$token = dechex( mt_rand() ) . dechex( mt_rand() );
* user's own login session, not a form submission from a third-party
* site.
*
- * @param $val \type{\string} Input value to compare
- * @param $salt \type{\string} Optional function-specific data for hashing
- * @return \type{\bool} Whether the token matches
+ * @param $val \string Input value to compare
+ * @param $salt \string Optional function-specific data for hashing
+ * @return \bool Whether the token matches
*/
function matchEditToken( $val, $salt = '' ) {
$sessionToken = $this->editToken( $salt );
* Check given value against the token value stored in the session,
* ignoring the suffix.
*
- * @param $val \type{\string} Input value to compare
- * @param $salt \type{\string} Optional function-specific data for hashing
- * @return \type{\bool} Whether the token matches
+ * @param $val \string Input value to compare
+ * @param $salt \string Optional function-specific data for hashing
+ * @return \bool Whether the token matches
*/
function matchEditTokenNoSuffix( $val, $salt = '' ) {
$sessionToken = $this->editToken( $salt );
* Generate a new e-mail confirmation token and send a confirmation/invalidation
* mail to the user's given address.
*
- * @return \twotypes{\bool,WikiError} True on success, a WikiError object on failure.
+ * @return \2types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
*/
function sendConfirmationMail() {
global $wgLang;
* Send an e-mail to this user's account. Does not check for
* confirmed status or validity.
*
- * @param $subject \type{\string} Message subject
- * @param $body \type{\string} Message body
- * @param $from \type{\string} Optional From address; if unspecified, default $wgPasswordSender will be used
- * @param $replyto \type{\string} Reply-to address
- * @return \twotypes{\bool,WikiError} True on success, a WikiError object on failure
+ * @param $subject \string Message subject
+ * @param $body \string Message body
+ * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
+ * @param $replyto \string Reply-To address
+ * @return \2types{\bool,\type{WikiError}} True on success, a WikiError object on failure
*/
function sendMail( $subject, $body, $from = null, $replyto = null ) {
if( is_null( $from ) ) {
* @note Call saveSettings() after calling this function to commit
* this change to the database.
*
- * @param[out] &$expiration \type{\mixed} Accepts the expiration time
- * @return \type{\string} New token
+ * @param[out] &$expiration \mixed Accepts the expiration time
+ * @return \string New token
* @private
*/
function confirmationToken( &$expiration ) {
/**
* Return a URL the user can use to confirm their email address.
- * @param $token \type{\string} Accepts the email confirmation token
- * @return \type{\string} New token URL
+ * @param $token \string Accepts the email confirmation token
+ * @return \string New token URL
* @private
*/
function confirmationTokenUrl( $token ) {
}
/**
* Return a URL the user can use to invalidate their email address.
- *
- * @param $token \type{\string} Accepts the email confirmation token
- * @return \type{\string} New token URL
+ * @param $token \string Accepts the email confirmation token
+ * @return \string New token URL
* @private
*/
function invalidationTokenUrl( $token ) {
* also sometimes can get corrupted in some browsers/mailers
* (bug 6957 with Gmail and Internet Explorer).
*
- * @param $page \type{\string} Special page
- * @param $token \type{\string} Token
- * @return \type{\string} Formatted URL
+ * @param $page \string Special page
+ * @param $token \string Token
+ * @return \string Formatted URL
*/
protected function getTokenUrl( $page, $token ) {
global $wgArticlePath;
/**
* Set the e-mail authentication timestamp.
- * @param $timestamp \type{\string} TS_MW timestamp
+ * @param $timestamp \string TS_MW timestamp
*/
function setEmailAuthenticationTimestamp( $timestamp ) {
$this->load();
/**
* Is this user allowed to send e-mails within limits of current
* site configuration?
- * @return \type{\bool} True if allowed
+ * @return \bool True if allowed
*/
function canSendEmail() {
global $wgEnableEmail, $wgEnableUserEmail;
/**
* Is this user allowed to receive e-mails within limits of current
* site configuration?
- * @return \type{\bool} True if allowed
+ * @return \bool True if allowed
*/
function canReceiveEmail() {
return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
* confirmed their address by returning a code or using a password
* sent to the address from the wiki.
*
- * @return \type{\bool} True if confirmed
+ * @return \bool True if confirmed
*/
function isEmailConfirmed() {
global $wgEmailAuthentication;
/**
* Check whether there is an outstanding request for e-mail confirmation.
- * @return \type{\bool} True if pending
+ * @return \bool True if pending
*/
function isEmailConfirmationPending() {
global $wgEmailAuthentication;
/**
* Get the timestamp of account creation.
*
- * @return \twotypes{\string,\bool} string Timestamp of account creation, or false for
+ * @return \2types{\string,\bool} string Timestamp of account creation, or false for
* non-existent/anonymous user accounts.
*/
public function getRegistration() {
/**
* Get all the groups who have a given permission
*
- * @param $role \type{\string} Role to check
+ * @param $role \string Role to check
* @return \type{\arrayof{\string}} List of internal group names with the given permission
*/
static function getGroupsWithPermission( $role ) {
/**
* Get the localized descriptive name for a group, if it exists
*
- * @param $group \type{\string} Internal group name
- * @return \type{\string} Localized descriptive group name
+ * @param $group \string Internal group name
+ * @return \string Localized descriptive group name
*/
static function getGroupName( $group ) {
global $wgMessageCache;
/**
* Get the localized descriptive name for a member of a group, if it exists
*
- * @param $group \type{\string} Internal group name
- * @return \type{\string} Localized name for group member
+ * @param $group \string Internal group name
+ * @return \string Localized name for group member
*/
static function getGroupMember( $group ) {
global $wgMessageCache;
/**
* Get the title of a page describing a particular group
*
- * @param $group \type{\string} Internal group name
- * @return \twotypes{Title,\bool} Title of the page if it exists, false otherwise
+ * @param $group \string Internal group name
+ * @return \2types{\type{Title},\bool} Title of the page if it exists, false otherwise
*/
static function getGroupPage( $group ) {
global $wgMessageCache;
* Create a link to the group in HTML, if available;
* else return the group name.
*
- * @param $group \type{\string} Internal name of the group
- * @param $text \type{\string} The text of the link
- * @return \type{\string} HTML link to the group
+ * @param $group \string Internal name of the group
+ * @param $text \string The text of the link
+ * @return \string HTML link to the group
*/
static function makeGroupLinkHTML( $group, $text = '' ) {
if( $text == '' ) {
* Create a link to the group in Wikitext, if available;
* else return the group name.
*
- * @param $group \type{\string} Internal name of the group
- * @param $text \type{\string} The text of the link
- * @return \type{\string} Wikilink to the group
+ * @param $group \string Internal name of the group
+ * @param $text \string The text of the link
+ * @return \string Wikilink to the group
*/
static function makeGroupLinkWiki( $group, $text = '' ) {
if( $text == '' ) {
/**
* Get the description of a given right
*
- * @param $right \type{\string} Right to query
- * @return \type{\string} Localized description of the right
+ * @param $right \string Right to query
+ * @return \string Localized description of the right
*/
static function getRightDescription( $right ) {
global $wgMessageCache;
/**
* Make an old-style password hash
*
- * @param $password \type{\string} Plain-text password
- * @param $userId \type{\string} %User ID
- * @return \type{\string} Password hash
+ * @param $password \string Plain-text password
+ * @param $userId \string User ID
+ * @return \string Password hash
*/
static function oldCrypt( $password, $userId ) {
global $wgPasswordSalt;
/**
* Make a new-style password hash
*
- * @param $password \type{\string} Plain-text password
- * @param $salt \type{\string} Optional salt, may be random or the user ID.
+ * @param $password \string Plain-text password
+ * @param $salt \string Optional salt, may be random or the user ID.
* If unspecified or false, will generate one automatically
- * @return \type{\string} Password hash
+ * @return \string Password hash
*/
static function crypt( $password, $salt = false ) {
global $wgPasswordSalt;
* 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.
*
- * @param $hash \type{\string} Password hash
- * @param $password \type{\string} Plain-text password to compare
- * @param $userId \type{\string} %User ID for old-style password salt
- * @return \type{\bool} True if matches, false otherwise
+ * @param $hash \string Password hash
+ * @param $password \string Plain-text password to compare
+ * @param $userId \string User ID for old-style password salt
+ * @return \bool
*/
static function comparePasswords( $hash, $password, $userId = false ) {
$m = false;
dépôts / lhc / web / wiklou.git / commitdiff