File: SettingsIncludeLocator.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (37 lines) | stat: -rw-r--r-- 1,236 bytes parent folder | download | duplicates (3)
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;
}