Provides functions to check a set of extensions with dependencies against a set of loaded extensions and given version information. More...
Public Member Functions | |
| __construct ( $coreVersion, $phpVersion, array $phpExtensions, array $abilities=[], array $abilityErrors=[]) | |
| checkArray (array $extDependencies) | |
| Check all given dependencies if they are compatible with the named installed extensions in the $credits array. More... | |
| setLoadedExtensionsAndSkins (array $credits) | |
| Set an array with credits of all loaded extensions and skins. More... | |
Private Member Functions | |
| handleDependency ( $version, $constraint, $checkedExt) | |
| Handle a simple dependency to MediaWiki core or PHP. More... | |
| handleExtensionDependency ( $dependencyName, $constraint, $checkedExt, $type) | |
| Handle a dependency to another extension. More... | |
| setCoreVersion ( $coreVersion) | |
| Set MediaWiki core version. More... | |
| setPhpVersion ( $phpVersion) | |
| Set PHP version. More... | |
Private Attributes | |
| bool[] | $abilities = [] |
| List of provided abilities. More... | |
| string[] | $abilityErrors = [] |
| List of provided ability errors. More... | |
| Constraint bool | $coreVersion = false |
| representing $wgVersion More... | |
| array | $loaded = [] |
| Loaded extensions. More... | |
| string[] | $phpExtensions = [] |
| List of installed PHP extensions. More... | |
| Constraint bool | $phpVersion = false |
| representing PHP version More... | |
| VersionParser | $versionParser |
Detailed Description
Provides functions to check a set of extensions with dependencies against a set of loaded extensions and given version information.
- Since
- 1.29
Definition at line 32 of file VersionChecker.php.
Constructor & Destructor Documentation
◆ __construct()
| VersionChecker::__construct | ( | $coreVersion, | |
| $phpVersion, | |||
| array | $phpExtensions, | ||
| array | $abilities = [], |
||
| array | $abilityErrors = [] |
||
| ) |
- Parameters
-
string $coreVersion Current version of core string $phpVersion Current PHP version string[] $phpExtensions List of installed PHP extensions bool[] $abilities List of provided abilities string[] $abilityErrors Error messages for the abilities
Definition at line 75 of file VersionChecker.php.
References $abilities, $abilityErrors, $phpExtensions, setCoreVersion(), and setPhpVersion().
Member Function Documentation
◆ checkArray()
| VersionChecker::checkArray | ( | array | $extDependencies | ) |
Check all given dependencies if they are compatible with the named installed extensions in the $credits array.
Example $extDependencies: { 'FooBar' => { 'MediaWiki' => '>= 1.25.0', 'platform': { 'php': '>= 7.0.0', 'ext-foo': '*', 'ability-bar': true }, 'extensions' => { 'FooBaz' => '>= 1.25.0' }, 'skins' => { 'BazBar' => '>= 1.0.0' } } }
- Parameters
-
array $extDependencies All extensions that depend on other ones
- Returns
- array
Definition at line 156 of file VersionChecker.php.
References handleDependency(), handleExtensionDependency(), and ExtensionRegistry\MEDIAWIKI_CORE.
◆ handleDependency()
|
private |
Handle a simple dependency to MediaWiki core or PHP.
See handleMediaWikiDependency and handlePhpDependency for details.
- Parameters
-
Constraint | bool $version The version installed string $constraint The required version constraint for this dependency string $checkedExt The Extension, which depends on this dependency
- Returns
- bool false if no error, true else
Definition at line 282 of file VersionChecker.php.
Referenced by checkArray().
◆ handleExtensionDependency()
|
private |
Handle a dependency to another extension.
- Parameters
-
string $dependencyName The name of the dependency string $constraint The required version constraint for this dependency string $checkedExt The Extension, which depends on this dependency string $type Either 'extensions' or 'skins'
- Returns
- bool|array false for no errors, or an array of info
Definition at line 306 of file VersionChecker.php.
Referenced by checkArray().
◆ setCoreVersion()
|
private |
Set MediaWiki core version.
- Parameters
-
string $coreVersion Current version of core
Definition at line 104 of file VersionChecker.php.
References $coreVersion.
Referenced by __construct().
◆ setLoadedExtensionsAndSkins()
| VersionChecker::setLoadedExtensionsAndSkins | ( | array | $credits | ) |
Set an array with credits of all loaded extensions and skins.
- Parameters
-
array $credits An array of installed extensions with credits of them
- Returns
- VersionChecker $this
Definition at line 93 of file VersionChecker.php.
◆ setPhpVersion()
|
private |
Set PHP version.
- Parameters
-
string $phpVersion Current PHP version. Must be well-formed.
- Exceptions
-
UnexpectedValueException
Definition at line 122 of file VersionChecker.php.
References $phpVersion.
Referenced by __construct().
Member Data Documentation
◆ $abilities
|
private |
List of provided abilities.
Definition at line 51 of file VersionChecker.php.
Referenced by __construct().
◆ $abilityErrors
|
private |
List of provided ability errors.
Definition at line 56 of file VersionChecker.php.
Referenced by __construct().
◆ $coreVersion
|
private |
representing $wgVersion
Definition at line 36 of file VersionChecker.php.
Referenced by setCoreVersion().
◆ $loaded
|
private |
Loaded extensions.
Definition at line 61 of file VersionChecker.php.
◆ $phpExtensions
|
private |
List of installed PHP extensions.
Definition at line 46 of file VersionChecker.php.
Referenced by __construct().
◆ $phpVersion
|
private |
representing PHP version
Definition at line 41 of file VersionChecker.php.
Referenced by setPhpVersion().
◆ $versionParser
|
private |
Definition at line 66 of file VersionChecker.php.
The documentation for this class was generated from the following file:
- includes/registration/VersionChecker.php
