MediaWiki  master
ChangesList Class Reference
Inheritance diagram for ChangesList:
Collaboration diagram for ChangesList:

Public Member Functions

 __construct ($obj, array $filterGroups=[])
 Changeslist constructor. More...
 
 beginRecentChangesList ()
 Returns text for the start of the tabular part of RC. More...
 
 endRecentChangesList ()
 Returns text for the end of RC. More...
 
 formatCharacterDifference (RecentChange $old, RecentChange $new=null)
 Format the character difference of one or several changes. More...
 
 getArticleLink (&$rc, $unpatrolled, $watched)
 
 getRollback (RecentChange $rc)
 
 getTags (RecentChange $rc, array &$classes)
 
 getTimestamp ($rc)
 Get the timestamp from $rc formatted with current user's settings and a separator. More...
 
 initChangesListRows ($rows)
 
 insertArticleLink (&$s, RecentChange $rc, $unpatrolled, $watched)
 
 insertComment ($rc)
 Insert a formatted comment. More...
 
 insertDateHeader (&$s, $rc_timestamp)
 
 insertDiffHist (&$s, &$rc, $unpatrolled=null)
 
 insertExtra (&$s, &$rc, &$classes)
 
 insertLog (&$s, $title, $logtype)
 
 insertLogEntry ($rc)
 Insert a formatted action. More...
 
 insertRollback (&$s, &$rc)
 Inserts a rollback link. More...
 
 insertTags (&$s, &$rc, &$classes)
 
 insertTimestamp (&$s, $rc)
 Insert time timestamp string from $rc into $s. More...
 
 insertUserRelatedLinks (&$s, &$rc)
 Insert links to user page, user talk page and eventually a blocking link. More...
 
 isWatchlist ()
 
 recentChangesFlags ($flags, $nothing= ' ')
 Returns the appropriate flags for new page, minor change and patrolling. More...
 
 recentChangesLine (&$rc, $watched=false, $linenumber=null)
 Format a line. More...
 
 setChangeLinePrefixer (callable $prefixer)
 Sets the callable that generates a change line prefix added to the beginning of each line. More...
 
 setWatchlistDivs ($value=true)
 Sets the list to use a "<li class='watchlist-(namespace)-(page)'>" tag. More...
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 Get the Config object. More...
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 Get the Language object. More...
 
 getOutput ()
 Get the OutputPage object. More...
 
 getRequest ()
 Get the WebRequest object. More...
 
 getSkin ()
 Get the Skin object. More...
 
 getStats ()
 Get the Stats object. More...
 
 getTiming ()
 Get the Timing object. More...
 
 getTitle ()
 Get the Title object. More...
 
 getUser ()
 Get the User object. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ($key)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 Set the IContextSource object. More...
 

Static Public Member Functions

static flag ($flag, IContextSource $context=null)
 Make an "<abbr>" element for a given change flag. More...
 
static isDeleted ($rc, $field)
 Determine if said field of a revision is hidden. More...
 
static isUnpatrolled ($rc, User $user)
 
static newFromContext (IContextSource $context, array $groups=[])
 Fetch an appropriate changes list class for the specified context Some users might want to use an enhanced list format, for instance. More...
 
static showCharacterDifference ($old, $new, IContextSource $context=null)
 Show formatted char difference. More...
 
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. More...
 

Public Attributes

Skin $skin
 
const CSS_CLASS_PREFIX = 'mw-changeslist-'
 

Protected Member Functions

 getDataAttributes (RecentChange $rc)
 Get recommended data attributes for a change line. More...
 
 getHTMLClasses ($rc, $watched)
 Get an array of default HTML class attributes for the change. More...
 
 getHTMLClassesForFilters ($rc)
 Get an array of CSS classes attributed to filters for this row. More...
 
 isCategorizationWithoutRevision ($rcObj)
 Determines whether a revision is linked to this change; this may not be the case when the categorization wasn't done by an edit but a conditional parser function. More...
 
 maybeWatchedLink ($link, $watched=false)
 
 numberofWatchingusers ($count)
 Returns the string which indicates the number of watching users. More...
 
 showAsUnpatrolled (RecentChange $rc)
 

