Inheritance diagram for DifferenceEngine:

Collaboration diagram for DifferenceEngine:

Public Member Functions
	__construct ($context=null, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)
	#@-
	addHeader ($diff, $otitle, $ntitle, $multi= '', $notice= '')
	Add the header to a diff body.
	deletedIdMarker ($id)
	Build a wikitext link toward a deleted revision, if viewable.
	deletedLink ($id)
	Look up a special:Undelete link to the given deleted revision id, as a workaround for being unable to load deleted diffs in currently.
	generateContentDiffBody (Content $old, Content $new)
	Generate a diff, no caching.
	generateDiffBody ($otext, $ntext)
	Generate a diff, no caching.
	generateTextDiffBody ($otext, $ntext)
	Generate a diff, no caching.
	getDiff ($otitle, $ntitle, $notice= '')
	Get complete diff table, including header.
	getDiffBody ()
	Get the diff table body, without header.
	getDiffLang ()
	getMultiNotice ()
	If there are revisions between the ones being compared, return a note saying so.
	getNewid ()
	getOldid ()
	loadNewText ()
	Load the text of the new revision, not the old one.
	loadRevisionData ()
	Load revision metadata for the specified articles.
	loadText ()
	Load the text of the revisions, as well as revision data.
	localiseLineNumbers ($text)
	Replace line numbers with the text in the user's language.
	localiseLineNumbersCb ($matches)
	renderNewRevision ()
	Show the new revision of the page.
	setContent (Content $oldContent, Content $newContent)
	Use specified text instead of loading from the database.
	setReducedLineNumbers ($value=true)
	setText ($oldText, $newText)
	Use specified text instead of loading from the database.
	setTextLanguage ($lang)
	Set the language in which the diff text is written (Defaults to page content language).
	showDiff ($otitle, $ntitle, $notice= '')
	Get the diff text, send it to the OutputPage object Returns false if the diff could not be generated, otherwise returns true.
	showDiffPage ($diffOnly=false)
	showDiffStyle ()
	Add style sheets and supporting JS for diff display.
	wasCacheHit ()
Static Public Member Functions
static	intermediateEditsMsg ($numEdits, $numUsers, $limit)
	Get a notice about how many intermediate edits and users there are.
Public Attributes
	$enableDebugComment = false
	Set this to true to add debug info to the HTML output.
	$mCacheHit = false
Content	$mNewContent
	$mNewid
Title	$mNewPage
Revision	$mNewRev
Content	$mOldContent
	$mOldid
	#@+
Title	$mOldPage
Revision	$mOldRev
	$mRcidMarkPatrolled
	$mRevisionsLoaded = false
	$mTextLoaded = 0
Protected Member Functions
	debug ($generator="internal")
	Generate a debug comment indicating diff generating time, server node, and generator backend.
	getParserOutput (WikiPage $page, Revision $rev)
	getRevisionHeader (Revision $rev, $complete= '')
	Get a header for a specified revision.
	markPatrolledLink ()
	Get a link to mark the change as patrolled, or '' if there's either no revision to patrol or the user is not allowed to to it.
	revisionDeleteLink ($rev)
Protected Attributes
	$mDiffLang
	$mMarkPatrolledLink = null
	$mReducedLineNumbers = false
	$unhide = false
Private Member Functions
	initDiffEngines ()
	Make sure the proper modules are loaded before we try to make the diff.
	loadRevisionIds ()
	Load revision IDs.
	showMissingRevision ()
Private Attributes
	$mRevisionsIdsLoaded = false

Detailed Description

Todo:: document

Definition at line 36 of file DifferenceEngine.php.

Constructor & Destructor Documentation

DifferenceEngine::__construct	(	$	context = `null`,
		$	old = `0`,
		$	new = `0`,
		$	rcid = `0`,
		$	refreshCache = `false`,
		$	unhide = `false`
	)

#@-

Constructor

Parameters:

	$context	IContextSource context to use, anything else will be ignored
	$old	Integer old ID we want to show and diff with.
string	$new	either 'prev' or 'next'.
	$rcid	Integer ??? FIXME (default 0)
	$refreshCache	boolean If set, refreshes the diff cache
	$unhide	boolean If set, allow viewing deleted revs

Definition at line 85 of file DifferenceEngine.php.

Member Function Documentation

DifferenceEngine::addHeader	(	$	diff,
		$	otitle,
		$	ntitle,
		$	multi = `''`,
		$	notice = `''`
	)

Add the header to a diff body.

Returns:: string

Definition at line 999 of file DifferenceEngine.php.

DifferenceEngine::debug ( $ generator = "internal" ) [protected]

Generate a debug comment indicating diff generating time, server node, and generator backend.

Returns:: string

Definition at line 865 of file DifferenceEngine.php.

DifferenceEngine::deletedIdMarker ( $ id )

