From: Happy-melon Date: Thu, 6 Jan 2011 15:55:56 +0000 (+0000) Subject: More documentation formatting X-Git-Tag: 1.31.0-rc.0~32763 X-Git-Url: https://git.cyclocoop.org/%28%28?a=commitdiff_plain;h=e6c1611379a7b2b4d1816bbf068e0cc0cf5db8b6;p=lhc%2Fweb%2Fwiklou.git More documentation formatting --- diff --git a/includes/Article.php b/includes/Article.php index 5a23b2a5cc..dbe3236c38 100644 --- a/includes/Article.php +++ b/includes/Article.php @@ -58,7 +58,7 @@ class Article { /** * Constructor from an page id - * @param $id The article ID to load + * @param $id Int article ID to load */ public static function newFromID( $id ) { $t = Title::newFromID( $id ); @@ -1175,7 +1175,7 @@ class Article { * merging of several policies using array_merge(). * @param $policy Mixed, returns empty array on null/false/'', transparent * to already-converted arrays, converts String. - * @return associative Array: 'index' => , 'follow' => + * @return Array: 'index' => , 'follow' => */ public static function formatRobotPolicy( $policy ) { if ( is_array( $policy ) ) { @@ -1525,7 +1525,7 @@ class Article { /** * View redirect * - * @param $target Title object or Array of destination(s) to redirect + * @param $target Title|Array of destination(s) to redirect * @param $appendSubtitle Boolean [optional] * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence? * @return string containing HMTL with redirect link @@ -1813,7 +1813,7 @@ class Article { * Add row to the redirect table if this is a redirect, remove otherwise. * * @param $dbw Database - * @param $redirectTitle a title object pointing to the redirect target, + * @param $redirectTitle Title object pointing to the redirect target, * or NULL if this is not a redirect * @param $lastRevIsRedirect If given, will optimize adding and * removing rows in redirect table. @@ -2050,7 +2050,7 @@ class Article { * auto-detection due to MediaWiki's performance-optimised locking strategy. * * @param $baseRevId the revision ID this edit was based off, if any - * @param $user Optional user object, $wgUser will be used if not passed + * @param $user User (optional), $wgUser will be used if not passed * * @return Status object. Possible errors: * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status @@ -3615,7 +3615,7 @@ class Article { * @param $text String: New text of the article * @param $summary String: Edit summary * @param $minoredit Boolean: Minor edit - * @param $timestamp_of_pagechange Timestamp associated with the page change + * @param $timestamp_of_pagechange String timestamp associated with the page change * @param $newid Integer: rev_id value of the new revision * @param $changed Boolean: Whether or not the content actually changed * @param $user User object: User doing the edit @@ -4004,7 +4004,7 @@ class Article { wfProfileOut( __METHOD__ ); } - /**#@+ + /** * The onArticle*() functions are supposed to be a kind of hooks * which should be called whenever any of the specified actions * are done. @@ -4013,7 +4013,7 @@ class Article { * * This is called on page move and undelete, as well as edit * - * @param $title a title object + * @param $title Title object */ public static function onArticleCreate( $title ) { # Update existence markers on article/talk tabs... @@ -4270,7 +4270,7 @@ class Article { * Return an applicable autosummary if one exists for the given edit. * @param $oldtext String: the previous text of the page. * @param $newtext String: The submitted text of the page. - * @param $flags Bitmask: a bitmask of flags submitted for the edit. + * @param $flags Int bitmask: a bitmask of flags submitted for the edit. * @return string An appropriate autosummary, or an empty string. */ public static function getAutosummary( $oldtext, $newtext, $flags ) { diff --git a/includes/User.php b/includes/User.php index bafa5410cd..acb64c9c65 100644 --- a/includes/User.php +++ b/includes/User.php @@ -5,19 +5,19 @@ */ /** - * \int Number of characters in user_token field. + * Int Number of characters in user_token field. * @ingroup Constants */ define( 'USER_TOKEN_LENGTH', 32 ); /** - * \int Serialized record version. + * Int Serialized record version. * @ingroup Constants */ define( 'MW_USER_VERSION', 8 ); /** - * \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', '+\\' ); @@ -50,7 +50,7 @@ class User { const EDIT_TOKEN_SUFFIX = EDIT_TOKEN_SUFFIX; /** - * \type{\arrayof{\string}} List of member variables which are saved to the + * 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. * @showinitializer @@ -78,7 +78,7 @@ class User { ); /** - * \type{\arrayof{\string}} Core rights. + * Array of Strings Core rights. * Each of these should have a corresponding message of the form * "right-$right". * @showinitializer @@ -140,7 +140,7 @@ class User { 'writeapi', ); /** - * \string Cached results of getAllRights() + * String Cached results of getAllRights() */ static $mAllRights = false; @@ -152,12 +152,12 @@ class User { //@} /** - * \bool Whether the cache variables have been loaded. + * Bool Whether the cache variables have been loaded. */ var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded; /** - * \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 @@ -167,12 +167,12 @@ class User { */ var $mFrom; - /** @name Lazy-initialized variables, invalidated with clearInstanceCache */ - //@{ + /** + * Lazy-initialized variables, invalidated with clearInstanceCache + */ var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights, $mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally, $mLocked, $mHideName, $mOptions; - //@} static $idCacheByName = array(); @@ -230,7 +230,7 @@ class User { /** * Load user table data, given mId has already been set. - * @return \bool false if the ID does not exist, true otherwise + * @return Bool false if the ID does not exist, true otherwise * @private */ function loadFromId() { @@ -297,12 +297,12 @@ class User { * This is slightly less efficient than newFromId(), so use newFromId() if * you have both an ID and a name handy. * - * @param $name \string Username, validated by Title::newFromText() - * @param $validate \mixed Validate username. Takes the same parameters as + * @param $name String Username, validated by Title::newFromText() + * @param $validate String|Bool Validate username. Takes the same parameters as * User::getCanonicalName(), except that true is accepted as an alias * for 'valid', for BC. * - * @return User The User object, or false if the username is invalid + * @return User object, or false if the username is invalid * (e.g. if it contains illegal characters or is an IP address). If the * username is not present in the database, the result will be a user object * with a name, zero user ID and default settings. @@ -326,8 +326,8 @@ class User { /** * Static factory method for creation from a given user ID. * - * @param $id \int Valid user ID - * @return \type{User} The corresponding User object + * @param $id Int Valid user ID + * @return User The corresponding User object */ static function newFromId( $id ) { $u = new User; @@ -343,8 +343,8 @@ class User { * * If the code is invalid or has expired, returns NULL. * - * @param $code \string Confirmation code - * @return \type{User} + * @param $code String Confirmation code + * @return User */ static function newFromConfirmationCode( $code ) { $dbr = wfGetDB( DB_SLAVE ); @@ -363,7 +363,7 @@ class User { * Create a new user object using data from session or cookies. If the * login credentials are invalid, the result is an anonymous user. * - * @return \type{User} + * @return User */ static function newFromSession() { $user = new User; @@ -374,8 +374,8 @@ class User { /** * Create a new user object from a user row. * The row should have all fields from the user table in it. - * @param $row array A row from the user table - * @return \type{User} + * @param $row Array A row from the user table + * @return User */ static function newFromRow( $row ) { $user = new User; @@ -388,8 +388,8 @@ class User { /** * Get the username corresponding to a given user ID - * @param $id \int User ID - * @return \string The corresponding username + * @param $id Int User ID + * @return String The corresponding username */ static function whoIs( $id ) { $dbr = wfGetDB( DB_SLAVE ); @@ -399,8 +399,8 @@ class User { /** * Get the real name of a user given their user ID * - * @param $id \int User ID - * @return \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 ); @@ -409,8 +409,8 @@ class User { /** * Get database id given a user name - * @param $name \string Username - * @return \types{\int,\null} The corresponding user's ID, or null if user is nonexistent + * @param $name String Username + * @return Int|Null The corresponding user's ID, or null if user is nonexistent */ static function idFromName( $name ) { $nt = Title::makeTitleSafe( NS_USER, $name ); @@ -454,8 +454,8 @@ class User { * 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 \string String to match - * @return \bool True or false + * @param $name String to match + * @return Bool */ static function isIP( $name ) { return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP::isIPv6($name); @@ -469,8 +469,8 @@ class User { * is longer than the maximum allowed username size or doesn't begin with * a capital letter. * - * @param $name \string String to match - * @return \bool True or false + * @param $name String to match + * @return Bool */ static function isValidUserName( $name ) { global $wgContLang, $wgMaxNameChars; @@ -523,8 +523,8 @@ class User { * If an account already exists in this form, login will be blocked * by a failure to pass this function. * - * @param $name \string String to match - * @return \bool True or false + * @param $name String to match + * @return Bool */ static function isUsableName( $name ) { global $wgReservedUsernames; @@ -560,8 +560,8 @@ class User { * Additional blacklisting may be added here rather than in * isValidUserName() to avoid disrupting existing accounts. * - * @param $name \string String to match - * @return \bool True or false + * @param $name String to match + * @return Bool */ static function isCreatableName( $name ) { global $wgInvalidUsernameCharacters; @@ -588,7 +588,7 @@ class User { * Is the input a valid password for this user? * * @param $password String Desired password - * @return bool True or false + * @return Bool */ function isValidPassword( $password ) { //simple boolean wrapper for getPasswordValidity @@ -644,8 +644,8 @@ class User { * * @todo Check for RFC 2822 compilance (bug 959) * - * @param $addr \string E-mail address - * @return \bool True or false + * @param $addr String E-mail address + * @return Bool */ public static function isValidEmailAddr( $addr ) { $result = null; @@ -670,8 +670,8 @@ class User { /** * Given unvalidated user input, return a canonical username, or false if * the username is invalid. - * @param $name \string User input - * @param $validate \types{\string,\bool} Type of validation to use: + * @param $name String User input + * @param $validate String|Bool type of validation to use: * - false No validation * - 'valid' Valid for batch processes * - 'usable' Valid for batch processes and login @@ -728,8 +728,8 @@ class User { * 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 \int User ID to check - * @return \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__ ); @@ -765,7 +765,7 @@ class User { * Return a random password. Sourced from mt_rand, so it's not particularly secure. * @todo hash random numbers to improve security, like generateToken() * - * @return \string New random password + * @return String new random password */ static function randomPassword() { global $wgMinimalPasswordLength; @@ -831,7 +831,7 @@ class User { /** * Load user data from the session or login cookie. If there are no valid * credentials, initialises the user as an anonymous user. - * @return \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 $wgRequest, $wgExternalAuthType, $wgAutocreatePolicy; @@ -922,7 +922,7 @@ class User { * Load user and user_group data from the database. * $this::mId must be set, this is how the user is identified. * - * @return \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() { @@ -957,7 +957,7 @@ class User { /** * Initialize this object from a row from the user table. * - * @param $row \type{\arrayof{\mixed}} Row from the user table to load. + * @param $row Array Row from the user table to load. */ function loadFromRow( $row ) { $this->mDataLoaded = true; @@ -1001,7 +1001,7 @@ class User { /** * Clear various cached data stored in this object. - * @param $reloadFrom \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. */ @@ -1025,7 +1025,7 @@ class User { * Combine the language default options with any site-specific options * and add the default language variants. * - * @return \type{\arrayof{\string}} Array of options + * @return Array of String options */ static function getDefaultOptions() { global $wgNamespacesToBeSearchedDefault; @@ -1052,8 +1052,8 @@ class User { /** * Get a given default option value. * - * @param $opt \string Name of option to retrieve - * @return \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(); @@ -1068,7 +1068,7 @@ class User { /** * Get blocking information * @private - * @param $bFromSlave \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. @@ -1160,9 +1160,9 @@ class User { /** * Whether the given IP is in a DNS blacklist. * - * @param $ip \string IP to check - * @param $checkWhitelist Boolean: whether to check the whitelist first - * @return \bool True if blacklisted. + * @param $ip String IP to check + * @param $checkWhitelist Bool: whether to check the whitelist first + * @return Bool True if blacklisted. */ function isDnsBlacklisted( $ip, $checkWhitelist = false ) { global $wgEnableSorbs, $wgEnableDnsBlacklist, @@ -1181,9 +1181,9 @@ class User { /** * Whether the given IP is in a given DNS blacklist. * - * @param $ip \string IP to check - * @param $bases \string or Array of Strings: URL of the DNS blacklist - * @return \bool True if blacklisted. + * @param $ip String IP to check + * @param $bases String|Array of Strings: URL of the DNS blacklist + * @return Bool True if blacklisted. */ function inDnsBlacklist( $ip, $bases ) { wfProfileIn( __METHOD__ ); @@ -1218,7 +1218,7 @@ class User { /** * Is this user subject to rate limiting? * - * @return \bool True if rate limited + * @return Bool True if rate limited */ public function isPingLimitable() { global $wgRateLimitsExcludedGroups; @@ -1243,8 +1243,8 @@ class User { * @note When using a shared cache like memcached, IP-address * last-hit counters will be shared across wikis. * - * @param $action \string Action to enforce; 'edit' if unspecified - * @return \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' ) { # Call the 'PingLimiter' hook @@ -1336,8 +1336,8 @@ class User { /** * Check if user is blocked * - * @param $bFromSlave \bool Whether to check the slave database instead of the master - * @return \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 $this->getBlockedStatus( $bFromSlave ); @@ -1347,9 +1347,9 @@ class User { /** * Check if user is blocked from editing a particular article * - * @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 + * @param $title Title to check + * @param $bFromSlave Bool whether to check the slave database instead of the master + * @return Bool */ function isBlockedFrom( $title, $bFromSlave = false ) { global $wgBlockAllowsUTEdit; @@ -1372,7 +1372,7 @@ class User { /** * If user is blocked, return the name of the user who placed the block - * @return \string name of blocker + * @return String name of blocker */ function blockedBy() { $this->getBlockedStatus(); @@ -1381,7 +1381,7 @@ class User { /** * If user is blocked, return the specified reason for the block - * @return \string Blocking reason + * @return String Blocking reason */ function blockedFor() { $this->getBlockedStatus(); @@ -1390,7 +1390,7 @@ class User { /** * If user is blocked, return the ID for the block - * @return \int Block ID + * @return Int Block ID */ function getBlockId() { $this->getBlockedStatus(); @@ -1402,8 +1402,8 @@ class User { * Do not use for actual edit permission checks! * This is intented for quick UI checks. * - * @param $ip \type{\string} IP address, uses current client if none given - * @return \type{\bool} True if blocked, false otherwise + * @param $ip String IP address, uses current client if none given + * @return Bool True if blocked, false otherwise */ function isBlockedGlobally( $ip = '' ) { if( $this->mBlockedGlobally !== null ) { @@ -1424,7 +1424,7 @@ class User { /** * Check if user account is locked * - * @return \type{\bool} True if locked, false otherwise + * @return Bool True if locked, false otherwise */ function isLocked() { if( $this->mLocked !== null ) { @@ -1439,7 +1439,7 @@ class User { /** * Check if user account is hidden * - * @return \type{\bool} True if hidden, false otherwise + * @return Bool True if hidden, false otherwise */ function isHidden() { if( $this->mHideName !== null ) { @@ -1456,7 +1456,7 @@ class User { /** * Get the user's ID. - * @return Integer 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 @@ -1472,7 +1472,7 @@ class User { /** * Set the user and reload all fields according to a given ID - * @param $v \int User ID to reload + * @param $v Int User ID to reload */ function setId( $v ) { $this->mId = $v; @@ -1481,7 +1481,7 @@ class User { /** * Get the user name, or the IP of an anonymous user - * @return \string User's name or IP address + * @return String User's name or IP address */ function getName() { if ( !$this->mDataLoaded && $this->mFrom == 'name' ) { @@ -1508,7 +1508,7 @@ class User { * * @note User::newFromName() has rougly the same function, when the named user * does not exist. - * @param $str \string New user name to set + * @param $str String New user name to set */ function setName( $str ) { $this->load(); @@ -1517,7 +1517,7 @@ class User { /** * Get the user's name escaped by underscores. - * @return \string Username escaped by underscores. + * @return String Username escaped by underscores. */ function getTitleKey() { return str_replace( ' ', '_', $this->getName() ); @@ -1525,7 +1525,7 @@ class User { /** * Check if the user has new messages. - * @return \bool True if the user has new messages + * @return Bool True if the user has new messages */ function getNewtalk() { $this->load(); @@ -1558,7 +1558,7 @@ class User { /** * Return the talk page(s) this user has new messages on. - * @return \type{\arrayof{\string}} Array of page URLs + * @return Array of String page URLs */ function getNewMessageLinks() { $talks = array(); @@ -1576,10 +1576,10 @@ class User { * Internal uncached check for new messages * * @see getNewtalk() - * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise - * @param $id \types{\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 + * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise + * @param $id 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 ) { @@ -1595,9 +1595,9 @@ class User { /** * Add or update the new messages flag - * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise - * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise - * @return \bool True if successful, false otherwise + * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise + * @param $id String|Int User's IP address for anonymous users, User ID otherwise + * @return Bool True if successful, false otherwise * @private */ function updateNewtalk( $field, $id ) { @@ -1617,9 +1617,9 @@ class User { /** * Clear the new messages flag for the given user - * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise - * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise - * @return \bool True if successful, false otherwise + * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise + * @param $id String|Int User's IP address for anonymous users, User ID otherwise + * @return Bool True if successful, false otherwise * @private */ function deleteNewtalk( $field, $id ) { @@ -1638,7 +1638,7 @@ class User { /** * Update the 'You have new messages!' status. - * @param $val \bool Whether the user has new messages + * @param $val Bool Whether the user has new messages */ function setNewtalk( $val ) { if( wfReadOnly() ) { @@ -1677,7 +1677,7 @@ class User { /** * Generate a current or new-future timestamp to be stored in the * user_touched field when we update things. - * @return \string Timestamp in TS_MW format + * @return String Timestamp in TS_MW format */ private static function newTouchedTimestamp() { global $wgClockSkewFudge; @@ -1724,7 +1724,7 @@ class User { /** * Validate the cache for this account. - * @param $timestamp \string A timestamp in TS_MW format + * @param $timestamp String A timestamp in TS_MW format */ function validateCache( $timestamp ) { $this->load(); @@ -1733,6 +1733,7 @@ class User { /** * Get the user touched timestamp + * @return String timestamp */ function getTouched() { $this->load(); @@ -1750,7 +1751,7 @@ class User { * wipes it, so the account cannot be logged in until * a new password is set, for instance via e-mail. * - * @param $str \string New password to set + * @param $str String New password to set * @throws PasswordError on failure */ function setPassword( $str ) { @@ -1781,7 +1782,7 @@ class User { /** * Set the password and reset the random token unconditionally. * - * @param $str \string New password to set + * @param $str String New password to set */ function setInternalPassword( $str ) { $this->load(); @@ -1799,7 +1800,7 @@ class User { /** * Get the user's current token. - * @return \string Token + * @return String Token */ function getToken() { $this->load(); @@ -1810,7 +1811,7 @@ class User { * Set the random token (used for persistent authentication) * Called from loadDefaults() among other places. * - * @param $token \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 ) { @@ -1833,7 +1834,7 @@ class User { /** * Set the cookie password * - * @param $str \string New cookie password + * @param $str String New cookie password * @private */ function setCookiePassword( $str ) { @@ -1844,8 +1845,8 @@ class User { /** * Set the password for a password reminder or new account email * - * @param $str \string New password to set - * @param $throttle \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(); @@ -1858,7 +1859,7 @@ class User { /** * Has password reminder email been sent within the last * $wgPasswordReminderResendTime hours? - * @return \bool True or false + * @return Bool */ function isPasswordReminderThrottled() { global $wgPasswordReminderResendTime; @@ -1872,7 +1873,7 @@ class User { /** * Get the user's e-mail address - * @return \string User's email address + * @return String User's email address */ function getEmail() { $this->load(); @@ -1882,7 +1883,7 @@ class User { /** * Get the timestamp of the user's e-mail authentication - * @return \string TS_MW timestamp + * @return String TS_MW timestamp */ function getEmailAuthenticationTimestamp() { $this->load(); @@ -1892,7 +1893,7 @@ class User { /** * Set the user's e-mail address - * @param $str \string New e-mail address + * @param $str String New e-mail address */ function setEmail( $str ) { $this->load(); @@ -1902,7 +1903,7 @@ class User { /** * Get the user's real name - * @return \string User's real name + * @return String User's real name */ function getRealName() { $this->load(); @@ -1911,7 +1912,7 @@ class User { /** * Set the user's real name - * @param $str \string New real name + * @param $str String New real name */ function setRealName( $str ) { $this->load(); @@ -1921,9 +1922,9 @@ class User { /** * Get the user's current setting for a given 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 + * @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() */ @@ -1957,8 +1958,8 @@ class User { /** * Get the user's current setting for a given option, as a boolean value. * - * @param $oname \string The option to check - * @return \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 ) { @@ -1969,9 +1970,9 @@ class User { /** * Get the user's current setting for a given option, as a boolean value. * - * @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 + * @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 ) { @@ -1985,8 +1986,8 @@ class User { /** * Set the given option for a user. * - * @param $oname \string The option to set - * @param $val \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(); @@ -2015,7 +2016,7 @@ class User { /** * Get the user's preferred date format. - * @return \string User's preferred date format + * @return String User's preferred date format */ function getDatePreference() { // Important migration for old data rows @@ -2047,7 +2048,7 @@ class User { /** * Get the permissions this user has. - * @return \type{\arrayof{\string}} Array of permission names + * @return Array of String permission names */ function getRights() { if ( is_null( $this->mRights ) ) { @@ -2062,7 +2063,7 @@ class User { /** * Get the list of explicit group memberships this user has. * The implicit * and user groups are not included. - * @return \type{\arrayof{\string}} Array of internal group names + * @return Array of String internal group names */ function getGroups() { $this->load(); @@ -2072,9 +2073,9 @@ class User { /** * 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 \bool Whether to avoid the cache - * @return \type{\arrayof{\string}} Array of internal group names + * '*' for all accounts, and autopromoted groups + * @param $recache Bool Whether to avoid the cache + * @return Array of String internal group names */ function getEffectiveGroups( $recache = false ) { if ( $recache || is_null( $this->mEffectiveGroups ) ) { @@ -2099,7 +2100,7 @@ class User { /** * Get the user's edit count. - * @return \int User'e edit count + * @return Int */ function getEditCount() { if( $this->getId() ) { @@ -2117,7 +2118,7 @@ class User { /** * Add the user to the given group. * This takes immediate effect. - * @param $group \string Name of the group to add + * @param $group String Name of the group to add */ function addGroup( $group ) { $dbw = wfGetDB( DB_MASTER ); @@ -2141,7 +2142,7 @@ class User { /** * Remove the user from the given group. * This takes immediate effect. - * @param $group \string Name of the group to remove + * @param $group String Name of the group to remove */ function removeGroup( $group ) { $this->load(); @@ -2161,7 +2162,7 @@ class User { /** * Get whether the user is logged in - * @return \bool True or false + * @return Bool */ function isLoggedIn() { return $this->getID() != 0; @@ -2169,7 +2170,7 @@ class User { /** * Get whether the user is anonymous - * @return \bool True or false + * @return Bool */ function isAnon() { return !$this->isLoggedIn(); @@ -2177,8 +2178,8 @@ class User { /** * Get whether the user is a bot - * @return \bool True or false - * @deprecated + * @return Bool + * @deprecated use isAllowed('bot') */ function isBot() { wfDeprecated( __METHOD__ ); @@ -2187,7 +2188,7 @@ class User { /** * Check if user is allowed to access a feature / make an action - * @param $action \string action to be checked + * @param $action String action to be checked * @return Boolean: True if action is allowed, else false */ function isAllowed( $action = '' ) { @@ -2216,7 +2217,7 @@ class User { /** * Check whether to enable new pages patrol features for this user - * @return \bool True or false + * @return Bool True or false */ public function useNPPatrol() { global $wgUseRCPatrol, $wgUseNPPatrol; @@ -2227,7 +2228,7 @@ class User { * Get the current skin, loading it if required, and setting a title * @param $t Title: the title to use in the skin * @return Skin The current skin - * @todo FIXME : need to check the old failback system [AV] + * @todo: FIXME : need to check the old failback system [AV] */ function getSkin( $t = null ) { if ( $t ) { @@ -2273,8 +2274,8 @@ class User { /** * Check the watched status of an article. - * @param $title \type{Title} Title of the article to look at - * @return \bool True if article is watched + * @param $title Title of the article to look at + * @return Bool */ function isWatched( $title ) { $wl = WatchedItem::fromUserTitle( $this, $title ); @@ -2283,7 +2284,7 @@ class User { /** * Watch an article. - * @param $title \type{Title} Title of the article to look at + * @param $title Title of the article to look at */ function addWatch( $title ) { $wl = WatchedItem::fromUserTitle( $this, $title ); @@ -2293,7 +2294,7 @@ class User { /** * Stop watching an article. - * @param $title \type{Title} Title of the article to look at + * @param $title Title of the article to look at */ function removeWatch( $title ) { $wl = WatchedItem::fromUserTitle( $this, $title ); @@ -2305,7 +2306,7 @@ class User { * 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. - * @param $title \type{Title} Title of the article to look at + * @param $title Title of the article to look at */ function clearNotification( &$title ) { global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker; @@ -2366,7 +2367,7 @@ class User { * If e-notif e-mails are on, they will receive notification mails on * the next change of any watched page. * - * @param $currentUser \int User ID + * @param $currentUser Int User ID */ function clearAllNotifications( $currentUser ) { global $wgUseEnotif, $wgShowUpdatedMarker; @@ -2390,7 +2391,7 @@ class User { /** * Set this user's options from an encoded string - * @param $str \string Encoded options to import + * @param $str String Encoded options to import * @private */ function decodeOptions( $str ) { @@ -2416,9 +2417,9 @@ class User { /** * Set a cookie on the user's client. Wrapper for * WebResponse::setCookie - * @param $name \string Name of the cookie to set - * @param $value \string Value to set - * @param $exp \int Expiration time, as a UNIX time value; + * @param $name String Name of the cookie to set + * @param $value String Value to set + * @param $exp Int Expiration time, as a UNIX time value; * if 0 or not specified, use the default $wgCookieExpiration */ protected function setCookie( $name, $value, $exp = 0 ) { @@ -2428,7 +2429,7 @@ class User { /** * Clear a cookie on the user's client - * @param $name \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 ); @@ -2535,6 +2536,7 @@ class User { /** * If only this user's username is known, and it exists, return the user ID. + * @return Int */ function idForName() { $s = trim( $this->getName() ); @@ -2551,8 +2553,8 @@ class User { /** * Add a user to the database, return the user object * - * @param $name \string Username to add - * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database: + * @param $name String Username to add + * @param $params Array of Strings 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 * - email The user's email address @@ -2562,7 +2564,7 @@ class User { * - token Random authentication token. Do not set. * - registration Registration timestamp. Do not set. * - * @return \type{User} A new User object, or null if the username already exists + * @return User object, or null if the username already exists */ static function createNew( $name, $params = array() ) { $user = new User; @@ -2662,7 +2664,7 @@ class User { * settings. * * @deprecated use the ParserOptions object to get the relevant options - * @return \string Page rendering hash + * @return String Page rendering hash */ function getPageRenderingHash() { global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang; @@ -2704,7 +2706,7 @@ class User { /** * Get whether the user is explicitly blocked from account creation. - * @return \bool True if blocked + * @return Bool */ function isBlockedFromCreateAccount() { $this->getBlockedStatus(); @@ -2713,7 +2715,7 @@ class User { /** * Get whether the user is blocked from using Special:Emailuser. - * @return Boolean: True if blocked + * @return Bool */ function isBlockedFromEmailuser() { $this->getBlockedStatus(); @@ -2722,7 +2724,7 @@ class User { /** * Get whether the user is allowed to create an account. - * @return Boolean: True if allowed + * @return Bool */ function isAllowedToCreateAccount() { return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount(); @@ -2766,7 +2768,7 @@ class User { /** * Determine whether the user is a newbie. Newbies are either * anonymous IPs, or the most recently created accounts. - * @return Boolean: True if the user is a newbie + * @return Bool */ function isNewbie() { return !$this->isAllowed( 'autoconfirmed' ); @@ -2836,8 +2838,8 @@ class User { * login credentials aren't being hijacked with a foreign form * submission. * - * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing - * @return \string The new edit token + * @param $salt String|Array of Strings Optional function-specific data for hashing + * @return String The new edit token */ function editToken( $salt = '' ) { if ( $this->isAnon() ) { @@ -2859,8 +2861,8 @@ class User { /** * Generate a looking random token for various uses. * - * @param $salt \string Optional salt value - * @return \string The new random token + * @param $salt String Optional salt value + * @return String The new random token */ public static function generateToken( $salt = '' ) { $token = dechex( mt_rand() ) . dechex( mt_rand() ); @@ -2873,8 +2875,8 @@ class User { * user's own login session, not a form submission from a third-party * site. * - * @param $val \string Input value to compare - * @param $salt \string Optional function-specific data for hashing + * @param $val String Input value to compare + * @param $salt String Optional function-specific data for hashing * @return Boolean: Whether the token matches */ function matchEditToken( $val, $salt = '' ) { @@ -2889,8 +2891,8 @@ class User { * Check given value against the token value stored in the session, * ignoring the suffix. * - * @param $val \string Input value to compare - * @param $salt \string Optional function-specific data for hashing + * @param $val String Input value to compare + * @param $salt String Optional function-specific data for hashing * @return Boolean: Whether the token matches */ function matchEditTokenNoSuffix( $val, $salt = '' ) { @@ -2929,11 +2931,11 @@ class User { * Send an e-mail to this user's account. Does not check for * confirmed status or validity. * - * @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 Status object + * @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 Status */ function sendMail( $subject, $body, $from = null, $replyto = null ) { if( is_null( $from ) ) { @@ -2955,7 +2957,7 @@ class User { * this change to the database. * * @param[out] &$expiration \mixed Accepts the expiration time - * @return \string New token + * @return String New token * @private */ function confirmationToken( &$expiration ) { @@ -2972,8 +2974,8 @@ class User { /** * Return a URL the user can use to confirm their email address. - * @param $token \string Accepts the email confirmation token - * @return \string New token URL + * @param $token String Accepts the email confirmation token + * @return String New token URL * @private */ function confirmationTokenUrl( $token ) { @@ -2982,8 +2984,8 @@ class User { /** * Return a URL the user can use to invalidate their email address. - * @param $token \string Accepts the email confirmation token - * @return \string New token URL + * @param $token String Accepts the email confirmation token + * @return String New token URL * @private */ function invalidationTokenUrl( $token ) { @@ -3000,9 +3002,9 @@ class User { * also sometimes can get corrupted in some browsers/mailers * (bug 6957 with Gmail and Internet Explorer). * - * @param $page \string Special page - * @param $token \string Token - * @return \string Formatted URL + * @param $page String Special page + * @param $token String Token + * @return String Formatted URL */ protected function getTokenUrl( $page, $token ) { global $wgArticlePath; @@ -3041,7 +3043,7 @@ class User { /** * Set the e-mail authentication timestamp. - * @param $timestamp \string TS_MW timestamp + * @param $timestamp String TS_MW timestamp */ function setEmailAuthenticationTimestamp( $timestamp ) { $this->load(); @@ -3052,7 +3054,7 @@ class User { /** * Is this user allowed to send e-mails within limits of current * site configuration? - * @return Boolean: True if allowed + * @return Bool */ function canSendEmail() { global $wgEnableEmail, $wgEnableUserEmail; @@ -3067,7 +3069,7 @@ class User { /** * Is this user allowed to receive e-mails within limits of current * site configuration? - * @return Boolean: True if allowed + * @return Bool */ function canReceiveEmail() { return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' ); @@ -3081,7 +3083,7 @@ class User { * confirmed their address by returning a code or using a password * sent to the address from the wiki. * - * @return Boolean: True if confirmed + * @return Bool */ function isEmailConfirmed() { global $wgEmailAuthentication; @@ -3102,7 +3104,7 @@ class User { /** * Check whether there is an outstanding request for e-mail confirmation. - * @return Boolean: True if pending + * @return Bool */ function isEmailConfirmationPending() { global $wgEmailAuthentication; @@ -3115,8 +3117,8 @@ class User { /** * Get the timestamp of account creation. * - * @return \types{\string,\bool} string Timestamp of account creation, or false for - * non-existent/anonymous user accounts. + * @return String|Bool Timestamp of account creation, or false for + * non-existent/anonymous user accounts. */ public function getRegistration() { return $this->getId() > 0 @@ -3127,8 +3129,8 @@ class User { /** * Get the timestamp of the first edit * - * @return \types{\string,\bool} string Timestamp of first edit, or false for - * non-existent/anonymous user accounts. + * @return String|Bool Timestamp of first edit, or false for + * non-existent/anonymous user accounts. */ public function getFirstEditTimestamp() { if( $this->getId() == 0 ) { @@ -3149,8 +3151,8 @@ class User { /** * Get the permissions associated with a given list of groups * - * @param $groups \type{\arrayof{\string}} List of internal group names - * @return \type{\arrayof{\string}} List of permission key names for given groups combined + * @param $groups Array of Strings List of internal group names + * @return Array of Strings List of permission key names for given groups combined */ static function getGroupPermissions( $groups ) { global $wgGroupPermissions, $wgRevokePermissions; @@ -3176,8 +3178,8 @@ class User { /** * Get all the groups who have a given permission * - * @param $role \string Role to check - * @return \type{\arrayof{\string}} List of internal group names with the given permission + * @param $role String Role to check + * @return Array of Strings List of internal group names with the given permission */ static function getGroupsWithPermission( $role ) { global $wgGroupPermissions; @@ -3193,8 +3195,8 @@ class User { /** * Get the localized descriptive name for a group, if it exists * - * @param $group \string Internal group name - * @return \string Localized descriptive group name + * @param $group String Internal group name + * @return String Localized descriptive group name */ static function getGroupName( $group ) { $key = "group-$group"; @@ -3207,8 +3209,8 @@ class User { /** * Get the localized descriptive name for a member of a group, if it exists * - * @param $group \string Internal group name - * @return \string Localized name for group member + * @param $group String Internal group name + * @return String Localized name for group member */ static function getGroupMember( $group ) { $key = "group-$group-member"; @@ -3251,7 +3253,7 @@ class User { /** * Get a list of implicit groups - * @return \type{\arrayof{\string}} Array of internal group names + * @return Array of Strings Array of internal group names */ public static function getImplicitGroups() { global $wgImplicitGroups; @@ -3263,8 +3265,8 @@ class User { /** * Get the title of a page describing a particular group * - * @param $group \string Internal group name - * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise + * @param $group String Internal group name + * @return Title|Bool Title of the page if it exists, false otherwise */ static function getGroupPage( $group ) { $page = wfMsgForContent( 'grouppage-' . $group ); @@ -3280,9 +3282,9 @@ class User { * Create a link to the group in HTML, if available; * else return the group name. * - * @param $group \string Internal name of the group - * @param $text \string The text of the link - * @return \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 == '' ) { @@ -3302,9 +3304,9 @@ class User { * Create a link to the group in Wikitext, if available; * else return the group name. * - * @param $group \string Internal name of the group - * @param $text \string The text of the link - * @return \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 == '' ) { @@ -3324,9 +3326,9 @@ class User { * * @param $group String: the group to check for whether it can add/remove * @return Array array( 'add' => array( addablegroups ), - * 'remove' => array( removablegroups ), - * 'add-self' => array( addablegroups to self), - * 'remove-self' => array( removable groups from self) ) + * 'remove' => array( removablegroups ), + * 'add-self' => array( addablegroups to self), + * 'remove-self' => array( removable groups from self) ) */ static function changeableByGroup( $group ) { global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf; @@ -3475,8 +3477,8 @@ class User { /** * Get the description of a given right * - * @param $right \string Right to query - * @return \string Localized description of the right + * @param $right String Right to query + * @return String Localized description of the right */ static function getRightDescription( $right ) { $key = "right-$right"; @@ -3489,9 +3491,9 @@ class User { /** * Make an old-style password hash * - * @param $password \string Plain-text password - * @param $userId \string User ID - * @return \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; @@ -3505,10 +3507,10 @@ class User { /** * Make a new-style password hash * - * @param $password \string Plain-text password - * @param $salt \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 \string Password hash + * @return String Password hash */ static function crypt( $password, $salt = false ) { global $wgPasswordSalt; @@ -3532,9 +3534,9 @@ class User { * 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 \string Password hash - * @param $password \string Plain-text password to compare - * @param $userId \string User ID for old-style password salt + * @param $hash String Password hash + * @param $password String Plain-text password to compare + * @param $userId String User ID for old-style password salt * @return Boolean: */ static function comparePasswords( $hash, $password, $userId = false ) { @@ -3706,6 +3708,8 @@ class User { * actually just returns array() unconditionally at the moment. May as * well keep it around for when the browser bugs get fixed, though. * + * FIXME : This does not belong here; put it in Html or Linker or somewhere + * * @return array Array of HTML attributes suitable for feeding to * Html::element(), directly or indirectly. (Don't feed to Xml::*()! * That will potentially output invalid XHTML 1.0 Transitional, and will