MediaWiki  master
MediaWiki\Settings\Source\SettingsIncludeLocator Interface Reference

Implementations of SettingsSource may additionally implement SettingsIncludeLocator as well, to provide support for relative include locations. More...

Inheritance diagram for MediaWiki\Settings\Source\SettingsIncludeLocator:

Public Member Functions

 locateInclude (string $location)
 This method defines how a relative reference to the location of another settings source is interpreted. More...
 

Detailed Description

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
Todo:
mark as stable before the 1.38 release

Definition at line 16 of file SettingsIncludeLocator.php.

Member Function Documentation

◆ locateInclude()

MediaWiki\Settings\Source\SettingsIncludeLocator::locateInclude ( string  $location)

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.

Parameters
string$location
Returns
string
Exceptions
SettingsBuilderExceptionif the given location cannot be used as an include by the current source.

Implemented in MediaWiki\Settings\Source\PhpSettingsSource, MediaWiki\Settings\Source\FileSource, and MediaWiki\Settings\Cache\CachedSource.


The documentation for this interface was generated from the following file: