Load JSON files, and uses a Processor to extract information. More...

Inherits MediaWiki\DomainEvent\DomainEventSubscriber.

Collaboration diagram for MediaWiki\Registration\ExtensionRegistry:

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.

	registerListeners (DomainEventSource $eventSource)
	Register any domain event subscribers defined by extensions.

	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	disableForTest ()

static	enableForTest ()

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

Load JSON files, and uses a Processor to extract information.

This also adds the extension's classes to the AutoLoader.

Since: 1.25

Definition at line 35 of file ExtensionRegistry.php.

Member Function Documentation

◆ clearQueue()

MediaWiki\Registration\ExtensionRegistry::clearQueue ( )

Clear the current load queue.

Not intended to be used outside of the installer.

Definition at line 380 of file ExtensionRegistry.php.

◆ disableForTest()

static MediaWiki\Registration\ExtensionRegistry::disableForTest ( )

static

Access: internal

Definition at line 184 of file ExtensionRegistry.php.

◆ enableForTest()

static MediaWiki\Registration\ExtensionRegistry::enableForTest ( )

static

Access: internal

Definition at line 194 of file ExtensionRegistry.php.

◆ exportExtractedData()

MediaWiki\Registration\ExtensionRegistry::exportExtractedData ( array $info )

protected

Definition at line 483 of file ExtensionRegistry.php.

References wfArrayPlus2d().

◆ finish()

MediaWiki\Registration\ExtensionRegistry::finish ( )

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

Since: 1.29

Definition at line 390 of file ExtensionRegistry.php.

◆ getAllThings()

MediaWiki\Registration\ExtensionRegistry::getAllThings ( )

Get credits information about all installed extensions and skins.

Returns: array[] Keyed by component name.

Definition at line 713 of file ExtensionRegistry.php.

◆ getAttribute()

MediaWiki\Registration\ExtensionRegistry::getAttribute ( $name )

Parameters

string $name

Returns: array

Definition at line 617 of file ExtensionRegistry.php.

Referenced by MediaWiki\ResourceLoader\getSkinThemeMap().

◆ getInstance()

static MediaWiki\Registration\ExtensionRegistry::getInstance ( )

static

Returns: ExtensionRegistry

Definition at line 170 of file ExtensionRegistry.php.

◆ getLazyLoadedAttribute()

MediaWiki\Registration\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 650 of file ExtensionRegistry.php.

◆ getQueue()

MediaWiki\Registration\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 372 of file ExtensionRegistry.php.

◆ isLoaded()

MediaWiki\Registration\ExtensionRegistry::isLoaded	(		$name,
			$constraint = '*' )

Whether a thing has been loaded.

Parameters

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

Returns: bool

Definition at line 597 of file ExtensionRegistry.php.

◆ loadFromQueue()

MediaWiki\Registration\ExtensionRegistry::loadFromQueue ( )

Definition at line 312 of file ExtensionRegistry.php.

◆ processAutoLoader()

static MediaWiki\Registration\ExtensionRegistry::processAutoLoader	(		$dir,
		array	$files )

staticprotected

Fully expand autoloader paths.

Parameters

string	$dir
string[]	$files

Returns: array

Definition at line 725 of file ExtensionRegistry.php.

◆ queue()

MediaWiki\Registration\ExtensionRegistry::queue ( $path )

Parameters

string $path Absolute path to the JSON file

Definition at line 238 of file ExtensionRegistry.php.

References $path, and $wgExtensionInfoMTime.

◆ readFromQueue()

MediaWiki\Registration\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

InvalidArgumentException
ExtensionDependencyError

Definition at line 437 of file ExtensionRegistry.php.

References $path.

◆ registerListeners()

MediaWiki\Registration\ExtensionRegistry::registerListeners ( DomainEventSource $eventSource )

Register any domain event subscribers defined by extensions.

Access: internal

Implements MediaWiki\DomainEvent\DomainEventSubscriber.

Definition at line 634 of file ExtensionRegistry.php.

References MediaWiki\DomainEvent\DomainEventSource\registerSubscriber().

◆ saveToCache()

