wiki.techinc.nl/includes/content/Hook/GetDifferenceEngineHook.php
James D. Forrester 4bae64d1c7 Namespace includes/context
Bug: T353458
Change-Id: I4dbef138fd0110c14c70214282519189d70c94fb
2024-02-08 11:07:01 -05:00

33 lines
1.1 KiB
PHP

<?php
namespace MediaWiki\Content\Hook;
use DifferenceEngine;
use MediaWiki\Context\IContextSource;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "GetDifferenceEngine" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface GetDifferenceEngineHook {
/**
* This hook is called when getting a new difference engine interface object.
* Use this hook to decorate or replace the default difference engine.
*
* @since 1.35
*
* @param IContextSource $context IContextSource context to be used for diff
* @param int $old Revision ID to show and diff with
* @param int|string $new Either a revision ID or one of the strings 'cur', 'prev' or 'next'
* @param bool $refreshCache If set, refreshes the diff cache
* @param bool $unhide If set, allow viewing deleted revs
* @param DifferenceEngine &$differenceEngine Difference engine object to be used for the diff
* @return bool|void True or no return value to continue or false to abort
*/
public function onGetDifferenceEngine( $context, $old, $new, $refreshCache,
$unhide, &$differenceEngine
);
}