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\EventStreamConfig\Hooks;
4
5/**
6 * @stable for implementation
7 * @ingroup Hooks
8 */
9interface GetStreamConfigsHook {
10
11    /**
12     * This hook is called by {@link StreamConfigsFactory}. It is called before the final
13     * collection of stream configs is constructed.
14     *
15     * Note well that initial value of the <code>$streamConfigs</code> is the empty map, not
16     * <code>$wgEventStreams</code>. <code>$streamConfigs</code> will be merged into the final
17     * collection of stream configs. If there are duplicate keys in <code>$wgEventStreams</code>
18     * and <code>$streamConfigs</code>, then those in <code>$wgEventStreams</code> are used.
19     *
20     * @since 1.42
21     *
22     * @param array<string,array> &$streamConfigs
23     * @return void This hook must not abort and it must return no value
24     */
25    public function onGetStreamConfigs( array &$streamConfigs ): void;
26}