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

Public Member Functions

 injectEventDispatcher (EventDispatcherInterface $eventDispatcher)
 
 injectDependencyUtility (DependencyUtility $dependencyUtility)
 
 injectFileHandlingUtility (FileHandlingUtility $fileHandlingUtility)
 
 injectListUtility (ListUtility $listUtility)
 
 injectExtensionRepository (ExtensionRepository $extensionRepository)
 
 injectPackageManager (PackageManager $packageManager)
 
 injectCacheManager (CacheManager $cacheManager)
 
 injectRegistry (Registry $registry)
 
 injectLateBootService (LateBootService $lateBootService)
 
 install (... $extensionKeys)
 
 processExtensionSetup (string $extensionKey)
 
 uninstall ($extensionKey)
 
bool isLoaded ($extensionKey)
 
 reloadAvailableExtensions ()
 
bool isAvailable ($extensionKey)
 
 reloadPackageInformation ($extensionKey)
 
array enrichExtensionWithDetails ($extensionKey, $loadTerInformation=true)
 
 reloadCaches ()
 
 importStaticSql ($rawDefinitions)
 
 removeExtension ($extension)
 
bool Extension getUpdateableVersion (Extension $extensionData)
 

Public Attributes

TYPO3 CMS Extensionmanager Domain Repository ExtensionRepository $extensionRepository
 

Protected Member Functions

 loadExtension ($extensionKey)
 
 unloadExtension ($extensionKey)
 
array getExtensionArray ($extensionKey)
 
 reloadOpcache ()
 
 updateDatabase ()
 
 saveDefaultConfiguration ($extensionKey)
 
Import null importT3DFile ($extensionKey, $extensionSiteRelPath)
 
 importStaticSqlFile (string $extensionKey, $extensionSiteRelPath)
 
 importInitialFiles ($extensionSiteRelPath, $extensionKey)
 
 importSiteConfiguration (string $extensionKey, string $extensionSiteRelPath, Import $import=null)
 

Protected Attributes

TYPO3 CMS Extensionmanager Utility DependencyUtility $dependencyUtility
 
TYPO3 CMS Extensionmanager Utility FileHandlingUtility $fileHandlingUtility
 
TYPO3 CMS Extensionmanager Utility ListUtility $listUtility
 
TYPO3 CMS Core Package PackageManager $packageManager
 
TYPO3 CMS Core Cache CacheManager $cacheManager
 
TYPO3 CMS Core Registry $registry
 
EventDispatcherInterface $eventDispatcher
 
LateBootService $lateBootService
 

Detailed Description

Extension Manager Install Utility

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

Definition at line 54 of file InstallUtility.php.

Member Function Documentation

◆ enrichExtensionWithDetails()

array TYPO3\CMS\Extensionmanager\Utility\InstallUtility::enrichExtensionWithDetails (   $extensionKey,
  $loadTerInformation = true 
)

Fetch additional information for an extension key

Parameters
string$extensionKey
bool$loadTerInformation
Returns
‪array
Exceptions
ExtensionManagerException

