MediaWiki  REL1_24
LogEventsList Class Reference
Inheritance diagram for LogEventsList:
Collaboration diagram for LogEventsList:

List of all members.

Public Member Functions

 __construct ($context, $unused=null, $flags=0)
 Constructor.
 beginLogEventsList ()
 endLogEventsList ()
 getDisplayTitle ()
 Deprecated alias for getTitle(); do not use.
 getTypeSelector ()
 Returns log page selector.
 logLine ($row)
 showOptions ($types=array(), $user= '', $page= '', $pattern= '', $year=0, $month=0, $filter=null, $tagFilter= '')
 Show options for the log list.

Static Public Member Functions

static getExcludeClause ($db, $audience= 'public', User $user=null)
 SQL clause to skip forbidden log types for this user.
static isDeleted ($row, $field)
static showLogExtract (&$out, $types=array(), $page= '', $user= '', $param=array())
 Show log extract.
static typeAction ($row, $type, $action, $right= '')
static userCan ($row, $field, User $user=null)
 Determine if the current user is allowed to view a particular field of this log row, if it's marked as deleted.
static userCanBitfield ($bitfield, $field, User $user=null)
 Determine if the current user is allowed to view a particular field of this log row, if it's marked as deleted.

Public Attributes

 $flags
const NO_ACTION_LINK = 1
const NO_EXTRA_USER_LINKS = 2
const USE_REVDEL_CHECKBOXES = 4

Protected Attributes

array $mDefaultQuery

Private Member Functions

 getDefaultQuery ()
 getExtraInputs ($types)
 getFilterLinks ($filter)
 getShowHideLinks ($row)
 getTitleInput ($title)
 getTitlePattern ($pattern)
 getTypeMenu ($queryTypes)
 getUserInput ($user)

Detailed Description

Definition at line 26 of file LogEventsList.php.


Constructor & Destructor Documentation

LogEventsList::__construct ( context,
unused = null,
flags = 0 
)

Constructor.

The first two parameters used to be $skin and $out, but now only a context is needed, that's why there's a second unused parameter.

Parameters:
IContextSource | Skin$contextContext to use; formerly it was a Skin object. Use of Skin is deprecated.
null$unusedUnused; used to be an OutputPage object.
int$flagsCan be a combination of self::NO_ACTION_LINK, self::NO_EXTRA_USER_LINKS or self::USE_REVDEL_CHECKBOXES.

Definition at line 48 of file LogEventsList.php.


Member Function Documentation

Returns:
string

Definition at line 289 of file LogEventsList.php.

Returns:
string

Definition at line 296 of file LogEventsList.php.

Definition at line 167 of file LogEventsList.php.

References ContextSource\getRequest().

Deprecated alias for getTitle(); do not use.

Deprecated:
since 1.20; use getTitle() instead.
Returns:
Title

Definition at line 65 of file LogEventsList.php.

static LogEventsList::getExcludeClause ( db,
audience = 'public',
User user = null 
) [static]

SQL clause to skip forbidden log types for this user.

Parameters:
DatabaseBase$db
string$audiencePublic/user
User$userUser to check, or null to use $wgUser
Returns:
string|bool String on success, false on failure.

Definition at line 635 of file LogEventsList.php.

Referenced by ApiQueryLogEvents\execute(), and ApiQueryLogEvents\getCacheMode().

LogEventsList::getExtraInputs ( types) [private]
Parameters:
array$types
Returns:
string

Definition at line 272 of file LogEventsList.php.

LogEventsList::getFilterLinks ( filter) [private]
Parameters:
array$filter
Returns:
string Formatted HTML

Definition at line 136 of file LogEventsList.php.

LogEventsList::getShowHideLinks ( row) [private]
Parameters:
stdClass$rowRow
Returns:
string

Definition at line 344 of file LogEventsList.php.

LogEventsList::getTitleInput ( title) [private]
Parameters:
string$title
Returns:
string Formatted HTML

Definition at line 246 of file LogEventsList.php.

LogEventsList::getTitlePattern ( pattern) [private]
Parameters:
string$pattern
Returns:
string Checkbox

Definition at line 262 of file LogEventsList.php.

LogEventsList::getTypeMenu ( queryTypes) [private]
Parameters:
array$queryTypes
Returns:
string Formatted HTML