Build a wikitext link toward a deleted revision, if viewable.

Parameters:

int $id revision ID

Returns:: string wikitext fragment

Definition at line 173 of file DifferenceEngine.php.

DifferenceEngine::deletedLink ( $ id )

Look up a special:Undelete link to the given deleted revision id, as a workaround for being unable to load deleted diffs in currently.

Parameters:

int $id revision ID

Returns:: mixed URL or false

Definition at line 149 of file DifferenceEngine.php.

DifferenceEngine::generateContentDiffBody	(	Content $	old,
		Content $	new
	)

Generate a diff, no caching.

This implementation uses generateTextDiffBody() to generate a diff based on the default serialization of the given Content objects. This will fail if $old or $new are not instances of TextContent.

Subclasses may override this to provide a different rendering for the diff, perhaps taking advantage of the content's native form. This is required for all content models that are not text based.

Parameters:

$old	Content: old content
$new	Content: new content

Returns:: bool|string

Since:: 1.21

Exceptions:

MWException if $old or $new are not instances of TextContent.

Definition at line 749 of file DifferenceEngine.php.

DifferenceEngine::generateDiffBody	(	$	otext,
		$	ntext
	)

Generate a diff, no caching.

Parameters:

string	$otext	old text, must be already segmented
string	$ntext	new text, must be already segmented

Returns:: bool|string

Deprecated:: since 1.21, use generateContentDiffBody() instead!

Definition at line 774 of file DifferenceEngine.php.

DifferenceEngine::generateTextDiffBody	(	$	otext,
		$	ntext
	)

Generate a diff, no caching.

Todo:: move this to TextDifferenceEngine, make DifferenceEngine abstract. At some point.

Parameters:

string	$otext	old text, must be already segmented
string	$ntext	new text, must be already segmented

Returns:: bool|string

Definition at line 789 of file DifferenceEngine.php.

DifferenceEngine::getDiff	(	$	otitle,
		$	ntitle,
		$	notice = `''`
	)

Get complete diff table, including header.

Parameters:

string \| bool	$otitle	Header for old text or false
string \| bool	$ntitle	Header for new text or false
string	$notice	HTML between diff header and body

Returns:: mixed

Definition at line 631 of file DifferenceEngine.php.

DifferenceEngine::getDiffBody ( )

Get the diff table body, without header.

Returns:: mixed (string/false)

Definition at line 646 of file DifferenceEngine.php.

DifferenceEngine::getDiffLang ( )

Returns:: Language

Definition at line 111 of file DifferenceEngine.php.

DifferenceEngine::getMultiNotice ( )

If there are revisions between the ones being compared, return a note saying so.

Returns:: string

Definition at line 901 of file DifferenceEngine.php.

DifferenceEngine::getNewid ( )

Returns:: Bool|int

Definition at line 137 of file DifferenceEngine.php.

DifferenceEngine::getOldid ( )

Returns:: int

Definition at line 129 of file DifferenceEngine.php.

DifferenceEngine::getParserOutput	(	WikiPage $	page,
		Revision $	rev
	)		`[protected]`

Definition at line 587 of file DifferenceEngine.php.

DifferenceEngine::getRevisionHeader	(	Revision $	rev,
		$	complete = `''`
	)		`[protected]`

Get a header for a specified revision.

Parameters:

	$rev	Revision
string	$complete	'complete' to get the header wrapped depending the visibility of the revision and a link to edit the page.

Returns:: String HTML fragment

Definition at line 951 of file DifferenceEngine.php.

DifferenceEngine::initDiffEngines ( ) [private]

Make sure the proper modules are loaded before we try to make the diff.

Definition at line 717 of file DifferenceEngine.php.

static DifferenceEngine::intermediateEditsMsg	(	$	numEdits,
		$	numUsers,
		$	limit
	)		`[static]`

Get a notice about how many intermediate edits and users there are.

Parameters:

$numEdits	int
$numUsers	int
$limit	int

Returns:: string

Definition at line 933 of file DifferenceEngine.php.

DifferenceEngine::loadNewText ( )

Load the text of the new revision, not the old one.

Returns:: bool

Definition at line 1208 of file DifferenceEngine.php.

DifferenceEngine::loadRevisionData ( )

Load revision metadata for the specified articles.

If newid is 0, then compare the old article in oldid to the current article; if oldid is 0, then compare the current article to the immediately previous one (ignoring the value of newid).

If oldid is false, leave the corresponding revision object set to false. This is impossible via ordinary user input, and is provided for API convenience.

Returns:: bool

Definition at line 1122 of file DifferenceEngine.php.

DifferenceEngine::loadRevisionIds ( ) [private]

Load revision IDs.

Definition at line 1078 of file DifferenceEngine.php.

DifferenceEngine::loadText ( )

Load the text of the revisions, as well as revision data.

