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

List of all members.

Public Member Functions

 __construct ($obj)
 Changeslist constructor.
 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.
 getTimestamp ($rc)
 Get the timestamp from $rc formatted with current user's settings and a separator.
 initChangesListRows ($rows)
 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)
 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= ' ')
 Returns the appropriate flags for new page, minor change and patrolling.
 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 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.
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.
 showAsUnpatrolled (RecentChange $rc)

Protected Attributes

 $lastdate
 $message
 $rc_cache
 $rcCacheIndex
 $rclistOpen
 $rcMoveIndex
MapCacheLRU $watchingCache
 *
 $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

Definition at line 25 of file ChangesList.php.


Constructor & Destructor Documentation

Changeslist constructor.

Parameters:
Skin | IContextSource$obj

Reimplemented in EnhancedChangesList.

Definition at line 45 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 166 of file ChangesList.php.

Returns text for the end of RC.

Returns:
string

Reimplemented in EnhancedChangesList.

Definition at line 263 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:
string$flagOne key of $wgRecentChangesFlags
Returns:
string Raw HTML

Definition at line 134 of file ChangesList.php.

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

Referenced by OldChangesList\formatChangeLine().

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

Parameters:
RecentChange$rc
Returns:
string HTML fragment

Definition at line 378 of file ChangesList.php.

Parameters:
ResultWrapper | array$rows

Definition at line 180 of file ChangesList.php.

ChangesList::insertArticleLink ( &$  s,
&$  rc,
unpatrolled,
watched 
)
Parameters:
string$sHTML to update
RecentChange$rc
bool$unpatrolled
bool$watched

Definition at line 345 of file ChangesList.php.

Referenced by OldChangesList\formatChangeLine().

Insert a formatted comment.

Parameters:
RecentChange$rc
Returns:
string

Definition at line 434 of file ChangesList.php.

Referenced by OldChangesList\formatChangeLine().

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

Definition at line 274 of file ChangesList.php.

Referenced by OldChangesList\recentChangesLine().

ChangesList::insertDiffHist ( &$  s,
&$  rc,
unpatrolled 
)
Parameters:
string$sHTML to update
RecentChange$rc
bool$unpatrolled

Definition at line 303 of file ChangesList.php.

Referenced by OldChangesList\formatChangeLine().

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

Definition at line 561 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 292 of file ChangesList.php.

Referenced by OldChangesList\formatChangeLine().

Insert a formatted action.

Parameters:
RecentChange$rc
Returns:
string

Definition at line 420 of file ChangesList.php.

Referenced by OldChangesList\formatChangeLine().

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

Inserts a rollback link.

Parameters:
string$s
RecentChange$rc

Definition at line 520 of file ChangesList.php.

Referenced by OldChangesList\formatChangeLine().

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

Definition at line 548 of file ChangesList.php.

Referenced by OldChangesList\formatChangeLine().

ChangesList::insertTimestamp ( &$  s,
rc 
)

Insert time timestamp string from $rc into $s.

Parameters:
string$sHTML to update
RecentChange$rc

Definition at line 393 of file ChangesList.php.

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

Referenced by OldChangesList\formatChangeLine().

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.

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.

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

Returns:
bool True when setWatchlistDivs has been called
Since:
1.23

Definition at line 89 of file ChangesList.php.

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

Definition at line 507 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:
IContextSource$context
Returns:
ChangesList

Definition at line 64 of file ChangesList.php.

Referenced by SpecialRecentChanges\outputChangesList(), and SpecialWatchlist\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 462 of file ChangesList.php.

Referenced by OldChangesList\formatChangeLine().

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

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

Referenced by OldChangesList\formatChangeLine().

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

Parameters:
bool$value

Definition at line 81 of file ChangesList.php.

Definition at line 565 of file ChangesList.php.

Referenced by OldChangesList\formatChangeLine().

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

static ChangesList::usePatrol ( ) [static]

Check whether to enable recent changes patrol features.

Deprecated:
since 1.22
Returns:
bool

Definition at line 449 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:
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.


Member Data Documentation

ChangesList::$lastdate [protected]

Definition at line 31 of file ChangesList.php.

ChangesList::$message [protected]

Definition at line 32 of file ChangesList.php.

ChangesList::$rc_cache [protected]

Reimplemented in EnhancedChangesList.

Definition at line 33 of file ChangesList.php.

ChangesList::$rcCacheIndex [protected]

Definition at line 34 of file ChangesList.php.

ChangesList::$rclistOpen [protected]

Definition at line 35 of file ChangesList.php.

ChangesList::$rcMoveIndex [protected]

Definition at line 36 of file ChangesList.php.

Skin ChangesList::$skin

Definition at line 28 of file ChangesList.php.

MapCacheLRU ChangesList::$watchingCache [protected]

*

Definition at line 38 of file ChangesList.php.

ChangesList::$watchlist = false [protected]

Definition at line 30 of file ChangesList.php.


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