Protected Attributes

callable $changeLinePrefixer
 
array $filterGroups
 
 $lastdate
 
LinkRenderer $linkRenderer
 
 $message
 
 $rc_cache
 
 $rcCacheIndex
 
 $rclistOpen
 
 $rcMoveIndex
 
 $watchlist = false
 
BagOStuff $watchMsgCache
 

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. More...
 

Detailed Description

Definition at line 28 of file ChangesList.php.

Constructor & Destructor Documentation

ChangesList::__construct (   $obj,
array  $filterGroups = [] 
)

Changeslist constructor.

Parameters
Skin | IContextSource$obj
array$filterGroupsArray of ChangesListFilterGroup objects (currently optional)

Definition at line 66 of file ChangesList.php.

References $filterGroups, ContextSource\getSkin(), preCacheMessages(), ContextSource\setContext(), and skin().

Member Function Documentation

ChangesList::beginRecentChangesList ( )

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

Returns
string

Definition at line 261 of file ChangesList.php.

References ContextSource\getOutput().

ChangesList::endRecentChangesList ( )

Returns text for the end of RC.

Returns
string

Definition at line 362 of file ChangesList.php.

References $out.

static ChangesList::flag (   $flag,
IContextSource  $context = null 
)
static

Make an "<abbr>" element for a given change flag.

The flag indicating a new page, minor edit, bot edit, or unpatrolled edit. In English it typically contains "N", "m", "b", or "!".

Parameters
string$flagOne key of $wgRecentChangesFlags
IContextSource$context
Returns
string HTML

Definition at line 228 of file ChangesList.php.

References ContextSource\$context, $key, $value, as, Html\element(), RequestContext\getMain(), global, ContextSource\setContext(), text, and wfMessage().

Referenced by SpecialUndelete\diffHeader(), DeletedContribsPager\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), ContribsPager\formatRow(), HistoryPager\historyLine(), and DifferenceEngine\showDiffPage().

ChangesList::formatCharacterDifference ( RecentChange  $old,
RecentChange  $new = null 
)

Format the character difference of one or several changes.

Parameters
RecentChange$old
RecentChange$newLast change to use, if not provided, $old will be used
Returns
string HTML fragment

Definition at line 342 of file ChangesList.php.

References ContextSource\getContext().

Referenced by OldChangesList\formatChangeLine(), EnhancedChangesList\getLineData(), EnhancedChangesList\recentChangesBlockGroup(), and EnhancedChangesList\recentChangesBlockLine().

ChangesList::getArticleLink ( $rc,
  $unpatrolled,
  $watched 
)
ChangesList::getDataAttributes ( RecentChange  $rc)
protected

Get recommended data attributes for a change line.

Parameters
RecentChange$rc
Returns
string[] attribute name => value

Definition at line 754 of file ChangesList.php.

References $type, RecentChange\getAttribute(), RecentChange\SRC_EDIT, RecentChange\SRC_LOG, and RecentChange\SRC_NEW.

Referenced by EnhancedChangesList\getLineData(), EnhancedChangesList\recentChangesBlockLine(), and OldChangesList\recentChangesLine().

ChangesList::getHTMLClasses (   $rc,
  $watched 
)
protected

Get an array of default HTML class attributes for the change.

Parameters
RecentChange | RCCacheEntry$rc
string | bool$watchedOptionally timestamp for adding watched class
Returns
array of classes

Definition at line 174 of file ChangesList.php.

References Sanitizer\escapeClass(), and getHTMLClassesForFilters().

Referenced by EnhancedChangesList\recentChangesBlockLine(), and OldChangesList\recentChangesLine().

ChangesList::getHTMLClassesForFilters (   $rc)
protected

