| Index: trunk/phase3/includes/LogEventsList.php |
| — | — | @@ -65,6 +65,7 @@ |
| 66 | 66 | |
| 67 | 67 | /** |
| 68 | 68 | * Show options for the log list |
| | 69 | + * |
| 69 | 70 | * @param $types string or Array |
| 70 | 71 | * @param $user String |
| 71 | 72 | * @param $page String |
| — | — | @@ -536,7 +537,7 @@ |
| 537 | 538 | * @param $type Mixed: string/array |
| 538 | 539 | * @param $action Mixed: string/array |
| 539 | 540 | * @param $right string |
| 540 | | - * @return bool |
| | 541 | + * @return Boolean |
| 541 | 542 | */ |
| 542 | 543 | public static function typeAction( $row, $type, $action, $right='' ) { |
| 543 | 544 | $match = is_array($type) ? |
| — | — | @@ -555,6 +556,7 @@ |
| 556 | 557 | /** |
| 557 | 558 | * Determine if the current user is allowed to view a particular |
| 558 | 559 | * field of this log row, if it's marked as deleted. |
| | 560 | + * |
| 559 | 561 | * @param $row Row |
| 560 | 562 | * @param $field Integer |
| 561 | 563 | * @return Boolean |
| — | — | @@ -562,10 +564,11 @@ |
| 563 | 565 | public static function userCan( $row, $field ) { |
| 564 | 566 | return self::userCanBitfield( $row->log_deleted, $field ); |
| 565 | 567 | } |
| 566 | | - |
| | 568 | + |
| 567 | 569 | /** |
| 568 | 570 | * Determine if the current user is allowed to view a particular |
| 569 | 571 | * field of this log row, if it's marked as deleted. |
| | 572 | + * |
| 570 | 573 | * @param $bitfield Integer (current field) |
| 571 | 574 | * @param $field Integer |
| 572 | 575 | * @return Boolean |
| — | — | @@ -597,6 +600,7 @@ |
| 598 | 601 | |
| 599 | 602 | /** |
| 600 | 603 | * Show log extract. Either with text and a box (set $msgKey) or without (don't set $msgKey) |
| | 604 | + * |
| 601 | 605 | * @param $out OutputPage or String-by-reference |
| 602 | 606 | * @param $types String or Array |
| 603 | 607 | * @param $page String The page title to show log entries for |
| — | — | @@ -706,9 +710,10 @@ |
| 707 | 711 | |
| 708 | 712 | /** |
| 709 | 713 | * SQL clause to skip forbidden log types for this user |
| | 714 | + * |
| 710 | 715 | * @param $db Database |
| 711 | 716 | * @param $audience string, public/user |
| 712 | | - * @return mixed (string or false) |
| | 717 | + * @return Mixed: string or false |
| 713 | 718 | */ |
| 714 | 719 | public static function getExcludeClause( $db, $audience = 'public' ) { |
| 715 | 720 | global $wgLogRestrictions, $wgUser; |
| — | — | @@ -739,15 +744,17 @@ |
| 740 | 745 | public $mLogEventsList; |
| 741 | 746 | |
| 742 | 747 | /** |
| 743 | | - * constructor |
| | 748 | + * Constructor |
| | 749 | + * |
| 744 | 750 | * @param $list LogEventsList |
| 745 | | - * @param $types String or Array log types to show |
| 746 | | - * @param $user String The user who made the log entries |
| 747 | | - * @param $title String The page title the log entries are for |
| 748 | | - * @param $pattern String Do a prefix search rather than an exact title match |
| 749 | | - * @param $conds Array Extra conditions for the query |
| 750 | | - * @param $year Integer The year to start from |
| 751 | | - * @param $month Integer The month to start from |
| | 751 | + * @param $types String or Array: log types to show |
| | 752 | + * @param $user String: the user who made the log entries |
| | 753 | + * @param $title String: the page title the log entries are for |
| | 754 | + * @param $pattern String: do a prefix search rather than an exact title match |
| | 755 | + * @param $conds Array: extra conditions for the query |
| | 756 | + * @param $year Integer: the year to start from |
| | 757 | + * @param $month Integer: the month to start from |
| | 758 | + * @param $tagFilter String: tag |
| 752 | 759 | */ |
| 753 | 760 | public function __construct( $list, $types = array(), $user = '', $title = '', $pattern = '', |
| 754 | 761 | $conds = array(), $year = false, $month = false, $tagFilter = '' ) |
| — | — | @@ -795,6 +802,7 @@ |
| 796 | 803 | /** |
| 797 | 804 | * Set the log reader to return only entries of the given type. |
| 798 | 805 | * Type restrictions enforced here |
| | 806 | + * |
| 799 | 807 | * @param $types String or array: Log types ('upload', 'delete', etc); |
| 800 | 808 | * empty string means no restriction |
| 801 | 809 | */ |
| — | — | @@ -827,6 +835,7 @@ |
| 828 | 836 | |
| 829 | 837 | /** |
| 830 | 838 | * Set the log reader to return only entries by the given user. |
| | 839 | + * |
| 831 | 840 | * @param $name String: (In)valid user name |
| 832 | 841 | */ |
| 833 | 842 | private function limitUser( $name ) { |
| — | — | @@ -860,6 +869,7 @@ |
| 861 | 870 | /** |
| 862 | 871 | * Set the log reader to return only entries affecting the given page. |
| 863 | 872 | * (For the block and rights logs, this is a user page.) |
| | 873 | + * |
| 864 | 874 | * @param $page String: Title name as text |
| 865 | 875 | * @param $pattern String |
| 866 | 876 | */ |
| — | — | @@ -1014,6 +1024,7 @@ |
| 1015 | 1025 | */ |
| 1016 | 1026 | class LogReader { |
| 1017 | 1027 | var $pager; |
| | 1028 | + |
| 1018 | 1029 | /** |
| 1019 | 1030 | * @param $request WebRequest: for internal use use a FauxRequest object to pass arbitrary parameters. |
| 1020 | 1031 | */ |
| — | — | @@ -1102,6 +1113,7 @@ |
| 1103 | 1114 | * Output just the list of entries given by the linked LogReader, |
| 1104 | 1115 | * with extraneous UI elements. Use for displaying log fragments in |
| 1105 | 1116 | * another page (eg at Special:Undelete) |
| | 1117 | + * |
| 1106 | 1118 | * @param $out OutputPage: where to send output |
| 1107 | 1119 | */ |
| 1108 | 1120 | public function showList( &$out ) { |