Collaboration diagram for ExtensionRegistry:

Public Member Functions
	clearQueue ()
	Clear the current load queue.

	finish ()
	After this is called, no more extensions can be loaded.

	getAllThings ()
	Get information about all things.

	getAttribute ( $name)

	getQueue ()
	Get the current load queue.

	isLoaded ( $name, $constraint=' *')
	Whether a thing has been loaded.

	load ( $path)
	Loads and processes the given JSON file without delay.

	loadFromQueue ()

	queue ( $path)

	readFromQueue (array $queue)
	Process a queue of extensions and return their extracted data.

	setAttributeForTest ( $name, array $value)
	Force override the value of an attribute during tests.

Static Public Member Functions
static	getInstance ()

Public Attributes
const	CACHE_VERSION = 7
	Bump whenever the registration cache needs resetting.

const	MANIFEST_VERSION = 2
	Version of the highest supported manifest version Note: Update MANIFEST_VERSION_MW_VERSION when changing this.

const	MANIFEST_VERSION_MW_VERSION = '>= 1.29.0'
	MediaWiki version constraint representing what the current highest MANIFEST_VERSION is supported in.

const	MEDIAWIKI_CORE = 'MediaWiki'
	"requires" key that applies to MediaWiki core/$wgVersion

const	MERGE_STRATEGY = '_merge_strategy'
	Special key that defines the merge strategy.

const	OLDEST_MANIFEST_VERSION = 1
	Version of the oldest supported manifest version.

Protected Member Functions
	exportExtractedData (array $info)

	processAutoLoader ( $dir, array $files)
	Fully expand autoloader paths.

Protected Attributes
array	$attributes = []
	Items in the JSON file that aren't being set as globals.

array	$queued = []
	List of paths that should be loaded.

array	$testAttributes = []
	Attributes for testing.

Private Member Functions
	buildVersionChecker ()
	Queries information about the software environment and constructs an appropiate version checker.

	getAbilities ()
	Get the list of abilities and their values.

Private Attributes
bool	$finished = false
	Whether we are done loading things.

array	$loaded = []
	Array of loaded things, keyed by name, values are credits information.

Static Private Attributes
static ExtensionRegistry	$instance

Detailed Description

ExtensionRegistry class.

The Registry loads JSON files, and uses a Processor to extract information from them. It also registers classes with the autoloader.

Since: 1.25

Definition at line 17 of file ExtensionRegistry.php.

Member Function Documentation

◆ buildVersionChecker()

ExtensionRegistry::buildVersionChecker ( )

private

Queries information about the software environment and constructs an appropiate version checker.

Returns: VersionChecker

Definition at line 228 of file ExtensionRegistry.php.

References $wgVersion, and getAbilities().

Referenced by readFromQueue().

◆ clearQueue()

ExtensionRegistry::clearQueue ( )

Clear the current load queue.

Not intended to be used outside of the installer.

Definition at line 200 of file ExtensionRegistry.php.

◆ exportExtractedData()

ExtensionRegistry::exportExtractedData ( array $info )

protected

Definition at line 334 of file ExtensionRegistry.php.

References $GLOBALS, $name, $path, AutoLoader\$psr4Namespaces, as, MERGE_STRATEGY, and wfArrayPlus2d().

Referenced by loadFromQueue().

◆ finish()

ExtensionRegistry::finish ( )

After this is called, no more extensions can be loaded.

Since: 1.29

Definition at line 209 of file ExtensionRegistry.php.

◆ getAbilities()

ExtensionRegistry::getAbilities ( )

private

Get the list of abilities and their values.

Returns: bool[]

Definition at line 217 of file ExtensionRegistry.php.

Referenced by buildVersionChecker(), and loadFromQueue().

◆ getAllThings()

ExtensionRegistry::getAllThings ( )

Get information about all things.

Returns: array

Definition at line 485 of file ExtensionRegistry.php.

References $loaded.

◆ getAttribute()

ExtensionRegistry::getAttribute ( $name )

Parameters

string $name

Returns: array

Definition at line 452 of file ExtensionRegistry.php.

References $name.

◆ getInstance()

static ExtensionRegistry::getInstance ( )

static

◆ getQueue()

ExtensionRegistry::getQueue ( )

Get the current load queue.

Not intended to be used outside of the installer.

Returns: array

Definition at line 192 of file ExtensionRegistry.php.

References $queued.

◆ isLoaded()

ExtensionRegistry::isLoaded	(	$name,
		$constraint = `'*'`
	)

Whether a thing has been loaded.

Parameters

string	$name
string	$constraint	The required version constraint for this dependency

Exceptions

LogicException if a specific contraint is asked for, but the extension isn't versioned

Returns: bool

Definition at line 433 of file ExtensionRegistry.php.

References $name.

◆ load()

ExtensionRegistry::load ( $path )

Loads and processes the given JSON file without delay.

If some extensions are already queued, this will load those as well.

Parameters

string $path Absolute path to the JSON file

Definition at line 419 of file ExtensionRegistry.php.

References $path, loadFromQueue(), and queue().

◆ loadFromQueue()

ExtensionRegistry::loadFromQueue ( )

Exceptions

MWException If the queue is already marked as finished (no further things should be loaded then).

Definition at line 133 of file ExtensionRegistry.php.

References $cache, $data, $e, $wgDevelopmentWarnings, $wgVersion, CACHE_VERSION, exportExtractedData(), getAbilities(), and readFromQueue().

Referenced by load().

◆ processAutoLoader()

ExtensionRegistry::processAutoLoader	(		$dir,
		array	$files
	)

protected

