[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/changes/ -> ChangesList.php (summary)

(no description)

File Size: 596 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ChangesList:: (31 methods):
  __construct()
  newFromContext()
  setWatchlistDivs()
  isWatchlist()
  preCacheMessages()
  recentChangesFlags()
  flag()
  beginRecentChangesList()
  initChangesListRows()
  showCharacterDifference()
  formatCharacterDifference()
  endRecentChangesList()
  insertDateHeader()
  insertLog()
  insertDiffHist()
  insertArticleLink()
  getTimestamp()
  insertTimestamp()
  insertUserRelatedLinks()
  insertLogEntry()
  insertComment()
  usePatrol()
  numberofWatchingusers()
  isDeleted()
  userCan()
  maybeWatchedLink()
  insertRollback()
  insertTags()
  insertExtra()
  showAsUnpatrolled()
  isUnpatrolled()


Class: ChangesList  - X-Ref

Base class for all changes lists.

The class is used for formatting recent changes, related changes and watchlist.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
http://www.gnu.org/copyleft/gpl.html

__construct( $obj )   X-Ref
Changeslist constructor

param: Skin|IContextSource $obj

newFromContext( IContextSource $context )   X-Ref
Fetch an appropriate changes list class for the specified context
Some users might want to use an enhanced list format, for instance

param: IContextSource $context
return: ChangesList

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

param: bool $value

isWatchlist()   X-Ref

return: bool True when setWatchlistDivs has been called

preCacheMessages()   X-Ref
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


recentChangesFlags( $flags, $nothing = '&)   X-Ref
Returns the appropriate flags for new page, minor change and patrolling

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

flag( $flag )   X-Ref
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.

param: string $flag One key of $wgRecentChangesFlags
return: string Raw HTML

beginRecentChangesList()   X-Ref
Returns text for the start of the tabular part of RC

return: string

initChangesListRows( $rows )   X-Ref

param: ResultWrapper|array $rows

showCharacterDifference( $old, $new, IContextSource $context = null )   X-Ref
Show formatted char difference

param: int $old Number of bytes
param: int $new Number of bytes
param: IContextSource $context
return: string

formatCharacterDifference( RecentChange $old, RecentChange $new = null )   X-Ref
Format the character difference of one or several changes.

param: RecentChange $old
param: RecentChange $new Last change to use, if not provided, $old will be used
return: string HTML fragment

endRecentChangesList()   X-Ref
Returns text for the end of RC

return: string

insertDateHeader( &$s, $rc_timestamp )   X-Ref

param: string $s HTML to update
param: mixed $rc_timestamp

insertLog( &$s, $title, $logtype )   X-Ref

param: string $s HTML to update
param: Title $title
param: string $logtype

insertDiffHist( &$s, &$rc, $unpatrolled )   X-Ref

param: string $s HTML to update
param: RecentChange $rc
param: bool $unpatrolled

insertArticleLink( &$s, &$rc, $unpatrolled, $watched )   X-Ref

param: string $s HTML to update
param: RecentChange $rc
param: bool $unpatrolled
param: bool $watched

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

param: RecentChange $rc
return: string HTML fragment

insertTimestamp( &$s, $rc )   X-Ref
Insert time timestamp string from $rc into $s

param: string $s HTML to update
param: RecentChange $rc

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

param: string &$s HTML to update
param: RecentChange &$rc

insertLogEntry( $rc )   X-Ref
Insert a formatted action

param: RecentChange $rc
return: string

insertComment( $rc )   X-Ref
Insert a formatted comment

param: RecentChange $rc
return: string

usePatrol()   X-Ref
Check whether to enable recent changes patrol features

return: bool

numberofWatchingusers( $count )   X-Ref
Returns the string which indicates the number of watching users

param: int $count Number of user watching a page
return: string

isDeleted( $rc, $field )   X-Ref
Determine if said field of a revision is hidden

param: RCCacheEntry|RecentChange $rc
param: int $field One of DELETED_* bitfield constants
return: bool

userCan( $rc, $field, User $user = null )   X-Ref
Determine if the current user is allowed to view a particular
field of this revision, if it's marked as deleted.

param: RCCacheEntry|RecentChange $rc
param: int $field
param: User $user User object to check, or null to use $wgUser
return: bool

maybeWatchedLink( $link, $watched = false )   X-Ref

param: string $link
param: bool $watched
return: string

insertRollback( &$s, &$rc )   X-Ref
No description

insertTags( &$s, &$rc, &$classes )   X-Ref

param: string $s
param: RecentChange $rc
param: array $classes

insertExtra( &$s, &$rc, &$classes )   X-Ref
No description

showAsUnpatrolled( RecentChange $rc )   X-Ref
No description

isUnpatrolled( $rc, User $user )   X-Ref

param: object|RecentChange $rc Database row from recentchanges or a RecentChange object
param: User $user
return: bool



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1