The Registry loads JSON files, and uses a Processor to extract information from them. More...

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

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

	getAllThings ()
	Get credits information about all installed extensions and skins.

	getAttribute ( $name)

	getQueue ()
	Get the current load queue.

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

	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.

	setCache (BagOStuff $cache)
	Set the cache to use for extension info.

	setCheckDevRequires ( $check)

	setLoadTestClassesAndNamespaces ( $load)
	Controls if classes and namespaces defined under the keys TestAutoloadClasses and TestAutoloadNamespaces should be added to the autoloader.

	setSettingsBuilder (SettingsBuilder $settingsBuilder)

Static Public Member Functions
static	getInstance ()

Public Attributes
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

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)

	getLazyLoadedAttribute ( $name)
	Get an attribute value that isn't cached by reading each extension.json file again.

	saveToCache (BagOStuff $cache, array $data)
	Save data in the cache.

Static Protected Member Functions
static	processAutoLoader ( $dir, array $files)
	Fully expand autoloader paths.

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

bool	$checkDev = false
	Whether to check dev-requires.

array	$lazyAttributes = []
	Lazy-loaded attributes.

bool	$loadTestClassesAndNamespaces = false
	Whether test classes and namespaces should be added to the auto loader.

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

array	$testAttributes = []
	Attributes for testing.

Detailed Description

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 16 of file ExtensionRegistry.php.

Member Function Documentation

◆ clearQueue()

ExtensionRegistry::clearQueue ( )

Clear the current load queue.

Not intended to be used outside of the installer.

Definition at line 333 of file ExtensionRegistry.php.

◆ exportExtractedData()

ExtensionRegistry::exportExtractedData ( array $info )

protected

Definition at line 444 of file ExtensionRegistry.php.

References AutoLoader\loadFiles(), AutoLoader\registerClasses(), AutoLoader\registerNamespaces(), and wfArrayPlus2d().

◆ finish()

ExtensionRegistry::finish ( )

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

Since: 1.29

Definition at line 343 of file ExtensionRegistry.php.

◆ getAllThings()

ExtensionRegistry::getAllThings ( )

Get credits information about all installed extensions and skins.

Returns: array[] Keyed by component name.

Definition at line 645 of file ExtensionRegistry.php.

◆ getAttribute()

ExtensionRegistry::getAttribute ( $name )

Parameters

string $name

Returns: array

Definition at line 567 of file ExtensionRegistry.php.

◆ getInstance()

static ExtensionRegistry::getInstance ( )

static

Returns: ExtensionRegistry

Definition at line 152 of file ExtensionRegistry.php.

Referenced by MediaWiki\Category\TrackingCategories\__construct().

◆ getLazyLoadedAttribute()

ExtensionRegistry::getLazyLoadedAttribute ( $name )

protected

Get an attribute value that isn't cached by reading each extension.json file again.

Parameters

string $name

Returns: array

Definition at line 585 of file ExtensionRegistry.php.

References BagOStuff\get().

◆ getQueue()

ExtensionRegistry::getQueue ( )

Get the current load queue.

Not intended to be used outside of the installer.

Returns: int[] Map of extension.json files' modification timestamps keyed by absolute path

Definition at line 325 of file ExtensionRegistry.php.

◆ 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 constraint is asked for, but the extension isn't versioned

Returns: bool

Definition at line 548 of file ExtensionRegistry.php.

◆ loadFromQueue()

ExtensionRegistry::loadFromQueue ( )

Exceptions

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

Definition at line 265 of file ExtensionRegistry.php.

References BagOStuff\get().

◆ processAutoLoader()

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

staticprotected

Fully expand autoloader paths.

Parameters

string	$dir
string[]	$files

Returns: array

Definition at line 656 of file ExtensionRegistry.php.

References $file.

◆ queue()

ExtensionRegistry::queue ( $path )

Parameters

string $path Absolute path to the JSON file

Definition at line 195 of file ExtensionRegistry.php.

References $path, and $wgExtensionInfoMTime.

◆ readFromQueue()

ExtensionRegistry::readFromQueue ( array $queue )

Process a queue of extensions and return their extracted data.

Access: internal: since 1.39. Extensions should use ExtensionProcessor instead.

Parameters

int[] $queue keys are filenames, values are ignored

Returns: array extracted info

Exceptions

Exception
ExtensionDependencyError

Definition at line 388 of file ExtensionRegistry.php.