Get an array of CSS classes attributed to filters for this row.

Parameters
RecentChange$rc
Returns
array Array of CSS classes

Definition at line 206 of file ChangesList.php.

References as.

Referenced by getHTMLClasses(), and EnhancedChangesList\getLineData().

ChangesList::getRollback ( RecentChange  $rc)
Parameters
RecentChange$rc
Returns
string
Since
1.26

Definition at line 659 of file ChangesList.php.

References $s, and insertRollback().

Referenced by EnhancedChangesList\getLineData(), and EnhancedChangesList\recentChangesBlockLine().

ChangesList::getTags ( RecentChange  $rc,
array $classes 
)
Parameters
RecentChange$rc
array&$classes
Returns
string
Since
1.26

Definition at line 690 of file ChangesList.php.

References $s, and insertTags().

Referenced by EnhancedChangesList\getLineData(), and EnhancedChangesList\recentChangesBlockLine().

ChangesList::getTimestamp (   $rc)

Get the timestamp from $rc formatted with current user's settings and a separator.

Parameters
RecentChange$rc
Returns
string HTML fragment

Definition at line 504 of file ChangesList.php.

References ContextSource\getLanguage(), and message.

Referenced by insertTimestamp().

ChangesList::initChangesListRows (   $rows)
Parameters
ResultWrapper | array$rows

Definition at line 275 of file ChangesList.php.

References $rows, and Hooks\run().

ChangesList::insertArticleLink ( $s,
RecentChange  $rc,
  $unpatrolled,
  $watched 
)
Parameters
string&$sArticle link will be appended to this string, in place.
RecentChange$rc
bool$unpatrolled
bool$watched
Deprecated:
since 1.27, use getArticleLink instead.

Definition at line 456 of file ChangesList.php.

References $s, and getArticleLink().

ChangesList::insertComment (   $rc)
ChangesList::insertDateHeader ( $s,
  $rc_timestamp 
)
Parameters
string&$sHTML to update
mixed$rc_timestamp

Definition at line 373 of file ChangesList.php.

References $s, Xml\element(), ContextSource\getLanguage(), and ContextSource\getUser().

Referenced by OldChangesList\recentChangesLine().

ChangesList::insertDiffHist ( $s,
$rc,
  $unpatrolled = null 
)
Parameters
string&$sHTML to update
RecentChange&$rc
bool | null$unpatrolledUnused variable, since 1.27.

Definition at line 404 of file ChangesList.php.

References $query, $s, Revision\DELETED_TEXT, ContextSource\getUser(), message, ContextSource\msg(), RC_CATEGORIZE, RC_LOG, and RC_NEW.

Referenced by OldChangesList\formatChangeLine().

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

Definition at line 696 of file ChangesList.php.

Referenced by OldChangesList\formatChangeLine().

ChangesList::insertLog ( $s,
  $title,
  $logtype 
)
Parameters
string&$sHTML to update
Title$title
string$logtype

Definition at line 391 of file ChangesList.php.

References $s, $title, ContextSource\getContext(), and ContextSource\msg().

Referenced by OldChangesList\formatChangeLine().

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

Inserts a rollback link.

Parameters
string&$s
RecentChange&$rc

Definition at line 631 of file ChangesList.php.

References $rev, $s, Linker\generateRollback(), ContextSource\getContext(), ContextSource\getUser(), and RC_EDIT.

Referenced by OldChangesList\formatChangeLine(), and getRollback().

ChangesList::insertTags ( $s,
$rc,
$classes 
)
Parameters
string&$s
RecentChange&$rc
array&$classes

Definition at line 670 of file ChangesList.php.

References $s, ChangeTags\formatSummaryRow(), and list.

Referenced by OldChangesList\formatChangeLine(), and getTags().

ChangesList::insertTimestamp ( $s,
  $rc 
)

Insert time timestamp string from $rc into $s.

