jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/404231 )
Change subject: Improve PHP documentation for functions and class member variables ...................................................................... Improve PHP documentation for functions and class member variables This improves PHP docs across the board, with the following improvements: - Reorders parameter syntax which is now organized like: - @param datatype $paramName description - Parameter descriptions are now capitalized at the beginning, for consistency and easier reading + distinction - Make data type on 'mixed' values more specific - Add spacing between function description and PHP doc annotations where there wasn't some already - Adds some @return annotation docs - Adds some @param annotation docs - Removed inaccurate "@private" and "@access private" annotations This helps SocialProfile further conform to the conventions as described in: https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP#Comments_and_documentation Change-Id: Ibd169c0491a23d7ca1cc8c8452420ab2e5e853cc --- M SystemGifts/SpecialPopulateAwards.php M SystemGifts/SpecialRemoveMasterSystemGift.php M SystemGifts/SpecialSystemGiftManager.php M SystemGifts/SpecialSystemGiftManagerLogo.php M SystemGifts/SpecialViewSystemGift.php M SystemGifts/SpecialViewSystemGifts.php M SystemGifts/SystemGiftsClass.php M SystemGifts/TopAwards.php M SystemGifts/UserSystemGiftsClass.php M UserActivity/SiteActivityHook.php M UserActivity/UserActivity.body.php M UserActivity/UserActivityClass.php M UserBoard/SpecialSendBoardBlast.php M UserBoard/SpecialUserBoard.php M UserBoard/UserBoardClass.php M UserGifts/GiftsClass.php M UserGifts/SpecialGiftManager.php M UserGifts/SpecialGiftManagerLogo.php M UserGifts/SpecialGiveGift.php M UserGifts/SpecialRemoveGift.php M UserGifts/SpecialRemoveMasterGift.php M UserGifts/SpecialViewGift.php M UserGifts/SpecialViewGifts.php M UserGifts/UserGiftsClass.php M UserProfile/AvatarClass.php M UserProfile/AvatarParserFunction.php M UserProfile/SpecialEditProfile.php M UserProfile/SpecialPopulateExistingUsersProfiles.php M UserProfile/SpecialRemoveAvatar.php M UserProfile/SpecialToggleUserPageType.php M UserProfile/SpecialUpdateProfile.php M UserProfile/SpecialUploadAvatar.php M UserProfile/UploadAvatar.php M UserProfile/UserProfileClass.php M UserProfile/UserProfilePage.php M UserRelationship/SpecialAddRelationship.php M UserRelationship/SpecialRemoveRelationship.php M UserRelationship/SpecialViewRelationshipRequests.php M UserRelationship/SpecialViewRelationships.php M UserRelationship/UserRelationshipClass.php M UserStats/EditCount.php M UserStats/GenerateTopUsersReport.php M UserStats/SpecialUpdateEditCounts.php M UserStats/TopFansByStat.php M UserStats/TopUsers.php M UserStats/TopUsersTag.php M UserStats/UserLevel.php M UserStats/UserStats.php M UserStats/UserStatsTrack.php M UserSystemMessages/UserSystemMessagesClass.php M UserWelcome/UserWelcomeClass.php 51 files changed, 509 insertions(+), 441 deletions(-) Approvals: Jack Phoenix: Looks good to me, approved jenkins-bot: Verified diff --git a/SystemGifts/SpecialPopulateAwards.php b/SystemGifts/SpecialPopulateAwards.php index 17dc727..bcddf26 100644 --- a/SystemGifts/SpecialPopulateAwards.php +++ b/SystemGifts/SpecialPopulateAwards.php @@ -19,7 +19,7 @@ /** * Show the special page * - * @param $gift_category Mixed: parameter passed to the page or null + * @param string|null $gift_category */ public function execute( $gift_category ) { global $wgUserLevels; diff --git a/SystemGifts/SpecialRemoveMasterSystemGift.php b/SystemGifts/SpecialRemoveMasterSystemGift.php index a68b07b..16d8358 100644 --- a/SystemGifts/SpecialRemoveMasterSystemGift.php +++ b/SystemGifts/SpecialRemoveMasterSystemGift.php @@ -17,9 +17,12 @@ /** * Deletes a gift image from $wgUploadDirectory/awards/ * - * @param $id Integer: internal ID number of the gift whose image we want to delete - * @param $size String: size of the image to delete (s for small, m for - * medium, ml for medium-large and l for large) + * @param int $id Internal ID number of the gift whose image we want to delete + * @param string $size Size of the image to delete, + * - s for small + * - m for medium + * - ml for medium-large + * - l for large */ function deleteImage( $id, $size ) { global $wgUploadDirectory; @@ -34,7 +37,8 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par + * @return string HTML */ public function execute( $par ) { $out = $this->getOutput(); @@ -113,7 +117,7 @@ /** * Displays the main form for removing a system gift permanently. * - * @return String: HTML output + * @return string HTML */ function displayForm() { global $wgUploadPath; diff --git a/SystemGifts/SpecialSystemGiftManager.php b/SystemGifts/SpecialSystemGiftManager.php index fce80de..9b55419 100644 --- a/SystemGifts/SpecialSystemGiftManager.php +++ b/SystemGifts/SpecialSystemGiftManager.php @@ -23,7 +23,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { $out = $this->getOutput(); @@ -100,7 +100,7 @@ * Display the text list of all existing system gifts and a delete link to * users who are allowed to delete gifts. * - * @return String: HTML + * @return string HTML */ function displayGiftList() { $output = ''; // Prevent E_NOTICE diff --git a/SystemGifts/SpecialSystemGiftManagerLogo.php b/SystemGifts/SpecialSystemGiftManagerLogo.php index 368e551..88fd631 100644 --- a/SystemGifts/SpecialSystemGiftManagerLogo.php +++ b/SystemGifts/SpecialSystemGiftManagerLogo.php @@ -31,7 +31,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { $out = $this->getOutput(); @@ -151,7 +151,6 @@ /** * Really do the upload * Checks are made in SpecialUpload::execute() - * @access private */ function processUpload() { /** @@ -355,9 +354,9 @@ * @todo If the later save fails, we may have disappeared the original file. * * @param string $saveName - * @param string $tempName full path to the temporary file - * @param bool $useRename if true, doesn't check that the source file - * is a PHP-managed upload temporary + * @param string $tempName Full path to the temporary file + * @param bool $useRename If true, doesn't check that the source file + * is a PHP-managed upload temporary */ function saveUploadedFile( $saveName, $tempName, $ext ) { $dest = $this->avatarUploadDirectory; @@ -436,10 +435,9 @@ * If the user doesn't explicitly cancel or accept, these files * can accumulate in the temp directory. * - * @param string $saveName - the destination filename - * @param string $tempName - the source temporary file to save - * @return string - full path the stashed file, or false on failure - * @access private + * @param string $saveName The destination filename + * @param string $tempName The source temporary file to save + * @return string Full path the stashed file, or false on failure */ function saveTempUploadedFile( $saveName, $tempName ) { $archive = wfImageArchiveDir( $saveName, 'temp' ); @@ -459,7 +457,6 @@ * to pick up the path info on a later invocation. * * @return int - * @access private */ function stashSession() { $stash = $this->saveTempUploadedFile( @@ -481,7 +478,6 @@ /** * Remove a temporarily kept file stashed by saveTempUploadedFile(). - * @access private */ function unsaveUploadedFile() { MediaWiki\suppressWarnings(); @@ -494,7 +490,6 @@ /** * Show some text and linkage on successful upload. - * @access private */ function showSuccess( $status ) { global $wgUploadPath; @@ -548,8 +543,7 @@ } /** - * @param string $error as HTML - * @access private + * @param string $error HTML */ function uploadError( $error ) { $out = $this->getOutput(); @@ -564,8 +558,7 @@ * totally but we require manual intervention to save it for real. * Stash it away, then present a form asking to confirm or cancel. * - * @param string $warning as HTML - * @access private + * @param string $warning HTML */ function uploadWarning( $warning ) { global $wgUseCopyrightUpload; @@ -619,8 +612,7 @@ * Displays the main upload form, optionally with a highlighted * error message up at the top. * - * @param string $msg as HTML - * @access private + * @param string $msg HTML */ function mainUploadForm( $msg = '' ) { global $wgUseCopyrightUpload; @@ -690,9 +682,9 @@ /** * Verifies that it's ok to include the uploaded file * - * @param string $tmpfile the full path opf the temporary file to verify + * @param string $tmpfile The full path opf the temporary file to verify * @param string $extension The filename extension that the file is to be served with - * @return Status object + * @return Status */ function verify( $tmpfile, $extension ) { global $wgDisableUploadScriptChecks, $wgVerifyMimeType, $wgMimeTypeBlacklist; diff --git a/SystemGifts/SpecialViewSystemGift.php b/SystemGifts/SpecialViewSystemGift.php index 0120ef5..05d763d 100644 --- a/SystemGifts/SpecialViewSystemGift.php +++ b/SystemGifts/SpecialViewSystemGift.php @@ -18,7 +18,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { global $wgUploadPath; diff --git a/SystemGifts/SpecialViewSystemGifts.php b/SystemGifts/SpecialViewSystemGifts.php index 460f640..1e524c1 100644 --- a/SystemGifts/SpecialViewSystemGifts.php +++ b/SystemGifts/SpecialViewSystemGifts.php @@ -27,7 +27,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { global $wgUploadPath; diff --git a/SystemGifts/SystemGiftsClass.php b/SystemGifts/SystemGiftsClass.php index 141ee07..a4861c5 100644 --- a/SystemGifts/SystemGiftsClass.php +++ b/SystemGifts/SystemGiftsClass.php @@ -106,10 +106,10 @@ * Checks if the given user has then given award (system gift) via their ID * numbers. * - * @param $user_id Integer: user ID number - * @param $gift_id Integer: award (system gift) ID number - * @return Boolean|Integer: false if the user doesn't have the specified - * gift, else the gift's ID number + * @param int $user_id User ID number + * @param int $gift_id Award (system gift) ID number + * @return bool|int False if the user doesn't have the specified + * gift, else the gift's ID number */ public function doesUserHaveGift( $user_id, $gift_id ) { $dbr = wfGetDB( DB_REPLICA ); @@ -129,11 +129,11 @@ /** * Adds a new system gift to the database. * - * @param $name Mixed: gift name - * @param $description Mixed: gift description - * @param $category Integer: see the $categories class member variable - * @param $threshold Integer: threshold number (i.e. 50 or 100 or whatever) - * @return Integer: the inserted gift's ID number + * @param mixed $name Gift name + * @param mixed $description Gift description + * @param int $category See the $categories class member variable + * @param int $threshold Threshold number (i.e. 50 or 100 or whatever) + * @return int The inserted gift's ID number */ public function addGift( $name, $description, $category, $threshold ) { $dbw = wfGetDB( DB_MASTER ); @@ -154,9 +154,9 @@ /** * Updates the data for a system gift. * - * @param $id Integer: system gift unique ID number - * @param $name Mixed: gift name - * @param $description Mixed: gift description + * @param int $id System gift unique ID number + * @param mixed $name Gift name + * @param mixed $description Gift description * @param $category * @param $threshold */ @@ -202,9 +202,10 @@ /** * Fetches the system gift with the ID $id from the database - * @param $id Integer: ID number of the system gift to be fetched - * @return Array: array of gift information, including, but not limited to, - * the gift ID, its name, description, category, threshold + * + * @param int $id ID number of the system gift to be fetched + * @return array Array of gift information, including, but not limited to, + * the gift ID, its name, description, category, threshold */ static function getGift( $id ) { $dbr = wfGetDB( DB_REPLICA ); @@ -233,10 +234,10 @@ /** * Gets the associated image for a system gift. * - * @param $id Integer: system gift ID number - * @param $size String: image size (s, m, ml or l) - * @return String: gift image filename (following the format - * sg_ID_SIZE.ext; for example, sg_1_l.jpg) + * @param int $id System gift ID number + * @param string $size Image size (s, m, ml or l) + * @return string gift Image filename (following the format + * sg_ID_SIZE.ext; for example, sg_1_l.jpg) */ static function getGiftImage( $id, $size ) { global $wgUploadDirectory; @@ -254,11 +255,12 @@ /** * Get the list of all existing system gifts (awards). * - * @param $limit Integer: LIMIT for the SQL query, 0 by default - * @param $page Integer: used to determine OFFSET for the SQL query; - * 0 by default - * @return Array: array containing gift info, including (but not limited - * to) gift ID, creation timestamp, name, description, etc. + * @param int $limit LIMIT for the SQL query, 0 by default + * @param int $page used to determine OFFSET for the SQL query; + * 0 by default + * @return array array containing gift info, including + * (but not limited to) gift ID, creation timestamp, name, + * description, etc. */ static function getGiftList( $limit = 0, $page = 0 ) { $dbr = wfGetDB( DB_REPLICA ); @@ -302,7 +304,7 @@ /** * Gets the amount of available system gifts from the database. * - * @return Integer: the amount of all system gifts on the database + * @return int The amount of all system gifts on the database */ static function getGiftCount() { $dbr = wfGetDB( DB_REPLICA ); diff --git a/SystemGifts/TopAwards.php b/SystemGifts/TopAwards.php index 1076d19..e733b4e 100644 --- a/SystemGifts/TopAwards.php +++ b/SystemGifts/TopAwards.php @@ -19,7 +19,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { global $wgUserStatsPointValues; diff --git a/SystemGifts/UserSystemGiftsClass.php b/SystemGifts/UserSystemGiftsClass.php index 9f820cc..54181fd 100644 --- a/SystemGifts/UserSystemGiftsClass.php +++ b/SystemGifts/UserSystemGiftsClass.php @@ -23,9 +23,9 @@ * Gives out a system gift with the ID of $gift_id, purges memcached and * optionally sends out e-mail to the user about their new system gift. * - * @param $gift_id Integer: ID number of the system gift - * @param $email Boolean: true to send out notification e-mail to users, - * otherwise false + * @param int $gift_id ID number of the system gift + * @param bool $email True to send out notification e-mail to users, + * otherwise false */ public function sendSystemGift( $gift_id, $email = true ) { global $wgMemc; @@ -84,8 +84,8 @@ * and they have opted in to these notifications on their social * preferences. * - * @param $user_id_to Integer: user ID of the recipient - * @param $gift_id Integer: system gift ID number + * @param int $user_id_to User ID of the recipient + * @param int $gift_id System gift ID number */ public function sendGiftNotificationEmail( $user_id_to, $gift_id ) { $gift = SystemGifts::getGift( $gift_id ); @@ -127,9 +127,9 @@ * Checks if the user with the ID $user_id has the system gift with the ID * $gift_id by querying the user_system_gift table. * - * @param $user_id Integer: user ID - * @param $gift_id Integer: system gift ID - * @return Boolean: true if the user has the gift, otherwise false + * @param int $user_id User ID + * @param int $gift_id System gift ID + * @return bool True if the user has the gift, otherwise false */ public function doesUserHaveGift( $user_id, $gift_id ) { $dbr = wfGetDB( DB_REPLICA ); @@ -168,11 +168,11 @@ * Checks if the user whose user ID is $user_id owns the system gift with * the ID = $sg_id. * - * @param $user_id Integer: user ID of the user - * @param $sg_id Integer: ID number of the system gift whose ownership - * we're trying to figure out here. - * @return Boolean: true if the specified user owns the system gift, - * otherwise false + * @param int $user_id User ID + * @param int $sg_id ID Number of the system gift whose ownership + * we're trying to figure out here. + * @return bool True if the specified user owns the system gift, + * otherwise false */ public function doesUserOwnGift( $user_id, $sg_id ) { $dbr = wfGetDB( DB_REPLICA ); @@ -193,8 +193,8 @@ /** * Deletes the system gift that has the ID $ug_id. * - * @param $ug_id Integer: gift ID of the system gift that we're about to - * delete. + * @param int $ug_id Gift ID of the system gift + * that we're about to delete. */ static function deleteGift( $ug_id ) { $dbw = wfGetDB( DB_MASTER ); @@ -210,8 +210,8 @@ * This info includes, but is not limited to, the gift ID, its description, * name, status and so on. * - * @param $id Integer: system gift ID number - * @return Array: array containing information about the system gift + * @param int $id System gift ID number + * @return array Array containing information about the system gift */ static function getUserGift( $id ) { $dbr = wfGetDB( DB_REPLICA ); @@ -249,8 +249,8 @@ /** * Increase the amount of new system gifts for the user with ID = $user_id. * - * @param $user_id Integer: user ID for the user whose gift count we're - * going to increase. + * @param int $user_id User ID for the user + * whose gift count we're going to increase. */ public function incNewSystemGiftCount( $user_id ) { global $wgMemc; @@ -261,8 +261,8 @@ /** * Decrease the amount of new system gifts for the user with ID = $user_id. * - * @param $user_id Integer: user ID for the user whose gift count we're - * going to decrease. + * @param int $user_id User ID for the user + * whose gift count we're going to decrease. */ public function decNewSystemGiftCount( $user_id ) { global $wgMemc; @@ -284,9 +284,9 @@ * Get the amount of new system gifts for the user with ID = $user_id * from memcached. If successful, returns the amount of new system gifts. * - * @param $user_id Integer: user ID for the user whose system gifts we're - * going to fetch. - * @return Integer: amount of new system gifts + * @param int $user_id User ID for the user + * whose system gifts we're going to fetch. + * @return int Amount of new system gifts */ static function getNewSystemGiftCountCache( $user_id ) { global $wgMemc; @@ -309,9 +309,9 @@ * data. If that fails, the count is fetched from the database. * UserWelcome.php calls this function. * - * @param $user_id Integer: user ID for the user whose system gifts we're - * going to fetch. - * @return Integer: amount of new gifts + * @param $user_id int User ID for the user + * whose system gifts we're going to fetch. + * @return int Amount of new gifts */ static function getNewSystemGiftCount( $user_id ) { global $wgMemc; @@ -329,9 +329,9 @@ * Get the amount of new system gifts for the user with ID = $user_id from * the database and stores it in memcached. * - * @param $user_id Integer: user ID for the user whose system gifts we're - * going to fetch. - * @return Integer: amount of new system gifts + * @param $user_id int User ID for the user + * whose system gifts we're going to fetch. + * @return int Amount of new system gifts */ static function getNewSystemGiftCountDB( $user_id ) { $logger = LoggerFactory::getInstance( 'SocialProfile' ); @@ -362,10 +362,10 @@ * Get the list of this user's system gifts. * * @param $type Unused - * @param $limit Integer: LIMIT for the SQL query - * @param $page Integer: if greater than 0, used to build the OFFSET for - * the SQL query - * @return Array: array of system gift information + * @param int $limit LIMIT for the SQL query + * @param int $page If greater than 0, used to build + * the OFFSET for the SQL query + * @return array Array of system gift information */ public function getUserGiftList( $type, $limit = 0, $page = 0 ) { $dbr = wfGetDB( DB_REPLICA ); @@ -414,7 +414,7 @@ * Update the counter that tracks how many times a system gift has been * given out. * - * @param $giftId Integer: ID number of the system gift that we're tracking + * @param int $giftId ID number of the system gift that we're tracking */ public static function incGiftGivenCount( $giftId ) { $dbw = wfGetDB( DB_MASTER ); @@ -429,9 +429,9 @@ /** * Get the amount of system gifts for the specified user. * - * @param $user_name Mixed: user name for the user whose gift count we're - * looking up; this is used to find out their UID. - * @return Integer: gift count for the specified user + * @param mixed $user_name User name for the user whose gift + * count we're looking up; this is used to find out their UID. + * @return int Gift count for the specified user */ static function getGiftCountByUsername( $user_name ) { $dbr = wfGetDB( DB_REPLICA ); diff --git a/UserActivity/SiteActivityHook.php b/UserActivity/SiteActivityHook.php index 1b8fbd4..9630121 100644 --- a/UserActivity/SiteActivityHook.php +++ b/UserActivity/SiteActivityHook.php @@ -7,7 +7,7 @@ /** * Register the <siteactivity> hook with the Parser. * - * @param Parser $parser Parser + * @param Parser $parser * @return bool */ public static function onParserFirstCallInit( &$parser ) { @@ -15,6 +15,13 @@ return true; } + /** + * Callback for ParserFirstCallInit hook subscriber + * + * @param string|null $input + * @param array $args + * @param Parser $parser + */ public static function getSiteActivity( $input, $args, $parser ) { global $wgMemc, $wgExtensionAssetsPath; diff --git a/UserActivity/UserActivity.body.php b/UserActivity/UserActivity.body.php index 218b333..72c56f2 100644 --- a/UserActivity/UserActivity.body.php +++ b/UserActivity/UserActivity.body.php @@ -28,7 +28,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { global $wgExtensionAssetsPath; diff --git a/UserActivity/UserActivityClass.php b/UserActivity/UserActivityClass.php index 19f6fc7..06f7c86 100644 --- a/UserActivity/UserActivityClass.php +++ b/UserActivity/UserActivityClass.php @@ -28,11 +28,11 @@ /** * Constructor * - * @param $username String: username (usually $wgUser's username) - * @param $filter String: passed to setFilter(); can be either 'user', - * 'friends', 'foes' or 'all', depending on what - * kind of information is wanted - * @param $item_max Integer: maximum amount of items to display in the feed + * @param string $username Username (usually $wgUser's username) + * @param string $filter Passed to setFilter(); can be either + * 'user', 'friends', 'foes' or 'all', depending on what + * kind of information is wanted + * @param int $item_max Maximum amount of items to display in the feed */ public function __construct( $username, $filter, $item_max ) { if ( $username ) { @@ -1072,8 +1072,8 @@ } /** - * @param $type String: activity type, such as 'friend' or 'foe' or 'edit' - * @param $has_page Boolean: true by default + * @param string $type Activity type, such as 'friend' or 'foe' or 'edit' + * @param bool $has_page True by default */ function simplifyPageActivity( $type, $has_page = true ) { global $wgLang; @@ -1196,9 +1196,9 @@ /** * Get the correct icon for the given activity type. * - * @param $type String: activity type, such as 'edit' or 'friend' (etc.) - * @return String: image file name (images are located in SocialProfile's - * images/ directory) + * @param string $type Activity type, such as 'edit' or 'friend' (etc.) + * @return string Image file name (images are located inSocialProfile's + * images/ directory) */ static function getTypeIcon( $type ) { switch( $type ) { @@ -1233,8 +1233,8 @@ * equivalents and, if necessary, truncates the comment and finally applies * stripslashes() to the comment. * - * @param $comment String: comment to "fix" - * @return String: "fixed" comment + * @param string $comment Comment to "fix" + * @return string "Fixed" comment */ function fixItemComment( $comment ) { global $wgLang; @@ -1254,10 +1254,10 @@ * Compares the timestamps of two given objects to decide how to sort them. * Called by getActivityList() and getActivityListGrouped(). * - * @param $x Object - * @param $y Object - * @return Integer: 0 if the timestamps are the same, -1 if $x's timestamp - * is greater than $y's, else 1 + * @param object $x + * @param object $y + * @return int 0 if the timestamps are the same, -1 if $x's timestamp + * is greater than $y's, else 1 */ private static function sortItems( $x, $y ) { if( $x['timestamp'] == $y['timestamp'] ) { diff --git a/UserBoard/SpecialSendBoardBlast.php b/UserBoard/SpecialSendBoardBlast.php index 986b0e7..9c8eb59 100644 --- a/UserBoard/SpecialSendBoardBlast.php +++ b/UserBoard/SpecialSendBoardBlast.php @@ -22,7 +22,7 @@ /** * Show the special page * - * @param $params Mixed: parameter(s) passed to the page or null + * @param string|null $params */ public function execute( $params ) { $out = $this->getOutput(); @@ -82,6 +82,8 @@ /** * Displays the form for sending board blasts + * + * @return string HTML */ function displayForm() { $user = $this->getUser(); diff --git a/UserBoard/SpecialUserBoard.php b/UserBoard/SpecialUserBoard.php index 97e50bc..98b7125 100644 --- a/UserBoard/SpecialUserBoard.php +++ b/UserBoard/SpecialUserBoard.php @@ -39,7 +39,7 @@ /** * Show the special page * - * @param string $par Name of the user whose board we want to view + * @param string|null $par Name of the user whose board we want to view */ public function execute( $par ) { $out = $this->getOutput(); diff --git a/UserBoard/UserBoardClass.php b/UserBoard/UserBoardClass.php index 5135fc0..8c0044c 100644 --- a/UserBoard/UserBoardClass.php +++ b/UserBoard/UserBoardClass.php @@ -17,13 +17,13 @@ * Performs the insertion to user_board table, sends e-mail notification * (if appliable), and increases social statistics as appropriate. * - * @param $user_id_from Integer: user ID of the sender - * @param $user_name_from Mixed: user name of the sender - * @param $user_id_to Integer: user ID of the reciever - * @param $user_name_to Mixed: user name of the reciever - * @param $message Mixed: message text - * @param $message_type Integer: 0 for public message - * @return Integer: the inserted value of ub_id row + * @param int $user_id_from User ID of the sender + * @param mixed $user_name_from User name of the sender + * @param int $user_id_to User ID of the reciever + * @param mixed $user_name_to User name of the reciever + * @param mixed $message Message text + * @param int $message_type 0 for public message + * @return int The inserted value of ub_id row */ public function sendBoardMessage( $user_id_from, $user_name_from, $user_id_to, $user_name_to, $message, $message_type = 0 ) { $dbw = wfGetDB( DB_MASTER ); @@ -84,8 +84,8 @@ /** * Sends an email to a user if someone wrote on their board * - * @param $user_id_to Integer: user ID of the reciever - * @param $user_from Mixed: the user name of the person who wrote the board message + * @param int $user_id_to User ID of the reciever + * @param mixed $user_from The user name of the person who wrote the board message */ public function sendBoardNotificationEmail( $user_id_to, $user_from ) { $user = User::newFromId( $user_id_to ); @@ -117,8 +117,8 @@ /** * Increase the amount of new messages for $user_id * - * @param $user_id Integer: user ID for the user whose message count we're - * going to increase. + * @param $user_id int User ID for the user + * whose message count we're going to increase. */ public function incNewMessageCount( $user_id ) { global $wgMemc; @@ -130,8 +130,8 @@ * Clear the new board messages counter for the user with ID = $user_id. * This is done by setting the value of the memcached key to 0. * - * @param $user_id Integer: user ID for the user whose message count we're - * going to clear. + * @param mixed $user_id User ID for the user + * whose message count we're going to clear. */ static function clearNewMessageCount( $user_id ) { global $wgMemc; @@ -143,9 +143,9 @@ * Get the amount of new board messages for the user with ID = $user_id * from memcached. If successful, returns the amount of new messages. * - * @param $user_id Integer: user ID for the user whose messages we're going - * to fetch. - * @return Integer: amount of new messages + * @param int $user_id User ID for the user + * whose messages we're going to fetch. + * @return int Amount of new messages */ static function getNewMessageCountCache( $user_id ) { global $wgMemc; @@ -167,9 +167,9 @@ * Get the amount of new board messages for the user with ID = $user_id * from the database. * - * @param $user_id Integer: user ID for the user whose messages we're going - * to fetch. - * @return Integer: amount of new messages + * @param int $user_id User ID for the user + * whose messages we're going to fetch. + * @return int Amount of new messages */ static function getNewMessageCountDB( $user_id ) { global $wgMemc; @@ -205,9 +205,9 @@ * data. If that fails, the count is fetched from the database. * UserWelcome.php calls this function. * - * @param $user_id Integer: user ID for the user whose messages we're going - * to fetch. - * @return Integer: amount of new messages + * @param $user_id int User ID for the user + * whose messages we're going to fetch. + * @return int Amount of new messages */ static function getNewMessageCount( $user_id ) { $data = self::getNewMessageCountCache( $user_id ); @@ -225,9 +225,9 @@ * Checks if the user with ID number $user_id owns the board message with * the ID number $ub_id. * - * @param $user_id Integer: user ID number - * @param $ub_id Integer: user board message ID number - * @return Boolean: true if user owns the message, otherwise false + * @param $user_id int User ID number + * @param $ub_id int User board message ID number + * @return bool True if user owns the message, otherwise false */ public function doesUserOwnMessage( $user_id, $ub_id ) { $dbr = wfGetDB( DB_REPLICA ); @@ -250,7 +250,7 @@ * statistics as appropriate (either 'user_board_count' or * 'user_board_count_priv' is decreased by one). * - * @param $ub_id Integer: ID number of the board message that we want to delete + * @param int $ub_id ID Number of the board message that we want to delete */ public function deleteMessage( $ub_id ) { if ( $ub_id ) { @@ -281,15 +281,15 @@ /** * Get the user board messages for the user with the ID $user_id. * - * @todo FIXME: rewrite this function to be compatible with non-MySQL DBMS - * @param $user_id Integer: user ID number - * @param $user_id_2 Integer: user ID number of the second user; only used - * in board-to-board stuff - * @param $limit Integer: used to build the LIMIT and OFFSET for the SQL - * query - * @param $page Integer: used to build the LIMIT and OFFSET for the SQL - * query - * @return Array: array of user board messages + * @todo FIXME: Rewrite this function to be compatible with non-MySQL DBMS + * @param int $user_id User ID number + * @param int $user_id_2 User ID number of the second user; only used + * in board-to-board stuff + * @param int $limit Used to build the LIMIT and OFFSET for the SQL + * query + * @param int $page Used to build the LIMIT and OFFSET for the SQL + * query + * @return array Array of user board messages */ public function getUserBoardMessages( $user_id, $user_id_2 = 0, $limit = 0, $page = 0 ) { global $wgUser, $wgOut, $wgTitle; @@ -353,10 +353,10 @@ * Get the amount of board-to-board messages sent between the users whose * IDs are $user_id and $user_id_2. * - * @todo FIXME: rewrite this function to be compatible with non-MySQL DBMS - * @param $user_id Integer: user ID of the first user - * @param $user_id_2 Integer: user ID of the second user - * @return Integer: the amount of board-to-board messages + * @todo FIXME: Rewrite this function to be compatible with non-MySQL DBMS + * @param int $user_id User ID of the first user + * @param int $user_id_2 User ID of the second user + * @return int The amount of board-to-board messages */ public function getUserBoardToBoardCount( $user_id, $user_id_2 ) { global $wgUser; @@ -457,7 +457,7 @@ * Get the escaped full URL to Special:SendBoardBlast. * This is just a silly wrapper function. * - * @return String: escaped full URL to Special:SendBoardBlast + * @return string Escaped full URL to Special:SendBoardBlast */ static function getBoardBlastURL() { $title = SpecialPage::getTitleFor( 'SendBoardBlast' ); @@ -467,9 +467,9 @@ /** * Get the user board URL for $user_name. * - * @param $user_name Mixed: name of the user whose user board URL we're - * going to get. - * @return String: escaped full URL to the user board page + * @param mixed $user_name Name of the user + * whose user board URL we're going to get. + * @return string Escaped full URL to the user board page */ static function getUserBoardURL( $user_name ) { $title = SpecialPage::getTitleFor( 'UserBoard' ); @@ -480,9 +480,9 @@ /** * Get the board-to-board URL for the users $user_name_1 and $user_name_2. * - * @param $user_name_1 Mixed: name of the first user - * @param $user_name_2 Mixed: name of the second user - * @return String: escaped full URL to the board-to-board conversation + * @param mixed $user_name_1 Name of the first user + * @param mixed $user_name_2 Name of the second user + * @return string Escaped full URL to the board-to-board conversation */ static function getUserBoardToBoardURL( $user_name_1, $user_name_2 ) { $title = SpecialPage::getTitleFor( 'UserBoard' ); @@ -494,9 +494,9 @@ /** * Gets the difference between two given dates * - * @param $dt1 Mixed: current time, as returned by PHP's time() function - * @param $dt2 Mixed: date - * @return Difference between dates + * @param int $dt1 Current time, as returned by PHP's time() function + * @param int $dt2 Date + * @return int Difference between dates */ public function dateDiff( $date1, $date2 ) { $dtDiff = $date1 - $date2; @@ -526,8 +526,8 @@ /** * Gets the time how long ago the given board message was posted * - * @param $time - * @return $timeStr Mixed: time, such as "20 days" or "11 hours" + * @param int $time + * @return string $timeStr Time, such as "20 days" or "11 hours" */ public function getTimeAgo( $time ) { $timeArray = $this->dateDiff( time(), $time ); diff --git a/UserGifts/GiftsClass.php b/UserGifts/GiftsClass.php index 3328f21..f9ffe5e 100644 --- a/UserGifts/GiftsClass.php +++ b/UserGifts/GiftsClass.php @@ -13,9 +13,9 @@ /** * Adds a gift to the database - * @param $gift_name Mixed: name of the gift, as supplied by the user - * @param $gift_description Mixed: a short description about the gift, as supplied by the user - * @param $gift_access Integer: 0 by default + * @param string $gift_name name of the gift, as supplied by the user + * @param string $gift_description a short description about the gift, as supplied by the user + * @param int $gift_access 0 by default */ static function addGift( $gift_name, $gift_description, $gift_access = 0 ) { global $wgUser; @@ -38,10 +38,10 @@ /** * Updates a gift's info in the database - * @param $id Integer: internal ID number of the gift that we want to update - * @param $gift_name Mixed: name of the gift, as supplied by the user - * @param $gift_description Mixed: a short description about the gift, as supplied by the user - * @param $gift_access Integer: 0 by default + * @param $id int internal ID number of the gift that we want to update + * @param $gift_namemixed name of the gift, as supplied by the user + * @param $gift_descriptionmixed a short description about the gift, as supplied by the user + * @param $gift_access int 0 by default */ public static function updateGift( $id, $gift_name, $gift_description, $access = 0 ) { $dbw = wfGetDB( DB_MASTER ); @@ -58,8 +58,10 @@ /** * Gets information, such as name and description, about a given gift from the database - * @param $id Integer: internal ID number of the gift - * @return Gift information, including ID number, name, description, creator's user name and ID and gift access + * + * @param int $id internal ID number of the gift + * @return Gift information, including ID number, name, description, + * creator's user name and ID and gift access */ static function getGift( $id ) { if ( !is_numeric( $id ) ) { diff --git a/UserGifts/SpecialGiftManager.php b/UserGifts/SpecialGiftManager.php index bac7bb8..5cfec7f 100644 --- a/UserGifts/SpecialGiftManager.php +++ b/UserGifts/SpecialGiftManager.php @@ -29,7 +29,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { $out = $this->getOutput(); @@ -112,7 +112,7 @@ /** * Function to check if the user can manage created gifts * - * @return bool true if - + * @return bool True if - * - the user has the 'giftadmin' permission * - ..or the max amount of custom user gifts is above zero */ @@ -134,8 +134,9 @@ /** * Function to check if the user can delete created gifts * - * @return Boolean: true if user has 'giftadmin' permission or is - * a member of the giftadmin group, otherwise false + * @return bool True if: + * - user has 'giftadmin' permission + * - ..or a member of the giftadmin group, otherwise false */ function canUserDelete() { $user = $this->getUser(); @@ -158,9 +159,9 @@ /** * Function to check if the user can create new gifts * - * @return Boolean: true if user has 'giftadmin' permission, is - * a member of the giftadmin group or if $wgMaxCustomUserGiftCount - * has been defined, otherwise false + * @return bool True if user has 'giftadmin' permission, is + * - a member of the giftadmin group + * - or if $wgMaxCustomUserGiftCount has been defined, otherwise false */ function canUserCreateGift() { global $wgMaxCustomUserGiftCount; @@ -188,7 +189,7 @@ * Display the text list of all existing gifts and a delete link to users * who are allowed to delete gifts. * - * @return String: HTML + * @return string HTML */ function displayGiftList() { $output = ''; // Prevent E_NOTICE diff --git a/UserGifts/SpecialGiftManagerLogo.php b/UserGifts/SpecialGiftManagerLogo.php index b36b760..6b23ac9 100644 --- a/UserGifts/SpecialGiftManagerLogo.php +++ b/UserGifts/SpecialGiftManagerLogo.php @@ -39,7 +39,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { $this->gift_id = $this->getRequest()->getInt( 'gift_id' ); @@ -170,7 +170,6 @@ /** * Really do the upload * Checks are made in SpecialUpload::execute() - * @access private */ function processUpload() { /** @@ -309,7 +308,8 @@ ' ' . $this->avatarUploadDirectory . '/' . $imgDest . '.png' ); } - } else { // ImageMagick is not enabled, so fall back to PHP's GD library + } else { + // ImageMagick is not enabled, so fall back to PHP's GD library // Get the image size, used in calculations later. switch( $typeCode ) { case '1': @@ -374,9 +374,9 @@ * @todo If the later save fails, we may have disappeared the original file. * * @param string $saveName - * @param string $tempName full path to the temporary file - * @param bool $useRename if true, doesn't check that the source file - * is a PHP-managed upload temporary + * @param string $tempName Full path to the temporary file + * @param bool $useRename If true, doesn't check that the source file + * is a PHP-managed upload temporary */ function saveUploadedFile( $saveName, $tempName, $ext ) { $dest = $this->avatarUploadDirectory; @@ -455,9 +455,9 @@ * If the user doesn't explicitly cancel or accept, these files * can accumulate in the temp directory. * - * @param string $saveName - the destination filename - * @param string $tempName - the source temporary file to save - * @return string - full path the stashed file, or false on failure + * @param string $saveName The destination filename + * @param string $tempName The source temporary file to save + * @return string full path the stashed file, or false on failure * @access private */ function saveTempUploadedFile( $saveName, $tempName ) { @@ -478,7 +478,6 @@ * to pick up the path info on a later invocation. * * @return int - * @access private */ function stashSession() { $stash = $this->saveTempUploadedFile( @@ -502,7 +501,6 @@ /** * Remove a temporarily kept file stashed by saveTempUploadedFile(). - * @access private */ function unsaveUploadedFile() { MediaWiki\suppressWarnings(); @@ -515,7 +513,6 @@ /** * Show some text and linkage on successful upload. - * @access private */ function showSuccess( $status ) { global $wgUploadPath; @@ -558,7 +555,6 @@ /** * @param string $error as HTML - * @access private */ function uploadError( $error ) { $out = $this->getOutput(); @@ -573,8 +569,7 @@ * totally but we require manual intervention to save it for real. * Stash it away, then present a form asking to confirm or cancel. * - * @param string $warning as HTML - * @access private + * @param string $warning HTML */ function uploadWarning( $warning ) { global $wgUseCopyrightUpload; @@ -629,8 +624,7 @@ * Displays the main upload form, optionally with a highlighted * error message up at the top. * - * @param string $msg as HTML - * @access private + * @param string $msg HTML */ function mainUploadForm( $msg = '' ) { global $wgUseCopyrightUpload; @@ -692,9 +686,9 @@ /** * Verifies that it's ok to include the uploaded file * - * @param string $tmpfile the full path opf the temporary file to verify + * @param string $tmpfile The full path opf the temporary file to verify * @param string $extension The filename extension that the file is to be served with - * @return Status object + * @return Status */ function verify( $tmpfile, $extension ) { global $wgDisableUploadScriptChecks, $wgVerifyMimeType, $wgMimeTypeBlacklist; diff --git a/UserGifts/SpecialGiveGift.php b/UserGifts/SpecialGiveGift.php index 4d72b53..9eaee05 100644 --- a/UserGifts/SpecialGiveGift.php +++ b/UserGifts/SpecialGiveGift.php @@ -195,7 +195,7 @@ * Display the form for sending out a single gift. * Relies on the gift_id URL parameter and bails out if it's not there. * - * @return String: HTML + * @return string HTML */ function displayFormSingle() { global $wgUploadPath; @@ -264,7 +264,7 @@ * Display the form for giving out a gift to a user when there was no user * parameter in the URL. * - * @return String: HTML + * @return string HTML */ function displayFormNoUser() { global $wgFriendingEnabled; diff --git a/UserGifts/SpecialRemoveGift.php b/UserGifts/SpecialRemoveGift.php index b472cc6..60f3705 100644 --- a/UserGifts/SpecialRemoveGift.php +++ b/UserGifts/SpecialRemoveGift.php @@ -21,7 +21,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { global $wgMemc, $wgUploadPath; @@ -92,7 +92,8 @@ /** * Displays the main form for removing a gift - * @return HTML output + * + * @return string HTML */ function displayForm() { global $wgUploadPath; diff --git a/UserGifts/SpecialRemoveMasterGift.php b/UserGifts/SpecialRemoveMasterGift.php index 191b669..d0cda78 100644 --- a/UserGifts/SpecialRemoveMasterGift.php +++ b/UserGifts/SpecialRemoveMasterGift.php @@ -21,9 +21,12 @@ /** * Deletes a gift image from $wgUploadDirectory/awards/ * - * @param $id Integer: internal ID number of the gift whose image we want to delete - * @param $size String: size of the image to delete (s for small, m for - * medium, ml for medium-large and l for large) + * @param int $id Internal ID number of the gift whose image we want to delete + * @param string $size size of the image to delete + * - s for small + * - m for medium + * - ml for medium-large + * - l for large */ function deleteImage( $id, $size ) { global $wgUploadDirectory; @@ -37,7 +40,7 @@ /** * Checks if a user is allowed to remove gifts. * - * @return Boolean: false by default or true if + * @return bool False by default or true if * - has'delete' permission or.. * - has the 'giftadmin' permission */ @@ -57,7 +60,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { $out = $this->getOutput(); @@ -133,7 +136,7 @@ /** * Displays the main form for removing a gift permanently * - * @return String: HTML output + * @return string HTML */ function displayForm() { global $wgUploadPath; diff --git a/UserGifts/SpecialViewGift.php b/UserGifts/SpecialViewGift.php index c6a3b65..ee1663f 100644 --- a/UserGifts/SpecialViewGift.php +++ b/UserGifts/SpecialViewGift.php @@ -21,7 +21,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { global $wgUploadPath; diff --git a/UserGifts/SpecialViewGifts.php b/UserGifts/SpecialViewGifts.php index 37891cf..e82651c 100644 --- a/UserGifts/SpecialViewGifts.php +++ b/UserGifts/SpecialViewGifts.php @@ -37,7 +37,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { global $wgUploadPath; diff --git a/UserGifts/UserGiftsClass.php b/UserGifts/UserGiftsClass.php index 01c74f7..ffc7304 100644 --- a/UserGifts/UserGiftsClass.php +++ b/UserGifts/UserGiftsClass.php @@ -23,10 +23,10 @@ /** * Sends a gift to the specified user. * - * @param $user_to Integer: user ID of the recipient - * @param $gift_id Integer: gift ID number - * @param $type Integer: gift type - * @param $message Mixed: message as supplied by the sender + * @param int $user_to User ID of the recipient + * @param int $gift_id Gift ID number + * @param int $type Gift type + * @param mixed $message Message as supplied by the sender */ public function sendGift( $user_to, $gift_id, $type, $message ) { $user_id_to = User::idFromName( $user_to ); @@ -84,10 +84,10 @@ * gift, if the user wants notifications about new gifts and their e-mail * is confirmed. * - * @param $user_id_to Integer: user ID of the receiver of the gift - * @param $user_from Mixed: name of the user who sent the gift - * @param $gift_id Integer: ID number of the given gift - * @param $type Integer: gift type; unused + * @param int $user_id_to User ID of the receiver of the gift + * @param mixed $user_from Name of the user who sent the gift + * @param int $gift_id ID Number of the given gift + * @param int $type Gift type; unused */ public function sendGiftNotificationEmail( $user_id_to, $user_from, $gift_id, $type ) { $gift = Gifts::getGift( $gift_id ); @@ -151,9 +151,9 @@ /** * Checks if a given user owns the gift, which is specified by its ID. * - * @param $user_id Integer: user ID of the given user - * @param $ug_id Integer: ID number of the gift that we're checking - * @return Boolean: true if the user owns the gift, otherwise false + * @param int $user_id User ID of the given user + * @param int $ug_id ID Number of the gift that we're checking + * @return bool True if the user owns the gift, otherwise false */ public function doesUserOwnGift( $user_id, $ug_id ) { $dbr = wfGetDB( DB_REPLICA ); @@ -174,7 +174,7 @@ /** * Deletes a gift from the user_gift table. * - * @param $ug_id Integer: ID number of the gift to delete + * @param int $ug_id ID number of the gift to delete */ static function deleteGift( $ug_id ) { $dbw = wfGetDB( DB_MASTER ); @@ -184,8 +184,8 @@ /** * Gets the user gift with the ID = $id. * - * @param $id Integer: gift ID number - * @return Array: array containing gift info, such as its ID, sender, etc. + * @param int $id Gift ID number + * @return array Array containing gift info, such as its ID, sender, etc. */ static function getUserGift( $id ) { if ( !is_numeric( $id ) ) { @@ -228,8 +228,8 @@ /** * Increase the amount of new gifts for the user with ID = $user_id. * - * @param $user_id Integer: user ID for the user whose gift count we're - * going to increase. + * @param int $user_id User ID for the user + * whose gift count we're going to increase. */ public function incNewGiftCount( $user_id ) { global $wgMemc; @@ -240,8 +240,8 @@ /** * Decrease the amount of new gifts for the user with ID = $user_id. * - * @param $user_id Integer: user ID for the user whose gift count we're - * going to decrease. + * @param int $user_id User ID for the user + * whose gift count we're going to decrease. */ public function decNewGiftCount( $user_id ) { global $wgMemc; @@ -263,9 +263,9 @@ * Get the amount of new gifts for the user with ID = $user_id * from memcached. If successful, returns the amount of new gifts. * - * @param $user_id Integer: user ID for the user whose gifts we're going to - * fetch. - * @return Integer: amount of new gifts + * @param int $user_id User ID for the user + * whose gifts we're going to fetch. + * @return int Amount of new gifts */ static function getNewGiftCountCache( $user_id ) { global $wgMemc; @@ -288,9 +288,9 @@ * data. If that fails, the count is fetched from the database. * UserWelcome.php calls this function. * - * @param $user_id Integer: user ID for the user whose gifts we're going to - * fetch. - * @return Integer: amount of new gifts + * @param int $user_id User ID for the user + * whose gifts we're going to fetch. + * @return int Amount of new gifts */ static function getNewGiftCount( $user_id ) { $data = self::getNewGiftCountCache( $user_id ); @@ -307,9 +307,9 @@ * Get the amount of new gifts for the user with ID = $user_id from the * database and stores it in memcached. * - * @param $user_id Integer: user ID for the user whose gifts we're going to - * fetch. - * @return Integer: amount of new gifts + * @param int $user_id User ID for the user + * whose gifts we're going to fetch. + * @return int Amount of new gifts */ static function getNewGiftCountDB( $user_id ) { $logger = LoggerFactory::getInstance( 'SocialProfile' ); @@ -431,7 +431,7 @@ /** * Update the counter that tracks how many times a gift has been given out. * - * @param $gift_id Integer: ID number of the gift that we're tracking + * @param int $gift_id ID number of the gift that we're tracking */ private function incGiftGivenCount( $gift_id ) { $dbw = wfGetDB( DB_MASTER ); @@ -446,8 +446,8 @@ /** * Gets the amount of gifts a user has. * - * @param $userName Mixed: username whose gift count we're looking up - * @return Integer: amount of gifts the specified user has + * @param mixed $userName Username whose gift count we're looking up + * @return int Amount of gifts the specified user has */ static function getGiftCountByUsername( $userName ) { $dbr = wfGetDB( DB_REPLICA ); diff --git a/UserProfile/AvatarClass.php b/UserProfile/AvatarClass.php index 7deaf1e..36544c6 100644 --- a/UserProfile/AvatarClass.php +++ b/UserProfile/AvatarClass.php @@ -18,8 +18,13 @@ /** * Constructor + * * @param $userid Integer: user's internal ID number - * @param $size String: 's' for small, 'm' for medium, 'ml' for medium-large and 'l' for large + * @param $size string + * - 's' for small + * - 'm' for medium + * - 'ml' for medium-large + * - 'l' for large */ function __construct( $userId, $size ) { $this->user_id = $userId; @@ -28,10 +33,11 @@ /** * Fetches the avatar image's name from the filesystem - * @return Avatar image's file name (i.e. default_l.gif or wikidb_3_l.jpg; - * first part for non-default images is the database name, second - * part is the user's ID number and third part is the letter for - * image size (s, m, ml or l) + * + * @return string Avatar image's file name i.e. default_l.gif or wikidb_3_l.jpg; + * - First part for non-default images is the database name + * - Second part is the user's ID number + * - Third part is the letter for image size (s, m, ml or l) */ function getAvatarImage() { global $wgAvatarKey, $wgUploadDirectory, $wgMemc; @@ -55,8 +61,8 @@ } /** - * @param Array $extraParams: array of extra parameters to give to the image - * @return String: <img> HTML tag with full path to the avatar image + * @param array $extraParams Array of extra parameters to give to the image + * @return string <img> HTML tag with full path to the avatar image */ function getAvatarURL( $extraParams = array() ) { global $wgUploadPath, $wgUserProfileDisplay; diff --git a/UserProfile/AvatarParserFunction.php b/UserProfile/AvatarParserFunction.php index fee0f7f..bed2ce4 100644 --- a/UserProfile/AvatarParserFunction.php +++ b/UserProfile/AvatarParserFunction.php @@ -5,8 +5,8 @@ /** * Setup function for the {{#avatar:Username}} function * - * @param Parser $parser: MW parser object - * @return boolean + * @param Parser $parser + * @return bool */ static function setupAvatarParserFunction( &$parser ) { $parser->setFunctionHook( 'avatar', 'AvatarParserFunction::renderAvatarParserFunction' ); @@ -17,10 +17,10 @@ /** * Function to render the {{#avatar:Username}} function * - * @param Parser $parser: MW parser object - * @param string $username: Username of user to show avatar for - * @param string $size: Size of avatar to return (s/m/ml/l), or px value (100px, 10px, etc) - * @return array: output of function, and options for the parser + * @param Parser $parser + * @param string $username Username of user to show avatar for + * @param string $size Size of avatar to return (s/m/ml/l), or px value (100px, 10px, etc) + * @return array Output of function, and options for the parser */ static function renderAvatarParserFunction( $parser, $username = '', $givenSize = 'm' ) { global $wgUploadPath; diff --git a/UserProfile/SpecialEditProfile.php b/UserProfile/SpecialEditProfile.php index e1a4dc3..a10e7bc 100644 --- a/UserProfile/SpecialEditProfile.php +++ b/UserProfile/SpecialEditProfile.php @@ -20,7 +20,7 @@ /** * Show the special page * - * @param $section Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { global $wgUpdateProfileInRecentChanges; @@ -436,7 +436,7 @@ /** * Displays the form for editing custom (site-specific) information * - * @return $form Mixed: HTML output + * @return string $form HTML */ function displayCustomForm( $tar ) { $dbr = wfGetDB( DB_REPLICA ); diff --git a/UserProfile/SpecialPopulateExistingUsersProfiles.php b/UserProfile/SpecialPopulateExistingUsersProfiles.php index a41bad6..10a4040 100644 --- a/UserProfile/SpecialPopulateExistingUsersProfiles.php +++ b/UserProfile/SpecialPopulateExistingUsersProfiles.php @@ -27,7 +27,7 @@ /** * Show the special page * - * @param $params Mixed: parameter(s) passed to the page or null + * @param string|null $params */ public function execute( $params ) { $out = $this->getOutput(); diff --git a/UserProfile/SpecialRemoveAvatar.php b/UserProfile/SpecialRemoveAvatar.php index b15f8bb..5312cb7 100644 --- a/UserProfile/SpecialRemoveAvatar.php +++ b/UserProfile/SpecialRemoveAvatar.php @@ -33,7 +33,7 @@ * Special page description shown on Special:SpecialPages -- different for * privileged users and mortals * - * @return string Special page description + * @return string */ function getDescription() { if ( $this->getUser()->isAllowed( 'avatarremove' ) ) { @@ -173,6 +173,7 @@ /** * Show the form for retrieving a user's current avatar + * * @return HTML */ private function showUserForm() { @@ -188,7 +189,7 @@ /** * Shows the requested user's current avatar and the button for deleting it * - * @param $user_name String: name of the user whose avatars we want to delete + * @param string $user_name Name of the user whose avatars we want to delete */ private function showUserAvatar( $user_name ) { $user_name = str_replace( '_', ' ', $user_name ); // replace underscores with spaces @@ -227,9 +228,9 @@ /** * Deletes all of the requested user's avatar images from the filesystem * - * @param $id Integer: user ID - * @param $size String: size of the avatar image to delete (small, medium or large). - * Doesn't really matter since we're just going to blast 'em all. + * @param int $id User ID + * @param string $size Size of the avatar image to delete (small, medium or large). + * Doesn't really matter since we're just going to blast 'em all. */ private function deleteImage( $id, $size ) { global $wgUploadDirectory, $wgAvatarKey, $wgMemc; diff --git a/UserProfile/SpecialToggleUserPageType.php b/UserProfile/SpecialToggleUserPageType.php index 133b850..eef1e79 100644 --- a/UserProfile/SpecialToggleUserPageType.php +++ b/UserProfile/SpecialToggleUserPageType.php @@ -23,7 +23,7 @@ /** * Show the special page * - * @param $params Mixed: parameter(s) passed to the page or null + * @param string|null $params */ public function execute( $params ) { global $wgMemc; diff --git a/UserProfile/SpecialUpdateProfile.php b/UserProfile/SpecialUpdateProfile.php index 75dab71..57dad49 100644 --- a/UserProfile/SpecialUpdateProfile.php +++ b/UserProfile/SpecialUpdateProfile.php @@ -22,7 +22,7 @@ * Initialize the user_profile records for a given user (either the current * user or someone else). * - * @param $user Object: User object; null by default (=current user) + * @param User|null $user User object; null by default (=current user) */ function initProfile( $user = null ) { if ( is_null( $user ) ) { @@ -48,7 +48,7 @@ /** * Show the special page * - * @param $section Mixed: parameter passed to the page or null + * @param string|null $section */ public function execute( $section ) { global $wgUpdateProfileInRecentChanges, $wgUserProfileThresholds, $wgAutoConfirmCount, $wgEmailConfirmToEdit; @@ -229,7 +229,7 @@ * Save basic settings about the user (real name, e-mail address) into the * database. * - * @param $user Object: User object representing the current user + * @param User $user Representing the current user */ function saveSettings_basic( $user ) { global $wgEmailAuthentication; @@ -328,7 +328,7 @@ /** * Save the basic user profile info fields into the database. * - * @param $user Object: User object, null by default (=the current user) + * @param User|null $user User object, null by default (=the current user) */ function saveProfileBasic( $user = null ) { global $wgMemc, $wgSitename; @@ -379,7 +379,7 @@ * Save the four custom (site-specific) user profile fields into the * database. * - * @param $user Object: User object + * @param User|null $user */ function saveProfileCustom( $user = null ) { global $wgMemc; @@ -411,7 +411,7 @@ * Save the user's personal info (interests, such as favorite music or * TV programs or video games, etc.) into the database. * - * @param $user Object: User object + * @param User|null $user */ function saveProfilePersonal( $user = null ) { global $wgMemc; @@ -452,7 +452,7 @@ } /** - * @param $user Object: User + * @param User $user */ function displayBasicForm( $user ) { $dbr = wfGetDB( DB_REPLICA ); @@ -655,7 +655,7 @@ } /** - * @param $user Object: User + * @param User $user */ function displayPersonalForm( $user ) { $dbr = wfGetDB( DB_REPLICA ); @@ -749,7 +749,7 @@ * Displays the form for toggling notifications related to social tools * (e-mail me when someone friends/foes me, send me a gift, etc.) * - * @return HTML + * @return string HTML */ function displayPreferencesForm() { $user = $this->getUser(); @@ -819,8 +819,8 @@ /** * Displays the form for editing custom (site-specific) information. * - * @param $user Object: User - * @return $form Mixed: HTML output + * @param User $user + * @return string $form HTML */ function displayCustomForm( $user ) { $dbr = wfGetDB( DB_MASTER ); diff --git a/UserProfile/SpecialUploadAvatar.php b/UserProfile/SpecialUploadAvatar.php index 1041446..12adb2c 100644 --- a/UserProfile/SpecialUploadAvatar.php +++ b/UserProfile/SpecialUploadAvatar.php @@ -40,7 +40,7 @@ * Show the special page. Let the parent handle most stuff, but handle a * successful upload ourselves * - * @param $params Mixed: parameter(s) passed to the page or null + * @param string|null $params */ public function execute( $params ) { $out = $this->getOutput(); @@ -67,7 +67,7 @@ /** * Show some text and linkage on successful upload. * - * @param $ext String: file extension (gif, jpg or png) + * @param string $ext File extension (gif, jpg or png) */ private function showSuccess( $ext ) { global $wgAvatarKey, $wgUploadPath, $wgUploadAvatarInRecentChanges; @@ -140,10 +140,10 @@ * Displays the main upload form, optionally with a highlighted * error message up at the top. * - * @param $msg String: error message as HTML - * @param $sessionKey String: session key in case this is a stashed upload - * @param $hideIgnoreWarning Boolean: whether to hide "ignore warning" check box - * @return HTML output + * @param string $msg Error message as HTML + * @param string $sessionKey Session key in case this is a stashed upload + * @param bool $hideIgnoreWarning Whether to hide "ignore warning" check box + * @return string HTML */ protected function getUploadForm( $message = '', $sessionKey = '', $hideIgnoreWarning = false ) { global $wgUseCopyrightUpload, $wgUserProfileDisplay; @@ -235,9 +235,12 @@ /** * Gets an avatar image with the specified size * - * @param $size String: size of the image ('s' for small, 'm' for medium, - * 'ml' for medium-large and 'l' for large) - * @return String: full img HTML tag + * @param string $size Size of the image + * - 's' for small + * - 'm' for medium + * - 'ml' for medium-large + * - 'l' for large + * @return string HTML */ function getAvatar( $size ) { global $wgAvatarKey, $wgUploadDirectory, $wgUploadPath; diff --git a/UserProfile/UploadAvatar.php b/UserProfile/UploadAvatar.php index fdb498e..4150652 100644 --- a/UserProfile/UploadAvatar.php +++ b/UserProfile/UploadAvatar.php @@ -206,6 +206,8 @@ /** * Don't verify the upload, since it all dangerous stuff is killed by * making thumbnails + * + * @return array */ public function verifyUpload() { return array( 'status' => self::OK ); @@ -213,6 +215,8 @@ /** * Only needed for the redirect; needs fixage + * + * @return Title */ public function getTitle() { return Title::makeTitle( NS_FILE, 'Avatar-placeholder' . uniqid() . '.jpg' ); @@ -220,6 +224,8 @@ /** * We don't overwrite stuff, so don't care + * + * @return array */ public function checkWarnings() { return array(); diff --git a/UserProfile/UserProfileClass.php b/UserProfile/UserProfileClass.php index 5f93280..89db25b 100644 --- a/UserProfile/UserProfileClass.php +++ b/UserProfile/UserProfileClass.php @@ -6,16 +6,18 @@ */ class UserProfile { /** - * @var Integer: the current user's user ID. Set in the constructor. + * @var int $user_id The current user's user ID. Set in the constructor. */ public $user_id; /** - * @var String: the current user's user name. Set in the constructor. + * @var string $user_name The current user's user name. Set in the constructor. */ public $user_name; - /** unused, remove me? */ + /** + * @var $profile Unused, remove me? + */ public $profile; /** @@ -24,7 +26,7 @@ public $profile_fields_count; /** - * @var Array: array of valid profile fields; used in getProfileComplete() + * @var array Array of valid profile fields; used in getProfileComplete() */ public $profile_fields = array( 'real_name', @@ -51,15 +53,14 @@ ); /** - * @var Array: unused, remove me? + * @var array $profile_missing Unused, remove me? */ public $profile_missing = array(); /** * Constructor - * @private */ - /* private */ function __construct( $username ) { + function __construct( $username ) { $title1 = Title::newFromDBkey( $username ); $this->user_name = $title1->getText(); $this->user_id = User::idFromName( $this->user_name ); @@ -68,7 +69,7 @@ /** * Deletes the memcached key for $user_id. * - * @param $user_id Integer: user ID number + * @param int $user_id User ID number */ static function clearCache( $user_id ) { global $wgMemc; @@ -79,8 +80,8 @@ /** * Loads social profile info for the current user. - * First tries fetching the info from memcached and if that fails, queries - * the database. + * First tries fetching the info from memcached and if that fails, + * queries the database. * Fetched info is cached in memcached. */ public function getProfile() { @@ -154,8 +155,8 @@ /** * Format the user's birthday. * - * @param $birthday String: birthday in YYYY-MM-DD format - * @return String: formatted birthday + * @param string $birthday birthday in YYYY-MM-DD format + * @return string formatted birthday */ function formatBirthday( $birthday, $showYear = true ) { $dob = explode( '-', $birthday ); @@ -184,8 +185,8 @@ * Get the user's birthday year by exploding the given birthday in three * parts and returning the first one. * - * @param $birthday String: birthday in YYYY-MM-DD format - * @return String: birthyear or '00' + * @param string $birthday Birthday in YYYY-MM-DD format + * @return string Birthyear or '00' */ function getBirthdayYear( $birthday ) { $dob = explode( '-', $birthday ); @@ -200,7 +201,7 @@ * Currently unused, I think that this might've been used in some older * ArmchairGM code, but this looks useful enough to be kept around. * - * @return Integer + * @return int */ public function getProfileComplete() { global $wgUser; diff --git a/UserProfile/UserProfilePage.php b/UserProfile/UserProfilePage.php index 4bb2d67..a0886b2 100644 --- a/UserProfile/UserProfilePage.php +++ b/UserProfile/UserProfilePage.php @@ -21,33 +21,33 @@ public $title = null; /** - * @var String: user name of the user whose profile we're viewing + * @var string user name of the user whose profile we're viewing */ public $user_name; /** - * @var Integer: user ID of the user whose profile we're viewing + * @var int user ID of the user whose profile we're viewing */ public $user_id; /** - * @var User: User object representing the user whose profile we're viewing + * @var User User object representing the user whose profile we're viewing */ public $user; /** - * @var Boolean: is the current user the owner of the profile page? + * @var bool is the current user the owner of the profile page? */ public $is_owner; /** - * @var Array: user profile data (interests, etc.) for the user whose + * @var array user profile data (interests, etc.) for the user whose * profile we're viewing */ public $profile_data; /** - * @var Array: array of profile fields visible to the user viewing the profile + * @var array array of profile fields visible to the user viewing the profile */ public $profile_visible_fields; @@ -76,7 +76,7 @@ * In other words, is the current user's username the same as that of the * profile's owner's? * - * @return Boolean + * @return bool */ function isOwner() { return $this->is_owner; @@ -264,7 +264,7 @@ * Get three of the polls the user has created and cache the data in * memcached. * - * @return Array + * @return array */ function getUserPolls() { global $wgMemc; @@ -311,7 +311,7 @@ * Get three of the quiz games the user has created and cache the data in * memcached. * - * @return Array + * @return array */ function getUserQuiz() { global $wgMemc; @@ -365,7 +365,7 @@ * Get three of the picture games the user has created and cache the data * in memcached. * - * @return Array + * @return array */ function getUserPicGames() { global $wgMemc; @@ -421,9 +421,9 @@ * has created if $wgUserProfileDisplay['games'] is set to true and the * PictureGame, PollNY and QuizGame extensions have been installed. * - * @param $user_id Integer: user ID number - * @param $user_name String: user name - * @return String: HTML or nothing if this feature isn't enabled + * @param int $user_id User ID number + * @param string $user_name User name + * @return string HTML or nothing if this feature isn't enabled */ function getCasualGames( $user_id, $user_name ) { global $wgUserProfileDisplay; @@ -772,8 +772,8 @@ /** * Get the custom info (site-specific stuff) for a given user. * - * @param $user_name String: user name whose custom info we should fetch - * @return String: HTML + * @param string $user_name User name whose custom info we should fetch + * @return string HTML */ function getCustomInfo( $user_name ) { global $wgUserProfileDisplay; @@ -854,8 +854,8 @@ * Get the interests (favorite movies, TV shows, music, etc.) for a given * user. * - * @param $user_name String: user name whose interests we should fetch - * @return String: HTML + * @param string $user_name user name whose interests we should fetch + * @return string HTML */ function getInterests( $user_name ) { global $wgUserProfileDisplay; @@ -950,8 +950,8 @@ * points and user level (if enabled in the site configuration) and lots * more. * - * @param $user_id Integer: user ID - * @param $user_name String: user name + * @param int $user_id User ID + * @param string $user_name User name */ function getProfileHeader( $user_id, $user_name ) { global $wgUserLevels; @@ -1142,8 +1142,8 @@ * This is currently unused, seems to be a leftover from the ArmchairGM * days. * - * @param $user_name String: user name - * @return String: HTML + * @param string $user_name User name + * @return string HTML */ function getProfileImage( $user_name ) { $context = $this->getContext(); @@ -1174,10 +1174,11 @@ /** * Get the relationships for a given user. * - * @param $user_name String: name of the user whose relationships we want - * to fetch - * @param $rel_type Integer: 1 for friends, 2 (or anything else than 1) for - * foes + * @param string $user_name Name of the user + * whose relationships we want to fetch + * @param int $rel_type + * - 1 for friends + * - 2 (or anything else than 1) for foes */ function getRelationships( $user_name, $rel_type ) { global $wgMemc, $wgUserProfileDisplay; @@ -1284,7 +1285,7 @@ /** * Gets the recent social activity for a given user. * - * @param $user_name String: name of the user whose activity we want to fetch + * @param string $user_name Name of the user whose activity we want to fetch */ function getActivity( $user_name ) { global $wgUserProfileDisplay, $wgExtensionAssetsPath, $wgUploadPath; @@ -1666,8 +1667,8 @@ /** * Get the user board for a given user. * - * @param $user_id Integer: user's ID number - * @param $user_name String: user name + * @param int $user_id User's ID number + * @param string $user_name User name */ function getUserBoard( $user_id, $user_name ) { global $wgUserProfileDisplay; @@ -1779,8 +1780,8 @@ * $wgUserProfileDisplay['userboxes'] = true; and the FanBoxes extension is * installed. * - * @param $user_name String: user name - * @return String: HTML + * @param string $user_name User name + * @return string HTML */ function getFanBoxes( $user_name ) { global $wgMemc, $wgUserProfileDisplay, $wgEnableUserBoxes; @@ -2000,7 +2001,7 @@ * Initialize UserProfile data for the given user if that hasn't been done * already. * - * @param $username String: name of the user whose profile data to initialize + * @param string $username Name of the user whose profile data to initialize */ private function initializeProfileData( $username ) { if ( !$this->profile_data ) { diff --git a/UserRelationship/SpecialAddRelationship.php b/UserRelationship/SpecialAddRelationship.php index 4125472..740b9f0 100644 --- a/UserRelationship/SpecialAddRelationship.php +++ b/UserRelationship/SpecialAddRelationship.php @@ -245,7 +245,7 @@ /** * Displays the form for adding a friend or a foe * - * @return $form Mixed: HTML code for the form + * @return string $form HTML */ function displayForm() { $out = $this->getOutput(); diff --git a/UserRelationship/SpecialRemoveRelationship.php b/UserRelationship/SpecialRemoveRelationship.php index acfdb0c..353156b 100644 --- a/UserRelationship/SpecialRemoveRelationship.php +++ b/UserRelationship/SpecialRemoveRelationship.php @@ -32,7 +32,7 @@ /** * Show the special page * - * @param $params Mixed: parameter(s) passed to the page or null + * @param string|null $params */ public function execute( $params ) { $out = $this->getOutput(); @@ -170,7 +170,7 @@ /** * Displays the form for removing a friend or a foe * - * @return $form Mixed: HTML code for the form + * @return string $form HTML code for the form */ function displayForm() { $avatar = new wAvatar( $this->user_id_to, 'l' ); diff --git a/UserRelationship/SpecialViewRelationshipRequests.php b/UserRelationship/SpecialViewRelationshipRequests.php index f2178c1..bf46f67 100644 --- a/UserRelationship/SpecialViewRelationshipRequests.php +++ b/UserRelationship/SpecialViewRelationshipRequests.php @@ -44,7 +44,7 @@ /** * Show the special page * - * @param $params Mixed: parameter(s) passed to the page or null + * @param string|null $params */ public function execute( $params ) { $out = $this->getOutput(); diff --git a/UserRelationship/SpecialViewRelationships.php b/UserRelationship/SpecialViewRelationships.php index dd33fd6..bdde9a3 100644 --- a/UserRelationship/SpecialViewRelationships.php +++ b/UserRelationship/SpecialViewRelationships.php @@ -41,7 +41,7 @@ /** * Show the special page * - * @param $params Mixed: parameter(s) passed to the page or null + * @param string|null $params */ public function execute( $params ) { $lang = $this->getLanguage(); diff --git a/UserRelationship/UserRelationshipClass.php b/UserRelationship/UserRelationshipClass.php index ec21da4..6f19188 100644 --- a/UserRelationship/UserRelationshipClass.php +++ b/UserRelationship/UserRelationshipClass.php @@ -21,14 +21,15 @@ /** * Add a relationship request to the database. * - * @param $user_to String: user name of the recipient of the relationship - * request - * @param $type Integer: 1 for friend request, 2 (or anything else than 1) - * for foe request - * @param $message String: user-supplied message to to the recipient; may - * be empty - * @param $email Boolean: send out email to the recipient of the request? - * @return Integer: ID of the new relationship request + * @param string $user_to User name of the + * recipient of the relationship request + * @param int $type + * - 1 for friend request + * - 2 (or anything else than 1) for foe request + * @param string|null $message User-supplied message + * to the recipient; may be empty + * @param bool $email Send out email to the recipient of the request? + * @return int ID of the new relationship request */ public function addRelationshipRequest( $userTo, $type, $message, $email = true ) { $userIdTo = User::idFromName( $userTo ); @@ -77,10 +78,11 @@ * Send e-mail about a new relationship request to the user whose user ID * is $userIdTo if they have opted in for these notification e-mails. * - * @param $userIdTo Integer: user ID of the recipient - * @param $userFrom String: name of the user who requested the relationship - * @param $type Integer: 1 for friend request, 2 (or anything else than 1) - * for foe request + * @param int $userIdTo User ID of the recipient + * @param string $userFrom Name of the user who requested the relationship + * @param int $type + * - 1 for friend request + * - 2 (or anything else than 1) for foe request */ public function sendRelationshipRequestEmail( $userIdTo, $userFrom, $type ) { $user = User::newFromId( $userIdTo ); @@ -135,9 +137,11 @@ * Send an e-mail to the user whose user ID is $userIdTo about a new user * relationship. * - * @param $userIdTo Integer: user ID of the recipient of the e-mail - * @param $userFrom String: name of the user who removed the relationship - * @param $type Integer: 1 for friend, 2 (or anything else but 1) for foe + * @param int $userIdTo User ID of the recipient of the e-mail + * @param string $userFrom Name of the user who removed the relationship + * @param int $type + * - 1 for friend + * - 2 (or anything else but 1) for foe */ public function sendRelationshipAcceptEmail( $userIdTo, $userFrom, $type ) { $user = User::newFromId( $userIdTo ); @@ -192,9 +196,11 @@ * Send an e-mail to the user whose user ID is $userIdTo about a removed * relationship. * - * @param $userIdTo Integer: user ID of the recipient of the e-mail - * @param $userFrom String: name of the user who removed the relationship - * @param $type Integer: 1 for friend, 2 (or anything else but 1) for foe + * @param string $userIdTo User ID of the recipient of the e-mail + * @param string $userFrom Name of the user who removed the relationship + * @param int $type + * - 1 for friend + * - 2 (or anything else but 1) for foe */ public function sendRelationshipRemoveEmail( $userIdTo, $userFrom, $type ) { $user = User::newFromId( $userIdTo ); @@ -248,9 +254,9 @@ /** * Add a new relationship to the database. * - * @param $relationshipRequestId Integer: relationship request ID number - * @param $email Boolean: send out email to the recipient of the request? - * @return Boolean: true if successful, otherwise false + * @param int $relationshipRequestId Relationship request ID number + * @param bool $email Send out email to the recipient of the request? + * @return bool True if successful, otherwise false */ public function addRelationship( $relationshipRequestId, $email = true ) { global $wgMemc; @@ -351,8 +357,8 @@ /** * Remove a relationship between two users and clear caches afterwards. * - * @param $user1 Integer: user ID of the first user - * @param $user2 Integer: user ID of the second user + * @param int $user1 User ID of the first user + * @param int $user2 User ID of the second user */ public function removeRelationshipByUserID( $user1, $user2 ) { global $wgUser, $wgMemc; @@ -398,7 +404,7 @@ /** * Delete a user relationship request from the database. * - * @param $id Integer: relationship request ID number + * @param int $id Relationship request ID number */ public function deleteRequest( $id ) { $request = $this->getRequest( $id ); @@ -413,7 +419,7 @@ } /** - * @param $relationshipRequestId Integer: relationship request ID number + * @param int $relationshipRequestId Relationship request ID number * @param $status */ public function updateRelationshipRequestStatus( $relationshipRequestId, $status ) { @@ -430,7 +436,7 @@ * Make sure that there is a pending user relationship request with the * given ID. * - * @param $relationshipRequestId Integer: relationship request ID number + * @param int $relationshipRequestId Relationship request ID number * @return bool */ public function verifyRelationshipRequest( $relationshipRequestId ) { @@ -450,9 +456,9 @@ } /** - * @param $user1 Integer: - * @param $user2 Integer: - * @return Mixed: integer or boolean false + * @param int $user1 + * @param int $user2 + * @return int|bool false */ static function getUserRelationshipByID( $user1, $user2 ) { $dbr = wfGetDB( DB_REPLICA ); @@ -470,8 +476,8 @@ } /** - * @param $user1 Integer: user ID of the recipient of the request - * @param $user2 Integer: user ID of the sender of the request + * @param int $user1 User ID of the recipient of the request + * @param int $user2 User ID of the sender of the request * @return bool */ static function userHasRequestByID( $user1, $user2 ) { @@ -496,9 +502,9 @@ /** * Get an individual user relationship request via its ID. * - * @param $id Integer: relationship request ID - * @return Array: array containing relationship request info, such as its - * ID, type, requester, etc. + * @param int $id Relationship request ID + * @return array Array containing relationship request info, + * such as its ID, type, requester, etc. */ public function getRequest( $id ) { $dbr = wfGetDB( DB_REPLICA ); @@ -534,9 +540,9 @@ /** * Get the list of open relationship requests. * - * @param $status Integer: - * @param $limit Integer: used as the LIMIT in the SQL query - * @return Array: array of open relationship requests + * @param int $status + * @param int $limit Used as the LIMIT in the SQL query + * @return array Array of open relationship requests */ public function getRequestList( $status, $limit = 0 ) { $dbr = wfGetDB( DB_REPLICA ); @@ -586,8 +592,10 @@ /** * Increase the amount of open relationship requests for a user. * - * @param $userId Integer: user ID for whom to get the requests - * @param $relType Integer: 1 for friends, 2 (or anything else but 1) for foes + * @param int $userId User ID for whom to get the requests + * @param int $relType + * - 1 for friends + * - 2 (or anything else but 1) for foes */ private function incNewRequestCount( $userId, $relType ) { global $wgMemc; @@ -598,8 +606,10 @@ /** * Decrease the amount of open relationship requests for a user. * - * @param $userId Integer: user ID for whom to get the requests - * @param $relType Integer: 1 for friends, 2 (or anything else but 1) for foes + * @param int $userId User ID for whom to get the requests + * @param int $relType + * - 1 for friends + * - 2 (or anything else but 1) for foes */ private function decNewRequestCount( $userId, $relType ) { global $wgMemc; @@ -611,9 +621,11 @@ * Get the amount of open user relationship requests for a user from the * database and cache it. * - * @param $userId Integer: user ID for whom to get the requests - * @param $relType Integer: 1 for friends, 2 (or anything else but 1) for foes - * @return Integer + * @param int $userId User ID for whom to get the requests + * @param int $relType + * - 1 for friends + * - 2 (or anything else but 1) for foes + * @return int */ static function getOpenRequestCountDB( $userId, $relType ) { global $wgMemc; @@ -651,9 +663,11 @@ /** * Get the amount of open user relationship requests from cache. * - * @param $userId Integer: user ID for whom to get the requests - * @param $relType Integer: 1 for friends, 2 (or anything else but 1) for foes - * @return Integer + * @param int $userId User ID for whom to get the requests + * @param int $relType + * - 1 for friends + * - 2 (or anything else but 1) for foes + * @return int */ static function getOpenRequestCountCache( $userId, $relType ) { global $wgMemc; @@ -675,9 +689,11 @@ * Get the amount of open user relationship requests; first tries cache, * and if that fails, fetches the count from the database. * - * @param $userId Integer: user ID for whom to get the requests - * @param $relType Integer: 1 for friends, 2 (or anything else but 1) for foes - * @return Integer + * @param int $userId User ID for whom to get the requests + * @param int $relType + * - 1 for friends + * - 2 (or anything else but 1) for foes + * @return int */ static function getOpenRequestCount( $userId, $relType ) { $data = self::getOpenRequestCountCache( $userId, $relType ); @@ -697,11 +713,13 @@ /** * Get the relationship list for the current user. * - * @param $type Integer: 1 for friends, 2 (or anything else but 1) for foes - * @param $limit Integer: used as the LIMIT in the SQL query - * @param $page Integer: if greater than 0, will be used to calculate the - * OFFSET for the SQL query - * @return Array: array of relationship information + * @param int $type + * - 1 for friends + * - 2 (or anything else but 1) for foes + * @param int $limit Used as the LIMIT in the SQL query + * @param int $page If greater than 0, will be used to + * calculate the OFFSET for the SQL query + * @return array Array of relationship information */ public function getRelationshipList( $type = 0, $limit = 0, $page = 0 ) { $dbr = wfGetDB( DB_REPLICA ); @@ -748,8 +766,10 @@ /** * Get the relationship IDs for the current user. * - * @param $type Integer: 1 for friends, 2 (or anything else but 1) for foes - * @return Array: array of relationship ID numbers + * @param int $type + * - 1 for friends + * - 2 (or anything else but 1) for foes + * @return array Array of relationship ID numbers */ public function getRelationshipIDs( $type ) { $dbr = wfGetDB( DB_REPLICA ); @@ -777,8 +797,8 @@ * Get the amount of friends and foes a user has from the * user_relationship_stats database table. * - * @param $userName String: name of the user whose stats we're looking up - * @return Array: array containing the amount of friends and foes + * @param string $userName Name of the user whose stats we're looking up + * @return array Array containing the amount of friends and foes */ static function getRelationshipCountByUsername( $userName ) { $dbr = wfGetDB( DB_REPLICA ); diff --git a/UserStats/EditCount.php b/UserStats/EditCount.php index e8b6793..0d72749 100644 --- a/UserStats/EditCount.php +++ b/UserStats/EditCount.php @@ -19,6 +19,11 @@ /** * Updates user's points after they've made an edit in a namespace that is * listed in the $wgNamespacesForEditPoints array. + * + * @param WikiPage $wikiPage + * @param Revision $revision + * @param int $baseRevId + * @return bool true */ function incEditCount( WikiPage $wikiPage, $revision, $baseRevId ) { global $wgUser, $wgNamespacesForEditPoints; @@ -38,6 +43,11 @@ /** * Updates user's points after a page in a namespace that is listed in the * $wgNamespacesForEditPoints array that they've edited has been deleted. + * + * @param WikiPage $article + * @param User $user + * @param string $reason + * @return bool true */ function removeDeletedEdits( &$article, &$user, &$reason ) { global $wgNamespacesForEditPoints; @@ -68,6 +78,10 @@ * Updates user's points after a page in a namespace that is listed in the * $wgNamespacesForEditPoints array that they've edited has been restored after * it was originally deleted. + * + * @param Title $title + * @param bool $new + * @return bool true */ function restoreDeletedEdits( &$title, $new ) { global $wgNamespacesForEditPoints; diff --git a/UserStats/GenerateTopUsersReport.php b/UserStats/GenerateTopUsersReport.php index de3b6d2..a9aee31 100644 --- a/UserStats/GenerateTopUsersReport.php +++ b/UserStats/GenerateTopUsersReport.php @@ -30,7 +30,7 @@ /** * Show the special page * - * @param $period String: either weekly or monthly + * @param string $period Either weekly or monthly */ public function execute( $period ) { global $wgContLang, $wgUser; diff --git a/UserStats/SpecialUpdateEditCounts.php b/UserStats/SpecialUpdateEditCounts.php index 248e157..54c90eb 100644 --- a/UserStats/SpecialUpdateEditCounts.php +++ b/UserStats/SpecialUpdateEditCounts.php @@ -99,7 +99,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { $out = $this->getOutput(); diff --git a/UserStats/TopFansByStat.php b/UserStats/TopFansByStat.php index 236b770..0907e3f 100644 --- a/UserStats/TopFansByStat.php +++ b/UserStats/TopFansByStat.php @@ -22,7 +22,7 @@ /** * Show the special page * - * @param @param string|null $par Statistic name, i.e. friends_count or edit_count, etc. (or null) + * @param string|null $par Statistic name, i.e. friends_count or edit_count, etc. (or null) */ public function execute( $par ) { global $wgMemc; diff --git a/UserStats/TopUsers.php b/UserStats/TopUsers.php index fceb7de..9138d7c 100644 --- a/UserStats/TopUsers.php +++ b/UserStats/TopUsers.php @@ -14,7 +14,7 @@ /** * Show the special page * - * @param $par Mixed: parameter passed to the page or null + * @param string|null $par */ public function execute( $par ) { global $wgMemc, $wgUserStatsTrackWeekly, $wgUserStatsTrackMonthly, $wgUserLevels; diff --git a/UserStats/TopUsersTag.php b/UserStats/TopUsersTag.php index 21dd43f..1119679 100644 --- a/UserStats/TopUsersTag.php +++ b/UserStats/TopUsersTag.php @@ -18,8 +18,8 @@ /** * Register the new <topusers /> parser hook with the Parser. * - * @param $parser Parser: instance of Parser (not necessarily $wgParser) - * @return Boolean: true + * @param Parser $parser + * @return bool true */ function wfRegisterTopUsersTag( &$parser ) { $parser->setHook( 'topusers', 'getTopUsersForTag' ); @@ -29,7 +29,7 @@ /** * Get the given amount of top users for the given timeframe. * - * @return String: HTML + * @return string HTML */ function getTopUsersForTag( $input, $args, $parser ) { // Don't allow showing OVER 9000...I mean, over 50 users, duh. diff --git a/UserStats/UserLevel.php b/UserStats/UserLevel.php index df403c4..9b99312 100644 --- a/UserStats/UserLevel.php +++ b/UserStats/UserLevel.php @@ -5,16 +5,19 @@ public $level_name; /** - * @var String: name of the next level + * @var int $next_level_name name of the next level */ public $next_level_name; /** - * @var Integer: amount of points needed to reach the next level + * @var int $next_level_points amount of points needed to reach the next level */ public $next_level_points_needed; - /* private */ function __construct( $points ) { + /** + * Constructor + */ + function __construct( $points ) { global $wgUserLevels; $this->levels = $wgUserLevels; $this->points = (int)str_replace( ',', '', $points ); diff --git a/UserStats/UserStats.php b/UserStats/UserStats.php index cec4f04..b81effd 100644 --- a/UserStats/UserStats.php +++ b/UserStats/UserStats.php @@ -5,11 +5,11 @@ class UserStats { /** * Constructor - * @private - * @param $user_id Integer: ID number of the user that we want to track stats for - * @param $user_name Mixed: user's name; if not supplied, then the user ID will be used to get the user name from DB. + * + * @param int $user_id ID number of the user that we want to track stats for + * @param mixed $user_name user's name; if not supplied, then the user ID will be used to get the user name from DB. */ - /* private */ function __construct( $user_id, $user_name ) { + function __construct( $user_id, $user_name ) { $this->user_id = $user_id; if ( !$user_name ) { $user = User::newFromId( $this->user_id ); @@ -51,6 +51,8 @@ /** * Retrieves cached per-user statistics from Memcached, if possible + * + * @return array */ public function getUserStatsCache() { global $wgMemc; @@ -68,6 +70,8 @@ /** * Retrieves per-user statistics from the database + * + * @return array */ public function getUserStatsDB() { global $wgMemc; @@ -128,9 +132,9 @@ /** * Get the list of top users, based on social statistics. * - * @param $limit Integer: LIMIT for SQL query, defaults to 10 - * @return Array: list of top users, contains the user IDs, names and - * amount of points the user has + * @param int $limit LIMIT for SQL query, defaults to 10 + * @return array list of top users, contains the user IDs, + * names and amount of points the user has */ static function getTopFansList( $limit = 10 ) { $dbr = wfGetDB( DB_REPLICA ); @@ -161,10 +165,10 @@ /** * Get the top users for a given period. * - * @param $limit Integer: LIMIT for SQL query, defaults to 10 - * @param $period String: period for which we're getting the top users, can - * be either 'weekly' or 'monthly' - * @return Array: list of top users + * @param int $limit LIMIT for SQL query, defaults to 10 + * @param string $period period for which we're getting the top users, + * can be either 'weekly' or 'monthly' + * @return array list of top users */ static function getTopFansListPeriod( $limit = 10, $period = 'weekly' ) { if ( $period == 'monthly' ) { @@ -220,15 +224,15 @@ /** * Gets the amount of friends relative to points. * - * @param $user_id Integer: user ID - * @param $points Integer: - * @param $limit Integer: LIMIT for SQL queries, defaults to 3 - * @param $condition Integer: if 1, the query operator for ORDER BY clause - * will be set to > and the results are - * ordered in ascending order, otherwise it'll - * be set to < and results are ordered in - * descending order - * @return Array + * @param int $user_id user ID + * @param int $points + * @param int $limit LIMIT for SQL queries, defaults to 3 + * @param int $condition if 1, the query operator for ORDER BY clause + * will be set to > and the results are + * ordered in ascending order, otherwise it'll + * be set to < and results are ordered in + * descending order + * @return array */ static function getFriendsRelativeToPoints( $user_id, $points, $limit = 3, $condition = 1 ) { if ( $condition == 1 ) { diff --git a/UserStats/UserStatsTrack.php b/UserStats/UserStatsTrack.php index 9134506..989f306 100644 --- a/UserStats/UserStatsTrack.php +++ b/UserStats/UserStatsTrack.php @@ -178,8 +178,8 @@ /** * Decrease a given social statistic field by $val. * - * @param $field String: field name in user_stats database table - * @param $val Integer: decrease $field by this amount, defaults to 1 + * @param string $field field name in user_stats database table + * @param int $val decrease $field by this amount, defaults to 1 */ function decStatField( $field, $val = 1 ) { global $wgUser, $wgUserStatsTrackWeekly, $wgUserStatsTrackMonthly; @@ -323,9 +323,9 @@ /** * Updates the comment scores for the current user. * - * @param $voteType Integer: if 1, sets the amount of positive comment - * scores, else sets the amount of negative - * comment scores + * @param int $voteType + * - if 1, sets the amount of positive comment scores + * - ..else sets the amount of negative comment scores */ function updateCommentScoreRec( $voteType ) { if ( $this->user_id != 0 ) { @@ -376,7 +376,7 @@ * This is called by UserRelationship::removeRelationshipByUserID(), which * in turn is called when removing friends or foes. * - * @param $relType Integer: 1 for updating friends + * @param int $relType 1 for updating friends */ function updateRelationshipCount( $relType ) { global $wgUser; diff --git a/UserSystemMessages/UserSystemMessagesClass.php b/UserSystemMessages/UserSystemMessagesClass.php index 72b05ee..9ab1a48 100644 --- a/UserSystemMessages/UserSystemMessagesClass.php +++ b/UserSystemMessages/UserSystemMessagesClass.php @@ -12,9 +12,9 @@ /** * Adds the message into the database * - * @param $userName Mixed: the name of the user who's receiving the message - * @param $type Integer: 0 by default - * @param $message Mixed: message to be sent out + * @param mixed $userName The name of the user who's receiving the message + * @param int $type 0 by default + * @param string $message Message to be sent out */ public function addMessage( $userName, $type = 0, $message ) { $userId = User::idFromName( $userName ); @@ -34,7 +34,8 @@ /** * Deletes a message from the user_system_messages table in the database - * @param $um_id Integer: internal ID number of the message to delete + * + * @param int $um_id Internal ID number of the message to delete */ static function deleteMessage( $um_id ) { $dbw = wfGetDB( DB_MASTER ); @@ -48,9 +49,9 @@ /** * Gets a list of system messages for the current user from the database * - * @param $type Integer: 0 by default - * @param $limit Integer: LIMIT for database queries, 0 by default - * @param $page Integer: 0 by default + * @param int $type 0 by default + * @param int $limit LIMIT for database queries, 0 by default + * @param int $page 0 by default * @return array */ public function getMessageList( $type, $limit = 0, $page = 0 ) { @@ -100,8 +101,8 @@ /** * Sends out the "you have advanced to level [fill in this]" messages to the users * - * @param $userIdTo Integer: user ID of the receiver - * @param $level Mixed: name of the level that the user advanced to + * @param int $userIdTo User ID of the receiver + * @param mixed $level Name of the level that the user advanced to */ public function sendAdvancementNotificationEmail( $userIdTo, $level ) { $user = User::newFromId( $userIdTo ); diff --git a/UserWelcome/UserWelcomeClass.php b/UserWelcome/UserWelcomeClass.php index e8d7fc4..dec45fa 100644 --- a/UserWelcome/UserWelcomeClass.php +++ b/UserWelcome/UserWelcomeClass.php @@ -16,7 +16,7 @@ * Register <welcomeUser /> tag with the parser * * @param Parser $parser - * @return bool + * @return bool true */ public static function onParserFirstCallInit( &$parser ) { $parser->setHook( 'welcomeUser', array( __CLASS__, 'getWelcomeUser' ) ); -- To view, visit https://gerrit.wikimedia.org/r/404231 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ibd169c0491a23d7ca1cc8c8452420ab2e5e853cc Gerrit-PatchSet: 4 Gerrit-Project: mediawiki/extensions/SocialProfile Gerrit-Branch: master Gerrit-Owner: SamanthaNguyen <samanthanguyen1...@gmail.com> Gerrit-Reviewer: Jack Phoenix <ash...@uncyclomedia.co> Gerrit-Reviewer: SamanthaNguyen <samanthanguyen1...@gmail.com> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
