1	<?php
2
3	namespace MediaWiki\Hook;
4
5	/**
6	* This is a hook handler interface, see docs/Hooks.md.
7	* Use the hook name "LogEventsListShowLogExtract" to register handlers implementing this interface.
8	*
9	* @stable to implement
10	* @ingroup Hooks
11	*/
12	interface LogEventsListShowLogExtractHook {
13	/**
14	* This hook is called before the string is added to OutputPage.
15	*
16	* @since 1.35
17	*
18	* @param string &$s HTML to show for the log extract
19	* @param string|array $types Log types to show
20	* @param string|null $page Page title to show log entries for
21	* @param string $user User who made the log entries
22	* @param array $param Associative array with the following additional options:
23	*   - `lim` (integer): Limit of items to show, default is 50
24	*   - `conds` (array): Extra conditions for the query (e.g. "log_action != 'revision'")
25	*   - `showIfEmpty` (boolean): Set to false if you don't want any output in case the
26	*     loglist is empty if set to true (default), "No matching items in log" is
27	*     displayed if loglist is empty
28	*   - `msgKey` (array): If you want a nice box with a message, set this to the key of
29	*     the message. First element is the message key, additional optional elements
30	*     are parameters for the key that are processed with
31	*     wfMessage()->params()->parseAsBlock()
32	*   - `offset`: Set to overwrite offset parameter in $wgRequest set to '' to unset
33	*     offset
34	*   - `wrap` (string): Wrap the message in html (usually something like
35	*     "&lt;div ...>$1&lt;/div>")
36	*   - `flags` (integer): Display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
37	* @return bool|void True or no return value to continue, or false to prevent the
38	*   string from being added to the OutputPage
39	*/
40	public function onLogEventsListShowLogExtract( &$s, $types, $page, $user,
41	$param
42	);
43	}