MediaWiki  master
ExtensionRegistry Class Reference

ExtensionRegistry class. More...

Collaboration diagram for ExtensionRegistry:

Public Member Functions

 clearQueue ()
 Clear the current load queue. More...
 
 finish ()
 After this is called, no more extensions can be loaded. More...
 
 getAllThings ()
 Get credits information about all installed extensions and skins. More...
 
 getAttribute ( $name)
 
 getQueue ()
 Get the current load queue. More...
 
 isLoaded ( $name, $constraint=' *')
 Whether a thing has been loaded. More...
 
 loadFromQueue ()
 
 queue ( $path)
 
 readFromQueue (array $queue)
 Process a queue of extensions and return their extracted data. More...
 
 setAttributeForTest ( $name, array $value)
 Force override the value of an attribute during tests. More...
 
 setCheckDevRequires ( $check)
 
 setLoadTestClassesAndNamespaces ( $load)
 Controls if classes and namespaces defined under the keys TestAutoloadClasses and TestAutoloadNamespaces should be added to the autoloader. More...
 

Static Public Member Functions

static exportAutoloadClassesAndNamespaces ( $dir, $info, &$autoloadClasses=[], &$autoloadNamespaces=[])
 Export autoload classes and namespaces for a given directory and parsed JSON info file. More...
 
static exportTestAutoloadClassesAndNamespaces ( $dir, $info, &$autoloadClasses=[], &$autoloadNamespaces=[])
 Export test autoload classes and namespaces for a given directory and parsed JSON info file. More...
 
static getInstance ()
 

Public Attributes

const MANIFEST_VERSION = 2
 Version of the highest supported manifest version Note: Update MANIFEST_VERSION_MW_VERSION when changing this. More...
 
const MANIFEST_VERSION_MW_VERSION = '>= 1.29.0'
 MediaWiki version constraint representing what the current highest MANIFEST_VERSION is supported in. More...
 
const MEDIAWIKI_CORE = 'MediaWiki'
 "requires" key that applies to MediaWiki core More...
 
const MERGE_STRATEGY = '_merge_strategy'
 Special key that defines the merge strategy. More...
 
const OLDEST_MANIFEST_VERSION = 1
 Version of the oldest supported manifest version. More...
 

Protected Member Functions

 exportExtractedData (array $info)
 
 getLazyLoadedAttribute ( $name)
 Get an attribute value that isn't cached by reading each extension.json file again. More...
 
 saveToCache (BagOStuff $cache, array $data)
 Save data in the cache. More...
 

Static Protected Member Functions

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

Protected Attributes

array $attributes = []
 Items in the JSON file that aren't being set as globals. More...
 
bool $checkDev = false
 Whether to check dev-requires. More...
 
array $lazyAttributes = []
 Lazy-loaded attributes. More...
 
bool $loadTestClassesAndNamespaces = false
 Whether test classes and namespaces should be added to the auto loader. More...
 
array $queued = []
 List of paths that should be loaded. More...
 
array $testAttributes = []
 Attributes for testing. More...
 

Private Member Functions

 buildVersionChecker ()
 Queries information about the software environment and constructs an appropiate version checker. More...
 
 getAbilities ()
 Get the list of abilities and their values. More...
 
 getCache ()
 
 makeCacheKey (BagOStuff $cache, $component,... $extra)
 

Private Attributes

bool $finished = false
 Whether we are done loading things. More...
 
array[] $loaded = []
 Array of loaded things, keyed by name, values are credits information. More...
 
const CACHE_EXPIRY = 60 * 60 * 24
 
const CACHE_VERSION = 7
 Bump whenever the registration cache needs resetting. More...
 
const LAZY_LOADED_ATTRIBUTES
 Attributes that should be lazy-loaded. More...
 

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

References getAbilities(), and MW_VERSION.

Referenced by readFromQueue().

◆ clearQueue()

ExtensionRegistry::clearQueue ( )

Clear the current load queue.

Not intended to be used outside of the installer.

Definition at line 280 of file ExtensionRegistry.php.

◆ exportAutoloadClassesAndNamespaces()

static ExtensionRegistry::exportAutoloadClassesAndNamespaces (   $dir,
  $info,
$autoloadClasses = [],
$autoloadNamespaces = [] 
)
static

Export autoload classes and namespaces for a given directory and parsed JSON info file.

