MediaWiki  master
DifferenceEngineSlotDiffRenderer Class Reference

B/C adapter for turning a DifferenceEngine into a SlotDiffRenderer. More...

Inheritance diagram for DifferenceEngineSlotDiffRenderer:
Collaboration diagram for DifferenceEngineSlotDiffRenderer:

Public Member Functions

 __construct (DifferenceEngine $differenceEngine)
 
 addModules (OutputPage $output)
 Add modules needed for correct styling/behavior of the diff. More...
 
 getDiff (Content $oldContent=null, Content $newContent=null)
 Get a diff between two content objects.One of them might be null (meaning a slot was created or removed), but both cannot be. $newContent (or if it's null then $oldContent) must have the same content model that was used to obtain this diff renderer.

Parameters
Content | null$oldContent
Content | null$newContent
Returns
string HTML, one or more
More...
 
 getExtraCacheKeys ()
 Return any extra keys to split the diff cache by. More...
 

Private Attributes

DifferenceEngine $differenceEngine
 

Additional Inherited Members

- Protected Member Functions inherited from SlotDiffRenderer
 normalizeContents (Content &$oldContent=null, Content &$newContent=null, $allowedClasses=null)
 Helper method to normalize the input of getDiff(). More...
 

Detailed Description

B/C adapter for turning a DifferenceEngine into a SlotDiffRenderer.

Before SlotDiffRenderer was introduced, getDiff() functionality was provided by DifferenceEngine subclasses. Convert such a subclass into a SlotDiffRenderer.

Deprecated:

Definition at line 32 of file DifferenceEngineSlotDiffRenderer.php.

Constructor & Destructor Documentation

◆ __construct()

DifferenceEngineSlotDiffRenderer::__construct ( DifferenceEngine  $differenceEngine)

Member Function Documentation

◆ addModules()

DifferenceEngineSlotDiffRenderer::addModules ( OutputPage  $output)

Add modules needed for correct styling/behavior of the diff.

Parameters
OutputPage$output

Reimplemented from SlotDiffRenderer.

Definition at line 57 of file DifferenceEngineSlotDiffRenderer.php.

References ContextSource\getOutput().

◆ getDiff()

DifferenceEngineSlotDiffRenderer::getDiff ( Content  $oldContent = null,
Content  $newContent = null 
)

Get a diff between two content objects.One of them might be null (meaning a slot was created or removed), but both cannot be. $newContent (or if it's null then $oldContent) must have the same content model that was used to obtain this diff renderer.

Parameters
Content | null$oldContent
Content | null$newContent
Returns
string HTML, one or more

Reimplemented from SlotDiffRenderer.

Definition at line 52 of file DifferenceEngineSlotDiffRenderer.php.

References SlotDiffRenderer\normalizeContents().

◆ getExtraCacheKeys()

DifferenceEngineSlotDiffRenderer::getExtraCacheKeys ( )

Return any extra keys to split the diff cache by.

Returns
array

Reimplemented from SlotDiffRenderer.

Definition at line 71 of file DifferenceEngineSlotDiffRenderer.php.

Member Data Documentation

◆ $differenceEngine

DifferenceEngine DifferenceEngineSlotDiffRenderer::$differenceEngine
private

Definition at line 35 of file DifferenceEngineSlotDiffRenderer.php.

Referenced by __construct().


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