blob: ab0e523aa4ed6c99c3279754697057b970f8961d (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
<?php
namespace MediaWiki\Settings\Source;
use MediaWiki\Settings\SettingsBuilderException;
/**
* Implementations of SettingsSource may additionally implement SettingsIncludeLocator
* as well, to provide support for relative include locations. For instance, a
* SettingsSource that loads a file may provide support for includes to be
* specified relative to the location of that file.
*
* @since 1.38
* @stable to implement
*/
interface SettingsIncludeLocator {
/**
* This method defines how a relative reference to the location of
* another settings source is interpreted.
*
* It tries to make $location absolute by interpreting it as
* relative to the location of the SettingsSource it originates from.
*
* Implementation are "best effort". If a location cannot be made
* absolute, it may be returned as-is. Implementations are also free
* to throw a SettingsBuilderException to indicate that the given
* include location is not supported in this context.
*
* @param string $location
*
* @return string
* @throws SettingsBuilderException if the given location cannot be used
* as an include by the current source.
*/
public function locateInclude( string $location ): string;
}
|