MediaWiki\Registration\ExtensionRegistry::saveToCache	(	BagOStuff	$cache,
		array	$data )

protected

Save data in the cache.

Parameters

BagOStuff	$cache
array	$data

Definition at line 341 of file ExtensionRegistry.php.

References $wgDevelopmentWarnings, and Wikimedia\ObjectCache\BagOStuff\set().

◆ setAttributeForTest()

MediaWiki\Registration\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 692 of file ExtensionRegistry.php.

◆ setCache()

MediaWiki\Registration\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 209 of file ExtensionRegistry.php.

◆ setCheckDevRequires()

MediaWiki\Registration\ExtensionRegistry::setCheckDevRequires ( $check )

Since: 1.34

Parameters

bool $check

Definition at line 218 of file ExtensionRegistry.php.

◆ setLoadTestClassesAndNamespaces()

MediaWiki\Registration\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 231 of file ExtensionRegistry.php.

◆ setSettingsBuilder()

MediaWiki\Registration\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 739 of file ExtensionRegistry.php.

Member Data Documentation

◆ $attributes

array MediaWiki\Registration\ExtensionRegistry::$attributes = []

protected

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

Definition at line 115 of file ExtensionRegistry.php.

◆ $checkDev

bool MediaWiki\Registration\ExtensionRegistry::$checkDev = false

protected

Whether to check dev-requires.

Definition at line 143 of file ExtensionRegistry.php.

◆ $lazyAttributes

array MediaWiki\Registration\ExtensionRegistry::$lazyAttributes = []

protected

Lazy-loaded attributes.

Definition at line 129 of file ExtensionRegistry.php.

◆ $loadTestClassesAndNamespaces

bool MediaWiki\Registration\ExtensionRegistry::$loadTestClassesAndNamespaces = false

protected

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

Definition at line 150 of file ExtensionRegistry.php.

◆ $queued

int [] MediaWiki\Registration\ExtensionRegistry::$queued = []

protected

List of paths that should be loaded.

Definition at line 100 of file ExtensionRegistry.php.

◆ $testAttributes

array MediaWiki\Registration\ExtensionRegistry::$testAttributes = []

protected

Attributes for testing.

Definition at line 122 of file ExtensionRegistry.php.

◆ MANIFEST_VERSION

const MediaWiki\Registration\ExtensionRegistry::MANIFEST_VERSION = 2

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

Definition at line 46 of file ExtensionRegistry.php.

Referenced by MediaWiki\Registration\ExtensionJsonValidator\validate().

◆ MANIFEST_VERSION_MW_VERSION

const MediaWiki\Registration\ExtensionRegistry::MANIFEST_VERSION_MW_VERSION = '>= 1.29.0'

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

Definition at line 52 of file ExtensionRegistry.php.

◆ MEDIAWIKI_CORE

const MediaWiki\Registration\ExtensionRegistry::MEDIAWIKI_CORE = 'MediaWiki'

"requires" key that applies to MediaWiki core

Definition at line 40 of file ExtensionRegistry.php.

Referenced by MediaWiki\Registration\VersionChecker\checkArray().

◆ MERGE_STRATEGY

const MediaWiki\Registration\ExtensionRegistry::MERGE_STRATEGY = '_merge_strategy'

Special key that defines the merge strategy.

Since: 1.26

Definition at line 71 of file ExtensionRegistry.php.

Referenced by MediaWiki\Registration\ExtensionProcessor\getExtractedInfo().

◆ OLDEST_MANIFEST_VERSION

const MediaWiki\Registration\ExtensionRegistry::OLDEST_MANIFEST_VERSION = 1

Version of the oldest supported manifest version.

Definition at line 57 of file ExtensionRegistry.php.

Referenced by MediaWiki\Registration\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

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ clearQueue()

◆ disableForTest()

◆ enableForTest()

◆ exportExtractedData()

◆ finish()

◆ getAllThings()

◆ getAttribute()

◆ getInstance()

◆ getLazyLoadedAttribute()

◆ getQueue()

◆ isLoaded()

◆ loadFromQueue()

◆ processAutoLoader()

◆ queue()

◆ readFromQueue()

◆ registerListeners()

◆ 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