Inheritance diagram for ChangesList:

[legend]

Collaboration diagram for ChangesList:

[legend]

Public Member Functions
	__construct ( $obj, array $filterGroups=[])

	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.

	getArticleLink (&$rc, $unpatrolled, $watched)
	Get the HTML link to the changed page, possibly with a prefix from hook handlers, and a suffix for temporarily watched items.

	getRollback (RecentChange $rc)

	getTags (RecentChange $rc, array &$classes)

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

	getWatchlistExpiry (RecentChange $recentChange)
	Get HTML to display the clock icon for watched items that have a watchlist expiry time.

	initChangesListRows ( $rows)

	insertComment ( $rc)
	Insert a formatted comment.

	insertDateHeader (&$s, $rc_timestamp)

	insertDiffHist (&$s, &$rc, $unpatrolled=null)

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

	insertLog (&$s, $title, $logtype, $useParentheses=true)

	insertLogEntry ( $rc)
	Insert a formatted action.

	insertRollback (&$s, &$rc)
	Insert a rollback link.

	insertTags (&$s, &$rc, &$classes)

	insertTimestamp (&$s, $rc)
	Insert time timestamp string from $rc into $s.

	insertUserRelatedLinks (&$s, &$rc)
	Insert links to user page, user talk page and eventually a blocking link.

	isWatchlist ()

	recentChangesFlags ( $flags, $nothing="\u{00A0}")
	Returns the appropriate flags for new page, minor change and patrolling.

	recentChangesLine (&$rc, $watched=false, $linenumber=null)
	Format a line.

	setChangeLinePrefixer (callable $prefixer)
	Sets the callable that generates a change line prefix added to the beginning of each line.

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

Public Member Functions inherited from ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()
	Stable to override.

	getWikiPage ()
	Get the WikiPage object.

	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()

	setContext (IContextSource $context)

Static Public Member Functions
static	flag ( $flag, IContextSource $context=null)
	Make an "<abbr>" element for a given change flag.

static	isDeleted ( $rc, $field)
	Determine if said field of a revision is hidden.

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.

static	revDateLink (RevisionRecord $rev, User $user, Language $lang, $title=null)
	Render the date and time of a revision in the current user language based on whether the user is able to view this information or not.

static	showCharacterDifference ( $old, $new, IContextSource $context=null)
	Show formatted char difference.

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

const	CSS_CLASS_PREFIX = 'mw-changeslist-'

Protected Member Functions
	getDataAttributes (RecentChange $rc)
	Get recommended data attributes for a change line.

	getHighlightsContainerDiv ()
	Get the container for highlights that are used in the new StructuredFilters system.

	getHTMLClasses ( $rc, $watched)
	Get an array of default HTML class attributes for the change.

	getHTMLClassesForFilters ( $rc)
	Get an array of CSS classes attributed to filters for this row.

	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.

	maybeWatchedLink ( $link, $watched=false)

	numberofWatchingusers ( $count)
	Returns the string which indicates the number of watching users.

	showAsUnpatrolled (RecentChange $rc)

Protected Attributes
callable	$changeLinePrefixer

array	$filterGroups

	$lastdate

LinkRenderer	$linkRenderer

	$message

	$rc_cache

	$rcCacheIndex

	$rclistOpen

	$rcMoveIndex

	$watchlist = false

MapCacheLRU	$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.

Detailed Description

Definition at line 34 of file ChangesList.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

Skin \| IContextSource	$obj
array	$filterGroups	Array of ChangesListFilterGroup objects (currently optional)

Reimplemented in EnhancedChangesList.

Definition at line 72 of file ChangesList.php.

References preCacheMessages(), and ContextSource\setContext().

Member Function Documentation

◆ beginRecentChangesList()

ChangesList::beginRecentChangesList ( )

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

Returns: string

Reimplemented in EnhancedChangesList.

Definition at line 302 of file ChangesList.php.

References ContextSource\getOutput().

◆ endRecentChangesList()

ChangesList::endRecentChangesList ( )

Returns text for the end of RC.

Returns: string

Reimplemented in EnhancedChangesList.

Definition at line 407 of file ChangesList.php.

◆ flag()

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	$flag	One key of $wgRecentChangesFlags
IContextSource \| null	$context

Returns: string HTML

Definition at line 269 of file ChangesList.php.

References ContextSource\$context, $wgRecentChangesFlags, ContextSource\setContext(), and wfMessage().

◆ formatCharacterDifference()

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

Format the character difference of one or several changes.

Parameters