Parameters
string&$sHTML to update
RecentChange$rc

Definition at line 519 of file ChangesList.php.

References $s, and getTimestamp().

Referenced by OldChangesList\formatChangeLine().

ChangesList::insertUserRelatedLinks ( $s,
$rc 
)

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

Parameters
string&$sHTML to update
RecentChange&$rc

Definition at line 529 of file ChangesList.php.

References $s, Revision\DELETED_USER, ContextSource\getLanguage(), isDeleted(), ContextSource\msg(), Linker\userLink(), and Linker\userToolLinks().

Referenced by OldChangesList\formatChangeLine().

ChangesList::isCategorizationWithoutRevision (   $rcObj)
protected

Determines whether a revision is linked to this change; this may not be the case when the categorization wasn't done by an edit but a conditional parser function.

Since
1.27
Parameters
RecentChange | RCCacheEntry$rcObj
Returns
bool

Definition at line 744 of file ChangesList.php.

References RC_CATEGORIZE.

Referenced by OldChangesList\formatChangeLine(), EnhancedChangesList\getLineData(), and EnhancedChangesList\recentChangesBlockLine().

static ChangesList::isDeleted (   $rc,
  $field 
)
static

Determine if said field of a revision is hidden.

Parameters
RCCacheEntry | RecentChange$rc
int$fieldOne of DELETED_* bitfield constants
Returns
bool

Definition at line 593 of file ChangesList.php.

Referenced by getArticleLink(), EnhancedChangesList\getLineData(), RCCacheEntryFactory\getUserLink(), insertComment(), insertUserRelatedLinks(), RCCacheEntryFactory\newFromRecentChange(), and EnhancedChangesList\recentChangesBlockGroup().

static ChangesList::isUnpatrolled (   $rc,
User  $user 
)
static
Parameters
object | RecentChange$rcDatabase row from recentchanges or a RecentChange object
User$user
Returns
bool

Definition at line 709 of file ChangesList.php.

References RC_NEW, User\useFilePatrol(), User\useNPPatrol(), and User\useRCPatrol().

Referenced by ApiQueryWatchlist\extractOutputData(), ApiQueryRecentChanges\extractRowInfo(), and RCCacheEntryFactory\newFromRecentChange().

ChangesList::isWatchlist ( )
Returns
bool True when setWatchlistDivs has been called
Since
1.23

Definition at line 130 of file ChangesList.php.

References $watchlist.

ChangesList::maybeWatchedLink (   $link,
  $watched = false 
)
protected
Parameters
string$link
bool$watched
Returns
string

Definition at line 618 of file ChangesList.php.

References $link.

Referenced by EnhancedChangesList\recentChangesBlockGroup().

static ChangesList::newFromContext ( IContextSource  $context,
array  $groups = [] 
)
static

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

Parameters
IContextSource$context
array$groupsArray of ChangesListFilterGroup objects (currently optional)
Returns
ChangesList

Definition at line 88 of file ChangesList.php.

References $user, IContextSource\getRequest(), IContextSource\getSkin(), IContextSource\getUser(), and Hooks\run().

Referenced by SpecialWatchlist\outputChangesList(), and SpecialRecentChanges\outputChangesList().

ChangesList::numberofWatchingusers (   $count)
protected

Returns the string which indicates the number of watching users.

Parameters
int$countNumber of user watching a page
Returns
string

Definition at line 574 of file ChangesList.php.

References $cache, $watchMsgCache, ContextSource\msg(), and use.

Referenced by OldChangesList\formatChangeLine(), EnhancedChangesList\recentChangesBlockGroup(), and EnhancedChangesList\recentChangesBlockLine().

ChangesList::preCacheMessages ( )
private

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 138 of file ChangesList.php.

References as, message, and ContextSource\msg().

Referenced by __construct().

ChangesList::recentChangesFlags (   $flags,
  $nothing = '&#160;' 
)

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

