InstallUtility implements LoggerAwareInterface uses LoggerAwareTrait

Extension Manager Install Utility

Internal

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

Table of Contents

Interfaces

LoggerAwareInterface

Methods

__construct()  : mixed
enrichExtensionWithDetails()  : array<string|int, mixed>
Fetch additional information for an extension key.
install()  : void
Wrapper around PackageActivationService to install an extension and processes db updates.
isAvailable()  : bool
Checks if an extension is available in the system.
reloadAvailableExtensions()  : void
Reset and reload the available extensions.
reloadPackageInformation()  : void
Reloads the package information, if the package is already registered.
removeExtension()  : void
Removing an extension deletes the directory.
uninstall()  : void
Helper function to uninstall an extension.
findInstalledExtensionsThatDependOnExtension()  : array<string|int, mixed>
Find installed extensions which depend on the given extension.
getExtensionArray()  : array<string|int, mixed>
isValidExtensionPath()  : bool
Is the given path a valid path for extension installation

Methods

__construct()

public __construct(EventDispatcherInterface $eventDispatcher, FileHandlingUtility $fileHandlingUtility, ListUtility $listUtility, PackageManager $packageManager, CacheManager $cacheManager, OpcodeCacheService $opcodeCacheService, PackageActivationService $packageActivationService, LanguageServiceFactory $languageServiceFactory) : mixed
Parameters
$eventDispatcher : EventDispatcherInterface
$fileHandlingUtility : FileHandlingUtility
$listUtility : ListUtility
$packageManager : PackageManager
$cacheManager : CacheManager
$opcodeCacheService : OpcodeCacheService
$packageActivationService : PackageActivationService
$languageServiceFactory : LanguageServiceFactory

enrichExtensionWithDetails()

Fetch additional information for an extension key.

public enrichExtensionWithDetails(string $extensionKey[, bool $loadTerInformation = true ]) : array<string|int, mixed>
Parameters
$extensionKey : string
$loadTerInformation : bool = true
Tags
throws
ExtensionManagerException
Return values
array<string|int, mixed>

install()

Wrapper around PackageActivationService to install an extension and processes db updates.

public install(string ...$extensionKeys) : void

The wrapper is used to properly dispatch the AfterPackageActivationEvent passing the current instance to the listeners.

Parameters
$extensionKeys : string
Tags
see
DispatchAfterPackageActivationEventOnPackageInitialization

isAvailable()

Checks if an extension is available in the system.

public isAvailable(string $extensionKey) : bool
Parameters
$extensionKey : string
Return values
bool

reloadAvailableExtensions()

Reset and reload the available extensions.

public reloadAvailableExtensions() : void

reloadPackageInformation()

Reloads the package information, if the package is already registered.

public reloadPackageInformation(string $extensionKey) : void
Parameters
$extensionKey : string
Tags
throws
InvalidPackageStateException

if the package isn't available

removeExtension()

Removing an extension deletes the directory.

public removeExtension(string $extension) : void
Parameters
$extension : string

uninstall()

Helper function to uninstall an extension.

public uninstall(string $extensionKey) : void
Parameters
$extensionKey : string
Tags
throws
ExtensionManagerException

findInstalledExtensionsThatDependOnExtension()

Find installed extensions which depend on the given extension.

protected findInstalledExtensionsThatDependOnExtension(string $extensionKey) : array<string|int, mixed>

Used by extension uninstall to stop the process if an installed extension depends on the extension to be uninstalled.

Parameters
$extensionKey : string
Return values
array<string|int, mixed>

getExtensionArray()

protected getExtensionArray(string $extensionKey) : array<string|int, mixed>
Parameters
$extensionKey : string
Return values
array<string|int, mixed>

isValidExtensionPath()

Is the given path a valid path for extension installation

protected isValidExtensionPath(string $path) : bool
Parameters
$path : string

Absolute (!) path in question

Return values
bool

        
On this page

Search results