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 | |
3 | namespace MediaWiki\Hook; |
4 | |
5 | use MediaWiki\Title\Title; |
6 | |
7 | /** |
8 | * This is a hook handler interface, see docs/Hooks.md. |
9 | * Use the hook name "LogLine" to register handlers implementing this interface. |
10 | * |
11 | * @stable to implement |
12 | * @ingroup Hooks |
13 | */ |
14 | interface LogLineHook { |
15 | /** |
16 | * Use this hook to process a single log entry on Special:Log. |
17 | * |
18 | * @since 1.35 |
19 | * |
20 | * @param string $log_type Type of log entry (e.g. 'move'). Corresponds to |
21 | * logging.log_type database field. |
22 | * @param string $log_action Type of log action (e.g. 'delete', 'block', |
23 | * 'create2'). Corresponds to logging.log_action database field. |
24 | * @param Title $title Title object that corresponds to logging.log_namespace and |
25 | * logging.log_title database fields |
26 | * @param array $paramArray Parameters that correspond to logging.log_params field. |
27 | * Note that only $paramArray[0] appears to contain anything. |
28 | * @param string &$comment Logging.log_comment database field, which is displayed |
29 | * in the UI |
30 | * @param string &$revert String that is displayed in the UI, similar to $comment |
31 | * @param string $time Timestamp of the log entry (added in 1.12) |
32 | * @return bool|void True or no return value to continue or false to abort |
33 | */ |
34 | public function onLogLine( $log_type, $log_action, $title, $paramArray, |
35 | &$comment, &$revert, $time |
36 | ); |
37 | } |