Returns:: bool

Definition at line 1177 of file DifferenceEngine.php.

DifferenceEngine::localiseLineNumbers ( $ text )

Replace line numbers with the text in the user's language.

Returns:: mixed

Definition at line 887 of file DifferenceEngine.php.

DifferenceEngine::localiseLineNumbersCb ( $ matches )

Definition at line 892 of file DifferenceEngine.php.

DifferenceEngine::markPatrolledLink ( ) [protected]

Get a link to mark the change as patrolled, or '' if there's either no revision to patrol or the user is not allowed to to it.

Side effect: When the patrol link is build, this method will call OutputPage::preventClickjacking() and load mediawiki.page.patrol.ajax.

Returns:: String

Definition at line 442 of file DifferenceEngine.php.

DifferenceEngine::renderNewRevision ( )

Show the new revision of the page.

Definition at line 518 of file DifferenceEngine.php.

DifferenceEngine::revisionDeleteLink ( $ rev ) [protected]

Parameters:

$rev Revision

Returns:: String

Definition at line 507 of file DifferenceEngine.php.

DifferenceEngine::setContent	(	Content $	oldContent,
		Content $	newContent
	)

Use specified text instead of loading from the database.

Since:: 1.21

Definition at line 1058 of file DifferenceEngine.php.

DifferenceEngine::setReducedLineNumbers ( $ value = true )

Parameters:

$value bool

Definition at line 104 of file DifferenceEngine.php.

DifferenceEngine::setText	(	$	oldText,
		$	newText
	)

Use specified text instead of loading from the database.

Deprecated:: since 1.21, use setContent() instead.

Definition at line 1045 of file DifferenceEngine.php.

DifferenceEngine::setTextLanguage ( $ lang )

Set the language in which the diff text is written (Defaults to page content language).

Since:: 1.19

Definition at line 1071 of file DifferenceEngine.php.

DifferenceEngine::showDiff	(	$	otitle,
		$	ntitle,
		$	notice = `''`
	)

Get the diff text, send it to the OutputPage object Returns false if the diff could not be generated, otherwise returns true.

Returns:: bool

Definition at line 604 of file DifferenceEngine.php.

DifferenceEngine::showDiffPage ( $ diffOnly = false )

Definition at line 198 of file DifferenceEngine.php.

DifferenceEngine::showDiffStyle ( )

Add style sheets and supporting JS for diff display.

Definition at line 619 of file DifferenceEngine.php.

DifferenceEngine::showMissingRevision ( ) [private]

Definition at line 182 of file DifferenceEngine.php.

DifferenceEngine::wasCacheHit ( )

Returns:: bool

Definition at line 122 of file DifferenceEngine.php.

Member Data Documentation

DifferenceEngine::$enableDebugComment = false

Set this to true to add debug info to the HTML output.

Warning: this may cause RSS readers to spuriously mark articles as "new" (bug 20601)

Definition at line 64 of file DifferenceEngine.php.

DifferenceEngine::$mCacheHit = false

Definition at line 57 of file DifferenceEngine.php.

DifferenceEngine::$mDiffLang [protected]

Definition at line 44 of file DifferenceEngine.php.

DifferenceEngine::$mMarkPatrolledLink = null [protected]

Definition at line 71 of file DifferenceEngine.php.

Content DifferenceEngine::$mNewContent

Definition at line 43 of file DifferenceEngine.php.

DifferenceEngine::$mNewid

Definition at line 40 of file DifferenceEngine.php.

Title DifferenceEngine::$mNewPage

Definition at line 48 of file DifferenceEngine.php.

Revision DifferenceEngine::$mNewRev

Definition at line 53 of file DifferenceEngine.php.

Content DifferenceEngine::$mOldContent

Definition at line 43 of file DifferenceEngine.php.

DifferenceEngine::$mOldid

#@+

Access:: private

Definition at line 40 of file DifferenceEngine.php.

Title DifferenceEngine::$mOldPage

Definition at line 48 of file DifferenceEngine.php.

Revision DifferenceEngine::$mOldRev

Definition at line 53 of file DifferenceEngine.php.

DifferenceEngine::$mRcidMarkPatrolled

Definition at line 49 of file DifferenceEngine.php.

DifferenceEngine::$mReducedLineNumbers = false [protected]

Definition at line 68 of file DifferenceEngine.php.

DifferenceEngine::$mRevisionsIdsLoaded = false [private]

Definition at line 54 of file DifferenceEngine.php.

DifferenceEngine::$mRevisionsLoaded = false

Definition at line 55 of file DifferenceEngine.php.

DifferenceEngine::$mTextLoaded = 0

Definition at line 56 of file DifferenceEngine.php.

DifferenceEngine::$unhide = false [protected]

Definition at line 73 of file DifferenceEngine.php.

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

includes/diff/DifferenceEngine.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation