| Index: trunk/phase3/includes/ImageQueryPage.php |
| — | — | @@ -13,12 +13,12 @@ |
| 14 | 14 | * Format and output report results using the given information plus |
| 15 | 15 | * OutputPage |
| 16 | 16 | * |
| 17 | | - * @param OutputPage $out OutputPage to print to |
| 18 | | - * @param Skin $skin User skin to use |
| 19 | | - * @param Database $dbr Database (read) connection to use |
| 20 | | - * @param int $res Result pointer |
| 21 | | - * @param int $num Number of available result rows |
| 22 | | - * @param int $offset Paging offset |
| | 17 | + * @param $out OutputPage to print to |
| | 18 | + * @param $skin Skin: user skin to use |
| | 19 | + * @param $dbr Database (read) connection to use |
| | 20 | + * @param $res Integer: result pointer |
| | 21 | + * @param $num Integer: number of available result rows |
| | 22 | + * @param $offset Integer: paging offset |
| 23 | 23 | */ |
| 24 | 24 | protected function outputResults( $out, $skin, $dbr, $res, $num, $offset ) { |
| 25 | 25 | if( $num > 0 ) { |
| — | — | @@ -41,7 +41,7 @@ |
| 42 | 42 | /** |
| 43 | 43 | * Prepare an image object given a result row |
| 44 | 44 | * |
| 45 | | - * @param object $row Result row |
| | 45 | + * @param $row Object: result row |
| 46 | 46 | * @return Image |
| 47 | 47 | */ |
| 48 | 48 | private function prepareImage( $row ) { |
| — | — | @@ -55,8 +55,8 @@ |
| 56 | 56 | /** |
| 57 | 57 | * Get additional HTML to be shown in a results' cell |
| 58 | 58 | * |
| 59 | | - * @param object $row Result row |
| 60 | | - * @return string |
| | 59 | + * @param $row Object: result row |
| | 60 | + * @return String |
| 61 | 61 | */ |
| 62 | 62 | protected function getCellHtml( $row ) { |
| 63 | 63 | return ''; |
| Index: trunk/phase3/includes/QueryPage.php |
| — | — | @@ -22,36 +22,36 @@ |
| 23 | 23 | array( 'DisambiguationsPage', 'Disambiguations' ), |
| 24 | 24 | array( 'DoubleRedirectsPage', 'DoubleRedirects' ), |
| 25 | 25 | array( 'LinkSearchPage', 'LinkSearch' ), |
| 26 | | - array( 'ListredirectsPage', 'Listredirects' ), |
| | 26 | + array( 'ListredirectsPage', 'Listredirects' ), |
| 27 | 27 | array( 'LonelyPagesPage', 'Lonelypages' ), |
| 28 | 28 | array( 'LongPagesPage', 'Longpages' ), |
| 29 | 29 | array( 'MostcategoriesPage', 'Mostcategories' ), |
| 30 | 30 | array( 'MostimagesPage', 'Mostimages' ), |
| 31 | 31 | array( 'MostlinkedCategoriesPage', 'Mostlinkedcategories' ), |
| 32 | | - array( 'SpecialMostlinkedtemplates', 'Mostlinkedtemplates' ), |
| | 32 | + array( 'SpecialMostlinkedtemplates', 'Mostlinkedtemplates' ), |
| 33 | 33 | array( 'MostlinkedPage', 'Mostlinked' ), |
| 34 | 34 | array( 'MostrevisionsPage', 'Mostrevisions' ), |
| 35 | 35 | array( 'FewestrevisionsPage', 'Fewestrevisions' ), |
| 36 | 36 | array( 'ShortPagesPage', 'Shortpages' ), |
| 37 | 37 | array( 'UncategorizedCategoriesPage', 'Uncategorizedcategories' ), |
| 38 | 38 | array( 'UncategorizedPagesPage', 'Uncategorizedpages' ), |
| 39 | | - array( 'UncategorizedImagesPage', 'Uncategorizedimages' ), |
| 40 | | - array( 'UncategorizedTemplatesPage', 'Uncategorizedtemplates' ), |
| | 39 | + array( 'UncategorizedImagesPage', 'Uncategorizedimages' ), |
| | 40 | + array( 'UncategorizedTemplatesPage', 'Uncategorizedtemplates' ), |
| 41 | 41 | array( 'UnusedCategoriesPage', 'Unusedcategories' ), |
| 42 | 42 | array( 'UnusedimagesPage', 'Unusedimages' ), |
| 43 | 43 | array( 'WantedCategoriesPage', 'Wantedcategories' ), |
| 44 | 44 | array( 'WantedFilesPage', 'Wantedfiles' ), |
| 45 | 45 | array( 'WantedPagesPage', 'Wantedpages' ), |
| 46 | | - array( 'WantedTemplatesPage', 'Wantedtemplates' ), |
| | 46 | + array( 'WantedTemplatesPage', 'Wantedtemplates' ), |
| 47 | 47 | array( 'UnwatchedPagesPage', 'Unwatchedpages' ), |
| 48 | | - array( 'UnusedtemplatesPage', 'Unusedtemplates' ), |
| 49 | | - array( 'WithoutInterwikiPage', 'Withoutinterwiki' ), |
| | 48 | + array( 'UnusedtemplatesPage', 'Unusedtemplates' ), |
| | 49 | + array( 'WithoutInterwikiPage', 'Withoutinterwiki' ), |
| 50 | 50 | ); |
| 51 | 51 | wfRunHooks( 'wgQueryPages', array( &$wgQueryPages ) ); |
| 52 | 52 | |
| 53 | 53 | global $wgDisableCounters; |
| 54 | 54 | if ( !$wgDisableCounters ) |
| 55 | | - $wgQueryPages[] = array( 'PopularPagesPage', 'Popularpages' ); |
| | 55 | + $wgQueryPages[] = array( 'PopularPagesPage', 'Popularpages' ); |
| 56 | 56 | |
| 57 | 57 | |
| 58 | 58 | /** |
| — | — | @@ -79,7 +79,7 @@ |
| 80 | 80 | /** |
| 81 | 81 | * A mutator for $this->listoutput; |
| 82 | 82 | * |
| 83 | | - * @param bool $bool |
| | 83 | + * @param $bool Boolean |
| 84 | 84 | */ |
| 85 | 85 | function setListoutput( $bool ) { |
| 86 | 86 | $this->listoutput = $bool; |
| — | — | @@ -89,6 +89,8 @@ |
| 90 | 90 | * Subclasses return their name here. Make sure the name is also |
| 91 | 91 | * specified in SpecialPage.php and in Language.php as a language message |
| 92 | 92 | * param. |
| | 93 | + * |
| | 94 | + * @return String |
| 93 | 95 | */ |
| 94 | 96 | function getName() { |
| 95 | 97 | return ''; |
| — | — | @@ -124,6 +126,8 @@ |
| 125 | 127 | |
| 126 | 128 | /** |
| 127 | 129 | * Override to sort by increasing values |
| | 130 | + * |
| | 131 | + * @return Boolean |
| 128 | 132 | */ |
| 129 | 133 | function sortDescending() { |
| 130 | 134 | return true; |
| — | — | @@ -138,8 +142,10 @@ |
| 139 | 143 | * Is this query expensive (for some definition of expensive)? Then we |
| 140 | 144 | * don't let it run in miser mode. $wgDisableQueryPages causes all query |
| 141 | 145 | * pages to be declared expensive. Some query pages are always expensive. |
| | 146 | + * |
| | 147 | + * @return Boolean |
| 142 | 148 | */ |
| 143 | | - function isExpensive( ) { |
| | 149 | + function isExpensive() { |
| 144 | 150 | global $wgDisableQueryPages; |
| 145 | 151 | return $wgDisableQueryPages; |
| 146 | 152 | } |
| — | — | @@ -148,7 +154,7 @@ |
| 149 | 155 | * Whether or not the output of the page in question is retrived from |
| 150 | 156 | * the database cache. |
| 151 | 157 | * |
| 152 | | - * @return bool |
| | 158 | + * @return Boolean |
| 153 | 159 | */ |
| 154 | 160 | function isCached() { |
| 155 | 161 | global $wgMiserMode; |
| — | — | @@ -158,6 +164,8 @@ |
| 159 | 165 | |
| 160 | 166 | /** |
| 161 | 167 | * Sometime we dont want to build rss / atom feeds. |
| | 168 | + * |
| | 169 | + * @return Boolean |
| 162 | 170 | */ |
| 163 | 171 | function isSyndicated() { |
| 164 | 172 | return true; |
| — | — | @@ -168,6 +176,9 @@ |
| 169 | 177 | * skin; you can use it for making links. The result is a single row of |
| 170 | 178 | * result data. You should be able to grab SQL results off of it. |
| 171 | 179 | * If the function return "false", the line output will be skipped. |
| | 180 | + * |
| | 181 | + * @param $skin Skin object |
| | 182 | + * @param $result Object: database row |
| 172 | 183 | */ |
| 173 | 184 | function formatResult( $skin, $result ) { |
| 174 | 185 | return ''; |
| — | — | @@ -175,8 +186,10 @@ |
| 176 | 187 | |
| 177 | 188 | /** |
| 178 | 189 | * The content returned by this function will be output before any result |
| | 190 | + * |
| | 191 | + * @return String |
| 179 | 192 | */ |
| 180 | | - function getPageHeader( ) { |
| | 193 | + function getPageHeader() { |
| 181 | 194 | return ''; |
| 182 | 195 | } |
| 183 | 196 | |
| — | — | @@ -184,7 +197,8 @@ |
| 185 | 198 | * If using extra form wheely-dealies, return a set of parameters here |
| 186 | 199 | * as an associative array. They will be encoded and added to the paging |
| 187 | 200 | * links (prev/next/lengths). |
| 188 | | - * @return array |
| | 201 | + * |
| | 202 | + * @return Array |
| 189 | 203 | */ |
| 190 | 204 | function linkParameters() { |
| 191 | 205 | return array(); |
| — | — | @@ -196,12 +210,15 @@ |
| 197 | 211 | * Setting this to return true, will call one more time wfFormatResult to |
| 198 | 212 | * be sure that the very last result is formatted and shown. |
| 199 | 213 | */ |
| 200 | | - function tryLastResult( ) { |
| | 214 | + function tryLastResult() { |
| 201 | 215 | return false; |
| 202 | 216 | } |
| 203 | 217 | |
| 204 | 218 | /** |
| 205 | 219 | * Clear the cache and save new results |
| | 220 | + * |
| | 221 | + * @param $limit Integer: limit for SQL statement |
| | 222 | + * @param $ignoreErrors Boolean: whether to ignore database errors |
| 206 | 223 | */ |
| 207 | 224 | function recache( $limit, $ignoreErrors = true ) { |
| 208 | 225 | $fname = get_class( $this ) . '::recache'; |
| — | — | @@ -376,12 +393,12 @@ |
| 377 | 394 | * Format and output report results using the given information plus |
| 378 | 395 | * OutputPage |
| 379 | 396 | * |
| 380 | | - * @param OutputPage $out OutputPage to print to |
| 381 | | - * @param Skin $skin User skin to use |
| 382 | | - * @param Database $dbr Database (read) connection to use |
| 383 | | - * @param int $res Result pointer |
| 384 | | - * @param int $num Number of available result rows |
| 385 | | - * @param int $offset Paging offset |
| | 397 | + * @param $out OutputPage to print to |
| | 398 | + * @param $skin Skin: user skin to use |
| | 399 | + * @param $dbr Database (read) connection to use |
| | 400 | + * @param $res Integer: result pointer |
| | 401 | + * @param $num Integer: number of available result rows |
| | 402 | + * @param $offset Integer: paging offset |
| 386 | 403 | */ |
| 387 | 404 | protected function outputResults( $out, $skin, $dbr, $res, $num, $offset ) { |
| 388 | 405 | global $wgContLang; |