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

Public Member Functions

 __construct ( $obj)
 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...
 
 getTimestamp ( $rc)
 Get the timestamp from $rc formatted with current user's settings and a separator. More...
 
 initChangesListRows ( $rows)
 
 insertArticleLink (&$s, &$rc, $unpatrolled, $watched)
 
 insertComment ( $rc)
 Insert a formatted comment. More...
 
 insertDateHeader (&$s, $rc_timestamp)
 
 insertDiffHist (&$s, &$rc, $unpatrolled)
 
 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...
 
 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 RequestContext object. More...
 
 getLang ()
 Get the Language 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...
 
 getTitle ()
 Get the Title object. More...
 
 getUser ()
 Get the User object. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ()
 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)
 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. More...
 
static isDeleted ( $rc, $field)
 Determine if said field of a revision is hidden. More...
 
static isUnpatrolled ( $rc, User $user)
 
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. More...
 
static showCharacterDifference ( $old, $new, IContextSource $context=null)
 Show formatted char difference. More...
 
static usePatrol ()
 Check whether to enable recent changes patrol features. 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
 

Protected Member Functions

 maybeWatchedLink ( $link, $watched=false)
 
 numberofWatchingusers ( $count)
 Returns the string which indicates the number of watching users. More...
 
 showAsUnpatrolled (RecentChange $rc)
 

Protected Attributes

 $lastdate
 
 $message
 
 $rc_cache
 
 $rcCacheIndex
 
 $rclistOpen
 
 $rcMoveIndex
 
 $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. More...
 

Detailed Description

Definition at line 25 of file ChangesList.php.

Constructor & Destructor Documentation

◆ __construct()

ChangesList::__construct (   $obj)

Changeslist constructor.

Parameters
Skin | IContextSource$obj

Reimplemented in EnhancedChangesList.

Definition at line 43 of file ChangesList.php.

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

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

References array(), and ContextSource\getOutput().

◆ endRecentChangesList()

ChangesList::endRecentChangesList ( )

Returns text for the end of RC.

Returns
String

Reimplemented in EnhancedChangesList.

Definition at line 262 of file ChangesList.php.

References $out.

◆ flag()

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
string$flagOne key of $wgRecentChangesFlags
Returns
string Raw HTML

Definition at line 132 of file ChangesList.php.

References $value, array(), as, Sanitizer\escapeClass(), global, and wfMessage().

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

◆ formatCharacterDifference()

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

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

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

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

◆ getTimestamp()

ChangesList::getTimestamp (   $rc)

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

Parameters
$rcRecentChange
Returns
string HTML fragment

Definition at line 374 of file ChangesList.php.

References ContextSource\getLanguage(), and message.

Referenced by insertTimestamp().

◆ initChangesListRows()

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

Definition at line 178 of file ChangesList.php.

References array(), and wfRunHooks().

◆ insertArticleLink()

ChangesList::insertArticleLink ( $s,
$rc,
  $unpatrolled,
  $watched 
)

◆ insertComment()

ChangesList::insertComment (   $rc)

◆ insertDateHeader()

ChangesList::insertDateHeader ( $s,
  $rc_timestamp 
)
Parameters
string$sHTML to update
$rc_timestampmixed

Definition at line 273 of file ChangesList.php.

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

Referenced by OldChangesList\recentChangesLine().

◆ insertDiffHist()

ChangesList::insertDiffHist ( $s,
$rc,
  $unpatrolled 
)
Parameters
string$sHTML to update
$rcRecentChange
$unpatrolled

Definition at line 302 of file ChangesList.php.

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

Referenced by OldChangesList\recentChangesLine().

◆ insertExtra()

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

Definition at line 561 of file ChangesList.php.

Referenced by OldChangesList\recentChangesLine().

◆ insertLog()

ChangesList::insertLog ( $s,
  $title,
  $logtype 
)
Parameters
string$sHTML to update
$titleTitle
$logtypestring