RecentChange	$old
RecentChange \| null	$new	Last change to use, if not provided, $old will be used

Returns: string HTML fragment

Definition at line 387 of file ChangesList.php.

References getContext().

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

◆ getArticleLink()

ChangesList::getArticleLink	(	&	$rc,
			$unpatrolled,
			$watched )

Get the HTML link to the changed page, possibly with a prefix from hook handlers, and a suffix for temporarily watched items.

Parameters

RecentChange	&$rc
bool	$unpatrolled
bool	$watched

Returns: string HTML

Since: 1.26

Definition at line 551 of file ChangesList.php.

References $s, ContextSource\getLanguage(), getWatchlistExpiry(), and isDeleted().

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

◆ getDataAttributes()

ChangesList::getDataAttributes ( RecentChange $rc )

protected

Get recommended data attributes for a change line.

Parameters

RecentChange $rc

Returns: string[] attribute name => value

Definition at line 913 of file ChangesList.php.

References $type, and RecentChange\getAttribute().

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

◆ getHighlightsContainerDiv()

ChangesList::getHighlightsContainerDiv ( )

protected

Get the container for highlights that are used in the new StructuredFilters system.

Returns: string HTML structure of the highlight container div

Definition at line 130 of file ChangesList.php.

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

◆ getHTMLClasses()

ChangesList::getHTMLClasses	(		$rc,
			$watched )

protected

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

Parameters

RecentChange \| RCCacheEntry	$rc
string \| bool	$watched	Optionally timestamp for adding watched class

Returns: string[] List of CSS class names

Definition at line 206 of file ChangesList.php.

References getHTMLClassesForFilters().

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

◆ getHTMLClassesForFilters()

ChangesList::getHTMLClassesForFilters ( $rc )

protected

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

Used for highlighting in the front-end.

Parameters

RecentChange $rc

Returns: array Array of CSS classes

Definition at line 237 of file ChangesList.php.

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

◆ getRollback()

ChangesList::getRollback ( RecentChange $rc )

Parameters

RecentChange $rc

Returns: string

Since: 1.26

Definition at line 818 of file ChangesList.php.

References $s.

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

◆ getTags()

ChangesList::getTags	(	RecentChange	$rc,
		array &	$classes )

Parameters

RecentChange	$rc
array	&$classes

Returns: string

Since: 1.26

Definition at line 849 of file ChangesList.php.

References $s.

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

◆ getTimestamp()

ChangesList::getTimestamp ( $rc )

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

Parameters

RecentChange $rc

Deprecated: use revDateLink instead.

Returns: string HTML fragment

Definition at line 624 of file ChangesList.php.

◆ getWatchlistExpiry()

ChangesList::getWatchlistExpiry ( RecentChange $recentChange )

Get HTML to display the clock icon for watched items that have a watchlist expiry time.

Since: 1.35

Parameters

RecentChange $recentChange

Returns: string The HTML to display an indication of the expiry time.

Definition at line 591 of file ChangesList.php.

◆ initChangesListRows()

ChangesList::initChangesListRows ( $rows )

Parameters

IResultWrapper | array $rows

Definition at line 319 of file ChangesList.php.

◆ insertComment()

ChangesList::insertComment ( $rc )

Insert a formatted comment.

Parameters

RecentChange $rc

Returns: string

Definition at line 696 of file ChangesList.php.

References Linker\commentBlock().

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

◆ insertDateHeader()

ChangesList::insertDateHeader	(	&	$s,
			$rc_timestamp )

Parameters

string	&$s	HTML to update
mixed	$rc_timestamp

Definition at line 457 of file ChangesList.php.

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

Referenced by OldChangesList\recentChangesLine().

◆ insertDiffHist()

ChangesList::insertDiffHist	(	&	$s,
		&	$rc,
			$unpatrolled = null )

Parameters

string	&$s	HTML to update
RecentChange	&$rc
bool \| null	$unpatrolled	Unused variable, since 1.27.

Definition at line 496 of file ChangesList.php.

References $s, getUser(), RC_CATEGORIZE, RC_LOG, and RC_NEW.

Referenced by OldChangesList\formatChangeLine().

◆ insertExtra()

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

Definition at line 855 of file ChangesList.php.

Referenced by OldChangesList\formatChangeLine().

◆ insertLog()

ChangesList::insertLog	(	&	$s,
			$title,
			$logtype,
			$useParentheses = true )

Parameters

string	&$s	HTML to update
Title	$title
string	$logtype
bool	$useParentheses	(optional) Wrap log entry in parentheses where needed

Definition at line 476 of file ChangesList.php.

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

