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

Public Member Functions

 injectEventDispatcher (EventDispatcherInterface $eventDispatcher)
 
 injectDownloadQueue (DownloadQueue $downloadQueue)
 
 injectDependencyUtility (DependencyUtility $dependencyUtility)
 
 injectInstallUtility (InstallUtility $installUtility)
 
 injectExtensionModelUtility (ExtensionModelUtility $extensionModelUtility)
 
 injectDownloadUtility (DownloadUtility $downloadUtility)
 
 markExtensionForInstallation ($extensionKey)
 
 markExtensionForCopy ($extensionKey, $sourceFolder)
 
 markExtensionForDownload (Extension $extension)
 
 markExtensionForUpdate (Extension $extension)
 
 setSkipDependencyCheck ($skipDependencyCheck)
 
 setAutomaticInstallationEnabled ($automaticInstallationEnabled)
 
bool array installExtension (Extension $extension)
 
array getDependencyErrors ()
 
Extension getExtension ($extensionKey)
 
bool isAvailable ($extensionKey)
 
 reloadPackageInformation ($extensionKey)
 
array getAndResolveDependencies (Extension $extension)
 
 downloadMainExtension (Extension $extension)
 

Protected Member Functions

 downloadExtension (Extension $extension)
 
bool checkDependencies (Extension $extension)
 
 setInExtensionRepository ($extensionKey)
 
 copyDependencies (array $copyQueue)
 
array uninstallDependenciesToBeUpdated (array $updateQueue)
 
array installDependencies (array $installQueue)
 
array downloadDependencies (array $downloadQueue)
 

Protected Attributes

DownloadQueue $downloadQueue
 
DependencyUtility $dependencyUtility
 
InstallUtility $installUtility
 
ExtensionModelUtility $extensionModelUtility
 
DownloadUtility $downloadUtility
 
bool $automaticInstallationEnabled = true
 
bool $skipDependencyCheck = false
 
EventDispatcherInterface $eventDispatcher
 

Detailed Description

Service class for managing multiple step processes (dependencies for example)

Definition at line 32 of file ExtensionManagementService.php.

Member Function Documentation

◆ checkDependencies()

bool TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::checkDependencies ( Extension  $extension)
protected

Check dependencies for an extension and its required extensions

Parameters
Extension$extension
Returns
‪bool Returns TRUE if all dependencies can be resolved, otherwise FALSE

Definition at line 304 of file ExtensionManagementService.php.

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\installExtension().

◆ copyDependencies()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::copyDependencies ( array  $copyQueue)
protected

Copies locally provided extensions to typo3conf/ext

Parameters
array$copyQueue

Definition at line 335 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\markExtensionForInstallation(), TYPO3\CMS\Core\Utility\GeneralUtility\mkdir(), and TYPO3\CMS\Extensionmanager\Domain\Model\Extension\returnAllowedInstallPaths().

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\installExtension().

◆ downloadDependencies()

array TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::downloadDependencies ( array  $downloadQueue)
protected

Download dependencies expects an array of extension objects to download

Parameters
Extension[]$downloadQueue
Returns
‪array

Definition at line 394 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\$downloadQueue, and TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\markExtensionForInstallation().

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\installExtension().

◆ downloadExtension()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::downloadExtension ( Extension  $extension)
protected

Download an extension

Parameters
Extension$extension

Definition at line 292 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\downloadMainExtension(), TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getExtensionKey(), and TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\setInExtensionRepository().

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\installExtension().

◆ downloadMainExtension()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::downloadMainExtension ( Extension  $extension)

Downloads the extension the user wants to install This is separated from downloading the dependencies as an extension is able to provide it's own dependencies

Parameters
Extension$extension

Definition at line 430 of file ExtensionManagementService.php.

References TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject\getUid().

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\downloadExtension().

◆ getAndResolveDependencies()

array TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::getAndResolveDependencies ( Extension  $extension)

Get and resolve dependencies

Parameters
Extension$extension
Returns
‪array

Definition at line 412 of file ExtensionManagementService.php.

◆ getDependencyErrors()

array TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::getDependencyErrors ( )

Returns the unresolved dependency errors

Returns
‪array

Definition at line 247 of file ExtensionManagementService.php.

◆ getExtension()

Extension TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::getExtension (   $extensionKey)
Parameters
string$extensionKey
Returns
‪Extension
Exceptions

Definition at line 257 of file ExtensionManagementService.php.

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\markExtensionForInstallation().

◆ injectDependencyUtility()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::injectDependencyUtility ( DependencyUtility  $dependencyUtility)
Parameters
DependencyUtility$dependencyUtility

Definition at line 82 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\$dependencyUtility.

◆ injectDownloadQueue()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::injectDownloadQueue ( DownloadQueue  $downloadQueue)
Parameters
DownloadQueue$downloadQueue

Definition at line 74 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\$downloadQueue.

◆ injectDownloadUtility()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::injectDownloadUtility ( DownloadUtility  $downloadUtility)
Parameters
DownloadUtility$downloadUtility

Definition at line 106 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\$downloadUtility.

◆ injectEventDispatcher()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::injectEventDispatcher ( EventDispatcherInterface  $eventDispatcher)