Parameters
array$flagsAssociative array of 'flag' => Bool
string$nothingTo use for empty space
Returns
string

Definition at line 155 of file ChangesList.php.

References $flags, as, ContextSource\getConfig(), and ContextSource\getContext().

Referenced by OldChangesList\formatChangeLine(), EnhancedChangesList\getLineData(), EnhancedChangesList\recentChangesBlockGroup(), and EnhancedChangesList\recentChangesBlockLine().

ChangesList::recentChangesLine ( $rc,
  $watched = false,
  $linenumber = null 
)

Format a line.

Since
1.27
Parameters
RecentChange&$rcPassed by reference
bool$watched(default false)
int$linenumber(default null)
Returns
string|bool

Definition at line 114 of file ChangesList.php.

ChangesList::setChangeLinePrefixer ( callable  $prefixer)

Sets the callable that generates a change line prefix added to the beginning of each line.

Parameters
callable$prefixerCallable to run that generates the change line prefix. Takes three parameters: a RecentChange object, a ChangesList object, and whether the current entry is a grouped entry.

Definition at line 782 of file ChangesList.php.

ChangesList::setWatchlistDivs (   $value = true)

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

Parameters
bool$value

Definition at line 122 of file ChangesList.php.

References $value.

ChangesList::showAsUnpatrolled ( RecentChange  $rc)
protected

Definition at line 700 of file ChangesList.php.

References ContextSource\getUser().

Referenced by OldChangesList\formatChangeLine().

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

Show formatted char difference.

Needs the css module 'mediawiki.special.changeslist' to style output

Parameters
int$oldNumber of bytes
int$newNumber of bytes
IContextSource$context
Returns
string

Definition at line 289 of file ChangesList.php.

References $code, ContextSource\$context, $lang, $tag, Html\element(), IContextSource\getConfig(), IContextSource\getLanguage(), RequestContext\getMain(), and MessageLocalizer\msg().

Referenced by ContribsPager\formatRow(), RecentChange\getCharacterDifference(), and HistoryPager\historyLine().

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
RCCacheEntry | RecentChange$rc
int$field
User$userUser object to check, or null to use $wgUser
Returns
bool

Definition at line 605 of file ChangesList.php.

References $user, RC_LOG, LogEventsList\userCanBitfield(), and Revision\userCanBitfield().

Referenced by EnhancedChangesList\getLineData(), EnhancedChangesList\getLogText(), and RCCacheEntryFactory\showDiffLinks().

Member Data Documentation

callable ChangesList::$changeLinePrefixer
protected

Definition at line 45 of file ChangesList.php.

array ChangesList::$filterGroups
protected

Definition at line 58 of file ChangesList.php.

Referenced by EnhancedChangesList\__construct(), and __construct().

ChangesList::$lastdate
protected

Definition at line 37 of file ChangesList.php.

LinkRenderer ChangesList::$linkRenderer
protected

Definition at line 53 of file ChangesList.php.

ChangesList::$message
protected

Definition at line 38 of file ChangesList.php.

ChangesList::$rc_cache
protected

Definition at line 39 of file ChangesList.php.

ChangesList::$rcCacheIndex
protected

Definition at line 40 of file ChangesList.php.

ChangesList::$rclistOpen
protected

Definition at line 41 of file ChangesList.php.

ChangesList::$rcMoveIndex
protected

Definition at line 42 of file ChangesList.php.

Skin ChangesList::$skin

Definition at line 34 of file ChangesList.php.

ChangesList::$watchlist = false
protected

Definition at line 36 of file ChangesList.php.

Referenced by isWatchlist().

BagOStuff ChangesList::$watchMsgCache
protected

Definition at line 48 of file ChangesList.php.

Referenced by numberofWatchingusers().

const ChangesList::CSS_CLASS_PREFIX = 'mw-changeslist-'

Definition at line 29 of file ChangesList.php.

Referenced by ChangesListFilter\getCssClass().


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