‪TYPO3CMS  11.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Extensionmanager\Utility\DependencyUtility Class Reference
Inheritance diagram for TYPO3\CMS\Extensionmanager\Utility\DependencyUtility:
TYPO3\CMS\Core\SingletonInterface

Public Member Functions

 injectExtensionRepository (ExtensionRepository $extensionRepository)
 
 injectListUtility (ListUtility $listUtility)
 
 injectEmConfUtility (EmConfUtility $emConfUtility)
 
 injectManagementService (ExtensionManagementService $managementService)
 
 setSkipDependencyCheck ($skipDependencyCheck)
 
 checkDependencies (Extension $extension)
 
bool hasDependencyErrors ()
 
array getDependencyErrors ()
 

Protected Member Functions

 setAvailableExtensions ()
 
bool checkTypo3Dependency (Dependency $dependency, string $version)
 
bool checkPhpDependency (Dependency $dependency, string $version)
 
bool checkExtensionDependency (Dependency $dependency)
 
 downloadExtensionFromRemote (string $extensionKey, Dependency $dependency)
 
bool isDependentExtensionLoaded ($extensionKey)
 
bool isLoadedVersionCompatible (Dependency $dependency)
 
bool isDependentExtensionAvailable (string $extensionKey)
 
bool isAvailableVersionCompatible (Dependency $dependency)
 
bool isExtensionDownloadableFromRemote (string $extensionKey)
 
bool isDownloadableVersionCompatible (Dependency $dependency)
 
Extension null getCompatibleExtension (iterable $extensions)
 
Extension null getLatestCompatibleExtensionByDependency (Dependency $dependency)
 

Protected Attributes

ExtensionRepository $extensionRepository
 
ListUtility $listUtility
 
EmConfUtility $emConfUtility
 
ExtensionManagementService $managementService
 
array $availableExtensions = array( )
 
array $dependencyErrors = array( )
 
bool $skipDependencyCheck = false
 

Detailed Description

Utility for dealing with dependencies

This class is a specific ExtensionManager implementation and is not part of the Public TYPO3 API.

Definition at line 34 of file DependencyUtility.php.

Member Function Documentation

◆ checkDependencies()

TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::checkDependencies ( Extension  $extension)

Checks dependencies for special cases (currently typo3 and php)

Parameters
Extension$extension

Definition at line 118 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\$specialDependencies, TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\checkExtensionDependency(), TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\checkPhpDependency(), TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\checkTypo3Dependency(), TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getDependencies(), TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getExtensionKey(), and TYPO3\CMS\Core\Utility\VersionNumberUtility\getNumericTypo3Version().

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\getCompatibleExtension().

◆ checkExtensionDependency()

bool TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::checkExtensionDependency ( Dependency  $dependency)
protected

Main controlling function for checking dependencies Dependency check is done in the following way:

  • ‪installed extension in matching version ? - return true
  • ‪available extension in matching version ? - mark for installation

  • remote (TER) extension in matching version? - mark for download

    Todo:
    ‪handle exceptions / markForUpload
    Parameters
    Dependency$dependency
    Exceptions
    Exception

Definition at line 252 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\$dependencyErrors, TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\downloadExtensionFromRemote(), TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getHighestVersion(), TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getIdentifier(), TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getLowestVersion(), TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\isAvailableVersionCompatible(), TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\isDependentExtensionAvailable(), TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\isDependentExtensionLoaded(), and TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\isLoadedVersionCompatible().

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\checkDependencies().

◆ checkPhpDependency()

bool TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::checkPhpDependency ( Dependency  $dependency,
string  $version 
)
protected

Returns true if current php version fulfills extension requirements

Parameters
Dependency$dependency
string$version
Exceptions
Exception

Definition at line 216 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getHighestVersion(), TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getIdentifier(), and TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getLowestVersion().

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\checkDependencies().

◆ checkTypo3Dependency()

bool TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::checkTypo3Dependency ( Dependency  $dependency,
string  $version 
)
protected

Returns true if current TYPO3 version fulfills extension requirements

Parameters
Dependency$dependency
string$version
Returns
‪bool
Exceptions
Exception

Definition at line 184 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getHighestVersion(), TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getIdentifier(), and TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getLowestVersion().

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\checkDependencies().

◆ downloadExtensionFromRemote()

TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::downloadExtensionFromRemote ( string  $extensionKey,
Dependency  $dependency 
)
protected

Handles checks to find a compatible extension version from TER to fulfill given dependency

Parameters
string$extensionKey
Dependency$dependency
Exceptions
MissingExtensionDependencyException

Definition at line 331 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getIdentifier(), TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\getLatestCompatibleExtensionByDependency(), TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\isDependentExtensionLoaded(), TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\isDownloadableVersionCompatible(), and TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\isExtensionDownloadableFromRemote().

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\checkExtensionDependency().

◆ getCompatibleExtension()

Extension null TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::getCompatibleExtension ( iterable  $extensions)
protected

Get the latest compatible version of an extension that's compatible with the current core and PHP version.

Parameters
iterable$extensions
Returns
‪Extension|null

Definition at line 460 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\checkDependencies().

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\getLatestCompatibleExtensionByDependency().

◆ getDependencyErrors()

array TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::getDependencyErrors ( )

Return the dependency errors

Returns
‪array

