MediaWiki  master
MediaWiki\Config\ServiceOptions Class Reference

A class for passing options to services. More...

Public Member Functions

 __construct (array $keys,... $sources)
 assertRequiredOptions (array $expectedKeys)
 Assert that the list of options provided in this instance exactly match $expectedKeys, without regard for order. More...
 get ( $key)

Private Attributes

 $keys = []
 $options = []

Detailed Description

A class for passing options to services.

It can be constructed from a Config, and in practice most options will be taken from site configuration, but they don't have to be. The options passed are copied and will not reflect subsequent updates to site configuration (assuming they're not objects).

Services that take this type as a parameter to their constructor should specify a list of the keys they expect to receive in an array. The convention is to make it a public const called CONSTRUCTOR_OPTIONS. In the constructor, they should call assertRequiredOptions() to make sure that they weren't passed too few or too many options. This way it's clear what each class depends on, and that it's getting passed the correct set of options. (This means there are no optional options. This makes sense for services, since they shouldn't be constructed by outside code.)

@newable since 1.36


Definition at line 27 of file ServiceOptions.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Config\ServiceOptions::__construct ( array  $keys,
Stability: stable
to call since 1.36
string[]$keysWhich keys to extract from $sources
Config|array...$sources Each source is either a Config object or an array. If the same key is present in two sources, the first one takes precedence. Keys that are not in $keys are ignored.
InvalidArgumentExceptionif one of $keys is not found in any of $sources

Definition at line 40 of file ServiceOptions.php.

References MediaWiki\Config\ServiceOptions\$keys, and $source.

Member Function Documentation

◆ assertRequiredOptions()

MediaWiki\Config\ServiceOptions::assertRequiredOptions ( array  $expectedKeys)

Assert that the list of options provided in this instance exactly match $expectedKeys, without regard for order.


Definition at line 66 of file ServiceOptions.php.

Referenced by MediaWiki\Storage\PageUpdater\__construct(), MediaWiki\Storage\EditResultCache\__construct(), MediaWiki\Storage\BlobStoreFactory\__construct(), MediaWiki\Storage\EditResultBuilder\__construct(), MediaWiki\Storage\RevertedTagUpdate\__construct(), PasswordReset\__construct(), MediaWiki\Permissions\GroupPermissionsLookup\__construct(), MediaWiki\Block\BlockUser\__construct(), MediaWiki\Block\BlockPermissionCheckerFactory\__construct(), MediaWiki\Block\BlockPermissionChecker\__construct(), MediaWiki\User\UserGroupManager\__construct(), MediaWiki\User\UserOptionsManager\__construct(), MediaWiki\Languages\LanguageNameUtils\__construct(), NamespaceInfo\__construct(), MediaWiki\Block\UserBlockCommandFactory\__construct(), MediaWiki\User\WatchlistNotificationManager\__construct(), WatchedItemStore\__construct(), MediaWiki\User\ActorStoreFactory\__construct(), MediaWiki\User\DefaultOptionsLookup\__construct(), MediaWiki\User\UserNameUtils\__construct(), MediaWiki\Preferences\DefaultPreferencesFactory\__construct(), MediaWiki\SpecialPage\SpecialPageFactory\__construct(), LocalisationCache\__construct(), MediaWiki\Languages\LanguageFactory\__construct(), MediaWiki\Http\HttpRequestFactory\__construct(), MediaWiki\Block\DatabaseBlockStore\__construct(), MediaWiki\Block\BlockManager\__construct(), MediaWiki\Rest\CorsUtils\__construct(), MediaWiki\Permissions\PermissionManager\__construct(), MediaWiki\EditPage\Constraint\EditConstraintFactory\__construct(), MediaWiki\Block\BlockUtils\__construct(), MediaWiki\User\TalkPageNotificationManager\__construct(), Parser\__construct(), ParserFactory\__construct(), and MWLBFactory\applyDefaultConfig().

◆ get()

Member Data Documentation

◆ $keys

MediaWiki\Config\ServiceOptions::$keys = []

Definition at line 28 of file ServiceOptions.php.

Referenced by MediaWiki\Config\ServiceOptions\__construct().

◆ $options

MediaWiki\Config\ServiceOptions::$options = []

Definition at line 29 of file ServiceOptions.php.

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