Parameters
string$dir
array$info
array&$autoloadClasses
array&$autoloadNamespaces

Definition at line 423 of file ExtensionRegistry.php.

References $GLOBALS, AutoLoader\$psr4Namespaces, and processAutoLoader().

Referenced by readFromQueue().

◆ exportExtractedData()

ExtensionRegistry::exportExtractedData ( array  $info)
protected

Definition at line 461 of file ExtensionRegistry.php.

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

Referenced by loadFromQueue().

◆ exportTestAutoloadClassesAndNamespaces()

static ExtensionRegistry::exportTestAutoloadClassesAndNamespaces (   $dir,
  $info,
$autoloadClasses = [],
$autoloadNamespaces = [] 
)
static

Export test autoload classes and namespaces for a given directory and parsed JSON info file.

Since
1.35
Parameters
string$dir
array$info
array&$autoloadClasses
array&$autoloadNamespaces

Definition at line 447 of file ExtensionRegistry.php.

References $GLOBALS, AutoLoader\$psr4Namespaces, and processAutoLoader().

Referenced by readFromQueue().

◆ finish()

ExtensionRegistry::finish ( )

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

Since
1.29

Definition at line 289 of file ExtensionRegistry.php.

◆ getAbilities()

ExtensionRegistry::getAbilities ( )
private

Get the list of abilities and their values.

Returns
bool[]

Definition at line 297 of file ExtensionRegistry.php.

Referenced by buildVersionChecker(), and makeCacheKey().

◆ 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.

References $loaded.

Referenced by SpecialVersion\getCredits().

◆ getAttribute()

ExtensionRegistry::getAttribute (   $name)
Parameters
string$name
Returns
array

Definition at line 572 of file ExtensionRegistry.php.

References getLazyLoadedAttribute().

◆ getCache()

ExtensionRegistry::getCache ( )
private

Definition at line 184 of file ExtensionRegistry.php.

References ObjectCache\makeLocalServerCache().

Referenced by getLazyLoadedAttribute(), and loadFromQueue().

◆ getInstance()

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

References $cache, getCache(), makeCacheKey(), readFromQueue(), and saveToCache().

Referenced by getAttribute().

◆ getQueue()

ExtensionRegistry::getQueue ( )

Get the current load queue.

Not intended to be used outside of the installer.

Returns
array

Definition at line 272 of file ExtensionRegistry.php.

References $queued.

◆ isLoaded()

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

Whether a thing has been loaded.

Parameters
string$name
string$constraintThe required version constraint for this dependency
Exceptions
LogicExceptionif a specific contraint is asked for, but the extension isn't versioned
Returns
bool

Definition at line 553 of file ExtensionRegistry.php.

◆ loadFromQueue()

ExtensionRegistry::loadFromQueue ( )
Exceptions
MWExceptionIf the queue is already marked as finished (no further things should be loaded then).

Definition at line 212 of file ExtensionRegistry.php.

References $cache, exportExtractedData(), getCache(), makeCacheKey(), readFromQueue(), and saveToCache().

◆ makeCacheKey()

ExtensionRegistry::makeCacheKey ( BagOStuff  $cache,
  $component,
  $extra 
)
private

◆ processAutoLoader()

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

Fully expand autoloader paths.

Parameters
string$dir
array$files
Returns
array

Definition at line 656 of file ExtensionRegistry.php.

References $file.

Referenced by exportAutoloadClassesAndNamespaces(), and exportTestAutoloadClassesAndNamespaces().

◆ queue()

ExtensionRegistry::queue (   $path)
Parameters
string$pathAbsolute path to the JSON file

Definition at line 166 of file ExtensionRegistry.php.

References $path, and $wgExtensionInfoMTime.

◆ readFromQueue()

ExtensionRegistry::readFromQueue ( array  $queue)

Process a queue of extensions and return their extracted data.

Parameters
array$queuekeys are filenames, values are ignored
Returns
array extracted info
Exceptions
Exception
ExtensionDependencyError

Definition at line 332 of file ExtensionRegistry.php.

References $path, $queue, buildVersionChecker(), exportAutoloadClassesAndNamespaces(), exportTestAutoloadClassesAndNamespaces(), and wfDeprecatedMsg().

Referenced by getLazyLoadedAttribute(), and loadFromQueue().

◆ saveToCache()

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

