| Index: trunk/phase3/includes/upload/UploadFromUrl.php |
| — | — | @@ -180,6 +180,7 @@ |
| 181 | 181 | /** |
| 182 | 182 | * Wrapper around the parent function in order to defer verifying the |
| 183 | 183 | * upload until the file really has been fetched. |
| | 184 | + * @return array|mixed |
| 184 | 185 | */ |
| 185 | 186 | public function verifyUpload() { |
| 186 | 187 | if ( $this->mAsync ) { |
| — | — | @@ -191,6 +192,7 @@ |
| 192 | 193 | /** |
| 193 | 194 | * Wrapper around the parent function in order to defer checking warnings |
| 194 | 195 | * until the file really has been fetched. |
| | 196 | + * @return Array |
| 195 | 197 | */ |
| 196 | 198 | public function checkWarnings() { |
| 197 | 199 | if ( $this->mAsync ) { |
| — | — | @@ -203,6 +205,7 @@ |
| 204 | 206 | /** |
| 205 | 207 | * Wrapper around the parent function in order to defer checking protection |
| 206 | 208 | * until we are sure that the file can actually be uploaded |
| | 209 | + * @return bool|mixed |
| 207 | 210 | */ |
| 208 | 211 | public function verifyTitlePermissions( $user ) { |
| 209 | 212 | if ( $this->mAsync ) { |
| — | — | @@ -214,6 +217,7 @@ |
| 215 | 218 | /** |
| 216 | 219 | * Wrapper around the parent function in order to defer uploading to the |
| 217 | 220 | * job queue for asynchronous uploads |
| | 221 | + * @return Status |
| 218 | 222 | */ |
| 219 | 223 | public function performUpload( $comment, $pageText, $watch, $user ) { |
| 220 | 224 | if ( $this->mAsync ) { |
| Index: trunk/phase3/includes/upload/UploadBase.php |
| — | — | @@ -64,6 +64,7 @@ |
| 65 | 65 | /** |
| 66 | 66 | * Returns true if uploads are enabled. |
| 67 | 67 | * Can be override by subclasses. |
| | 68 | + * @return bool |
| 68 | 69 | */ |
| 69 | 70 | public static function isEnabled() { |
| 70 | 71 | global $wgEnableUploads; |
| — | — | @@ -82,6 +83,7 @@ |
| 83 | 84 | * Can be overriden by subclasses. |
| 84 | 85 | * |
| 85 | 86 | * @param $user User |
| | 87 | + * @return bool |
| 86 | 88 | */ |
| 87 | 89 | public static function isAllowed( $user ) { |
| 88 | 90 | foreach ( array( 'upload', 'edit' ) as $permission ) { |
| — | — | @@ -100,6 +102,7 @@ |
| 101 | 103 | * |
| 102 | 104 | * @param $request WebRequest |
| 103 | 105 | * @param $type |
| | 106 | + * @return null |
| 104 | 107 | */ |
| 105 | 108 | public static function createFromRequest( &$request, $type = null ) { |
| 106 | 109 | $type = $type ? $type : $request->getVal( 'wpSourceType', 'File' ); |
| — | — | @@ -140,6 +143,7 @@ |
| 141 | 144 | |
| 142 | 145 | /** |
| 143 | 146 | * Check whether a request if valid for this handler |
| | 147 | + * @return bool |
| 144 | 148 | */ |
| 145 | 149 | public static function isValidRequest( $request ) { |
| 146 | 150 | return false; |
| — | — | @@ -180,6 +184,7 @@ |
| 181 | 185 | |
| 182 | 186 | /** |
| 183 | 187 | * Fetch the file. Usually a no-op |
| | 188 | + * @return Status |
| 184 | 189 | */ |
| 185 | 190 | public function fetchFile() { |
| 186 | 191 | return Status::newGood(); |
| — | — | @@ -984,6 +989,7 @@ |
| 985 | 990 | |
| 986 | 991 | /** |
| 987 | 992 | * @todo Replace this with a whitelist filter! |
| | 993 | + * @return bool |
| 988 | 994 | */ |
| 989 | 995 | public function checkSvgScriptCallback( $element, $attribs ) { |
| 990 | 996 | $stripped = $this->stripXmlNamespace( $element ); |
| — | — | @@ -1249,6 +1255,7 @@ |
| 1250 | 1256 | |
| 1251 | 1257 | /** |
| 1252 | 1258 | * Helper function that checks whether the filename looks like a thumbnail |
| | 1259 | + * @return bool |
| 1253 | 1260 | */ |
| 1254 | 1261 | public static function isThumbName( $filename ) { |
| 1255 | 1262 | $n = strrpos( $filename, '.' ); |
| Index: trunk/phase3/includes/upload/UploadFromChunks.php |
| — | — | @@ -129,6 +129,7 @@ |
| 130 | 130 | /** |
| 131 | 131 | * Returns the virtual chunk location: |
| 132 | 132 | * @param $index |
| | 133 | + * @return string |
| 133 | 134 | */ |
| 134 | 135 | function getVirtualChunkLocation( $index ){ |
| 135 | 136 | return $this->repo->getVirtualUrl( 'temp' ) . |
| — | — | @@ -241,6 +242,7 @@ |
| 242 | 243 | * Output the chunk to disk |
| 243 | 244 | * |
| 244 | 245 | * @param $chunkPath string |
| | 246 | + * @return \FileRepoStatus |
| 245 | 247 | */ |
| 246 | 248 | private function outputChunk( $chunkPath ){ |
| 247 | 249 | // Key is fileKey + chunk index |
| Index: trunk/phase3/includes/upload/UploadStash.php |
| — | — | @@ -391,6 +391,7 @@ |
| 392 | 392 | * with an extension. |
| 393 | 393 | * XXX this is somewhat redundant with the checks that ApiUpload.php does with incoming |
| 394 | 394 | * uploads versus the desired filename. Maybe we can get that passed to us... |
| | 395 | + * @return string |
| 395 | 396 | */ |
| 396 | 397 | public static function getExtensionForPath( $path ) { |
| 397 | 398 | // Does this have an extension? |
| Index: trunk/phase3/includes/upload/UploadFromFile.php |
| — | — | @@ -14,6 +14,7 @@ |
| 15 | 15 | |
| 16 | 16 | /** |
| 17 | 17 | * @param $request WebRequest |
| | 18 | + * @return null |
| 18 | 19 | */ |
| 19 | 20 | function initializeFromRequest( &$request ) { |
| 20 | 21 | $upload = $request->getUpload( 'wpUploadFile' ); |
| — | — | @@ -28,6 +29,7 @@ |
| 29 | 30 | * Initialize from a filename and a WebRequestUpload |
| 30 | 31 | * @param $name |
| 31 | 32 | * @param $webRequestUpload |
| | 33 | + * @return null |
| 32 | 34 | */ |
| 33 | 35 | function initialize( $name, $webRequestUpload ) { |
| 34 | 36 | $this->mUpload = $webRequestUpload; |
| Index: trunk/phase3/includes/Xml.php |
| — | — | @@ -40,6 +40,7 @@ |
| 41 | 41 | * The values are passed to Sanitizer::encodeAttribute. |
| 42 | 42 | * Return null if no attributes given. |
| 43 | 43 | * @param $attribs Array of attributes for an XML element |
| | 44 | + * @return null|string |
| 44 | 45 | */ |
| 45 | 46 | public static function expandAttributes( $attribs ) { |
| 46 | 47 | $out = ''; |
| Index: trunk/phase3/includes/SpecialPageFactory.php |
| — | — | @@ -276,6 +276,7 @@ |
| 277 | 277 | * Get the group that the special page belongs in on Special:SpecialPage |
| 278 | 278 | * |
| 279 | 279 | * @param $page SpecialPage |
| | 280 | + * @return String |
| 280 | 281 | */ |
| 281 | 282 | public static function getGroup( &$page ) { |
| 282 | 283 | $name = $page->getName(); |
| Index: trunk/phase3/includes/search/SearchEngine.php |
| — | — | @@ -65,6 +65,7 @@ |
| 66 | 66 | /** |
| 67 | 67 | * If this search backend can list/unlist redirects |
| 68 | 68 | * @deprecated since 1.18 Call supports( 'list-redirects' ); |
| | 69 | + * @return bool |
| 69 | 70 | */ |
| 70 | 71 | function acceptListRedirects() { |
| 71 | 72 | wfDeprecated( __METHOD__, '1.18' ); |
| — | — | @@ -147,6 +148,7 @@ |
| 148 | 149 | |
| 149 | 150 | /** |
| 150 | 151 | * Really find the title match. |
| | 152 | + * @return null|\Title |
| 151 | 153 | */ |
| 152 | 154 | private static function getNearMatchInternal( $searchterm ) { |
| 153 | 155 | global $wgContLang, $wgEnableSearchContributorsByIP; |
| — | — | @@ -287,6 +289,7 @@ |
| 288 | 290 | * or namespace names |
| 289 | 291 | * |
| 290 | 292 | * @param $query String |
| | 293 | + * @return string |
| 291 | 294 | */ |
| 292 | 295 | function replacePrefixes( $query ) { |
| 293 | 296 | global $wgContLang; |
| — | — | @@ -391,6 +394,7 @@ |
| 392 | 395 | * and preferences |
| 393 | 396 | * |
| 394 | 397 | * @param $namespaces Array |
| | 398 | + * @return array |
| 395 | 399 | */ |
| 396 | 400 | public static function namespacesAsText( $namespaces ) { |
| 397 | 401 | global $wgContLang; |
| — | — | @@ -1185,6 +1189,7 @@ |
| 1186 | 1190 | * Do manual case conversion for non-ascii chars |
| 1187 | 1191 | * |
| 1188 | 1192 | * @param $matches Array |
| | 1193 | + * @return string |
| 1189 | 1194 | */ |
| 1190 | 1195 | function caseCallback( $matches ) { |
| 1191 | 1196 | global $wgContLang; |
| — | — | @@ -1305,6 +1310,7 @@ |
| 1306 | 1311 | /** |
| 1307 | 1312 | * Basic wikitext removal |
| 1308 | 1313 | * @protected |
| | 1314 | + * @return mixed |
| 1309 | 1315 | */ |
| 1310 | 1316 | function removeWiki( $text ) { |
| 1311 | 1317 | $fname = __METHOD__; |
| Index: trunk/phase3/includes/search/SearchMySQL.php |
| — | — | @@ -308,6 +308,7 @@ |
| 309 | 309 | |
| 310 | 310 | /** |
| 311 | 311 | * @since 1.18 (changed) |
| | 312 | + * @return array |
| 312 | 313 | */ |
| 313 | 314 | function getCountQuery( $filteredTerm, $fulltext ) { |
| 314 | 315 | $match = $this->parseQuery( $filteredTerm, $fulltext ); |
| — | — | @@ -365,6 +366,7 @@ |
| 366 | 367 | /** |
| 367 | 368 | * Converts some characters for MySQL's indexing to grok it correctly, |
| 368 | 369 | * and pads short words to overcome limitations. |
| | 370 | + * @return mixed|string |
| 369 | 371 | */ |
| 370 | 372 | function normalizeText( $string ) { |
| 371 | 373 | global $wgContLang; |
| — | — | @@ -412,6 +414,7 @@ |
| 413 | 415 | * Armor a case-folded UTF-8 string to get through MySQL's |
| 414 | 416 | * fulltext search without being mucked up by funny charset |
| 415 | 417 | * settings or anything else of the sort. |
| | 418 | + * @return string |
| 416 | 419 | */ |
| 417 | 420 | protected function stripForSearchCallback( $matches ) { |
| 418 | 421 | return 'u8' . bin2hex( $matches[1] ); |
| Index: trunk/phase3/includes/search/SearchOracle.php |
| — | — | @@ -147,6 +147,7 @@ |
| 148 | 148 | * The guts shoulds be constructed in queryMain() |
| 149 | 149 | * @param $filteredTerm String |
| 150 | 150 | * @param $fulltext Boolean |
| | 151 | + * @return String |
| 151 | 152 | */ |
| 152 | 153 | function getQuery( $filteredTerm, $fulltext ) { |
| 153 | 154 | return $this->queryLimit($this->queryMain($filteredTerm, $fulltext) . ' ' . |
| — | — | @@ -184,6 +185,7 @@ |
| 185 | 186 | /** |
| 186 | 187 | * Parse a user input search string, and return an SQL fragment to be used |
| 187 | 188 | * as part of a WHERE clause |
| | 189 | + * @return string |
| 188 | 190 | */ |
| 189 | 191 | function parseQuery($filteredText, $fulltext) { |
| 190 | 192 | global $wgContLang; |
| Index: trunk/phase3/includes/search/SearchPostgres.php |
| — | — | @@ -146,6 +146,7 @@ |
| 147 | 147 | * @param $term String |
| 148 | 148 | * @param $fulltext String |
| 149 | 149 | * @param $colname |
| | 150 | + * @return string |
| 150 | 151 | */ |
| 151 | 152 | function searchQuery( $term, $fulltext, $colname ) { |
| 152 | 153 | # Get the SQL fragment for the given term |
| Index: trunk/phase3/includes/search/SearchIBM_DB2.php |
| — | — | @@ -111,6 +111,7 @@ |
| 112 | 112 | * The guts shoulds be constructed in queryMain() |
| 113 | 113 | * @param $filteredTerm String |
| 114 | 114 | * @param $fulltext Boolean |
| | 115 | + * @return String |
| 115 | 116 | */ |
| 116 | 117 | function getQuery( $filteredTerm, $fulltext ) { |
| 117 | 118 | return $this->queryLimit($this->queryMain($filteredTerm, $fulltext) . ' ' . |
| — | — | @@ -145,7 +146,9 @@ |
| 146 | 147 | 'WHERE page_id=si_page AND ' . $match; |
| 147 | 148 | } |
| 148 | 149 | |
| 149 | | - /** @todo document */ |
| | 150 | + /** @todo document |
| | 151 | + * @return string |
| | 152 | + */ |
| 150 | 153 | function parseQuery($filteredText, $fulltext) { |
| 151 | 154 | global $wgContLang; |
| 152 | 155 | $lc = SearchEngine::legalSearchChars(); |
| Index: trunk/phase3/includes/search/SearchMssql.php |
| — | — | @@ -115,6 +115,7 @@ |
| 116 | 116 | * |
| 117 | 117 | * @param $filteredTerm String |
| 118 | 118 | * @param $fulltext Boolean |
| | 119 | + * @return String |
| 119 | 120 | */ |
| 120 | 121 | function getQuery( $filteredTerm, $fulltext ) { |
| 121 | 122 | return $this->queryLimit( $this->queryMain( $filteredTerm, $fulltext ) . ' ' . |
| — | — | @@ -151,7 +152,9 @@ |
| 152 | 153 | 'WHERE page_id=ftindex.[KEY] '; |
| 153 | 154 | } |
| 154 | 155 | |
| 155 | | - /** @todo document */ |
| | 156 | + /** @todo document |
| | 157 | + * @return string |
| | 158 | + */ |
| 156 | 159 | function parseQuery( $filteredText, $fulltext ) { |
| 157 | 160 | global $wgContLang; |
| 158 | 161 | $lc = SearchEngine::legalSearchChars(); |
| — | — | @@ -189,6 +192,7 @@ |
| 190 | 193 | * @param $id Integer |
| 191 | 194 | * @param $title String |
| 192 | 195 | * @param $text String |
| | 196 | + * @return bool|\ResultWrapper |
| 193 | 197 | */ |
| 194 | 198 | function update( $id, $title, $text ) { |
| 195 | 199 | // We store the column data as UTF-8 byte order marked binary stream |
| — | — | @@ -211,6 +215,7 @@ |
| 212 | 216 | * |
| 213 | 217 | * @param $id Integer |
| 214 | 218 | * @param $title String |
| | 219 | + * @return bool|\ResultWrapper |
| 215 | 220 | */ |
| 216 | 221 | function updateTitle( $id, $title ) { |
| 217 | 222 | $table = $this->db->tableName( 'searchindex' ); |
| Index: trunk/phase3/includes/search/SearchSqlite.php |
| — | — | @@ -238,6 +238,7 @@ |
| 239 | 239 | * The guts shoulds be constructed in queryMain() |
| 240 | 240 | * @param $filteredTerm String |
| 241 | 241 | * @param $fulltext Boolean |
| | 242 | + * @return String |
| 242 | 243 | */ |
| 243 | 244 | function getQuery( $filteredTerm, $fulltext ) { |
| 244 | 245 | return $this->limitResult( |
| Index: trunk/phase3/includes/Status.php |
| — | — | @@ -28,6 +28,7 @@ |
| 29 | 29 | * Factory function for fatal errors |
| 30 | 30 | * |
| 31 | 31 | * @param $message String: message name |
| | 32 | + * @return Status |
| 32 | 33 | */ |
| 33 | 34 | static function newFatal( $message /*, parameters...*/ ) { |
| 34 | 35 | $params = func_get_args(); |
| — | — | @@ -41,6 +42,7 @@ |
| 42 | 43 | * Factory function for good results |
| 43 | 44 | * |
| 44 | 45 | * @param $value Mixed |
| | 46 | + * @return Status |
| 45 | 47 | */ |
| 46 | 48 | static function newGood( $value = null ) { |
| 47 | 49 | $result = new self; |
| Index: trunk/phase3/includes/WikiFilePage.php |
| — | — | @@ -148,6 +148,7 @@ |
| 149 | 149 | |
| 150 | 150 | /** |
| 151 | 151 | * Override handling of action=purge |
| | 152 | + * @return bool |
| 152 | 153 | */ |
| 153 | 154 | public function doPurge() { |
| 154 | 155 | $this->loadFile(); |
| Index: trunk/phase3/includes/StubObject.php |
| — | — | @@ -52,6 +52,7 @@ |
| 53 | 53 | * |
| 54 | 54 | * @param $name String: name of the function called |
| 55 | 55 | * @param $args Array: arguments |
| | 56 | + * @return mixed |
| 56 | 57 | */ |
| 57 | 58 | function _call( $name, $args ) { |
| 58 | 59 | $this->_unstub( $name, 5 ); |
| — | — | @@ -72,6 +73,7 @@ |
| 73 | 74 | * |
| 74 | 75 | * @param $name String: name of the function called |
| 75 | 76 | * @param $args Array: arguments |
| | 77 | + * @return mixed |
| 76 | 78 | */ |
| 77 | 79 | function __call( $name, $args ) { |
| 78 | 80 | return $this->_call( $name, $args ); |
| Index: trunk/phase3/includes/UserMailer.php |
| — | — | @@ -300,6 +300,7 @@ |
| 301 | 301 | /** |
| 302 | 302 | * Converts a string into quoted-printable format |
| 303 | 303 | * @since 1.17 |
| | 304 | + * @return string |
| 304 | 305 | */ |
| 305 | 306 | public static function quotedPrintable( $string, $charset = '' ) { |
| 306 | 307 | # Probably incomplete; see RFC 2045 |
| — | — | @@ -705,6 +706,7 @@ |
| 706 | 707 | /** |
| 707 | 708 | * Same as sendPersonalised but does impersonal mail suitable for bulk |
| 708 | 709 | * mailing. Takes an array of MailAddress objects. |
| | 710 | + * @return Status |
| 709 | 711 | */ |
| 710 | 712 | function sendImpersonal( $addresses ) { |
| 711 | 713 | global $wgContLang; |
| Index: trunk/phase3/includes/revisiondelete/RevisionDelete.php |
| — | — | @@ -191,6 +191,7 @@ |
| 192 | 192 | /** |
| 193 | 193 | * Get the HTML link to the revision text. |
| 194 | 194 | * Overridden by RevDel_ArchiveItem. |
| | 195 | + * @return string |
| 195 | 196 | */ |
| 196 | 197 | protected function getRevisionLink() { |
| 197 | 198 | $date = $this->list->getLanguage()->timeanddate( $this->revision->getTimestamp(), true ); |
| — | — | @@ -211,6 +212,7 @@ |
| 212 | 213 | /** |
| 213 | 214 | * Get the HTML link to the diff. |
| 214 | 215 | * Overridden by RevDel_ArchiveItem |
| | 216 | + * @return string |
| 215 | 217 | */ |
| 216 | 218 | protected function getDiffLink() { |
| 217 | 219 | if ( $this->isDeleted() && !$this->canViewContent() ) { |
| — | — | @@ -569,6 +571,7 @@ |
| 570 | 572 | /** |
| 571 | 573 | * Get the link to the file. |
| 572 | 574 | * Overridden by RevDel_ArchivedFileItem. |
| | 575 | + * @return string |
| 573 | 576 | */ |
| 574 | 577 | protected function getLink() { |
| 575 | 578 | $date = $this->list->getLanguage()->timeanddate( $this->file->getTimestamp(), true ); |
| Index: trunk/phase3/includes/revisiondelete/RevisionDeleteAbstracts.php |
| — | — | @@ -16,6 +16,7 @@ |
| 17 | 17 | * Get the DB field name associated with the ID list. |
| 18 | 18 | * This used to populate the log_search table for finding log entries. |
| 19 | 19 | * Override this function. |
| | 20 | + * @return null |
| 20 | 21 | */ |
| 21 | 22 | public static function getRelationType() { |
| 22 | 23 | return null; |
| — | — | @@ -189,6 +190,7 @@ |
| 190 | 191 | |
| 191 | 192 | /** |
| 192 | 193 | * Get the log action for this list type |
| | 194 | + * @return string |
| 193 | 195 | */ |
| 194 | 196 | public function getLogAction() { |
| 195 | 197 | return 'revision'; |
| — | — | @@ -247,6 +249,7 @@ |
| 248 | 250 | * Returns true if the item is "current", and the operation to set the given |
| 249 | 251 | * bits can't be executed for that reason |
| 250 | 252 | * STUB |
| | 253 | + * @return bool |
| 251 | 254 | */ |
| 252 | 255 | public function isHideCurrentOp( $newBits ) { |
| 253 | 256 | return false; |
| Index: trunk/phase3/includes/Revision.php |
| — | — | @@ -321,6 +321,7 @@ |
| 322 | 322 | /** |
| 323 | 323 | * Return the list of revision fields that should be selected to create |
| 324 | 324 | * a new revision. |
| | 325 | + * @return array |
| 325 | 326 | */ |
| 326 | 327 | public static function selectFields() { |
| 327 | 328 | return array( |
| — | — | @@ -342,6 +343,7 @@ |
| 343 | 344 | /** |
| 344 | 345 | * Return the list of text fields that should be selected to read the |
| 345 | 346 | * revision text |
| | 347 | + * @return array |
| 346 | 348 | */ |
| 347 | 349 | public static function selectTextFields() { |
| 348 | 350 | return array( |
| — | — | @@ -352,6 +354,7 @@ |
| 353 | 355 | |
| 354 | 356 | /** |
| 355 | 357 | * Return the list of page fields that should be selected from page table |
| | 358 | + * @return array |
| 356 | 359 | */ |
| 357 | 360 | public static function selectPageFields() { |
| 358 | 361 | return array( |
| — | — | @@ -364,6 +367,7 @@ |
| 365 | 368 | |
| 366 | 369 | /** |
| 367 | 370 | * Return the list of user fields that should be selected from user table |
| | 371 | + * @return array |
| 368 | 372 | */ |
| 369 | 373 | public static function selectUserFields() { |
| 370 | 374 | return array( 'user_name' ); |
| Index: trunk/phase3/includes/Title.php |
| — | — | @@ -863,6 +863,7 @@ |
| 864 | 864 | * This is MUCH simpler than individually testing for equivilance |
| 865 | 865 | * against both NS_USER and NS_USER_TALK, and is also forward compatible. |
| 866 | 866 | * @since 1.19 |
| | 867 | + * @return bool |
| 867 | 868 | */ |
| 868 | 869 | public function hasSubjectNamespace( $ns ) { |
| 869 | 870 | return MWNamespace::subjectEquals( $this->getNamespace(), $ns ); |
| — | — | @@ -1226,6 +1227,7 @@ |
| 1227 | 1228 | * andthe wfArrayToCGI moved to getLocalURL(); |
| 1228 | 1229 | * |
| 1229 | 1230 | * @since 1.19 (r105919) |
| | 1231 | + * @return String |
| 1230 | 1232 | */ |
| 1231 | 1233 | private static function fixUrlQueryArgs( $query, $query2 = false ) { |
| 1232 | 1234 | if( $query2 !== false ) { |
| — | — | @@ -1478,6 +1480,7 @@ |
| 1479 | 1481 | * |
| 1480 | 1482 | * @see self::getLocalURL |
| 1481 | 1483 | * @since 1.18 |
| | 1484 | + * @return string |
| 1482 | 1485 | */ |
| 1483 | 1486 | public function escapeCanonicalURL( $query = '', $query2 = false ) { |
| 1484 | 1487 | wfDeprecated( __METHOD__, '1.19' ); |
| Index: trunk/phase3/includes/SkinLegacy.php |
| — | — | @@ -84,6 +84,7 @@ |
| 85 | 85 | /** |
| 86 | 86 | * This will be called immediately after the <body> tag. Split into |
| 87 | 87 | * two functions to make it easier to subclass. |
| | 88 | + * @return string |
| 88 | 89 | */ |
| 89 | 90 | function beforeContent() { |
| 90 | 91 | return $this->doBeforeContent(); |
| — | — | @@ -152,7 +153,9 @@ |
| 153 | 154 | return $this->doAfterContent(); |
| 154 | 155 | } |
| 155 | 156 | |
| 156 | | - /** overloaded by derived classes */ |
| | 157 | + /** overloaded by derived classes |
| | 158 | + * @return string |
| | 159 | + */ |
| 157 | 160 | function doAfterContent() { |
| 158 | 161 | return '</div></div>'; |
| 159 | 162 | } |
| — | — | @@ -388,6 +391,7 @@ |
| 389 | 392 | |
| 390 | 393 | /** |
| 391 | 394 | * Show a drop-down box of special pages |
| | 395 | + * @return string |
| 392 | 396 | */ |
| 393 | 397 | function specialPagesList() { |
| 394 | 398 | global $wgScript; |
| — | — | @@ -530,6 +534,7 @@ |
| 531 | 535 | |
| 532 | 536 | /** |
| 533 | 537 | * @deprecated in 1.19 |
| | 538 | + * @return string |
| 534 | 539 | */ |
| 535 | 540 | function getQuickbarCompensator( $rows = 1 ) { |
| 536 | 541 | wfDeprecated( __METHOD__, '1.19' ); |
| Index: trunk/phase3/includes/SkinTemplate.php |
| — | — | @@ -513,6 +513,7 @@ |
| 514 | 514 | * This is setup as a method so that like with $wgLogo and getLogo() a skin |
| 515 | 515 | * can override this setting and always output one or the other if it has |
| 516 | 516 | * a reason it can't output one of the two modes. |
| | 517 | + * @return bool |
| 517 | 518 | */ |
| 518 | 519 | function useCombinedLoginLink() { |
| 519 | 520 | global $wgUseCombinedLoginLink; |
| — | — | @@ -1310,6 +1311,7 @@ |
| 1311 | 1312 | |
| 1312 | 1313 | /** |
| 1313 | 1314 | * @private |
| | 1315 | + * @return bool |
| 1314 | 1316 | */ |
| 1315 | 1317 | function haveData( $str ) { |
| 1316 | 1318 | return isset( $this->data[$str] ); |
| — | — | @@ -1369,6 +1371,7 @@ |
| 1370 | 1372 | * stored by SkinTemplate. |
| 1371 | 1373 | * The resulting array is built acording to a format intended to be passed |
| 1372 | 1374 | * through makeListItem to generate the html. |
| | 1375 | + * @return array |
| 1373 | 1376 | */ |
| 1374 | 1377 | function getToolbox() { |
| 1375 | 1378 | wfProfileIn( __METHOD__ ); |
| — | — | @@ -1429,6 +1432,7 @@ |
| 1430 | 1433 | * This is in reality the same list as already stored in personal_urls |
| 1431 | 1434 | * however it is reformatted so that you can just pass the individual items |
| 1432 | 1435 | * to makeListItem instead of hardcoding the element creation boilerplate. |
| | 1436 | + * @return array |
| 1433 | 1437 | */ |
| 1434 | 1438 | function getPersonalTools() { |
| 1435 | 1439 | $personal_tools = array(); |
| — | — | @@ -1602,6 +1606,7 @@ |
| 1603 | 1607 | * A link-fallback can be used to specify a tag to use instead of <a> if there is |
| 1604 | 1608 | * no link. eg: If you specify 'link-fallback' => 'span' than any non-link will |
| 1605 | 1609 | * output a <span> instead of just text. |
| | 1610 | + * @return string |
| 1606 | 1611 | */ |
| 1607 | 1612 | function makeLink( $key, $item, $options = array() ) { |
| 1608 | 1613 | if ( isset( $item['text'] ) ) { |
| — | — | @@ -1680,6 +1685,7 @@ |
| 1681 | 1686 | * If you need an id or class on a single link you should include a "links" |
| 1682 | 1687 | * array with just one link item inside of it. |
| 1683 | 1688 | * $options is also passed on to makeLink calls |
| | 1689 | + * @return string |
| 1684 | 1690 | */ |
| 1685 | 1691 | function makeListItem( $key, $item, $options = array() ) { |
| 1686 | 1692 | if ( isset( $item['links'] ) ) { |
| — | — | @@ -1774,6 +1780,7 @@ |
| 1775 | 1781 | * If you pass "flat" as an option then the returned array will be a flat array |
| 1776 | 1782 | * of footer icons instead of a key/value array of footerlinks arrays broken |
| 1777 | 1783 | * up into categories. |
| | 1784 | + * @return array|mixed |
| 1778 | 1785 | */ |
| 1779 | 1786 | function getFooterLinks( $option = null ) { |
| 1780 | 1787 | $footerlinks = $this->data['footerlinks']; |
| — | — | @@ -1812,6 +1819,7 @@ |
| 1813 | 1820 | * in the list of footer icons. This is mostly useful for skins which only |
| 1814 | 1821 | * display the text from footericons instead of the images and don't want a |
| 1815 | 1822 | * duplicate copyright statement because footerlinks already rendered one. |
| | 1823 | + * @return |
| 1816 | 1824 | */ |
| 1817 | 1825 | function getFooterIcons( $option = null ) { |
| 1818 | 1826 | // Generate additional footer icons |
| Index: trunk/phase3/includes/WikiPage.php |
| — | — | @@ -888,6 +888,7 @@ |
| 889 | 889 | |
| 890 | 890 | /** |
| 891 | 891 | * Perform the actions of a page purging |
| | 892 | + * @return bool |
| 892 | 893 | */ |
| 893 | 894 | public function doPurge() { |
| 894 | 895 | global $wgUseSquid; |
| — | — | @@ -1498,6 +1499,7 @@ |
| 1499 | 1500 | /** |
| 1500 | 1501 | * Prepare text which is about to be saved. |
| 1501 | 1502 | * Returns a stdclass with source, pst and output members |
| | 1503 | + * @return bool|object |
| 1502 | 1504 | */ |
| 1503 | 1505 | public function prepareTextForEdit( $text, $revid = null, User $user = null ) { |
| 1504 | 1506 | global $wgParser, $wgContLang, $wgUser; |
| — | — | @@ -2169,6 +2171,7 @@ |
| 2170 | 2172 | * |
| 2171 | 2173 | * @param $resultDetails Array: contains result-specific array of additional values |
| 2172 | 2174 | * @param $guser User The user performing the rollback |
| | 2175 | + * @return array |
| 2173 | 2176 | */ |
| 2174 | 2177 | public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User $guser ) { |
| 2175 | 2178 | global $wgUseRCPatrol, $wgContLang; |
| — | — | @@ -2793,6 +2796,7 @@ |
| 2794 | 2797 | |
| 2795 | 2798 | /** |
| 2796 | 2799 | * @deprecated since 1.18 |
| | 2800 | + * @return bool |
| 2797 | 2801 | */ |
| 2798 | 2802 | public function useParserCache( $oldid ) { |
| 2799 | 2803 | wfDeprecated( __METHOD__, '1.18' ); |
| — | — | @@ -2973,6 +2977,7 @@ |
| 2974 | 2978 | |
| 2975 | 2979 | /** |
| 2976 | 2980 | * @param $status Status |
| | 2981 | + * @return bool |
| 2977 | 2982 | */ |
| 2978 | 2983 | function error( $status ) { |
| 2979 | 2984 | $this->error = $status; |
| Index: trunk/phase3/includes/ZipDirectoryReader.php |
| — | — | @@ -426,6 +426,7 @@ |
| 427 | 427 | |
| 428 | 428 | /** |
| 429 | 429 | * Interpret ZIP64 "extra field" data and return an associative array. |
| | 430 | + * @return array|bool |
| 430 | 431 | */ |
| 431 | 432 | function unpackZip64Extra( $extraField ) { |
| 432 | 433 | $extraHeaderInfo = array( |
| — | — | @@ -520,6 +521,7 @@ |
| 521 | 522 | * If there are not enough bytes in the file to satsify the request, the |
| 522 | 523 | * return value will be truncated. If a request is made for a segment beyond |
| 523 | 524 | * the end of the file, an empty string will be returned. |
| | 525 | + * @return string |
| 524 | 526 | */ |
| 525 | 527 | function getSegment( $segIndex ) { |
| 526 | 528 | if ( !isset( $this->buffer[$segIndex] ) ) { |
| — | — | @@ -542,6 +544,7 @@ |
| 543 | 545 | |
| 544 | 546 | /** |
| 545 | 547 | * Get the size of a structure in bytes. See unpack() for the format of $struct. |
| | 548 | + * @return int |
| 546 | 549 | */ |
| 547 | 550 | function getStructSize( $struct ) { |
| 548 | 551 | $size = 0; |
| Index: trunk/phase3/includes/specials/SpecialAllpages.php |
| — | — | @@ -95,6 +95,7 @@ |
| 96 | 96 | * @param $namespace Integer: a namespace constant (default NS_MAIN). |
| 97 | 97 | * @param $from String: dbKey we are starting listing at. |
| 98 | 98 | * @param $to String: dbKey we are ending listing at. |
| | 99 | + * @return string |
| 99 | 100 | */ |
| 100 | 101 | function namespaceForm( $namespace = NS_MAIN, $from = '', $to = '' ) { |
| 101 | 102 | global $wgScript; |
| — | — | @@ -270,6 +271,7 @@ |
| 271 | 272 | * @param $inpoint String: lower limit of pagenames |
| 272 | 273 | * @param $outpoint String: upper limit of pagenames |
| 273 | 274 | * @param $namespace Integer (Default NS_MAIN) |
| | 275 | + * @return string |
| 274 | 276 | */ |
| 275 | 277 | function showline( $inpoint, $outpoint, $namespace = NS_MAIN ) { |
| 276 | 278 | global $wgContLang; |
| Index: trunk/phase3/includes/specials/SpecialUnblock.php |
| — | — | @@ -136,6 +136,7 @@ |
| 137 | 137 | |
| 138 | 138 | /** |
| 139 | 139 | * Submit callback for an HTMLForm object |
| | 140 | + * @return \Array( Array(message key, parameters) |
| 140 | 141 | */ |
| 141 | 142 | public static function processUIUnblock( array $data, HTMLForm $form ) { |
| 142 | 143 | return self::processUnblock( $data, $form->getContext() ); |
| Index: trunk/phase3/includes/specials/SpecialFewestrevisions.php |
| — | — | @@ -68,6 +68,7 @@ |
| 69 | 69 | /** |
| 70 | 70 | * @param $skin Skin object |
| 71 | 71 | * @param $result Object: database row |
| | 72 | + * @return String |
| 72 | 73 | */ |
| 73 | 74 | function formatResult( $skin, $result ) { |
| 74 | 75 | global $wgContLang; |
| Index: trunk/phase3/includes/specials/SpecialAllmessages.php |
| — | — | @@ -290,6 +290,7 @@ |
| 291 | 291 | /** |
| 292 | 292 | * This function normally does a database query to get the results; we need |
| 293 | 293 | * to make a pretend result using a FakeResultWrapper. |
| | 294 | + * @return \FakeResultWrapper |
| 294 | 295 | */ |
| 295 | 296 | function reallyDoQuery( $offset, $limit, $descending ) { |
| 296 | 297 | $result = new FakeResultWrapper( array() ); |
| Index: trunk/phase3/includes/specials/SpecialExport.php |
| — | — | @@ -510,6 +510,7 @@ |
| 511 | 511 | |
| 512 | 512 | /** |
| 513 | 513 | * Expand a list of pages to include items used in those pages. |
| | 514 | + * @return array |
| 514 | 515 | */ |
| 515 | 516 | private function getLinks( $inputPages, $pageSet, $table, $fields, $join ) { |
| 516 | 517 | $dbr = wfGetDB( DB_SLAVE ); |
| Index: trunk/phase3/includes/specials/SpecialWantedfiles.php |
| — | — | @@ -66,6 +66,7 @@ |
| 67 | 67 | * that exist e.g. in a shared repo. Setting this at least |
| 68 | 68 | * keeps them from showing up as redlinks in the output, even |
| 69 | 69 | * if it doesn't fix the real problem (bug 6220). |
| | 70 | + * @return bool |
| 70 | 71 | */ |
| 71 | 72 | function forceExistenceCheck() { |
| 72 | 73 | return true; |
| Index: trunk/phase3/includes/specials/SpecialUserlogin.php |
| — | — | @@ -209,6 +209,7 @@ |
| 210 | 210 | |
| 211 | 211 | /** |
| 212 | 212 | * @private |
| | 213 | + * @return bool|void |
| 213 | 214 | */ |
| 214 | 215 | function addNewAccount() { |
| 215 | 216 | global $wgUser, $wgEmailAuthentication, $wgLoginLanguageSelector; |
| — | — | @@ -270,6 +271,7 @@ |
| 271 | 272 | |
| 272 | 273 | /** |
| 273 | 274 | * @private |
| | 275 | + * @return bool|\User |
| 274 | 276 | */ |
| 275 | 277 | function addNewAccountInternal() { |
| 276 | 278 | global $wgAuth, $wgMemc, $wgAccountCreationThrottle, |
| — | — | @@ -470,6 +472,7 @@ |
| 471 | 473 | * This may create a local account as a side effect if the |
| 472 | 474 | * authentication plugin allows transparent local account |
| 473 | 475 | * creation. |
| | 476 | + * @return int |
| 474 | 477 | */ |
| 475 | 478 | public function authenticateUserData() { |
| 476 | 479 | global $wgUser, $wgAuth; |
| — | — | @@ -1117,6 +1120,7 @@ |
| 1118 | 1121 | * previous pass through the system. |
| 1119 | 1122 | * |
| 1120 | 1123 | * @private |
| | 1124 | + * @return bool |
| 1121 | 1125 | */ |
| 1122 | 1126 | function hasSessionCookie() { |
| 1123 | 1127 | global $wgDisableCookieCheck; |
| — | — | @@ -1125,6 +1129,7 @@ |
| 1126 | 1130 | |
| 1127 | 1131 | /** |
| 1128 | 1132 | * Get the login token from the current session |
| | 1133 | + * @return Mixed |
| 1129 | 1134 | */ |
| 1130 | 1135 | public static function getLoginToken() { |
| 1131 | 1136 | global $wgRequest; |
| — | — | @@ -1151,6 +1156,7 @@ |
| 1152 | 1157 | |
| 1153 | 1158 | /** |
| 1154 | 1159 | * Get the createaccount token from the current session |
| | 1160 | + * @return Mixed |
| 1155 | 1161 | */ |
| 1156 | 1162 | public static function getCreateaccountToken() { |
| 1157 | 1163 | global $wgRequest; |
| — | — | @@ -1175,6 +1181,7 @@ |
| 1176 | 1182 | |
| 1177 | 1183 | /** |
| 1178 | 1184 | * @private |
| | 1185 | + * @return void |
| 1179 | 1186 | */ |
| 1180 | 1187 | function cookieRedirectCheck( $type ) { |
| 1181 | 1188 | $titleObj = SpecialPage::getTitleFor( 'Userlogin' ); |
| — | — | @@ -1243,6 +1250,7 @@ |
| 1244 | 1251 | * |
| 1245 | 1252 | * @param $text Link text |
| 1246 | 1253 | * @param $lang Language code |
| | 1254 | + * @return string |
| 1247 | 1255 | */ |
| 1248 | 1256 | function makeLanguageSelectorLink( $text, $lang ) { |
| 1249 | 1257 | $attr = array( 'uselang' => $lang ); |
| Index: trunk/phase3/includes/specials/SpecialRecentchanges.php |
| — | — | @@ -534,6 +534,7 @@ |
| 535 | 535 | /** |
| 536 | 536 | * Get the query string to append to feed link URLs. |
| 537 | 537 | * This is overridden by RCL to add the target parameter |
| | 538 | + * @return bool |
| 538 | 539 | */ |
| 539 | 540 | public function getFeedQuery() { |
| 540 | 541 | return false; |
| — | — | @@ -760,6 +761,7 @@ |
| 761 | 762 | * @param $override Array: options to override |
| 762 | 763 | * @param $options Array: current options |
| 763 | 764 | * @param $active Boolean: whether to show the link in bold |
| | 765 | + * @return string |
| 764 | 766 | */ |
| 765 | 767 | function makeOptionsLink( $title, $override, $options, $active = false ) { |
| 766 | 768 | $params = $override + $options; |
| — | — | @@ -775,6 +777,7 @@ |
| 776 | 778 | * |
| 777 | 779 | * @param $defaults Array |
| 778 | 780 | * @param $nondefaults Array |
| | 781 | + * @return string |
| 779 | 782 | */ |
| 780 | 783 | function optionsPanel( $defaults, $nondefaults ) { |
| 781 | 784 | global $wgRCLinkLimits, $wgRCLinkDays; |
| Index: trunk/phase3/includes/specials/SpecialProtectedtitles.php |
| — | — | @@ -112,6 +112,7 @@ |
| 113 | 113 | * @param $namespace Integer: |
| 114 | 114 | * @param $type string |
| 115 | 115 | * @param $level string |
| | 116 | + * @return string |
| 116 | 117 | * @private |
| 117 | 118 | */ |
| 118 | 119 | function showOptions( $namespace, $type='edit', $level ) { |
| Index: trunk/phase3/includes/specials/SpecialRevisiondelete.php |
| — | — | @@ -251,6 +251,7 @@ |
| 252 | 252 | |
| 253 | 253 | /** |
| 254 | 254 | * Get the condition used for fetching log snippets |
| | 255 | + * @return array |
| 255 | 256 | */ |
| 256 | 257 | protected function getLogQueryCond() { |
| 257 | 258 | $conds = array(); |
| — | — | @@ -497,6 +498,7 @@ |
| 498 | 499 | |
| 499 | 500 | /** |
| 500 | 501 | * UI entry point for form submission. |
| | 502 | + * @return bool |
| 501 | 503 | */ |
| 502 | 504 | protected function submit() { |
| 503 | 505 | # Check edit token on submission |
| — | — | @@ -592,6 +594,7 @@ |
| 593 | 595 | |
| 594 | 596 | /** |
| 595 | 597 | * Do the write operations. Simple wrapper for RevDel_*List::setVisibility(). |
| | 598 | + * @return |
| 596 | 599 | */ |
| 597 | 600 | protected function save( $bitfield, $reason, $title ) { |
| 598 | 601 | return $this->getList()->setVisibility( |
| Index: trunk/phase3/includes/specials/SpecialPrefixindex.php |
| — | — | @@ -83,7 +83,8 @@ |
| 84 | 84 | * HTML for the top form |
| 85 | 85 | * @param $namespace Integer: a namespace constant (default NS_MAIN). |
| 86 | 86 | * @param $from String: dbKey we are starting listing at. |
| 87 | | - */ |
| | 87 | + * @return string |
| | 88 | + */ |
| 88 | 89 | function namespacePrefixForm( $namespace = NS_MAIN, $from = '' ) { |
| 89 | 90 | global $wgScript; |
| 90 | 91 | |
| Index: trunk/phase3/includes/specials/SpecialUploadStash.php |
| — | — | @@ -58,6 +58,7 @@ |
| 59 | 59 | * n.b. Most sanity checking done in UploadStashLocalFile, so this is straightforward. |
| 60 | 60 | * |
| 61 | 61 | * @param $key String: the key of a particular requested file |
| | 62 | + * @return bool |
| 62 | 63 | */ |
| 63 | 64 | public function showUpload( $key ) { |
| 64 | 65 | // prevent callers from doing standard HTML output -- we'll take it from here |
| — | — | @@ -241,6 +242,7 @@ |
| 242 | 243 | * Side effect: writes HTTP response to STDOUT. |
| 243 | 244 | * |
| 244 | 245 | * @param $file File object with a local path (e.g. UnregisteredLocalFile, LocalFile. Oddly these don't share an ancestor!) |
| | 246 | + * @return bool |
| 245 | 247 | */ |
| 246 | 248 | private function outputLocalFile( File $file ) { |
| 247 | 249 | if ( $file->getSize() > self::MAX_SERVE_BYTES ) { |
| — | — | @@ -257,6 +259,7 @@ |
| 258 | 260 | * Side effect: writes HTTP response to STDOUT. |
| 259 | 261 | * @param String $content: content |
| 260 | 262 | * @param String $mimeType: mime type |
| | 263 | + * @return bool |
| 261 | 264 | */ |
| 262 | 265 | private function outputContents( $content, $contentType ) { |
| 263 | 266 | $size = strlen( $content ); |
| — | — | @@ -304,6 +307,7 @@ |
| 305 | 308 | * Default action when we don't have a subpage -- just show links to the uploads we have, |
| 306 | 309 | * Also show a button to clear stashed files |
| 307 | 310 | * @param Status : $status - the result of processRequest |
| | 311 | + * @return bool |
| 308 | 312 | */ |
| 309 | 313 | private function showUploads( $status = null ) { |
| 310 | 314 | if ( $status === null ) { |
| Index: trunk/phase3/includes/specials/SpecialContributions.php |
| — | — | @@ -698,6 +698,7 @@ |
| 699 | 699 | |
| 700 | 700 | /** |
| 701 | 701 | * Do a batched query to get the parent revision lengths |
| | 702 | + * @return array |
| 702 | 703 | */ |
| 703 | 704 | private function getParentLengths( array $revIds ) { |
| 704 | 705 | $revLens = array(); |
| — | — | @@ -739,6 +740,7 @@ |
| 740 | 741 | * was not written by the target user. |
| 741 | 742 | * |
| 742 | 743 | * @todo This would probably look a lot nicer in a table. |
| | 744 | + * @return string |
| 743 | 745 | */ |
| 744 | 746 | function formatRow( $row ) { |
| 745 | 747 | wfProfileIn( __METHOD__ ); |
| — | — | @@ -871,6 +873,7 @@ |
| 872 | 874 | |
| 873 | 875 | /** |
| 874 | 876 | * Overwrite Pager function and return a helpful comment |
| | 877 | + * @return string |
| 875 | 878 | */ |
| 876 | 879 | function getSqlComment() { |
| 877 | 880 | if ( $this->namespace || $this->deletedOnly ) { |
| Index: trunk/phase3/includes/specials/SpecialJavaScriptTest.php |
| — | — | @@ -97,6 +97,7 @@ |
| 98 | 98 | * be thrown. |
| 99 | 99 | * @param $html String: The raw HTML. |
| 100 | 100 | * @param $state String: State, one of 'noframework', 'unknownframework' or 'frameworkfound' |
| | 101 | + * @return string |
| 101 | 102 | */ |
| 102 | 103 | private function wrapSummaryHtml( $html, $state ) { |
| 103 | 104 | $validStates = array( 'noframework', 'unknownframework', 'frameworkfound' ); |
| Index: trunk/phase3/includes/specials/SpecialUnusedcategories.php |
| — | — | @@ -52,6 +52,7 @@ |
| 53 | 53 | |
| 54 | 54 | /** |
| 55 | 55 | * A should come before Z (bug 30907) |
| | 56 | + * @return bool |
| 56 | 57 | */ |
| 57 | 58 | function sortDescending() { |
| 58 | 59 | return false; |
| Index: trunk/phase3/includes/specials/SpecialVersion.php |
| — | — | @@ -356,6 +356,7 @@ |
| 357 | 357 | |
| 358 | 358 | /** |
| 359 | 359 | * Callback to sort extensions by type. |
| | 360 | + * @return int |
| 360 | 361 | */ |
| 361 | 362 | function compare( $a, $b ) { |
| 362 | 363 | if( $a['name'] === $b['name'] ) { |
| — | — | @@ -589,6 +590,7 @@ |
| 590 | 591 | * url The subversion URL of the directory |
| 591 | 592 | * repo-url The base URL of the repository |
| 592 | 593 | * viewvc-url A ViewVC URL pointing to the checked-out revision |
| | 594 | + * @return array|bool |
| 593 | 595 | */ |
| 594 | 596 | public static function getSvnInfo( $dir ) { |
| 595 | 597 | // http://svnbook.red-bean.com/nightly/en/svn.developer.insidewc.html |
| Index: trunk/phase3/includes/specials/SpecialDeletedContributions.php |
| — | — | @@ -130,6 +130,7 @@ |
| 131 | 131 | * written by the target user. |
| 132 | 132 | * |
| 133 | 133 | * @todo This would probably look a lot nicer in a table. |
| | 134 | + * @return string |
| 134 | 135 | */ |
| 135 | 136 | function formatRow( $row ) { |
| 136 | 137 | wfProfileIn( __METHOD__ ); |
| — | — | @@ -449,6 +450,7 @@ |
| 450 | 451 | /** |
| 451 | 452 | * Generates the namespace selector form with hidden attributes. |
| 452 | 453 | * @param $options Array: the options to be included. |
| | 454 | + * @return string |
| 453 | 455 | */ |
| 454 | 456 | function getForm( $options ) { |
| 455 | 457 | global $wgScript; |
| Index: trunk/phase3/includes/specials/SpecialBlock.php |
| — | — | @@ -297,6 +297,7 @@ |
| 298 | 298 | |
| 299 | 299 | /** |
| 300 | 300 | * Add header elements like block log entries, etc. |
| | 301 | + * @return String |
| 301 | 302 | */ |
| 302 | 303 | protected function preText(){ |
| 303 | 304 | $text = $this->msg( 'blockiptext' )->parse(); |
| Index: trunk/phase3/includes/specials/SpecialBooksources.php |
| — | — | @@ -64,6 +64,7 @@ |
| 65 | 65 | /** |
| 66 | 66 | * Returns whether a given ISBN (10 or 13) is valid. True indicates validity. |
| 67 | 67 | * @param isbn string ISBN passed for check |
| | 68 | + * @return bool |
| 68 | 69 | */ |
| 69 | 70 | public static function isValidISBN( $isbn ) { |
| 70 | 71 | $isbn = self::cleanIsbn( $isbn ); |
| Index: trunk/phase3/includes/specials/SpecialLinkSearch.php |
| — | — | @@ -112,6 +112,7 @@ |
| 113 | 113 | |
| 114 | 114 | /** |
| 115 | 115 | * Disable RSS/Atom feeds |
| | 116 | + * @return bool |
| 116 | 117 | */ |
| 117 | 118 | function isSyndicated() { |
| 118 | 119 | return false; |
| — | — | @@ -203,6 +204,7 @@ |
| 204 | 205 | * We do a truncated index search, so the optimizer won't trust |
| 205 | 206 | * it as good enough for optimizing sort. The implicit ordering |
| 206 | 207 | * from the scan will usually do well enough for our needs. |
| | 208 | + * @return array |
| 207 | 209 | */ |
| 208 | 210 | function getOrderFields() { |
| 209 | 211 | return array(); |
| Index: trunk/phase3/includes/RevisionList.php |
| — | — | @@ -31,6 +31,7 @@ |
| 32 | 32 | /** |
| 33 | 33 | * Get the internal type name of this list. Equal to the table name. |
| 34 | 34 | * Override this function. |
| | 35 | + * @return null |
| 35 | 36 | */ |
| 36 | 37 | public function getType() { |
| 37 | 38 | return null; |
| — | — | @@ -80,6 +81,7 @@ |
| 81 | 82 | |
| 82 | 83 | /** |
| 83 | 84 | * Get the number of items in the list. |
| | 85 | + * @return int |
| 84 | 86 | */ |
| 85 | 87 | public function length() { |
| 86 | 88 | if( !$this->res ) { |
| — | — | @@ -124,6 +126,7 @@ |
| 125 | 127 | /** |
| 126 | 128 | * Get the DB field name associated with the ID list. |
| 127 | 129 | * Override this function. |
| | 130 | + * @return null |
| 128 | 131 | */ |
| 129 | 132 | public function getIdField() { |
| 130 | 133 | return null; |
| — | — | @@ -132,6 +135,7 @@ |
| 133 | 136 | /** |
| 134 | 137 | * Get the DB field name storing timestamps. |
| 135 | 138 | * Override this function. |
| | 139 | + * @return bool |
| 136 | 140 | */ |
| 137 | 141 | public function getTimestampField() { |
| 138 | 142 | return false; |
| — | — | @@ -140,6 +144,7 @@ |
| 141 | 145 | /** |
| 142 | 146 | * Get the DB field name storing user ids. |
| 143 | 147 | * Override this function. |
| | 148 | + * @return bool |
| 144 | 149 | */ |
| 145 | 150 | public function getAuthorIdField() { |
| 146 | 151 | return false; |
| — | — | @@ -148,6 +153,7 @@ |
| 149 | 154 | /** |
| 150 | 155 | * Get the DB field name storing user names. |
| 151 | 156 | * Override this function. |
| | 157 | + * @return bool |
| 152 | 158 | */ |
| 153 | 159 | public function getAuthorNameField() { |
| 154 | 160 | return false; |
| — | — | @@ -155,6 +161,7 @@ |
| 156 | 162 | |
| 157 | 163 | /** |
| 158 | 164 | * Get the ID, as it would appear in the ids URL parameter |
| | 165 | + * @return |
| 159 | 166 | */ |
| 160 | 167 | public function getId() { |
| 161 | 168 | $field = $this->getIdField(); |
| — | — | @@ -163,6 +170,7 @@ |
| 164 | 171 | |
| 165 | 172 | /** |
| 166 | 173 | * Get the date, formatted in user's languae |
| | 174 | + * @return String |
| 167 | 175 | */ |
| 168 | 176 | public function formatDate() { |
| 169 | 177 | return $this->list->getLanguage()->userDate( $this->getTimestamp(), |
| — | — | @@ -171,6 +179,7 @@ |
| 172 | 180 | |
| 173 | 181 | /** |
| 174 | 182 | * Get the time, formatted in user's languae |
| | 183 | + * @return String |
| 175 | 184 | */ |
| 176 | 185 | public function formatTime() { |
| 177 | 186 | return $this->list->getLanguage()->userTime( $this->getTimestamp(), |
| — | — | @@ -179,6 +188,7 @@ |
| 180 | 189 | |
| 181 | 190 | /** |
| 182 | 191 | * Get the timestamp in MW 14-char form |
| | 192 | + * @return Mixed |
| 183 | 193 | */ |
| 184 | 194 | public function getTimestamp() { |
| 185 | 195 | $field = $this->getTimestampField(); |
| — | — | @@ -187,6 +197,7 @@ |
| 188 | 198 | |
| 189 | 199 | /** |
| 190 | 200 | * Get the author user ID |
| | 201 | + * @return int |
| 191 | 202 | */ |
| 192 | 203 | public function getAuthorId() { |
| 193 | 204 | $field = $this->getAuthorIdField(); |
| — | — | @@ -195,6 +206,7 @@ |
| 196 | 207 | |
| 197 | 208 | /** |
| 198 | 209 | * Get the author user name |
| | 210 | + * @return string |
| 199 | 211 | */ |
| 200 | 212 | public function getAuthorName() { |
| 201 | 213 | $field = $this->getAuthorNameField(); |
| — | — | @@ -292,6 +304,7 @@ |
| 293 | 305 | /** |
| 294 | 306 | * Get the HTML link to the revision text. |
| 295 | 307 | * Overridden by RevDel_ArchiveItem. |
| | 308 | + * @return string |
| 296 | 309 | */ |
| 297 | 310 | protected function getRevisionLink() { |
| 298 | 311 | $date = $this->list->getLanguage()->timeanddate( $this->revision->getTimestamp(), true ); |
| — | — | @@ -312,6 +325,7 @@ |
| 313 | 326 | /** |
| 314 | 327 | * Get the HTML link to the diff. |
| 315 | 328 | * Overridden by RevDel_ArchiveItem |
| | 329 | + * @return string |
| 316 | 330 | */ |
| 317 | 331 | protected function getDiffLink() { |
| 318 | 332 | if ( $this->isDeleted() && !$this->canViewContent() ) { |
| Index: trunk/phase3/includes/UserRightsProxy.php |
| — | — | @@ -163,6 +163,7 @@ |
| 164 | 164 | |
| 165 | 165 | /** |
| 166 | 166 | * Replaces User::getUserGroups() |
| | 167 | + * @return array |
| 167 | 168 | */ |
| 168 | 169 | function getGroups() { |
| 169 | 170 | $res = $this->db->select( 'user_groups', |
| Index: trunk/phase3/includes/QueryPage.php |
| — | — | @@ -259,6 +259,7 @@ |
| 260 | 260 | * Setting this to return true will ensure formatResult() is called |
| 261 | 261 | * one more time to make sure that the very last result is formatted |
| 262 | 262 | * as well. |
| | 263 | + * @return bool |
| 263 | 264 | */ |
| 264 | 265 | function tryLastResult() { |
| 265 | 266 | return false; |
| — | — | @@ -269,6 +270,7 @@ |
| 270 | 271 | * |
| 271 | 272 | * @param $limit Integer: limit for SQL statement |
| 272 | 273 | * @param $ignoreErrors Boolean: whether to ignore database errors |
| | 274 | + * @return bool|int |
| 273 | 275 | */ |
| 274 | 276 | function recache( $limit, $ignoreErrors = true ) { |
| 275 | 277 | if ( !$this->isCacheable() ) { |
| — | — | @@ -382,6 +384,7 @@ |
| 383 | 385 | |
| 384 | 386 | /** |
| 385 | 387 | * Somewhat deprecated, you probably want to be using execute() |
| | 388 | + * @return \ResultWrapper |
| 386 | 389 | */ |
| 387 | 390 | function doQuery( $offset = false, $limit = false ) { |
| 388 | 391 | if ( $this->isCached() && $this->isCacheable() ) { |
| — | — | @@ -435,6 +438,7 @@ |
| 436 | 439 | /** |
| 437 | 440 | * This is the actual workhorse. It does everything needed to make a |
| 438 | 441 | * real, honest-to-gosh query page. |
| | 442 | + * @return int |
| 439 | 443 | */ |
| 440 | 444 | function execute( $par ) { |
| 441 | 445 | global $wgQueryCacheLimit, $wgDisableQueryPageUpdate; |
| — | — | @@ -621,6 +625,7 @@ |
| 622 | 626 | |
| 623 | 627 | /** |
| 624 | 628 | * Similar to above, but packaging in a syndicated feed instead of a web page |
| | 629 | + * @return bool |
| 625 | 630 | */ |
| 626 | 631 | function doFeed( $class = '', $limit = 50 ) { |
| 627 | 632 | global $wgFeed, $wgFeedClasses; |
| — | — | @@ -660,6 +665,7 @@ |
| 661 | 666 | /** |
| 662 | 667 | * Override for custom handling. If the titles/links are ok, just do |
| 663 | 668 | * feedItemDesc() |
| | 669 | + * @return FeedItem|null |
| 664 | 670 | */ |
| 665 | 671 | function feedResult( $row ) { |
| 666 | 672 | if ( !isset( $row->title ) ) { |
| — | — | @@ -745,6 +751,7 @@ |
| 746 | 752 | * kluge for Special:WantedFiles, which may contain false |
| 747 | 753 | * positives for files that exist e.g. in a shared repo (bug |
| 748 | 754 | * 6220). |
| | 755 | + * @return bool |
| 749 | 756 | */ |
| 750 | 757 | function forceExistenceCheck() { |
| 751 | 758 | return false; |
| Index: trunk/phase3/includes/Skin.php |
| — | — | @@ -1540,6 +1540,7 @@ |
| 1541 | 1541 | * |
| 1542 | 1542 | * @param $fname String Name of called method |
| 1543 | 1543 | * @param $args Array Arguments to the method |
| | 1544 | + * @return mixed |
| 1544 | 1545 | */ |
| 1545 | 1546 | function __call( $fname, $args ) { |
| 1546 | 1547 | $realFunction = array( 'Linker', $fname ); |