Referenced by OldChangesList\formatChangeLine().

◆ insertLogEntry()

ChangesList::insertLogEntry ( $rc )

Insert a formatted action.

Parameters

RecentChange $rc

Returns: string

Definition at line 680 of file ChangesList.php.

References getContext(), and LogFormatter\newFromRow().

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

◆ insertRollback()

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

Insert a rollback link.

Parameters

string	&$s
RecentChange	&$rc

Definition at line 780 of file ChangesList.php.

References $s, $title, Linker\generateRollback(), getContext(), getPermissionManager(), getUser(), and RC_EDIT.

Referenced by OldChangesList\formatChangeLine().

◆ insertTags()

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

Parameters

string	&$s
RecentChange	&$rc
array	&$classes

Definition at line 829 of file ChangesList.php.

References $s, and ChangeTags\formatSummaryRow().

Referenced by OldChangesList\formatChangeLine().

◆ insertTimestamp()

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

Insert time timestamp string from $rc into $s.

Parameters

string	&$s	HTML to update
RecentChange	$rc

Definition at line 647 of file ChangesList.php.

References $s, and getTimestamp().

Referenced by OldChangesList\formatChangeLine().

◆ insertUserRelatedLinks()

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

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

Parameters

string	&$s	HTML to update
RecentChange	&$rc

Definition at line 657 of file ChangesList.php.

References $s, Linker\userLink(), and Linker\userToolLinks().

Referenced by OldChangesList\formatChangeLine().

◆ isCategorizationWithoutRevision()

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

References RC_CATEGORIZE.

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

◆ isDeleted()

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

static

Determine if said field of a revision is hidden.

Parameters

RCCacheEntry \| RecentChange	$rc
int	$field	One of DELETED_* bitfield constants

Returns: bool

Definition at line 736 of file ChangesList.php.

Referenced by getArticleLink().

◆ isUnpatrolled()

static ChangesList::isUnpatrolled	(		$rc,
		User	$user )

static

Parameters

object \| RecentChange	$rc	Database row from recentchanges or a RecentChange object
User	$user

Returns: bool

Definition at line 868 of file ChangesList.php.

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

◆ isWatchlist()

ChangesList::isWatchlist ( )

Returns: bool True when setWatchlistDivs has been called

Since: 1.23

Definition at line 161 of file ChangesList.php.

◆ maybeWatchedLink()

ChangesList::maybeWatchedLink	(		$link,
			$watched = false )

protected

Parameters

string	$link
bool	$watched

Returns: string

Definition at line 766 of file ChangesList.php.

Referenced by EnhancedChangesList\recentChangesBlockGroup().

◆ newFromContext()

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	$groups	Array of ChangesListFilterGroup objects (currently optional)

Returns: ChangesList

Definition at line 94 of file ChangesList.php.

References IContextSource\getRequest(), IContextSource\getSkin(), and IContextSource\getUser().

◆ numberofWatchingusers()

ChangesList::numberofWatchingusers ( $count )

protected

Returns the string which indicates the number of watching users.

Parameters

int $count Number of user watching a page

Returns: string

Definition at line 716 of file ChangesList.php.

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

◆ preCacheMessages()

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

References ContextSource\msg().

Referenced by __construct().

◆ recentChangesFlags()

ChangesList::recentChangesFlags	(		$flags,
			$nothing = "\u{00A0}" )

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

Parameters

array	$flags	Associative array of 'flag' => Bool
string	$nothing	To use for empty space

Returns: string

Definition at line 187 of file ChangesList.php.

References ContextSource\getConfig(), and getContext().

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

◆ recentChangesLine()

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

Format a line.

Since: 1.27

Parameters

RecentChange	&$rc	Passed by reference
bool	$watched	(default false)
int \| null	$linenumber	(default null)

Returns: string|bool

Reimplemented in EnhancedChangesList, and OldChangesList.

Definition at line 120 of file ChangesList.php.

◆ revDateLink()

static ChangesList::revDateLink	(	RevisionRecord	$rev,
		User	$user,
		Language	$lang,
			$title = null )

static

Render the date and time of a revision in the current user language based on whether the user is able to view this information or not.

Parameters

RevisionRecord	$rev
User	$user
Language	$lang
Title \| null	$title	(optional) where Title does not match the Title associated with the Revision

Definition at line 425 of file ChangesList.php.

References $lang, $title, MediaWiki\Revision\RevisionRecord\getId(), MediaWiki\Revision\RevisionRecord\getPageAsLinkTarget(), MediaWiki\Revision\RevisionRecord\getTimestamp(), MediaWiki\Revision\RevisionRecord\getVisibility(), and MediaWiki\Revision\RevisionRecord\isDeleted().

