1	<?php
2
3	namespace MediaWiki\Extension\AbuseFilter\Hooks;
4
5	use MediaWiki\User\UserIdentity;
6
7	interface AbuseFilterProtectedVarsAccessLoggerHook {
8	/**
9	* Allows other extensions to hook into the logging mechanism triggered when a
10	* protected variable is viewed. This allows them access to the parameters and
11	* the ability to override the logger by aborting additional logging.
12	*
13	* This is useful if an extension wants to divert a log to their own logger
14	* (eg. CheckUser wants to centralize its IP access logs). It's recommended
15	* that in such cases the extension removes its variables from $params['variables']
16	* and leaves the rest of them to be stored in their own log.
17	*
18	* @param UserIdentity $performer
19	* @param string $target
20	* @param string $action
21	* @param bool $shouldDebounce
22	* @param int $timestamp
23	* @param array &$params
24	* @return bool|void True or no return value to continue or false to abort
25	*/
26	public function onAbuseFilterLogProtectedVariableValueAccess(
27	UserIdentity $performer,
28	string $target,
29	string $action,
30	bool $shouldDebounce,
31	int $timestamp,
32	array &$params
33	);
34	}