Fully expand autoloader paths.

Parameters

string	$dir
array	$files

Returns: array

Definition at line 496 of file ExtensionRegistry.php.

References $file, and as.

Referenced by readFromQueue().

◆ queue()

ExtensionRegistry::queue ( $path )

Parameters

string $path Absolute path to the JSON file

Definition at line 109 of file ExtensionRegistry.php.

References $path, and $wgExtensionInfoMTime.

Referenced by load().

◆ readFromQueue()

ExtensionRegistry::readFromQueue ( array $queue )

Process a queue of extensions and return their extracted data.

Parameters

array $queue keys are filenames, values are ignored

Returns: array extracted info

Exceptions

Exception
ExtensionDependencyError

Definition at line 253 of file ExtensionRegistry.php.

References $data, $GLOBALS, $path, AutoLoader\$psr4Namespaces, $queue, as, buildVersionChecker(), processAutoLoader(), and wfDeprecated().

Referenced by loadFromQueue().

◆ setAttributeForTest()

ExtensionRegistry::setAttributeForTest	(		$name,
		array	$value
	)

Force override the value of an attribute during tests.

Parameters

string	$name	Name of attribute to override
array	$value	Value to set

Returns: ScopedCallback to reset

Since: 1.33

Definition at line 465 of file ExtensionRegistry.php.

References $name, $value, and use.

Member Data Documentation

◆ $attributes

array ExtensionRegistry::$attributes = []

protected

Items in the JSON file that aren't being set as globals.

Definition at line 80 of file ExtensionRegistry.php.

◆ $finished

bool ExtensionRegistry::$finished = false

private

Whether we are done loading things.

Definition at line 72 of file ExtensionRegistry.php.

◆ $instance

ExtensionRegistry ExtensionRegistry::$instance

staticprivate

Definition at line 92 of file ExtensionRegistry.php.

Referenced by getInstance().

◆ $loaded

array ExtensionRegistry::$loaded = []

private

Array of loaded things, keyed by name, values are credits information.

Definition at line 58 of file ExtensionRegistry.php.

Referenced by getAllThings().

◆ $queued

array ExtensionRegistry::$queued = []

protected

List of paths that should be loaded.

Definition at line 65 of file ExtensionRegistry.php.

Referenced by getQueue().

◆ $testAttributes

array ExtensionRegistry::$testAttributes = []

protected

Attributes for testing.

Definition at line 87 of file ExtensionRegistry.php.

◆ CACHE_VERSION

const ExtensionRegistry::CACHE_VERSION = 7

Bump whenever the registration cache needs resetting.

Definition at line 44 of file ExtensionRegistry.php.

Referenced by loadFromQueue().

◆ MANIFEST_VERSION

const ExtensionRegistry::MANIFEST_VERSION = 2

Version of the highest supported manifest version Note: Update MANIFEST_VERSION_MW_VERSION when changing this.

Definition at line 28 of file ExtensionRegistry.php.

Referenced by ConvertExtensionToRegistration\execute(), UpdateExtensionJsonSchema\execute(), ExtensionProcessorTest\testGlobalSettingsDocumentedInSchema(), and ExtensionJsonValidator\validate().

◆ MANIFEST_VERSION_MW_VERSION

const ExtensionRegistry::MANIFEST_VERSION_MW_VERSION = '>= 1.29.0'

MediaWiki version constraint representing what the current highest MANIFEST_VERSION is supported in.

Definition at line 34 of file ExtensionRegistry.php.

Referenced by ConvertExtensionToRegistration\execute().

◆ MEDIAWIKI_CORE

const ExtensionRegistry::MEDIAWIKI_CORE = 'MediaWiki'

"requires" key that applies to MediaWiki core/$wgVersion

Definition at line 22 of file ExtensionRegistry.php.

Referenced by VersionChecker\checkArray(), and ConvertExtensionToRegistration\execute().

◆ MERGE_STRATEGY

const ExtensionRegistry::MERGE_STRATEGY = '_merge_strategy'

Special key that defines the merge strategy.

Since: 1.26

Definition at line 51 of file ExtensionRegistry.php.

Referenced by exportExtractedData(), ExtensionProcessor\extractConfig2(), ExtensionProcessor\getExtractedInfo(), ExtensionRegistryTest\provideExportExtractedDataGlobals(), ExtensionProcessorTest\provideRegisterHooks(), ExtensionProcessorTest\testExtractConfig2(), and UpdateExtensionJsonSchema\updateTo2().

◆ OLDEST_MANIFEST_VERSION

const ExtensionRegistry::OLDEST_MANIFEST_VERSION = 1

Version of the oldest supported manifest version.

Definition at line 39 of file ExtensionRegistry.php.

Referenced by ExtensionJsonValidator\validate().

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

includes/registration/ExtensionRegistry.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ buildVersionChecker()

◆ clearQueue()

◆ exportExtractedData()

◆ finish()

◆ getAbilities()

◆ getAllThings()

◆ getAttribute()

◆ getInstance()

◆ getQueue()

◆ isLoaded()

◆ load()

◆ loadFromQueue()

◆ processAutoLoader()

◆ queue()

◆ readFromQueue()

◆ setAttributeForTest()

Member Data Documentation

◆ $attributes

◆ $finished

◆ $instance

◆ $loaded

◆ $queued

◆ $testAttributes

◆ CACHE_VERSION

◆ MANIFEST_VERSION

◆ MANIFEST_VERSION_MW_VERSION

◆ MEDIAWIKI_CORE

◆ MERGE_STRATEGY

◆ OLDEST_MANIFEST_VERSION