Inheritance diagram for TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService:

Public Member Functions
	__construct (RemoteRegistry $remoteRegistry, FileHandlingUtility $fileHandlingUtility)

	injectEventDispatcher (EventDispatcherInterface $eventDispatcher)

	injectDownloadQueue (DownloadQueue $downloadQueue)

	injectDependencyUtility (DependencyUtility $dependencyUtility)

	injectInstallUtility (InstallUtility $installUtility)

	markExtensionForInstallation ($extensionKey)

	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)

	setDownloadPath (string $downloadPath)

Protected Member Functions
bool	checkDependencies (Extension $extension)

array	uninstallDependenciesToBeUpdated (array $updateQueue)

array	installDependencies (array $installQueue)

array	downloadDependencies (array $downloadQueue)

	rawDownload (Extension $extension)

Protected Attributes
DownloadQueue	$downloadQueue

DependencyUtility	$dependencyUtility

InstallUtility	$installUtility

bool	$automaticInstallationEnabled = true

bool	$skipDependencyCheck = false

EventDispatcherInterface	$eventDispatcher

FileHandlingUtility	$fileHandlingUtility

RemoteRegistry	$remoteRegistry

string	$downloadPath = 'Local'

Detailed Description

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

Definition at line 35 of file ExtensionManagementService.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::__construct	(	RemoteRegistry	$remoteRegistry,
		FileHandlingUtility	$fileHandlingUtility
	)

Definition at line 73 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\$fileHandlingUtility, and TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\$remoteRegistry.

Member Function Documentation

◆ checkDependencies()

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

protected

Check dependencies for an extension and its required extensions

Returns: ‪bool Returns TRUE if all dependencies can be resolved, otherwise FALSE

Definition at line 256 of file ExtensionManagementService.php.

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 310 of file ExtensionManagementService.php.

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

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

Definition at line 343 of file ExtensionManagementService.php.

References TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface\getUid(), and TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\rawDownload().

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

◆ getAndResolveDependencies()

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

Get and resolve dependencies

Returns: ‪array

Definition at line 327 of file ExtensionManagementService.php.

◆ getDependencyErrors()

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

Returns the unresolved dependency errors

Returns: ‪array

Definition at line 211 of file ExtensionManagementService.php.

◆ getExtension()

Extension TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::getExtension ( $extensionKey )

Parameters

string $extensionKey

Returns: ‪Extension

Exceptions

Definition at line 221 of file ExtensionManagementService.php.

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

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

◆ injectDependencyUtility()

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

Definition at line 89 of file ExtensionManagementService.php.

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

◆ injectDownloadQueue()

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

Definition at line 84 of file ExtensionManagementService.php.

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

◆ injectEventDispatcher()

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

Definition at line 79 of file ExtensionManagementService.php.

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

◆ injectInstallUtility()

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

Definition at line 94 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

Returns: ‪array

Definition at line 286 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

Returns: ‪bool|array Returns FALSE if dependencies cannot be resolved, otherwise array with installation information

Definition at line 156 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\checkDependencies(), TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\downloadDependencies(), TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\downloadMainExtension(), 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 234 of file ExtensionManagementService.php.

◆ markExtensionForDownload()

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

Mark an extension for download

Definition at line 115 of file ExtensionManagementService.php.

◆ markExtensionForInstallation()

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

Parameters

string $extensionKey

Definition at line 102 of file ExtensionManagementService.php.

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

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

◆ markExtensionForUpdate()

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

Definition at line 125 of file ExtensionManagementService.php.

◆ rawDownload()

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

protected

Definition at line 352 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getExtensionKey(), TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getMd5hash(), TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getRemoteIdentifier(), TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getVersion(), and TYPO3\CMS\Core\Core\Environment\isComposerMode().

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

◆ reloadPackageInformation()

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

Parameters

string $extensionKey

Exceptions

Definition at line 246 of file ExtensionManagementService.php.

◆ setAutomaticInstallationEnabled()

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

Parameters

bool $automaticInstallationEnabled

Definition at line 146 of file ExtensionManagementService.php.

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

◆ setDownloadPath()

TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::setDownloadPath ( string $downloadPath )

Set the download path

Exceptions

ExtensionManagerException

Definition at line 381 of file ExtensionManagementService.php.

References TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\$downloadPath, and TYPO3\CMS\Extensionmanager\Domain\Model\Extension\returnAllowedInstallTypes().

◆ 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 138 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 271 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 51 of file ExtensionManagementService.php.

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

◆ $dependencyUtility

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

protected

Definition at line 43 of file ExtensionManagementService.php.

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

◆ $downloadPath

string TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::$downloadPath = 'Local'

protected

Definition at line 71 of file ExtensionManagementService.php.

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

◆ $downloadQueue

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

protected

Definition at line 39 of file ExtensionManagementService.php.

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

◆ $eventDispatcher

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

protected

Definition at line 59 of file ExtensionManagementService.php.

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

◆ $fileHandlingUtility

FileHandlingUtility TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::$fileHandlingUtility

protected

Definition at line 63 of file ExtensionManagementService.php.

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

◆ $installUtility

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

protected

Definition at line 47 of file ExtensionManagementService.php.

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

◆ $remoteRegistry

RemoteRegistry TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService::$remoteRegistry

protected

Definition at line 67 of file ExtensionManagementService.php.

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

◆ $skipDependencyCheck

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

protected

Definition at line 55 of file ExtensionManagementService.php.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkDependencies()

◆ downloadDependencies()

◆ downloadMainExtension()

◆ getAndResolveDependencies()

◆ getDependencyErrors()

◆ getExtension()

◆ injectDependencyUtility()

◆ injectDownloadQueue()

◆ injectEventDispatcher()

◆ injectInstallUtility()

◆ installDependencies()

◆ installExtension()

◆ isAvailable()

◆ markExtensionForDownload()

◆ markExtensionForInstallation()

◆ markExtensionForUpdate()

◆ rawDownload()

◆ reloadPackageInformation()

◆ setAutomaticInstallationEnabled()

◆ setDownloadPath()

◆ setSkipDependencyCheck()

◆ uninstallDependenciesToBeUpdated()

Member Data Documentation

◆ $automaticInstallationEnabled

◆ $dependencyUtility

◆ $downloadPath

◆ $downloadQueue

◆ $eventDispatcher

◆ $fileHandlingUtility

◆ $installUtility

◆ $remoteRegistry

◆ $skipDependencyCheck