MediaWiki  REL1_20
ChangesList Class Reference

Base class for all changes lists. More...

Inheritance diagram for ChangesList:
Collaboration diagram for ChangesList:

List of all members.

Public Member Functions

 __construct ($obj)
 Changeslist contructor.
 beginRecentChangesList ()
 Returns text for the start of the tabular part of RC.
 endRecentChangesList ()
 Returns text for the end of RC.
 formatCharacterDifference (RecentChange $old, RecentChange $new=null)
 Format the character difference of one or several changes.
 insertArticleLink (&$s, &$rc, $unpatrolled, $watched)
 insertComment ($rc)
 Insert a formatted comment.
 insertDateHeader (&$s, $rc_timestamp)
 insertDiffHist (&$s, &$rc, $unpatrolled)
 insertExtra (&$s, &$rc, &$classes)
 insertLog (&$s, $title, $logtype)
 insertLogEntry ($rc)
 Insert a formatted action.
 insertRollback (&$s, &$rc)
 Inserts a rollback link.
 insertTags (&$s, &$rc, &$classes)
 insertTimestamp (&$s, $rc)
 insertUserRelatedLinks (&$s, &$rc)
 Insert links to user page, user talk page and eventually a blocking link.
 setWatchlistDivs ($value=true)
 Sets the list to use a "<li class='watchlist-(namespace)-(page)'>" tag.

Static Public Member Functions

static flag ($flag)
 Provide the "<abbr>" element appropriate to a given abbreviated flag, namely the flag indicating a new page, a minor edit, a bot edit, or an unpatrolled edit.
static isDeleted ($rc, $field)
 Determine if said field of a revision is hidden.
static newFromContext (IContextSource $context)
 Fetch an appropriate changes list class for the specified context Some users might want to use an enhanced list format, for instance.
static newFromUser ($unused)
 Fetch an appropriate changes list class for the main context This first argument used to be an User object.
static showCharacterDifference ($old, $new, IContextSource $context=null)
 Show formatted char difference.
static usePatrol ()
 Check whether to enable recent changes patrol features.
static userCan ($rc, $field, User $user=null)
 Determine if the current user is allowed to view a particular field of this revision, if it's marked as deleted.

Public Attributes

Skin $skin

Protected Member Functions

 maybeWatchedLink ($link, $watched=false)
 numberofWatchingusers ($count)
 Returns the string which indicates the number of watching users.
 recentChangesFlags ($flags, $nothing= '&#160;')
 Returns the appropriate flags for new page, minor change and patrolling.
 showAsUnpatrolled (RecentChange $rc)

Protected Attributes

 $message
 $watchlist = false

Private Member Functions

 preCacheMessages ()
 As we use the same small set of messages in various methods and that they are called often, we call them once and save them in $this->message.

Detailed Description

Base class for all changes lists.

Definition at line 51 of file ChangesList.php.


Constructor & Destructor Documentation

Changeslist contructor.

Parameters:
$objSkin or IContextSource

Definition at line 66 of file ChangesList.php.


Member Function Documentation

Returns text for the start of the tabular part of RC.

Returns:
String

Reimplemented in EnhancedChangesList.

Definition at line 188 of file ChangesList.php.

Returns text for the end of RC.

Returns:
String

Reimplemented in EnhancedChangesList.

Definition at line 280 of file ChangesList.php.

static ChangesList::flag ( flag) [static]

Provide the "<abbr>" element appropriate to a given abbreviated flag, namely the flag indicating a new page, a minor edit, a bot edit, or an unpatrolled edit.

By default in English it will contain "N", "m", "b", "!" respectively, plus it will have an appropriate title and class.

Parameters:
$flagString: 'newpage', 'unpatrolled', 'minor', or 'bot'
Returns:
String: Raw HTML

Definition at line 155 of file ChangesList.php.

Referenced by DeletedContribsPager\formatRow().

Format the character difference of one or several changes.

Parameters:
$oldRecentChange
$newRecentChange last change to use, if not provided, $old will be used
Returns:
string HTML fragment

Definition at line 260 of file ChangesList.php.

ChangesList::insertArticleLink ( &$  s,
&$  rc,
unpatrolled,
watched 
)
Parameters:
$s
$rcRecentChange
$unpatrolled
$watched

Definition at line 356 of file ChangesList.php.

Insert a formatted comment.

Parameters:
$rcRecentChange
Returns:
string

Definition at line 429 of file ChangesList.php.

ChangesList::insertDateHeader ( &$  s,
rc_timestamp 
)
ChangesList::insertDiffHist ( &$  s,
&$  rc,
unpatrolled 
)
Parameters:
$s
$rcRecentChange
$unpatrolled

