InstallUtility implements SingletonInterface, 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

SingletonInterface
"empty" interface for singletons (marker interface pattern)
LoggerAwareInterface

Properties

$bootService  : BootService
$cacheManager  : CacheManager
$eventDispatcher  : EventDispatcherInterface
$fileHandlingUtility  : FileHandlingUtility
$listUtility  : ListUtility
$packageManager  : PackageManager
$registry  : Registry

Methods

enrichExtensionWithDetails()  : array<string|int, mixed>
Fetch additional information for an extension key
importStaticSql()  : mixed
Import static SQL data (normally used for ext_tables_static+adt.sql)
injectBootService()  : mixed
injectCacheManager()  : mixed
injectEventDispatcher()  : mixed
injectFileHandlingUtility()  : mixed
injectListUtility()  : mixed
injectPackageManager()  : mixed
injectRegistry()  : mixed
install()  : mixed
Helper function to install an extension also processes db updates and clears the cache if the extension asks for it
isAvailable()  : bool
Checks if an extension is available in the system
processExtensionSetup()  : void
reloadAvailableExtensions()  : mixed
Reset and reload the available extensions
reloadCaches()  : mixed
Reload Cache files and Typo3LoadedExtensions
reloadPackageInformation()  : mixed
Reloads the package information, if the package is already registered
removeExtension()  : mixed
Remove an extension (delete the directory)
uninstall()  : mixed
Helper function to uninstall an extension
updateDatabase()  : mixed
Executes all safe database statements.
findInstalledExtensionsThatDependOnExtension()  : array<string|int, mixed>
Find installed extensions which depend on the given extension.
getExtensionArray()  : array<string|int, mixed>
importInitialFiles()  : mixed
Imports files from Initialisation/Files to fileadmin via lowlevel copy directory method
importSiteConfiguration()  : void
importStaticSqlFile()  : mixed
Imports a static tables SQL File (ext_tables_static+adt) Execution state is saved in the this->registry, so it only happens once
importT3DFile()  : Import|null
Uses the export import extension to import a T3D or XML file to PID 0 Execution state is saved in the this->registry, so it only happens once
isValidExtensionPath()  : bool
Is the given path a valid path for extension installation
loadExtension()  : mixed
Wrapper function for loading extensions
reloadOpcache()  : mixed
Reloads PHP opcache
saveDefaultConfiguration()  : mixed
Save default configuration of an extension
unloadExtension()  : mixed
Wrapper function for unloading extensions

Properties

$eventDispatcher

protected EventDispatcherInterface $eventDispatcher

Methods

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
Internal
Tags
throws
ExtensionManagerException
Return values
array<string|int, mixed>

importStaticSql()

Import static SQL data (normally used for ext_tables_static+adt.sql)

public importStaticSql(string $rawDefinitions) : mixed
Parameters
$rawDefinitions : string

injectEventDispatcher()

public injectEventDispatcher(EventDispatcherInterface $eventDispatcher) : mixed
Parameters
$eventDispatcher : EventDispatcherInterface

install()

Helper function to install an extension also processes db updates and clears the cache if the extension asks for it

public install(string ...$extensionKeys) : mixed
Parameters
$extensionKeys : string
Tags
throws
ExtensionManagerException

isAvailable()

Checks if an extension is available in the system

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

processExtensionSetup()

public processExtensionSetup(string $extensionKey) : void
Parameters
$extensionKey : string

reloadAvailableExtensions()

Reset and reload the available extensions

public reloadAvailableExtensions() : mixed

reloadCaches()

Reload Cache files and Typo3LoadedExtensions

public reloadCaches() : mixed

reloadPackageInformation()

Reloads the package information, if the package is already registered

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

if the package isn't available

throws
InvalidPackageKeyException

if an invalid package key was passed

throws
InvalidPackagePathException

if an invalid package path was passed

throws
InvalidPackageManifestException

if no extension configuration file could be found

removeExtension()

Remove an extension (delete the directory)

public removeExtension(string $extension) : mixed
Parameters
$extension : string
Tags
throws
ExtensionManagerException

uninstall()

Helper function to uninstall an extension

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

updateDatabase()

Executes all safe database statements.

public updateDatabase() : mixed

Tables and fields are created and altered. Nothing gets deleted or renamed here.

Internal

findInstalledExtensionsThatDependOnExtension()

Find installed extensions which depend on the given extension.

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

This is used at 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
Tags
throws
ExtensionManagerException
Return values
array<string|int, mixed>

importInitialFiles()

Imports files from Initialisation/Files to fileadmin via lowlevel copy directory method

protected importInitialFiles(string $packagePath, string $extensionKey) : mixed
Parameters
$packagePath : string

absolute path to extension dir

$extensionKey : string

importSiteConfiguration()

protected importSiteConfiguration(string $extensionKey, string $packagePath[, Import|null $import = null ]) : void
Parameters
$extensionKey : string
$packagePath : string
$import : Import|null = null

importStaticSqlFile()

Imports a static tables SQL File (ext_tables_static+adt) Execution state is saved in the this->registry, so it only happens once

protected importStaticSqlFile(string $extensionKey, string $packagePath) : mixed
Parameters
$extensionKey : string
$packagePath : string

importT3DFile()

Uses the export import extension to import a T3D or XML file to PID 0 Execution state is saved in the this->registry, so it only happens once

protected importT3DFile(string $extensionKey, string $packagePath) : Import|null
Parameters
$extensionKey : string
$packagePath : string
Return values
Import|null

isValidExtensionPath()

Is the given path a valid path for extension installation

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

the absolute (!) path in question

Return values
bool

loadExtension()

Wrapper function for loading extensions

protected loadExtension(string $extensionKey) : mixed
Parameters
$extensionKey : string

reloadOpcache()

Reloads PHP opcache

protected reloadOpcache() : mixed

saveDefaultConfiguration()

Save default configuration of an extension

protected saveDefaultConfiguration(string $extensionKey) : mixed
Parameters
$extensionKey : string

unloadExtension()

Wrapper function for unloading extensions

protected unloadExtension(string $extensionKey) : mixed
Parameters
$extensionKey : string 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results