Definition at line 186 of file LogEventsList.php.

Returns log page selector.

Returns:
XmlSelect
Since:
1.19

Definition at line 199 of file LogEventsList.php.

LogEventsList::getUserInput ( user) [private]
Parameters:
string$user
Returns:
string Formatted HTML

Definition at line 230 of file LogEventsList.php.

static LogEventsList::isDeleted ( row,
field 
) [static]
Parameters:
stdClass$rowRow
int$fieldOne of DELETED_* bitfield constants
Returns:
bool

Definition at line 464 of file LogEventsList.php.

Referenced by ApiQueryLogEvents\extractRowInfo(), ProtectedPagesPager\formatValue(), and RevDelLogItem\getHTML().

Parameters:
stdClass$rowA single row from the result set
Returns:
string Formatted HTML list item

Definition at line 304 of file LogEventsList.php.

static LogEventsList::showLogExtract ( &$  out,
types = array(),
page = '',
user = '',
param = array() 
) [static]

Show log extract.

Either with text and a box (set $msgKey) or without (don't set $msgKey)

Parameters:
OutputPage | string$outBy-reference
string | array$typesLog types to show
string | Title$pageThe page title to show log entries for
string$userThe user who made the log entries
array$paramAssociative Array with the following additional options:
  • lim Integer Limit of items to show, default is 50
  • conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
  • showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty if set to true (default), "No matching items in log" is displayed if loglist is empty
  • msgKey Array If you want a nice box with a message, set this to the key of the message. First element is the message key, additional optional elements are parameters for the key that are processed with wfMessage
  • offset Set to overwrite offset parameter in WebRequest set to '' to unset offset
  • wrap String Wrap the message in html (usually something like "<div ...>$1</div>").
  • flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
  • useRequestParams boolean Set true to use Pager-related parameters in the WebRequest
  • useMaster boolean Use master DB
Returns:
int Number of total log items (not limited by $lim)

Definition at line 491 of file LogEventsList.php.

Referenced by DeletedContributionsPage\__construct(), SpecialContributions\contributionsSub(), SpecialBlock\postText(), SpecialPageLanguage\showLogFragment(), and UserrightsPage\showLogFragment().

LogEventsList::showOptions ( types = array(),
user = '',
page = '',
pattern = '',
year = 0,
month = 0,
filter = null,
tagFilter = '' 
)

Show options for the log list.

Parameters:
array | string$types
string$user
string$page
string$pattern
int$yearYear
int$monthMonth
array$filter
string$tagFilterTag to select by default

Definition at line 82 of file LogEventsList.php.

static LogEventsList::typeAction ( row,
type,
action,
right = '' 
) [static]
Parameters:
stdClass$rowRow
string | array$type
string | array$action
string$right
Returns:
bool

Definition at line 404 of file LogEventsList.php.

Referenced by PopulateLogSearch\doDBUpdates().

static LogEventsList::userCan ( row,
field,
User user = null 
) [static]

Determine if the current user is allowed to view a particular field of this log row, if it's marked as deleted.

Parameters:
stdClass$rowRow
int$field
User$userUser to check, or null to use $wgUser
Returns:
bool

Definition at line 428 of file LogEventsList.php.

Referenced by RevDelLogItem\canView(), ApiQueryLogEvents\extractRowInfo(), and RevDelLogItem\getApiData().

static LogEventsList::userCanBitfield ( bitfield,
field,
User user = null 
) [static]

Determine if the current user is allowed to view a particular field of this log row, if it's marked as deleted.

Parameters:
int$bitfieldCurrent field
int$field
User$userUser to check, or null to use $wgUser
Returns:
bool

Definition at line 441 of file LogEventsList.php.

Referenced by ApiQueryWatchlist\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), and ProtectedPagesPager\formatValue().


Member Data Documentation

LogEventsList::$flags

Definition at line 31 of file LogEventsList.php.

array LogEventsList::$mDefaultQuery [protected]

Definition at line 35 of file LogEventsList.php.

Definition at line 27 of file LogEventsList.php.

Definition at line 28 of file LogEventsList.php.

Definition at line 29 of file LogEventsList.php.

Referenced by SpecialLog\show().


The documentation for this class was generated from the following file: