aboutsummaryrefslogtreecommitdiffstats
path: root/includes/diff/Hook/AbortDiffCacheHook.php
blob: c5d3dc68d237d7cfd23c6e87e9dddb1114e64708 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<?php

namespace MediaWiki\Diff\Hook;

use DifferenceEngine;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "AbortDiffCache" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface AbortDiffCacheHook {
	/**
	 * Use this hook to cancel the caching of a diff.
	 *
	 * @since 1.35
	 *
	 * @param DifferenceEngine $diffEngine
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onAbortDiffCache( $diffEngine );
}