Inheritance diagram for ExtensionProcessor:

Collaboration diagram for ExtensionProcessor:

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

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

	getExtractedInfo ()

	getRequirements (array $info, $includeDev)
	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, string $path)
	Extract hook information from Hooks and HookHandler attributes.

	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)
	Stores $value to $array; using array_merge() if $array already contains $name.

	storeToArrayRecursive ( $path, $name, $value, &$array)
	Stores $value to $array; using array_merge_recursive() if $array already contains $name.

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	$config = []

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 array	$globalSettings
	Keys that should be set to $GLOBALS.

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

	setArrayHookHandler (array $callback, array $hookHandlersAttr, string $name, string $path)
	When handler value is an array, set $wgHooks or Hooks attribute Could be legacy hook e.g.

	setStringHookHandler (string $callback, array $hookHandlersAttr, string $name, string $path)
	When handler value is a string, set $wgHooks or Hooks attribute.

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 728 of file ExtensionProcessor.php.

Referenced by extractConfig1(), and extractConfig2().

◆ extractAttributes()

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

protected

Parameters

string	$path
array	$info

Definition at line 282 of file ExtensionProcessor.php.

References $path, and storeToArrayRecursive().

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 670 of file ExtensionProcessor.php.

References addConfigGlobal().

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 693 of file ExtensionProcessor.php.

References addConfigGlobal().

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 638 of file ExtensionProcessor.php.

References $credits, and $path.

Referenced by extractInfo().

◆ extractExtensionMessagesFiles()

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

protected

Definition at line 606 of file ExtensionProcessor.php.

References $file.

Referenced by extractInfo().

◆ extractHooks()

ExtensionProcessor::extractHooks	(	array	$info,
		string	$path
	)

protected

Extract hook information from Hooks and HookHandler attributes.

Store hook in $wgHooks if a legacy style handler or the 'Hooks' attribute if a non-legacy handler

Parameters

array	$info	attributes and associated values from extension.json
string	$path	path to extension.json

Definition at line 473 of file ExtensionProcessor.php.

References $path, setArrayHookHandler(), and setStringHookHandler().

Referenced by extractInfo().

◆ extractInfo()

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

Parameters

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

Implements Processor.

Definition at line 198 of file ExtensionProcessor.php.

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

◆ 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 622 of file ExtensionProcessor.php.

References $file.

Referenced by extractInfo().

◆ extractNamespaces()

ExtensionProcessor::extractNamespaces ( array $info )

protected

Register namespaces with the appropriate global settings.

Parameters

array $info

Definition at line 507 of file ExtensionProcessor.php.

Referenced by extractInfo().

◆ extractPathBasedGlobal()

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

protected

Definition at line 737 of file ExtensionProcessor.php.

References $path.

Referenced by extractInfo().

◆ extractResourceLoaderModules()

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

protected

Definition at line 549 of file ExtensionProcessor.php.

References $basePath.

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 783 of file ExtensionProcessor.php.

◆ getExtractedInfo()

ExtensionProcessor::getExtractedInfo ( )

Returns: array With following keys: 'globals' - variables to be set to $GLOBALS 'defines' - constants to define 'config' - configuration information '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 290 of file ExtensionProcessor.php.

References $attributes, $callbacks, $config, $credits, $defines, $globals, and storeToArrayRecursive().

◆ getRequirements()

ExtensionProcessor::getRequirements	(	array	$info,
			$includeDev
	)

Get the requirements for the provided info.

Since: 1.26

Parameters

array	$info
bool	$includeDev

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 324 of file ExtensionProcessor.php.

◆ setArrayHookHandler()

ExtensionProcessor::setArrayHookHandler	(	array	$callback,
		array	$hookHandlersAttr,
		string	$name,
		string	$path
	)

private

When handler value is an array, set $wgHooks or Hooks attribute Could be legacy hook e.g.

'GlobalFunctionName' or non-legacy hook referencing a handler definition from 'HookHandler' attribute

Parameters

array	$callback	Handler
array	$hookHandlersAttr	handler definitions from 'HookHandler' attribute
string	$name
string	$path	extension.json file path

Exceptions

UnexpectedValueException

Definition at line 406 of file ExtensionProcessor.php.

References $path, setArrayHookHandler(), and setStringHookHandler().

Referenced by extractHooks(), and setArrayHookHandler().

◆ setStringHookHandler()

ExtensionProcessor::setStringHookHandler	(	string	$callback,
		array	$hookHandlersAttr,
		string	$name,
		string	$path
	)

private

When handler value is a string, set $wgHooks or Hooks attribute.

Could be legacy hook e.g. 'GlobalFunctionName' or non-legacy hook referencing a handler definition from 'HookHandler' attribute

Parameters

string	$callback	Handler
array	$hookHandlersAttr	handler definitions from 'HookHandler' attribute
string	$name
string	$path

Definition at line 448 of file ExtensionProcessor.php.

References $path.

Referenced by extractHooks(), and setArrayHookHandler().

◆ storeToArray()

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

protected

Stores $value to $array; using array_merge() if $array already contains $name.

Parameters

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

Exceptions

InvalidArgumentException

Definition at line 772 of file ExtensionProcessor.php.

Referenced by extractInfo().

◆ storeToArrayRecursive()

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

protected

Stores $value to $array; using array_merge_recursive() if $array already contains $name.

Parameters

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

Exceptions

InvalidArgumentException

Definition at line 752 of file ExtensionProcessor.php.

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 183 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 165 of file ExtensionProcessor.php.

Referenced by getExtractedInfo().

◆ $config

array ExtensionProcessor::$config = []

protected

Definition at line 175 of file ExtensionProcessor.php.

Referenced by getExtractedInfo().

◆ $credits

array ExtensionProcessor::$credits = []

protected

Definition at line 170 of file ExtensionProcessor.php.

Referenced by extractCredits(), and getExtractedInfo().

◆ $defines

array ExtensionProcessor::$defines = []

protected

Things that should be define()'d.

Definition at line 157 of file ExtensionProcessor.php.

Referenced by getExtractedInfo().

◆ $extAttributes

array ExtensionProcessor::$extAttributes = []

protected

Extension attributes, keyed by name => settings.

Definition at line 191 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 147 of file ExtensionProcessor.php.

Referenced by getExtractedInfo().

◆ $globalSettings

array ExtensionProcessor::$globalSettings

staticprotected

Keys that should be set to $GLOBALS.

Definition at line 10 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()

◆ setArrayHookHandler()

◆ setStringHookHandler()

◆ storeToArray()

◆ storeToArrayRecursive()

Member Data Documentation

◆ $attributes

◆ $callbacks

◆ $config

◆ $credits

◆ $defines

◆ $extAttributes

◆ $globals

◆ $globalSettings