Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3namespace MediaWiki\Extension\AbuseFilter\Hooks;
4
5use MediaWiki\User\UserIdentity;
6
7interface 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).
15     *
16     * @param UserIdentity $performer
17     * @param string $target
18     * @param string $action
19     * @param bool $shouldDebounce
20     * @param int $timestamp
21     * @param array $params
22     * @return bool|void True or no return value to continue or false to abort
23     */
24    public function onAbuseFilterLogProtectedVariableValueAccess(
25        UserIdentity $performer,
26        string $target,
27        string $action,
28        bool $shouldDebounce,
29        int $timestamp,
30        array $params
31    );
32}