Definition at line 291 of file ChangesList.php.

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

Referenced by OldChangesList\recentChangesLine().

◆ insertLogEntry()

ChangesList::insertLogEntry (   $rc)

◆ insertRollback()

ChangesList::insertRollback ( $s,
$rc 
)

◆ insertTags()

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

◆ insertTimestamp()

ChangesList::insertTimestamp ( $s,
  $rc 
)

Insert time timestamp string from $rc into $s.

Parameters
string$sHTML to update
$rcRecentChange

Definition at line 389 of file ChangesList.php.

References $s, and getTimestamp().

Referenced by OldChangesList\recentChangesLine().

◆ insertUserRelatedLinks()

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

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

Referenced by OldChangesList\recentChangesLine().

◆ isDeleted()

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

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

◆ isUnpatrolled()

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

References $user, and RC_NEW.

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

◆ isWatchlist()

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

Definition at line 86 of file ChangesList.php.

References $watchlist.

◆ maybeWatchedLink()

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

Definition at line 507 of file ChangesList.php.

References $link.

Referenced by EnhancedChangesList\recentChangesBlockGroup().

◆ newFromContext()

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
IContextSource$context
Returns
ChangesList derivative

Definition at line 61 of file ChangesList.php.

References ContextSource\$context, $user, array(), IContextSource\getRequest(), IContextSource\getSkin(), IContextSource\getUser(), and wfRunHooks().

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

◆ numberofWatchingusers()

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

References $cache, $count, array(), and ContextSource\msg().

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

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

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

Referenced by __construct().

◆ recentChangesFlags()

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

References $f, $flags, as, flag(), and global.

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

◆ setWatchlistDivs()

ChangesList::setWatchlistDivs (   $value = true)

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

Parameters
$valueBoolean

Definition at line 78 of file ChangesList.php.

References $value.

◆ showAsUnpatrolled()

ChangesList::showAsUnpatrolled ( RecentChange  $rc)
protected

Definition at line 565 of file ChangesList.php.

References ContextSource\getUser(), and isUnpatrolled().

Referenced by OldChangesList\recentChangesLine().

◆ showCharacterDifference()

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

Show formatted char difference.

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

Definition at line 189 of file ChangesList.php.

References ContextSource\$context, array(), Html\element(), IContextSource\getLanguage(), RequestContext\getMain(), global, and IContextSource\msg().

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

◆ usePatrol()

static ChangesList::usePatrol ( )
static

Check whether to enable recent changes patrol features.

Deprecated:
since 1.22
Returns
Boolean

Definition at line 449 of file ChangesList.php.

References $wgUser, global, and wfDeprecated().

◆ 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$userUser object to check, or null to use $wgUser
Returns
bool

Definition at line 494 of file ChangesList.php.

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

Referenced by EnhancedChangesList\recentChangesBlockGroup(), and RCCacheEntryFactory\showDiffLinks().

Member Data Documentation

◆ $lastdate

ChangesList::$lastdate
protected

Definition at line 31 of file ChangesList.php.

◆ $message

ChangesList::$message
protected

Definition at line 32 of file ChangesList.php.

◆ $rc_cache

ChangesList::$rc_cache
protected

Definition at line 33 of file ChangesList.php.

◆ $rcCacheIndex

ChangesList::$rcCacheIndex
protected

Definition at line 34 of file ChangesList.php.

◆ $rclistOpen

ChangesList::$rclistOpen
protected

Definition at line 35 of file ChangesList.php.

◆ $rcMoveIndex

ChangesList::$rcMoveIndex
protected

Definition at line 36 of file ChangesList.php.

◆ $skin

Skin ChangesList::$skin

Definition at line 28 of file ChangesList.php.

◆ $watchlist

ChangesList::$watchlist = false
protected

Definition at line 30 of file ChangesList.php.

Referenced by isWatchlist().


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