Save data in the cache.

Parameters
BagOStuff$cache
array$data

Definition at line 241 of file ExtensionRegistry.php.

References $cache, $wgDevelopmentWarnings, and makeCacheKey().

Referenced by getLazyLoadedAttribute(), and loadFromQueue().

◆ setAttributeForTest()

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

Force override the value of an attribute during tests.

Parameters
string$nameName of attribute to override
array$valueValue to set
Returns
ScopedCallback to reset
Since
1.33

Definition at line 625 of file ExtensionRegistry.php.

◆ setCheckDevRequires()

ExtensionRegistry::setCheckDevRequires (   $check)
Since
1.34
Parameters
bool$check

Definition at line 148 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 159 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 97 of file ExtensionRegistry.php.

◆ $checkDev

bool ExtensionRegistry::$checkDev = false
protected

Whether to check dev-requires.

Definition at line 118 of file ExtensionRegistry.php.

Referenced by makeCacheKey().

◆ $finished

bool ExtensionRegistry::$finished = false
private

Whether we are done loading things.

Definition at line 89 of file ExtensionRegistry.php.

◆ $instance

ExtensionRegistry ExtensionRegistry::$instance
staticprivate

Definition at line 130 of file ExtensionRegistry.php.

Referenced by getInstance().

◆ $lazyAttributes

array ExtensionRegistry::$lazyAttributes = []
protected

Lazy-loaded attributes.

Definition at line 111 of file ExtensionRegistry.php.

◆ $loaded

array [] ExtensionRegistry::$loaded = []
private

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

The keys that the credit info arrays may have is defined by ExtensionProcessor::CREDIT_ATTRIBS (plus a 'path' key that points to the skin or extension JSON file).

This info may be accessed via via ExtensionRegistry::getAllThings.

Definition at line 75 of file ExtensionRegistry.php.

Referenced by getAllThings().

◆ $loadTestClassesAndNamespaces

bool ExtensionRegistry::$loadTestClassesAndNamespaces = false
protected

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

Definition at line 125 of file ExtensionRegistry.php.

◆ $queued

array ExtensionRegistry::$queued = []
protected

List of paths that should be loaded.

Definition at line 82 of file ExtensionRegistry.php.

Referenced by getQueue(), and makeCacheKey().

◆ $testAttributes

array ExtensionRegistry::$testAttributes = []
protected

Attributes for testing.

Definition at line 104 of file ExtensionRegistry.php.

◆ CACHE_EXPIRY

const ExtensionRegistry::CACHE_EXPIRY = 60 * 60 * 24
private

Definition at line 47 of file ExtensionRegistry.php.

◆ CACHE_VERSION

const ExtensionRegistry::CACHE_VERSION = 7
private

Bump whenever the registration cache needs resetting.

Definition at line 45 of file ExtensionRegistry.php.

Referenced by makeCacheKey().

◆ LAZY_LOADED_ATTRIBUTES

const ExtensionRegistry::LAZY_LOADED_ATTRIBUTES
private
Initial value:
= [
'TrackingCategories',
'QUnitTestModules',
]

Attributes that should be lazy-loaded.

Definition at line 59 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 29 of file ExtensionRegistry.php.

Referenced by UpdateExtensionJsonSchema\execute(), ConvertExtensionToRegistration\execute(), 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 35 of file ExtensionRegistry.php.

Referenced by ConvertExtensionToRegistration\execute(), and UpdateExtensionJsonSchema\updateRequiredMwVersion().

◆ MEDIAWIKI_CORE

const ExtensionRegistry::MEDIAWIKI_CORE = 'MediaWiki'

◆ MERGE_STRATEGY

const ExtensionRegistry::MERGE_STRATEGY = '_merge_strategy'

Special key that defines the merge strategy.

Since
1.26

Definition at line 54 of file ExtensionRegistry.php.

Referenced by exportExtractedData(), ExtensionProcessor\extractConfig2(), ExtensionProcessor\getExtractedInfo(), and UpdateExtensionJsonSchema\updateTo2().

◆ OLDEST_MANIFEST_VERSION

const ExtensionRegistry::OLDEST_MANIFEST_VERSION = 1

Version of the oldest supported manifest version.

Definition at line 40 of file ExtensionRegistry.php.

Referenced by ExtensionJsonValidator\validate().


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