◆ setChangeLinePrefixer()

ChangesList::setChangeLinePrefixer ( callable $prefixer )

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

Parameters

callable $prefixer Callable 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 941 of file ChangesList.php.

◆ setWatchlistDivs()

ChangesList::setWatchlistDivs ( $value = true )

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

Parameters

bool $value

Definition at line 153 of file ChangesList.php.

◆ showAsUnpatrolled()

ChangesList::showAsUnpatrolled ( RecentChange $rc )

protected

Definition at line 859 of file ChangesList.php.

References getUser().

Referenced by OldChangesList\formatChangeLine().

◆ showCharacterDifference()

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	$old	Number of bytes
int	$new	Number of bytes
IContextSource \| null	$context

Returns: string

Definition at line 333 of file ChangesList.php.

References ContextSource\$context, $lang, IContextSource\getConfig(), IContextSource\getLanguage(), and MessageLocalizer\msg().

◆ userCan()

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 \| null	$user	User object to check against. If null, the global RequestContext's User is assumed instead.

Returns: bool

Definition at line 749 of file ChangesList.php.

References RC_LOG.

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

Member Data Documentation

◆ $changeLinePrefixer

callable ChangesList::$changeLinePrefixer

protected

Definition at line 53 of file ChangesList.php.

◆ $filterGroups

array ChangesList::$filterGroups

protected

Definition at line 66 of file ChangesList.php.

Referenced by EnhancedChangesList\__construct().

◆ $lastdate

ChangesList::$lastdate

protected

Definition at line 45 of file ChangesList.php.

◆ $linkRenderer

LinkRenderer ChangesList::$linkRenderer

protected

Definition at line 61 of file ChangesList.php.

◆ $message

ChangesList::$message

protected

Definition at line 46 of file ChangesList.php.

◆ $rc_cache

ChangesList::$rc_cache

protected

Definition at line 47 of file ChangesList.php.

◆ $rcCacheIndex

ChangesList::$rcCacheIndex

protected

Definition at line 48 of file ChangesList.php.

◆ $rclistOpen

ChangesList::$rclistOpen

protected

Definition at line 49 of file ChangesList.php.

◆ $rcMoveIndex

ChangesList::$rcMoveIndex

protected

Definition at line 50 of file ChangesList.php.

◆ $skin

Skin ChangesList::$skin

Definition at line 42 of file ChangesList.php.

◆ $watchlist

ChangesList::$watchlist = false

protected

Definition at line 44 of file ChangesList.php.

◆ $watchMsgCache

MapCacheLRU ChangesList::$watchMsgCache

protected

Definition at line 56 of file ChangesList.php.

◆ CSS_CLASS_PREFIX

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

Definition at line 37 of file ChangesList.php.

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

includes/changes/ChangesList.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ beginRecentChangesList()

◆ endRecentChangesList()

◆ flag()

◆ formatCharacterDifference()

◆ getArticleLink()

◆ getDataAttributes()

◆ getHighlightsContainerDiv()

◆ getHTMLClasses()

◆ getHTMLClassesForFilters()

◆ getRollback()

◆ getTags()

◆ getTimestamp()

◆ getWatchlistExpiry()

◆ initChangesListRows()

◆ insertComment()

◆ insertDateHeader()

◆ insertDiffHist()

◆ insertExtra()

◆ insertLog()

◆ insertLogEntry()

◆ insertRollback()

◆ insertTags()

◆ insertTimestamp()

◆ insertUserRelatedLinks()

◆ isCategorizationWithoutRevision()

◆ isDeleted()

◆ isUnpatrolled()

◆ isWatchlist()

◆ maybeWatchedLink()

◆ newFromContext()

◆ numberofWatchingusers()

◆ preCacheMessages()

◆ recentChangesFlags()

◆ recentChangesLine()

◆ revDateLink()

◆ setChangeLinePrefixer()

◆ setWatchlistDivs()

◆ showAsUnpatrolled()

◆ showCharacterDifference()

◆ userCan()

Member Data Documentation

◆ $changeLinePrefixer

◆ $filterGroups

◆ $lastdate

◆ $linkRenderer

◆ $message

◆ $rc_cache

◆ $rcCacheIndex

◆ $rclistOpen

◆ $rcMoveIndex

◆ $skin

◆ $watchlist

◆ $watchMsgCache

◆ CSS_CLASS_PREFIX