Inheritance diagram for ExtensionProcessor:

[legend]

Collaboration diagram for ExtensionProcessor:

[legend]

Public Member Functions
	extractInfo ( $path, array $info, $version)

	getExtraAutoloaderPaths ( $dir, array $info)
	Get the path for additional autoloaders, e.g.

	getExtractedInfo ()

	getRequirements (array $info)
	Get the requirements for the provided info.

Protected Member Functions
	extractAttributes ( $path, array $info)

	extractConfig1 (array $info)
	Set configuration settings for manifest_version == 1.

	extractConfig2 (array $info, $dir)
	Set configuration settings for manifest_version == 2.

	extractCredits ( $path, array $info)

	extractExtensionMessagesFiles ( $dir, array $info)

	extractHooks (array $info)

	extractMessagesDirs ( $dir, array $info)
	Set message-related settings, which need to be expanded to use absolute paths.

	extractNamespaces (array $info)
	Register namespaces with the appropriate global settings.

	extractPathBasedGlobal ( $global, $dir, $paths)

	extractResourceLoaderModules ( $dir, array $info)

	storeToArray ( $path, $name, $value, &$array)

Protected Attributes
array	$attributes = []
	Any thing else in the $info that hasn't already been processed.

callable[]	$callbacks = []
	Things to be called once registration of these extensions are done keyed by the name of the extension that it belongs to.

array	$credits = []

array	$defines = []
	Things that should be define()'d.

array	$extAttributes = []
	Extension attributes, keyed by name => settings.

array	$globals
	Stuff that is going to be set to $GLOBALS.

Static Protected Attributes
static string[]	$coreAttributes
	Top-level attributes that come from MW core.

static array	$creditsAttributes
	Keys that are part of the extension credits.

static array	$globalSettings
	Keys that should be set to $GLOBALS.

static array	$mergeStrategies
	Mapping of global settings to their specific merge strategies.

static array	$notAttributes
	Things that are not 'attributes', but are not in $globalSettings or $creditsAttributes.

Private Member Functions
	addConfigGlobal ( $key, $value, $extName)
	Helper function to set a value to a specific global, if it isn't set already.

Detailed Description

Definition at line 3 of file ExtensionProcessor.php.

Member Function Documentation

◆ addConfigGlobal()

ExtensionProcessor::addConfigGlobal	(	$key,
		$value,
		$extName
	)

private

Helper function to set a value to a specific global, if it isn't set already.

Parameters

string	$key	The config key with the prefix and anything
mixed	$value	The value of the config
string	$extName	Name of the extension

Definition at line 509 of file ExtensionProcessor.php.

References $value, and globals.

Referenced by extractConfig1(), and extractConfig2().

◆ extractAttributes()

ExtensionProcessor::extractAttributes	(		$path,
		array	$info
	)

protected

Parameters

string	$path
array	$info

Definition at line 259 of file ExtensionProcessor.php.

References $path, $value, as, and storeToArray().

Referenced by extractInfo().

◆ extractConfig1()

ExtensionProcessor::extractConfig1 ( array $info )

protected

Set configuration settings for manifest_version == 1.

Todo:: In the future, this should be done via Config interfaces

Parameters

array $info

Definition at line 459 of file ExtensionProcessor.php.

References addConfigGlobal(), and as.

Referenced by extractInfo().

◆ extractConfig2()

ExtensionProcessor::extractConfig2	(	array	$info,
			$dir
	)

protected

Set configuration settings for manifest_version == 2.

Todo:: In the future, this should be done via Config interfaces

Parameters

array	$info
string	$dir

Definition at line 482 of file ExtensionProcessor.php.

References $value, addConfigGlobal(), as, and ExtensionRegistry\MERGE_STRATEGY.

Referenced by extractInfo().

◆ extractCredits()

ExtensionProcessor::extractCredits	(		$path,
		array	$info
	)

protected

Parameters

string	$path
array	$info

Returns: string Name of thing

Exceptions

Exception

Definition at line 426 of file ExtensionProcessor.php.

References $credits, $name, $path, as, and globals.

Referenced by extractInfo().

◆ extractExtensionMessagesFiles()

ExtensionProcessor::extractExtensionMessagesFiles	(		$dir,
		array	$info
	)

protected

Definition at line 394 of file ExtensionProcessor.php.

References as, and globals.

Referenced by extractInfo().

◆ extractHooks()