References $path, and wfDeprecatedMsg().

◆ saveToCache()

ExtensionRegistry::saveToCache	(	BagOStuff	$cache,
		array	$data )

protected

Save data in the cache.

Parameters

BagOStuff	$cache
array	$data

Definition at line 294 of file ExtensionRegistry.php.

References $wgDevelopmentWarnings, and BagOStuff\set().

◆ 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 625 of file ExtensionRegistry.php.

◆ setCache()

ExtensionRegistry::setCache ( BagOStuff $cache )

Set the cache to use for extension info.

Intended for use during testing.

Access: internal

Parameters

BagOStuff $cache

Definition at line 168 of file ExtensionRegistry.php.

◆ setCheckDevRequires()

ExtensionRegistry::setCheckDevRequires ( $check )

Since: 1.34

Parameters

bool $check

Definition at line 176 of file ExtensionRegistry.php.

◆ setLoadTestClassesAndNamespaces()

ExtensionRegistry::setLoadTestClassesAndNamespaces ( $load )

Controls if classes and namespaces defined under the keys TestAutoloadClasses and TestAutoloadNamespaces should be added to the autoloader.

Since: 1.35

Parameters

bool $load

Definition at line 188 of file ExtensionRegistry.php.

◆ setSettingsBuilder()

ExtensionRegistry::setSettingsBuilder ( SettingsBuilder $settingsBuilder )

Access: internal: for use by Setup. Hopefully in the future, we find a better way.

Parameters

SettingsBuilder $settingsBuilder

Definition at line 668 of file ExtensionRegistry.php.

Member Data Documentation

◆ $attributes

array ExtensionRegistry::$attributes = []

protected

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

Definition at line 96 of file ExtensionRegistry.php.

◆ $checkDev

bool ExtensionRegistry::$checkDev = false

protected

Whether to check dev-requires.

Definition at line 124 of file ExtensionRegistry.php.

◆ $lazyAttributes

array ExtensionRegistry::$lazyAttributes = []

protected

Lazy-loaded attributes.

Definition at line 110 of file ExtensionRegistry.php.

◆ $loadTestClassesAndNamespaces

bool ExtensionRegistry::$loadTestClassesAndNamespaces = false

protected

Whether test classes and namespaces should be added to the auto loader.

Definition at line 131 of file ExtensionRegistry.php.

◆ $queued

int [] ExtensionRegistry::$queued = []

protected

List of paths that should be loaded.

Definition at line 81 of file ExtensionRegistry.php.

◆ $testAttributes

array ExtensionRegistry::$testAttributes = []

protected

Attributes for testing.

Definition at line 103 of file ExtensionRegistry.php.

◆ 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 27 of file ExtensionRegistry.php.

◆ 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 33 of file ExtensionRegistry.php.

◆ MEDIAWIKI_CORE

const ExtensionRegistry::MEDIAWIKI_CORE = 'MediaWiki'

"requires" key that applies to MediaWiki core

Definition at line 21 of file ExtensionRegistry.php.

◆ MERGE_STRATEGY

const ExtensionRegistry::MERGE_STRATEGY = '_merge_strategy'

Special key that defines the merge strategy.

Since: 1.26

Definition at line 52 of file ExtensionRegistry.php.

◆ OLDEST_MANIFEST_VERSION

const ExtensionRegistry::OLDEST_MANIFEST_VERSION = 1

Version of the oldest supported manifest version.

Definition at line 38 of file ExtensionRegistry.php.

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

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ clearQueue()

◆ exportExtractedData()

◆ finish()

◆ getAllThings()

◆ getAttribute()

◆ getInstance()

◆ getLazyLoadedAttribute()

◆ getQueue()

◆ isLoaded()

◆ loadFromQueue()

◆ processAutoLoader()

◆ queue()

◆ readFromQueue()

◆ saveToCache()

◆ setAttributeForTest()

◆ setCache()

◆ setCheckDevRequires()

◆ setLoadTestClassesAndNamespaces()

◆ setSettingsBuilder()

Member Data Documentation

◆ $attributes

◆ $checkDev

◆ $lazyAttributes

◆ $loadTestClassesAndNamespaces

◆ $queued

◆ $testAttributes

◆ MANIFEST_VERSION

◆ MANIFEST_VERSION_MW_VERSION

◆ MEDIAWIKI_CORE

◆ MERGE_STRATEGY

◆ OLDEST_MANIFEST_VERSION