Definition at line 316 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\getExtensionArray().

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\install(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\processExtensionSetup().

◆ getExtensionArray()

array TYPO3\CMS\Extensionmanager\Utility\InstallUtility::getExtensionArray (   $extensionKey)
protected
Parameters
string$extensionKey
Returns
‪array
Exceptions
ExtensionManagerException

Definition at line 340 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\enrichExtensionWithDetails().

◆ getUpdateableVersion()

bool Extension TYPO3\CMS\Extensionmanager\Utility\InstallUtility::getUpdateableVersion ( Extension  $extensionData)

Returns the updateable version for an extension which also resolves dependencies.

Parameters
Extension$extensionData
Returns
‪bool|Extension FALSE if no update available otherwise latest possible update

Definition at line 453 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getExtensionKey(), and TYPO3\CMS\Extensionmanager\Domain\Model\Extension\getIntegerVersion().

◆ importInitialFiles()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::importInitialFiles (   $extensionSiteRelPath,
  $extensionKey 
)
protected

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

Parameters
string$extensionSiteRelPath‪relative path to extension dir
string$extensionKey

Definition at line 554 of file InstallUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Core\Environment\getPublicPath(), and TYPO3\CMS\Core\Utility\GeneralUtility\mkdir().

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\processExtensionSetup().

◆ importSiteConfiguration()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::importSiteConfiguration ( string  $extensionKey,
string  $extensionSiteRelPath,
Import  $import = null 
)
protected
Parameters
string$extensionKey
string$extensionSiteRelPath
Import | null$import

Definition at line 579 of file InstallUtility.php.

References $finder, TYPO3\CMS\Core\Core\Environment\getConfigPath(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), and TYPO3\CMS\Core\Utility\GeneralUtility\mkdir().

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\processExtensionSetup().

◆ importStaticSql()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::importStaticSql (   $rawDefinitions)

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

Parameters
string$rawDefinitions

Definition at line 415 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\importStaticSqlFile().

◆ importStaticSqlFile()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::importStaticSqlFile ( string  $extensionKey,
  $extensionSiteRelPath 
)
protected

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

Parameters
string$extensionKey
string$extensionSiteRelPath

Definition at line 531 of file InstallUtility.php.

References TYPO3\CMS\Core\Core\Environment\getPublicPath(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\importStaticSql().

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\processExtensionSetup().

◆ importT3DFile()

Import null TYPO3\CMS\Extensionmanager\Utility\InstallUtility::importT3DFile (   $extensionKey,
  $extensionSiteRelPath 
)
protected

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

Parameters
string$extensionKey
string$extensionSiteRelPath
Returns
‪Import|null

Definition at line 487 of file InstallUtility.php.

References TYPO3\CMS\Core\Core\Environment\getPublicPath().

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\processExtensionSetup().

◆ injectCacheManager()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::injectCacheManager ( CacheManager  $cacheManager)
Parameters
\TYPO3\CMS\Core\Cache\CacheManager$cacheManager

Definition at line 142 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\$cacheManager.

◆ injectDependencyUtility()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::injectDependencyUtility ( DependencyUtility  $dependencyUtility)
Parameters
\TYPO3\CMS\Extensionmanager\Utility\DependencyUtility$dependencyUtility

Definition at line 102 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\$dependencyUtility.

◆ injectEventDispatcher()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::injectEventDispatcher ( EventDispatcherInterface  $eventDispatcher)

Definition at line 94 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\$eventDispatcher.

◆ injectExtensionRepository()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::injectExtensionRepository ( ExtensionRepository  $extensionRepository)
Parameters
\TYPO3\CMS\Extensionmanager\Domain\Repository\ExtensionRepository$extensionRepository

Definition at line 126 of file InstallUtility.php.

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

◆ injectFileHandlingUtility()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::injectFileHandlingUtility ( FileHandlingUtility  $fileHandlingUtility)
Parameters
\TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility$fileHandlingUtility

Definition at line 110 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\$fileHandlingUtility.

◆ injectLateBootService()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::injectLateBootService ( LateBootService  $lateBootService)
Parameters
LateBootService$lateBootService

Definition at line 158 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\$lateBootService.

◆ injectListUtility()

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

Definition at line 118 of file InstallUtility.php.

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

◆ injectPackageManager()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::injectPackageManager ( PackageManager  $packageManager)
Parameters
\TYPO3\CMS\Core\Package\PackageManager$packageManager

Definition at line 134 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\$packageManager.

◆ injectRegistry()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::injectRegistry ( Registry  $registry)
Parameters
\TYPO3\CMS\Core\Registry$registry

Definition at line 150 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\$registry.

◆ install()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::install (   $extensionKeys)

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

Parameters
string‪...$extensionKeys
Exceptions
ExtensionManagerException

Definition at line 170 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\enrichExtensionWithDetails(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\loadExtension(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\processExtensionSetup(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\reloadCaches(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\saveDefaultConfiguration(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\updateDatabase().

◆ isAvailable()

bool TYPO3\CMS\Extensionmanager\Utility\InstallUtility::isAvailable (   $extensionKey)

Checks if an extension is available in the system

Parameters
string$extensionKey
Returns
‪bool

Definition at line 285 of file InstallUtility.php.

◆ isLoaded()

bool TYPO3\CMS\Extensionmanager\Utility\InstallUtility::isLoaded (   $extensionKey)

Wrapper function to check for loaded extensions

Parameters
string$extensionKey
Returns
‪bool TRUE if extension is loaded

Definition at line 244 of file InstallUtility.php.

◆ loadExtension()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::loadExtension (   $extensionKey)
protected

Wrapper function for loading extensions

Parameters
string$extensionKey

Definition at line 262 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\install().

◆ processExtensionSetup()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::processExtensionSetup ( string  $extensionKey)
Parameters
string$extensionKey

Definition at line 207 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\enrichExtensionWithDetails(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\importInitialFiles(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\importSiteConfiguration(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\importStaticSqlFile(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\importT3DFile().

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\install().

◆ reloadAvailableExtensions()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::reloadAvailableExtensions ( )

Reset and reload the available extensions

Definition at line 252 of file InstallUtility.php.

◆ reloadCaches()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::reloadCaches ( )

Reload Cache files and Typo3LoadedExtensions

Definition at line 352 of file InstallUtility.php.

References TYPO3\CMS\Core\Core\Bootstrap\loadBaseTca(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\loadExtLocalconf(), TYPO3\CMS\Core\Core\Bootstrap\loadExtTables(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\reloadOpcache().

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\install().

◆ reloadOpcache()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::reloadOpcache ( )
protected

Reloads PHP opcache

Definition at line 363 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\reloadCaches(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\reloadPackageInformation().

◆ reloadPackageInformation()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::reloadPackageInformation (   $extensionKey)

Reloads the package information, if the package is already registered

Parameters
string$extensionKey
Exceptions

Definition at line 299 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\reloadOpcache().

◆ removeExtension()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::removeExtension (   $extension)

Remove an extension (delete the directory)

Parameters
string$extension
Exceptions
ExtensionManagerException

Definition at line 430 of file InstallUtility.php.

◆ saveDefaultConfiguration()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::saveDefaultConfiguration (   $extensionKey)
protected

Save default configuration of an extension

Parameters
string$extensionKey

Definition at line 404 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\install().

◆ uninstall()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::uninstall (   $extensionKey)

Helper function to uninstall an extension

Parameters
string$extensionKey
Exceptions
ExtensionManagerException

Definition at line 222 of file InstallUtility.php.

References TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\unloadExtension().

◆ unloadExtension()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::unloadExtension (   $extensionKey)
protected

Wrapper function for unloading extensions

Parameters
string$extensionKey

Definition at line 272 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\uninstall().

◆ updateDatabase()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::updateDatabase ( )
protected

Executes all safe database statements. Tables and fields are created and altered. Nothing gets deleted or renamed here.

Definition at line 372 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\install().

Member Data Documentation

◆ $cacheManager

TYPO3 CMS Core Cache CacheManager TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$cacheManager
protected

Definition at line 80 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\injectCacheManager().

◆ $dependencyUtility

TYPO3 CMS Extensionmanager Utility DependencyUtility TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$dependencyUtility
protected

Definition at line 60 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\injectDependencyUtility().

◆ $eventDispatcher

EventDispatcherInterface TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$eventDispatcher
protected

Definition at line 88 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\injectEventDispatcher().

◆ $extensionRepository

TYPO3 CMS Extensionmanager Domain Repository ExtensionRepository TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$extensionRepository

Definition at line 72 of file InstallUtility.php.

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

◆ $fileHandlingUtility

TYPO3 CMS Extensionmanager Utility FileHandlingUtility TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$fileHandlingUtility
protected

Definition at line 64 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\injectFileHandlingUtility().

◆ $lateBootService

LateBootService TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$lateBootService
protected

Definition at line 92 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\injectLateBootService().

◆ $listUtility

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

Definition at line 68 of file InstallUtility.php.

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

◆ $packageManager

TYPO3 CMS Core Package PackageManager TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$packageManager
protected

Definition at line 76 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\injectPackageManager().

◆ $registry

TYPO3 CMS Core Registry TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$registry
protected

Definition at line 84 of file InstallUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\injectRegistry().