ExtensionProcessor::extractHooks ( array $info )

protected

Definition at line 304 of file ExtensionProcessor.php.

References $name, $value, as, and globals.

Referenced by extractInfo().

◆ extractInfo()

ExtensionProcessor::extractInfo	(		$path,
		array	$info,
			$version
	)

Parameters

string	$path
array	$info
int	$version	manifest_version for info

Returns: array

Implements Processor.

Definition at line 187 of file ExtensionProcessor.php.

References $name, $path, as, extractAttributes(), extractConfig1(), extractConfig2(), extractCredits(), extractExtensionMessagesFiles(), extractHooks(), extractMessagesDirs(), extractNamespaces(), extractPathBasedGlobal(), extractResourceLoaderModules(), globals, and storeToArray().

Referenced by ExtensionProcessorTest\testDuplicateConfigKey1(), ExtensionProcessorTest\testDuplicateConfigKey2(), ExtensionProcessorTest\testExtractConfig1(), and ExtensionProcessorTest\testExtractConfig2().

◆ extractMessagesDirs()

ExtensionProcessor::extractMessagesDirs	(		$dir,
		array	$info
	)

protected

Set message-related settings, which need to be expanded to use absolute paths.

Parameters

string	$dir
array	$info

Definition at line 410 of file ExtensionProcessor.php.

References $name, array(), as, and globals.

Referenced by extractInfo().

◆ extractNamespaces()

ExtensionProcessor::extractNamespaces ( array $info )

protected

Register namespaces with the appropriate global settings.

Parameters

array $info

Definition at line 323 of file ExtensionProcessor.php.

References as, and globals.

Referenced by extractInfo().

◆ extractPathBasedGlobal()

ExtensionProcessor::extractPathBasedGlobal	(	$global,
		$dir,
		$paths
	)

protected

Definition at line 518 of file ExtensionProcessor.php.

References $path, as, and globals.

Referenced by extractInfo().

◆ extractResourceLoaderModules()

ExtensionProcessor::extractResourceLoaderModules	(		$dir,
		array	$info
	)

protected

Definition at line 361 of file ExtensionProcessor.php.

References $name, as, and globals.

Referenced by extractInfo().

◆ getExtraAutoloaderPaths()

ExtensionProcessor::getExtraAutoloaderPaths	(		$dir,
		array	$info
	)

Get the path for additional autoloaders, e.g.

the one of Composer.

Parameters

string	$dir
array	$info

Returns: array Containing the paths for autoloader file(s).

Since: 1.27

Implements Processor.

Definition at line 542 of file ExtensionProcessor.php.

◆ getExtractedInfo()

ExtensionProcessor::getExtractedInfo ( )

Returns: array With following keys: 'globals' - variables to be set to $GLOBALS 'defines' - constants to define 'callbacks' - functions to be executed by the registry 'credits' - metadata to be stored by registry 'attributes' - registration info which isn't a global variable

Implements Processor.

Definition at line 267 of file ExtensionProcessor.php.

References $attributes, $callbacks, $credits, $defines, $globals, $value, as, globals, ExtensionRegistry\MERGE_STRATEGY, and storeToArray().

◆ getRequirements()

ExtensionProcessor::getRequirements ( array $info )

Get the requirements for the provided info.

Since: 1.26

Parameters

array $info

Returns: array Where keys are the name to have a constraint on, like 'MediaWiki'. Values are a constraint string like "1.26.1".

Implements Processor.

Definition at line 300 of file ExtensionProcessor.php.

◆ storeToArray()

ExtensionProcessor::storeToArray	(		$path,
			$name,
			$value,
		&	$array
	)

protected

Parameters

string	$path
string	$name
array	$value
array	&$array

Exceptions

InvalidArgumentException

Definition at line 531 of file ExtensionProcessor.php.

References $name, and $value.

Referenced by extractAttributes(), extractInfo(), and getExtractedInfo().

Member Data Documentation

◆ $attributes

array ExtensionProcessor::$attributes = []

protected

Any thing else in the $info that hasn't already been processed.

Definition at line 171 of file ExtensionProcessor.php.

Referenced by getExtractedInfo().

◆ $callbacks

callable [] ExtensionProcessor::$callbacks = []

protected

Things to be called once registration of these extensions are done keyed by the name of the extension that it belongs to.

Definition at line 158 of file ExtensionProcessor.php.

Referenced by getExtractedInfo().

◆ $coreAttributes