Definition at line 312 of file ChangesList.php.

ChangesList::insertExtra ( &$  s,
&$  rc,
&$  classes 
)

Definition at line 541 of file ChangesList.php.

ChangesList::insertLog ( &$  s,
title,
logtype 
)

Definition at line 301 of file ChangesList.php.

References $page, $s, $title, Linker\linkKnown(), and ContextSource\msg().

Insert a formatted action.

Parameters:
$rcRecentChange
Returns:
string

Definition at line 416 of file ChangesList.php.

ChangesList::insertRollback ( &$  s,
&$  rc 
)

Inserts a rollback link.

Parameters:
$sstring
$rcRecentChange

Definition at line 508 of file ChangesList.php.

ChangesList::insertTags ( &$  s,
&$  rc,
&$  classes 
)
Parameters:
$sstring
$rcRecentChange
$classes

Definition at line 532 of file ChangesList.php.

ChangesList::insertTimestamp ( &$  s,
rc 
)
Parameters:
$s
$rcRecentChange

Definition at line 389 of file ChangesList.php.

ChangesList::insertUserRelatedLinks ( &$  s,
&$  rc 
)

Insert links to user page, user talk page and eventually a blocking link.

Parameters:
&$sString HTML to update
&$rcRecentChange

Definition at line 400 of file ChangesList.php.

static ChangesList::isDeleted ( rc,
field 
) [static]

Determine if said field of a revision is hidden.

Parameters:
$rcRCCacheEntry
$fieldInteger: one of DELETED_* bitfield constants
Returns:
Boolean

Definition at line 470 of file ChangesList.php.

ChangesList::maybeWatchedLink ( link,
watched = false 
) [protected]
Parameters:
$linkstring
$watchedbool
Returns:
string

Definition at line 495 of file ChangesList.php.

static ChangesList::newFromContext ( IContextSource context) [static]

Fetch an appropriate changes list class for the specified context Some users might want to use an enhanced list format, for instance.

Parameters:
$contextIContextSource to use
Returns:
ChangesList|EnhancedChangesList|OldChangesList derivative

Definition at line 97 of file ChangesList.php.

Referenced by SpecialWatchlist\execute(), and SpecialRecentChanges\webOutput().

static ChangesList::newFromUser ( unused) [static]

Fetch an appropriate changes list class for the main context This first argument used to be an User object.

Deprecated:
in 1.18; use newFromContext() instead
Parameters:
$unusedstring|User Unused
Returns:
ChangesList|EnhancedChangesList|OldChangesList derivative

Definition at line 85 of file ChangesList.php.

ChangesList::numberofWatchingusers ( count) [protected]

Returns the string which indicates the number of watching users.

Returns:
string

Definition at line 452 of file ChangesList.php.

As we use the same small set of messages in various methods and that they are called often, we call them once and save them in $this->message.

Definition at line 121 of file ChangesList.php.

ChangesList::recentChangesFlags ( flags,
nothing = '&#160;' 
) [protected]

Returns the appropriate flags for new page, minor change and patrolling.

Parameters:
$flagsArray Associative array of 'flag' => Bool
$nothingString to use for empty space
Returns:
String

Definition at line 136 of file ChangesList.php.

ChangesList::setWatchlistDivs ( value = true)

Sets the list to use a "<li class='watchlist-(namespace)-(page)'>" tag.

Parameters:
$valueBoolean

Definition at line 113 of file ChangesList.php.

Definition at line 545 of file ChangesList.php.

References ContextSource\getUser().

static ChangesList::showCharacterDifference ( old,
new,
IContextSource context = null 
) [static]

Show formatted char difference.

Parameters:
$oldInteger: bytes
$newInteger: bytes
$contextIContextSource context to use
Returns:
String

Definition at line 205 of file ChangesList.php.

static ChangesList::usePatrol ( ) [static]

Check whether to enable recent changes patrol features.

Returns:
Boolean

Definition at line 443 of file ChangesList.php.

static ChangesList::userCan ( rc,
field,
User user = null 
) [static]

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

Parameters:
$rcRCCacheEntry
$fieldInteger
$userUser object to check, or null to use $wgUser
Returns:
Boolean

Definition at line 482 of file ChangesList.php.


Member Data Documentation

ChangesList::$message [protected]

Definition at line 59 of file ChangesList.php.

Skin ChangesList::$skin

Definition at line 55 of file ChangesList.php.

ChangesList::$watchlist = false [protected]

Definition at line 57 of file ChangesList.php.


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