File: GetDifferenceEngineHook.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (33 lines) | stat: -rw-r--r-- 1,159 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<?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
	);
}