string [] ExtensionProcessor::$coreAttributes

staticprotected

Initial value:

= [
        'SkinOOUIThemes',
        'TrackingCategories',
    ]

Top-level attributes that come from MW core.

Definition at line 64 of file ExtensionProcessor.php.

◆ $credits

array ExtensionProcessor::$credits = []

protected

Definition at line 163 of file ExtensionProcessor.php.

Referenced by extractCredits(), and getExtractedInfo().

◆ $creditsAttributes

array ExtensionProcessor::$creditsAttributes

staticprotected

Initial value:

= [
        'name',
        'namemsg',
        'author',
        'version',
        'url',
        'description',
        'descriptionmsg',
        'license-name',
    ]

Keys that are part of the extension credits.

Definition at line 97 of file ExtensionProcessor.php.

◆ $defines

array ExtensionProcessor::$defines = []

protected

Things that should be define()'d.

Definition at line 150 of file ExtensionProcessor.php.

Referenced by getExtractedInfo().

◆ $extAttributes

array ExtensionProcessor::$extAttributes = []

protected

Extension attributes, keyed by name => settings.

Definition at line 179 of file ExtensionProcessor.php.

◆ $globals

array ExtensionProcessor::$globals

protected

Initial value:

= [
        'wgExtensionMessagesFiles' => [],
        'wgMessagesDirs' => [],
    ]

Stuff that is going to be set to $GLOBALS.

Some keys are pre-set to arrays so we can += to them

Definition at line 140 of file ExtensionProcessor.php.

Referenced by MockExtensionProcessor\__construct(), and getExtractedInfo().

◆ $globalSettings

array ExtensionProcessor::$globalSettings

staticprotected

Keys that should be set to $GLOBALS.

Definition at line 10 of file ExtensionProcessor.php.

◆ $mergeStrategies

array ExtensionProcessor::$mergeStrategies

staticprotected

Initial value:

= [
        'wgAuthManagerAutoConfig' => 'array_plus_2d',
        'wgCapitalLinkOverrides' => 'array_plus',
        'wgExtensionCredits' => 'array_merge_recursive',
        'wgExtraGenderNamespaces' => 'array_plus',
        'wgGrantPermissions' => 'array_plus_2d',
        'wgGroupPermissions' => 'array_plus_2d',
        'wgHooks' => 'array_merge_recursive',
        'wgNamespaceContentModels' => 'array_plus',
        'wgNamespaceProtection' => 'array_plus',
        'wgNamespacesWithSubpages' => 'array_plus',
        'wgPasswordPolicy' => 'array_merge_recursive',
        'wgRateLimits' => 'array_plus_2d',
        'wgRevokePermissions' => 'array_plus_2d',
    ]

Mapping of global settings to their specific merge strategies.

See also: ExtensionRegistry::exportExtractedData; getExtractedInfo

Definition at line 76 of file ExtensionProcessor.php.

◆ $notAttributes

array ExtensionProcessor::$notAttributes

staticprotected

Initial value:

= [
        'callback',
        'Hooks',
        'namespaces',
        'ResourceFileModulePaths',
        'ResourceModules',
        'ResourceModuleSkinStyles',
        'ExtensionMessagesFiles',
        'MessagesDirs',
        'type',
        'config',
        'config_prefix',
        'ServiceWiringFiles',
        'ParserTestFiles',
        'AutoloadClasses',
        'manifest_version',
        'load_composer_autoloader',
    ]

Things that are not 'attributes', but are not in $globalSettings or $creditsAttributes.

Definition at line 114 of file ExtensionProcessor.php.

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

includes/registration/ExtensionProcessor.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ addConfigGlobal()

◆ extractAttributes()

◆ extractConfig1()

◆ extractConfig2()

◆ extractCredits()

◆ extractExtensionMessagesFiles()

◆ extractHooks()

◆ extractInfo()

◆ extractMessagesDirs()

◆ extractNamespaces()

◆ extractPathBasedGlobal()

◆ extractResourceLoaderModules()

◆ getExtraAutoloaderPaths()

◆ getExtractedInfo()

◆ getRequirements()

◆ storeToArray()

Member Data Documentation

◆ $attributes

◆ $callbacks

◆ $coreAttributes

◆ $credits

◆ $creditsAttributes

◆ $defines

◆ $extAttributes

◆ $globals

◆ $globalSettings

◆ $mergeStrategies

◆ $notAttributes