| Index: trunk/phase3/includes/LogEventsList.php |
| — | — | @@ -47,7 +47,7 @@ |
| 48 | 48 | |
| 49 | 49 | /** |
| 50 | 50 | * Set page title and show header for this log type |
| 51 | | - * @param string $type |
| | 51 | + * @param $type String |
| 52 | 52 | */ |
| 53 | 53 | public function showHeader( $type ) { |
| 54 | 54 | if( LogPage::isLogType( $type ) ) { |
| — | — | @@ -58,13 +58,13 @@ |
| 59 | 59 | |
| 60 | 60 | /** |
| 61 | 61 | * Show options for the log list |
| 62 | | - * @param string $type, |
| 63 | | - * @param string $user, |
| 64 | | - * @param string $page, |
| 65 | | - * @param string $pattern |
| 66 | | - * @param int $year year |
| 67 | | - * @param int $month month |
| 68 | | - * @param bool $filter |
| | 62 | + * @param $type String |
| | 63 | + * @param $user String |
| | 64 | + * @param $page String |
| | 65 | + * @param $pattern String |
| | 66 | + * @param $year Integer: year |
| | 67 | + * @param $month Integer: month |
| | 68 | + * @param $filter Boolean |
| 69 | 69 | */ |
| 70 | 70 | public function showOptions( $type = '', $user = '', $page = '', $pattern = '', $year = '', |
| 71 | 71 | $month = '', $filter = null ) |
| — | — | @@ -120,8 +120,8 @@ |
| 121 | 121 | } |
| 122 | 122 | |
| 123 | 123 | /** |
| 124 | | - * @return string Formatted HTML |
| 125 | | - * @param string $queryType |
| | 124 | + * @param $queryType String |
| | 125 | + * @return String: Formatted HTML |
| 126 | 126 | */ |
| 127 | 127 | private function getTypeMenu( $queryType ) { |
| 128 | 128 | global $wgLogRestrictions, $wgUser; |
| — | — | @@ -158,25 +158,25 @@ |
| 159 | 159 | } |
| 160 | 160 | |
| 161 | 161 | /** |
| 162 | | - * @return string Formatted HTML |
| 163 | | - * @param string $user |
| | 162 | + * @param $user String |
| | 163 | + * @return String: Formatted HTML |
| 164 | 164 | */ |
| 165 | 165 | private function getUserInput( $user ) { |
| 166 | 166 | return Xml::inputLabel( wfMsg( 'specialloguserlabel' ), 'user', 'user', 15, $user ); |
| 167 | 167 | } |
| 168 | 168 | |
| 169 | 169 | /** |
| 170 | | - * @return string Formatted HTML |
| 171 | | - * @param string $title |
| | 170 | + * @param $title String |
| | 171 | + * @return String: Formatted HTML |
| 172 | 172 | */ |
| 173 | 173 | private function getTitleInput( $title ) { |
| 174 | 174 | return Xml::inputLabel( wfMsg( 'speciallogtitlelabel' ), 'page', 'page', 20, $title ); |
| 175 | 175 | } |
| 176 | 176 | |
| 177 | 177 | /** |
| | 178 | + * @param $year Integer |
| | 179 | + * @param $month Integer |
| 178 | 180 | * @return string Formatted HTML |
| 179 | | - * @param int $year |
| 180 | | - * @param int $month |
| 181 | 181 | */ |
| 182 | 182 | private function getDateMenu( $year, $month ) { |
| 183 | 183 | # Offset overrides year/month selection |
| — | — | @@ -221,10 +221,9 @@ |
| 222 | 222 | return "</ul>\n"; |
| 223 | 223 | } |
| 224 | 224 | |
| 225 | | - /** |
| 226 | | - * @param Row $row a single row from the result set |
| 227 | | - * @return string Formatted HTML list item |
| 228 | | - * @private |
| | 225 | + /** |
| | 226 | + * @param $row Row: a single row from the result set |
| | 227 | + * @return String: Formatted HTML list item |
| 229 | 228 | */ |
| 230 | 229 | public function logLine( $row ) { |
| 231 | 230 | global $wgLang, $wgUser, $wgContLang; |
| — | — | @@ -343,7 +342,7 @@ |
| 344 | 343 | } |
| 345 | 344 | |
| 346 | 345 | /** |
| 347 | | - * @param Row $row |
| | 346 | + * @param $row Row |
| 348 | 347 | * @return string |
| 349 | 348 | */ |
| 350 | 349 | private function getShowHideLinks( $row ) { |
| — | — | @@ -366,9 +365,9 @@ |
| 367 | 366 | } |
| 368 | 367 | |
| 369 | 368 | /** |
| 370 | | - * @param Row $row |
| 371 | | - * @param mixed $type (string/array) |
| 372 | | - * @param mixed $action (string/array) |
| | 369 | + * @param $row Row |
| | 370 | + * @param $type Mixed: string/array |
| | 371 | + * @param $action Mixed: string/array |
| 373 | 372 | * @return bool |
| 374 | 373 | */ |
| 375 | 374 | public static function typeAction( $row, $type, $action ) { |
| — | — | @@ -382,9 +381,9 @@ |
| 383 | 382 | /** |
| 384 | 383 | * Determine if the current user is allowed to view a particular |
| 385 | 384 | * field of this log row, if it's marked as deleted. |
| 386 | | - * @param Row $row |
| 387 | | - * @param int $field |
| 388 | | - * @return bool |
| | 385 | + * @param $row Row |
| | 386 | + * @param $field Integer |
| | 387 | + * @return Boolean |
| 389 | 388 | */ |
| 390 | 389 | public static function userCan( $row, $field ) { |
| 391 | 390 | if( ( $row->log_deleted & $field ) == $field ) { |
| — | — | @@ -400,9 +399,9 @@ |
| 401 | 400 | } |
| 402 | 401 | |
| 403 | 402 | /** |
| 404 | | - * @param Row $row |
| 405 | | - * @param int $field one of DELETED_* bitfield constants |
| 406 | | - * @return bool |
| | 403 | + * @param $row Row |
| | 404 | + * @param $field Integer: one of DELETED_* bitfield constants |
| | 405 | + * @return Boolean |
| 407 | 406 | */ |
| 408 | 407 | public static function isDeleted( $row, $field ) { |
| 409 | 408 | return ($row->log_deleted & $field) == $field; |
| — | — | @@ -410,12 +409,12 @@ |
| 411 | 410 | |
| 412 | 411 | /** |
| 413 | 412 | * Quick function to show a short log extract |
| 414 | | - * @param OutputPage $out |
| 415 | | - * @param string $type |
| 416 | | - * @param string $page |
| 417 | | - * @param string $user |
| 418 | | - * @param int $lim |
| 419 | | - * @param array $conds |
| | 413 | + * @param $out OutputPage |
| | 414 | + * @param $type String |
| | 415 | + * @param $page String |
| | 416 | + * @param $user String |
| | 417 | + * @param $lim Integer |
| | 418 | + * @param $conds Array |
| 420 | 419 | */ |
| 421 | 420 | public static function showLogExtract( $out, $type='', $page='', $user='', $lim=0, $conds=array() ) { |
| 422 | 421 | global $wgUser; |
| — | — | @@ -436,10 +435,10 @@ |
| 437 | 436 | return $pager->getNumRows(); |
| 438 | 437 | } |
| 439 | 438 | |
| 440 | | - /** |
| | 439 | + /** |
| 441 | 440 | * SQL clause to skip forbidden log types for this user |
| 442 | | - * @param Database $db |
| 443 | | - * @returns mixed (string or false) |
| | 441 | + * @param $db Database |
| | 442 | + * @return mixed (string or false) |
| 444 | 443 | */ |
| 445 | 444 | public static function getExcludeClause( $db ) { |
| 446 | 445 | global $wgLogRestrictions, $wgUser; |
| — | — | @@ -467,15 +466,18 @@ |
| 468 | 467 | class LogPager extends ReverseChronologicalPager { |
| 469 | 468 | private $type = '', $user = '', $title = '', $pattern = ''; |
| 470 | 469 | public $mLogEventsList; |
| | 470 | + |
| 471 | 471 | /** |
| 472 | | - * constructor |
| 473 | | - * @param LogEventsList $loglist, |
| 474 | | - * @param string $type, |
| 475 | | - * @param string $user, |
| 476 | | - * @param string $page, |
| 477 | | - * @param string $pattern |
| 478 | | - * @param array $conds |
| 479 | | - */ |
| | 472 | + * constructor |
| | 473 | + * @param $list LogEventsList |
| | 474 | + * @param $type String |
| | 475 | + * @param $user String |
| | 476 | + * @param $title String |
| | 477 | + * @param $pattern String |
| | 478 | + * @param $conds Array |
| | 479 | + * @param $year Integer |
| | 480 | + * @param $month Integer |
| | 481 | + */ |
| 480 | 482 | function __construct( $list, $type = '', $user = '', $title = '', $pattern = '', |
| 481 | 483 | $conds = array(), $year = false, $month = false ) |
| 482 | 484 | { |
| — | — | @@ -519,8 +521,7 @@ |
| 520 | 522 | /** |
| 521 | 523 | * Set the log reader to return only entries of the given type. |
| 522 | 524 | * Type restrictions enforced here |
| 523 | | - * @param string $type A log type ('upload', 'delete', etc) |
| 524 | | - * @private |
| | 525 | + * @param $type String: A log type ('upload', 'delete', etc) |
| 525 | 526 | */ |
| 526 | 527 | private function limitType( $type ) { |
| 527 | 528 | global $wgLogRestrictions, $wgUser; |
| — | — | @@ -542,8 +543,7 @@ |
| 543 | 544 | |
| 544 | 545 | /** |
| 545 | 546 | * Set the log reader to return only entries by the given user. |
| 546 | | - * @param string $name (In)valid user name |
| 547 | | - * @private |
| | 547 | + * @param $name String: (In)valid user name |
| 548 | 548 | */ |
| 549 | 549 | private function limitUser( $name ) { |
| 550 | 550 | if( $name == '' ) { |
| — | — | @@ -568,8 +568,8 @@ |
| 569 | 569 | /** |
| 570 | 570 | * Set the log reader to return only entries affecting the given page. |
| 571 | 571 | * (For the block and rights logs, this is a user page.) |
| 572 | | - * @param string $page Title name as text |
| 573 | | - * @private |
| | 572 | + * @param $page String: Title name as text |
| | 573 | + * @param $pattern String |
| 574 | 574 | */ |
| 575 | 575 | private function limitTitle( $page, $pattern ) { |
| 576 | 576 | global $wgMiserMode; |
| — | — | @@ -679,7 +679,7 @@ |
| 680 | 680 | class LogReader { |
| 681 | 681 | var $pager; |
| 682 | 682 | /** |
| 683 | | - * @param WebRequest $request For internal use use a FauxRequest object to pass arbitrary parameters. |
| | 683 | + * @param $request WebRequest: for internal use use a FauxRequest object to pass arbitrary parameters. |
| 684 | 684 | */ |
| 685 | 685 | function __construct( $request ) { |
| 686 | 686 | global $wgUser, $wgOut; |
| — | — | @@ -716,13 +716,15 @@ |
| 717 | 717 | */ |
| 718 | 718 | class LogViewer { |
| 719 | 719 | const NO_ACTION_LINK = 1; |
| | 720 | + |
| 720 | 721 | /** |
| 721 | | - * @var LogReader $reader |
| | 722 | + * LogReader object |
| 722 | 723 | */ |
| 723 | 724 | var $reader; |
| | 725 | + |
| 724 | 726 | /** |
| 725 | | - * @param LogReader &$reader where to get our data from |
| 726 | | - * @param integer $flags Bitwise combination of flags: |
| | 727 | + * @param &$reader LogReader: where to get our data from |
| | 728 | + * @param $flags Integer: Bitwise combination of flags: |
| 727 | 729 | * LogEventsList::NO_ACTION_LINK Don't show restore/unblock/block links |
| 728 | 730 | */ |
| 729 | 731 | function __construct( &$reader, $flags = 0 ) { |
| — | — | @@ -762,7 +764,7 @@ |
| 763 | 765 | * Output just the list of entries given by the linked LogReader, |
| 764 | 766 | * with extraneous UI elements. Use for displaying log fragments in |
| 765 | 767 | * another page (eg at Special:Undelete) |
| 766 | | - * @param OutputPage $out where to send output |
| | 768 | + * @param $out OutputPage: where to send output |
| 767 | 769 | */ |
| 768 | 770 | public function showList( &$out ) { |
| 769 | 771 | $logBody = $this->pager->getBody(); |