MediaWiki master
ExtensionProcessor Class Reference

Load extension manifests and then aggregate their contents. More...

Inherits Processor.

Collaboration diagram for ExtensionProcessor:

Public Member Functions

 extractInfo ( $path, array $info, $version)
 
 extractInfoFromFile (string $path)
 Extracts extension info from the given JSON file.
 
 getExtractedAutoloadInfo (bool $includeDev=false)
 Returns the extracted autoload info.
 
 getExtractedInfo (bool $includeDev=false)
 
 getRequirements (array $info, $includeDev)
 Get the requirements for the provided info.
 
- Public Member Functions inherited from Processor
 getExtractedInfo ()
 

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)
 
 extractForeignResourcesDir (array $info, string $name, string $dir)
 
 extractHooks (array $info, string $path)
 Extract hook information from Hooks and HookHandler attributes.
 
 extractImplicitRights (array $info)
 Extract any user rights that should be granted implicitly.
 
 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)
 
 extractSkinImportPaths ( $dir, array $info)
 
 extractSkins ( $dir, array $info)
 Extract skins and handle path correction for templateDirectory.
 
 extractTranslationAliasesDirs ( $dir, array $info)
 Set localization related settings, which need to be expanded to use absolute paths.
 
 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 = []
 Anything else in the $info that hasn't already been processed.
 
string[][] $autoload
 Autoloader information.
 
string[][] $autoloadDev
 Autoloader information for development.
 
callable[] $callbacks = []
 Things to be called once the registration of these extensions is done.
 
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.
 

Detailed Description

Load extension manifests and then aggregate their contents.

Stability: newable
since 1.39

Definition at line 12 of file ExtensionProcessor.php.

Member Function Documentation

◆ extractAttributes()

ExtensionProcessor::extractAttributes ( $path,
array $info )
protected
Parameters
string$path
array$info

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

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

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

References $path.

Referenced by extractInfo().

◆ extractExtensionMessagesFiles()

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

Definition at line 672 of file ExtensionProcessor.php.

Referenced by extractInfo().

◆ extractForeignResourcesDir()

ExtensionProcessor::extractForeignResourcesDir ( array $info,
string $name,
string $dir )
protected

Definition at line 801 of file ExtensionProcessor.php.

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$infoattributes and associated values from extension.json
string$pathpath to extension.json

Definition at line 537 of file ExtensionProcessor.php.

References $path.

Referenced by extractInfo().

◆ extractImplicitRights()

ExtensionProcessor::extractImplicitRights ( array $info)
protected

Extract any user rights that should be granted implicitly.

Parameters
array$info

Definition at line 736 of file ExtensionProcessor.php.

Referenced by extractInfo().

◆ extractInfo()

◆ extractInfoFromFile()

ExtensionProcessor::extractInfoFromFile ( string $path)

Extracts extension info from the given JSON file.

Parameters
string$path
Returns
void

Definition at line 242 of file ExtensionProcessor.php.

References $path, and extractInfo().

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

Referenced by extractInfo().

◆ extractNamespaces()

ExtensionProcessor::extractNamespaces ( array $info)
protected

Register namespaces with the appropriate global settings.

Parameters
array$info

Definition at line 571 of file ExtensionProcessor.php.

Referenced by extractInfo().

◆ extractPathBasedGlobal()

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

Definition at line 908 of file ExtensionProcessor.php.

References $path.

Referenced by extractInfo().

◆ extractResourceLoaderModules()

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

Definition at line 615 of file ExtensionProcessor.php.

Referenced by extractInfo().

◆ extractSkinImportPaths()

ExtensionProcessor::extractSkinImportPaths ( $dir,
array $info )
protected
Parameters
string$dir
array$info

Definition at line 759 of file ExtensionProcessor.php.

Referenced by extractInfo().

◆ extractSkins()

ExtensionProcessor::extractSkins ( $dir,
array $info )
protected

Extract skins and handle path correction for templateDirectory.

Parameters
string$dir
array$info

Definition at line 719 of file ExtensionProcessor.php.

Referenced by extractInfo().

◆ extractTranslationAliasesDirs()

ExtensionProcessor::extractTranslationAliasesDirs ( $dir,
array $info )
protected

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

Parameters
string$dir
array$info

Definition at line 705 of file ExtensionProcessor.php.

Referenced by extractInfo().

◆ getExtractedAutoloadInfo()

ExtensionProcessor::getExtractedAutoloadInfo ( bool $includeDev = false)

Returns the extracted autoload info.

The autoload info is returned as an associative array with three keys:

  • files: a list of files to load, for use with Autoloader::loadFile()
  • classes: a map of class names to files, for use with Autoloader::registerClass()
  • namespaces: a map of namespace names to directories, for use with Autoloader::registerNamespace()
Since
1.39
Parameters
bool$includeDev
Returns
array[] The autoload info.

Implements Processor.

Definition at line 968 of file ExtensionProcessor.php.

Referenced by getExtractedInfo().

◆ getExtractedInfo()

ExtensionProcessor::getExtractedInfo ( bool $includeDev = false)

Definition at line 351 of file ExtensionProcessor.php.

References getExtractedAutoloadInfo(), 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 388 of file ExtensionProcessor.php.

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

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

Member Data Documentation

◆ $attributes

array ExtensionProcessor::$attributes = []
protected

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

Definition at line 225 of file ExtensionProcessor.php.

◆ $autoload

string [][] ExtensionProcessor::$autoload
protected
Initial value:
= [
'files' => [],
'classes' => [],
'namespaces' => [],
]

Autoloader information.

Each element is an array of strings. 'files' is just a list, 'classes' and 'namespaces' are associative.

Definition at line 201 of file ExtensionProcessor.php.

◆ $autoloadDev

string [][] ExtensionProcessor::$autoloadDev
protected
Initial value:
= [
'files' => [],
'classes' => [],
'namespaces' => [],
]

Autoloader information for development.

Same structure as $autoload.

Definition at line 213 of file ExtensionProcessor.php.

◆ $callbacks

callable [] ExtensionProcessor::$callbacks = []
protected

Things to be called once the registration of these extensions is done.

Keyed by the name of the extension that it belongs to

Definition at line 187 of file ExtensionProcessor.php.

◆ $credits

array ExtensionProcessor::$credits = []
protected

Definition at line 192 of file ExtensionProcessor.php.

◆ $defines

array ExtensionProcessor::$defines = []
protected

Things that should be define()'d.

Definition at line 178 of file ExtensionProcessor.php.

◆ $extAttributes

array ExtensionProcessor::$extAttributes = []
protected

Extension attributes, keyed by name => settings.

Definition at line 233 of file ExtensionProcessor.php.

◆ $globals

array ExtensionProcessor::$globals
protected
Initial value:
= [
'wgExtensionMessagesFiles' => [],
'wgMessagesDirs' => [],
'TranslationAliasesDirs' => [],
]

Stuff that is going to be set to $GLOBALS.

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

Definition at line 167 of file ExtensionProcessor.php.

◆ $globalSettings

array ExtensionProcessor::$globalSettings
staticprotected

Keys that should be set to $GLOBALS.

Definition at line 19 of file ExtensionProcessor.php.


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