Definition at line 66 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\$eventDispatcher.

◆ injectExtensionModelUtility()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::injectExtensionModelUtility ( ExtensionModelUtility  $extensionModelUtility)
Parameters
ExtensionModelUtility$extensionModelUtility

Definition at line 98 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\$extensionModelUtility.

◆ injectInstallUtility()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::injectInstallUtility ( InstallUtility  $installUtility)
Parameters
InstallUtility$installUtility

Definition at line 90 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\$installUtility.

◆ installDependencies()

array TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::installDependencies ( array  $installQueue)
protected

Install dependent extensions

Parameters
array$installQueue
Returns
‪array

Definition at line 370 of file ExtensionManagementService.php.

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\installExtension().

◆ installExtension()

bool array TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::installExtension ( Extension  $extension)

Install the extension

Parameters
Extension$extension
Returns
‪bool|array Returns FALSE if dependencies cannot be resolved, otherwise array with installation information

Definition at line 185 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\checkDependencies(), TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\copyDependencies(), TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\downloadDependencies(), TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\downloadExtension(), TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\installDependencies(), and TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\uninstallDependenciesToBeUpdated().

◆ isAvailable()

bool TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::isAvailable (   $extensionKey)

Checks if an extension is available in the system

Parameters
string$extensionKey
Returns
‪bool

Definition at line 270 of file ExtensionManagementService.php.

◆ markExtensionForCopy()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::markExtensionForCopy (   $extensionKey,
  $sourceFolder 
)

Mark an extension for copy

Parameters
string$extensionKey
string$sourceFolder

Definition at line 130 of file ExtensionManagementService.php.

◆ markExtensionForDownload()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::markExtensionForDownload ( Extension  $extension)

Mark an extension for download

Parameters
Extension$extension

Definition at line 140 of file ExtensionManagementService.php.

◆ markExtensionForInstallation()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::markExtensionForInstallation (   $extensionKey)
Parameters
string$extensionKey

Definition at line 114 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\getExtension().

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\copyDependencies(), and TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\downloadDependencies().

◆ markExtensionForUpdate()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::markExtensionForUpdate ( Extension  $extension)
Parameters
Extension$extension

Definition at line 153 of file ExtensionManagementService.php.

◆ reloadPackageInformation()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::reloadPackageInformation (   $extensionKey)
Parameters
string$extensionKey
Exceptions

Definition at line 282 of file ExtensionManagementService.php.

◆ setAutomaticInstallationEnabled()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::setAutomaticInstallationEnabled (   $automaticInstallationEnabled)
Parameters
bool$automaticInstallationEnabled

Definition at line 174 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\$automaticInstallationEnabled.

◆ setInExtensionRepository()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::setInExtensionRepository (   $extensionKey)
protected

Sets the path to the repository in an extension (Initialisation/Extensions) depending on the extension that is currently installed

Parameters
string$extensionKey

Definition at line 319 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\returnInstallPaths().

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\downloadExtension().

◆ setSkipDependencyCheck()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::setSkipDependencyCheck (   $skipDependencyCheck)

Enables or disables the dependency check for system environment (PHP, TYPO3) before extension installation

Parameters
bool$skipDependencyCheck

Definition at line 166 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\$skipDependencyCheck.

◆ uninstallDependenciesToBeUpdated()

array TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::uninstallDependenciesToBeUpdated ( array  $updateQueue)
protected

Uninstall extensions that will be updated This is not strictly necessary but cleaner all in all

Parameters
Extension[]$updateQueue
Returns
‪array

Definition at line 354 of file ExtensionManagementService.php.

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\installExtension().

Member Data Documentation

◆ $automaticInstallationEnabled

bool TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::$automaticInstallationEnabled = true
protected

Definition at line 56 of file ExtensionManagementService.php.

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\setAutomaticInstallationEnabled().

◆ $dependencyUtility

DependencyUtility TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::$dependencyUtility
protected

Definition at line 40 of file ExtensionManagementService.php.

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\injectDependencyUtility().

◆ $downloadQueue

DownloadQueue TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::$downloadQueue
protected

Definition at line 36 of file ExtensionManagementService.php.

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\downloadDependencies(), and TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\injectDownloadQueue().

◆ $downloadUtility

DownloadUtility TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::$downloadUtility
protected

Definition at line 52 of file ExtensionManagementService.php.

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\injectDownloadUtility().

◆ $eventDispatcher

EventDispatcherInterface TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::$eventDispatcher
protected

Definition at line 64 of file ExtensionManagementService.php.

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\injectEventDispatcher().

◆ $extensionModelUtility

ExtensionModelUtility TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::$extensionModelUtility
protected

Definition at line 48 of file ExtensionManagementService.php.

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\injectExtensionModelUtility().

◆ $installUtility

InstallUtility TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::$installUtility
protected

Definition at line 44 of file ExtensionManagementService.php.

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\injectInstallUtility().

◆ $skipDependencyCheck

bool TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::$skipDependencyCheck = false
protected

Definition at line 60 of file ExtensionManagementService.php.

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\setSkipDependencyCheck().