Definition at line 171 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\$dependencyErrors.

◆ getLatestCompatibleExtensionByDependency()

Extension null TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::getLatestCompatibleExtensionByDependency ( Dependency  $dependency)
protected

Get the latest compatible version of an extension that fulfills the given dependency from TER

Parameters
Dependency$dependency
Returns
‪Extension|null

Definition at line 486 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\getCompatibleExtension(), TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getHighestVersionAsInteger(), TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getIdentifier(), and TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getLowestVersionAsInteger().

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\downloadExtensionFromRemote().

◆ hasDependencyErrors()

bool TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::hasDependencyErrors ( )

Returns TRUE if a dependency error was found

Returns
‪bool

Definition at line 161 of file DependencyUtility.php.

◆ injectEmConfUtility()

TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::injectEmConfUtility ( EmConfUtility  $emConfUtility)
Parameters
EmConfUtility$emConfUtility

Definition at line 83 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\$emConfUtility.

◆ injectExtensionRepository()

TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::injectExtensionRepository ( ExtensionRepository  $extensionRepository)
Parameters
ExtensionRepository$extensionRepository

Definition at line 67 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\$extensionRepository.

◆ injectListUtility()

TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::injectListUtility ( ListUtility  $listUtility)
Parameters
ListUtility$listUtility

Definition at line 75 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\$listUtility.

◆ injectManagementService()

TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::injectManagementService ( ExtensionManagementService  $managementService)
Parameters
ExtensionManagementService$managementService

Definition at line 91 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\$managementService.

◆ isAvailableVersionCompatible()

bool TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::isAvailableVersionCompatible ( Dependency  $dependency)
protected

Checks whether the available version is compatible

Parameters
Dependency$dependency
Returns
‪bool

Definition at line 416 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getIdentifier(), TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\isVersionCompatible(), and TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\setAvailableExtensions().

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\checkExtensionDependency().

◆ isDependentExtensionAvailable()

bool TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::isDependentExtensionAvailable ( string  $extensionKey)
protected

Checks whether the needed extension is available (not necessarily installed, but present in system)

Parameters
string$extensionKey
Returns
‪bool

Definition at line 404 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\setAvailableExtensions().

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\checkExtensionDependency().

◆ isDependentExtensionLoaded()

bool TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::isDependentExtensionLoaded (   $extensionKey)
protected
Parameters
string$extensionKey
Returns
‪bool

Definition at line 382 of file DependencyUtility.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded().

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\checkExtensionDependency(), and TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\downloadExtensionFromRemote().

◆ isDownloadableVersionCompatible()

bool TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::isDownloadableVersionCompatible ( Dependency  $dependency)
protected

Checks whether a compatible version of the extension exists in TER

Parameters
Dependency$dependency
Returns
‪bool

Definition at line 443 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getHighestVersionAsInteger(), TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getIdentifier(), and TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getLowestVersionAsInteger().

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\downloadExtensionFromRemote().

◆ isExtensionDownloadableFromRemote()

bool TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::isExtensionDownloadableFromRemote ( string  $extensionKey)
protected

Checks whether a ter extension with $extensionKey exists

Parameters
string$extensionKey
Returns
‪bool

Definition at line 432 of file DependencyUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\downloadExtensionFromRemote().

◆ isLoadedVersionCompatible()

bool TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::isLoadedVersionCompatible ( Dependency  $dependency)
protected
Parameters
Dependency$dependency
Returns
‪bool

Definition at line 391 of file DependencyUtility.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\getExtensionVersion(), TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\getIdentifier(), and TYPO3\CMS\Extensionmanager\Domain\Model\Dependency\isVersionCompatible().

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\checkExtensionDependency().

◆ setAvailableExtensions()

TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::setAvailableExtensions ( )
protected

Setter for available extensions gets available extensions from list utility if not already done

Definition at line 100 of file DependencyUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\isAvailableVersionCompatible(), and TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\isDependentExtensionAvailable().

◆ setSkipDependencyCheck()

TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::setSkipDependencyCheck (   $skipDependencyCheck)
Parameters
bool$skipDependencyCheck

Definition at line 108 of file DependencyUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\$skipDependencyCheck.

Member Data Documentation

◆ $availableExtensions

array TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::$availableExtensions = array( )
protected

Definition at line 54 of file DependencyUtility.php.

◆ $dependencyErrors

array TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::$dependencyErrors = array( )
protected

Definition at line 58 of file DependencyUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\checkExtensionDependency(), and TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\getDependencyErrors().

◆ $emConfUtility

EmConfUtility TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::$emConfUtility
protected

Definition at line 46 of file DependencyUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\injectEmConfUtility().

◆ $extensionRepository

ExtensionRepository TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::$extensionRepository
protected

Definition at line 38 of file DependencyUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\injectExtensionRepository().

◆ $listUtility

ListUtility TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::$listUtility
protected

Definition at line 42 of file DependencyUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\injectListUtility().

◆ $managementService

ExtensionManagementService TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::$managementService
protected

Definition at line 50 of file DependencyUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\injectManagementService().

◆ $skipDependencyCheck

bool TYPO3\CMS\Extensionmanager\Utility\DependencyUtility::$skipDependencyCheck = false
protected

Definition at line 62 of file DependencyUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\setSkipDependencyCheck().