/**
* Show options for the log list
+ *
* @param $types string or Array
* @param $user String
* @param $page String
* @param $type Mixed: string/array
* @param $action Mixed: string/array
* @param $right string
- * @return bool
+ * @return Boolean
*/
public static function typeAction( $row, $type, $action, $right='' ) {
$match = is_array($type) ?
/**
* Determine if the current user is allowed to view a particular
* field of this log row, if it's marked as deleted.
+ *
* @param $row Row
* @param $field Integer
* @return Boolean
public static function userCan( $row, $field ) {
return self::userCanBitfield( $row->log_deleted, $field );
}
-
+
/**
* Determine if the current user is allowed to view a particular
* field of this log row, if it's marked as deleted.
+ *
* @param $bitfield Integer (current field)
* @param $field Integer
* @return Boolean
/**
* Show log extract. Either with text and a box (set $msgKey) or without (don't set $msgKey)
+ *
* @param $out OutputPage or String-by-reference
* @param $types String or Array
* @param $page String The page title to show log entries for
/**
* SQL clause to skip forbidden log types for this user
+ *
* @param $db Database
* @param $audience string, public/user
- * @return mixed (string or false)
+ * @return Mixed: string or false
*/
public static function getExcludeClause( $db, $audience = 'public' ) {
global $wgLogRestrictions, $wgUser;
public $mLogEventsList;
/**
- * constructor
+ * Constructor
+ *
* @param $list LogEventsList
- * @param $types String or Array log types to show
- * @param $user String The user who made the log entries
- * @param $title String The page title the log entries are for
- * @param $pattern String Do a prefix search rather than an exact title match
- * @param $conds Array Extra conditions for the query
- * @param $year Integer The year to start from
- * @param $month Integer The month to start from
+ * @param $types String or Array: log types to show
+ * @param $user String: the user who made the log entries
+ * @param $title String: the page title the log entries are for
+ * @param $pattern String: do a prefix search rather than an exact title match
+ * @param $conds Array: extra conditions for the query
+ * @param $year Integer: the year to start from
+ * @param $month Integer: the month to start from
+ * @param $tagFilter String: tag
*/
public function __construct( $list, $types = array(), $user = '', $title = '', $pattern = '',
$conds = array(), $year = false, $month = false, $tagFilter = '' )
/**
* Set the log reader to return only entries of the given type.
* Type restrictions enforced here
+ *
* @param $types String or array: Log types ('upload', 'delete', etc);
* empty string means no restriction
*/
/**
* Set the log reader to return only entries by the given user.
+ *
* @param $name String: (In)valid user name
*/
private function limitUser( $name ) {
/**
* Set the log reader to return only entries affecting the given page.
* (For the block and rights logs, this is a user page.)
+ *
* @param $page String: Title name as text
* @param $pattern String
*/
*/
class LogReader {
var $pager;
+
/**
* @param $request WebRequest: for internal use use a FauxRequest object to pass arbitrary parameters.
*/
* Output just the list of entries given by the linked LogReader,
* with extraneous UI elements. Use for displaying log fragments in
* another page (eg at Special:Undelete)
+ *
* @param $out OutputPage: where to send output
*/
public function showList( &$out ) {