TYPO3 CMS  TYPO3_6-2
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

 install ($extensionKey)
 
 uninstall ($extensionKey)
 
 isLoaded ($extensionKey)
 
 isAvailable ($extensionKey)
 
 enrichExtensionWithDetails ($extensionKey, $loadTerInformation=TRUE)
 
 processDatabaseUpdates (array $extension)
 
 reloadCaches ()
 
 updateDbWithExtTablesSql ($rawDefinitions)
 
 importStaticSql ($rawDefinitions)
 
 removeExtension ($extension)
 
 getExtensionSqlDataDump ($extension)
 
 isUpdateAvailable (\TYPO3\CMS\Extensionmanager\Domain\Model\Extension $extensionData)
 

Public Attributes

 $objectManager
 
 $installToolSqlParser
 
 $extensionRepository
 

Protected Member Functions

 loadExtension ($extensionKey)
 
 unloadExtension ($extensionKey)
 
 ensureConfiguredDirectoriesExist (array $extension)
 
 processRuntimeDatabaseUpdates ($extensionKey)
 
 emitTablesDefinitionIsBeingBuiltSignal ($extensionKey)
 
 getSqlDataDumpForFile ($sqlFile)
 
 emitAfterExtensionT3DImportSignal ($importFileToUse, $importResult)
 
 importStaticSqlFile ($extensionSiteRelPath)
 
 emitAfterExtensionStaticSqlImportSignal ($extTablesStaticSqlRelFile)
 
 importInitialFiles ($extensionSiteRelPath, $extensionKey)
 
 emitAfterExtensionFileImportSignal ($destinationAbsolutePath)
 
 getDatabaseConnection ()
 

Protected Attributes

 $dependencyUtility
 
 $fileHandlingUtility
 
 $listUtility
 
 $databaseUtility
 
 $packageManager
 
 $cacheManager
 
 $signalSlotDispatcher
 
 $registry
 

Detailed Description

Extension Manager Install Utility

Author
Susanne Moog susan.nosp@m.ne.m.nosp@m.oog@t.nosp@m.ypo3.nosp@m..org

Definition at line 25 of file InstallUtility.php.

Member Function Documentation

◆ emitAfterExtensionFileImportSignal()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::emitAfterExtensionFileImportSignal (   $destinationAbsolutePath)
protected

Emits a signal after extension files were imported

Parameters
string$destinationAbsolutePath

Definition at line 569 of file InstallUtility.php.

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

◆ emitAfterExtensionStaticSqlImportSignal()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::emitAfterExtensionStaticSqlImportSignal (   $extTablesStaticSqlRelFile)
protected

Emits a signal after a static sql file was imported

Parameters
string$extTablesStaticSqlRelFile

Definition at line 534 of file InstallUtility.php.

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

◆ emitAfterExtensionT3DImportSignal()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::emitAfterExtensionT3DImportSignal (   $importFileToUse,
  $importResult 
)
protected

Emits a signal after an t3d file was imported

Parameters
string$importFileToUse
int$importResult

Definition at line 505 of file InstallUtility.php.

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

◆ emitTablesDefinitionIsBeingBuiltSignal()

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

Emits a signal to manipulate the tables definitions

Parameters
string$extensionKey
Returns
mixed
Exceptions

Definition at line 265 of file InstallUtility.php.

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

◆ enrichExtensionWithDetails()

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

Fetch additional information for an extension key

Parameters
string$extensionKey
bool$loadTerInformationprivate
Returns
array
Exceptions

Definition at line 193 of file InstallUtility.php.

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

◆ ensureConfiguredDirectoriesExist()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::ensureConfiguredDirectoriesExist ( array  $extension)
protected

Creates directories as requested in ext_emconf.php

Parameters
array$extension

Definition at line 221 of file InstallUtility.php.

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

◆ getDatabaseConnection()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::getDatabaseConnection ( )
protected
Returns

Definition at line 576 of file InstallUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\importStaticSql(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\updateDbWithExtTablesSql().

◆ getExtensionSqlDataDump()

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

Get the data dump for an extension

Parameters
string$extension
Returns
array

Definition at line 386 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\enrichExtensionWithDetails(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\getSqlDataDumpForFile().

◆ getSqlDataDumpForFile()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::getSqlDataDumpForFile (   $sqlFile)
protected

Gets the sql data dump for a specific sql file (for example ext_tables.sql)

Parameters
string$sqlFile
Returns
string

Definition at line 400 of file InstallUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\getUrl().

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

◆ importInitialFiles()

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

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

Parameters
string$extensionSiteRelPathrelative path to extension dir
string$extensionKey

Definition at line 545 of file InstallUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\copyDirectory(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\emitAfterExtensionFileImportSignal(), TYPO3\CMS\Core\Utility\GeneralUtility\isAllowedAbsPath(), and TYPO3\CMS\Core\Utility\GeneralUtility\mkdir().

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

◆ importStaticSql()

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

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

Parameters
string$rawDefinitions
Returns
void

Definition at line 341 of file InstallUtility.php.

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

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

◆ importStaticSqlFile()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::importStaticSqlFile (   $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$extensionSiteRelPath
Returns
void

Definition at line 516 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\emitAfterExtensionStaticSqlImportSignal(), TYPO3\CMS\Core\Utility\GeneralUtility\getUrl(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\importStaticSql().

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

◆ install()

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

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

Parameters
string$extensionKey
Exceptions

Definition at line 101 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\enrichExtensionWithDetails(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\ensureConfiguredDirectoriesExist(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\importInitialFiles(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\isLoaded(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\loadExtension(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\processDatabaseUpdates(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\processRuntimeDatabaseUpdates(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\reloadCaches().

◆ isAvailable()

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

Checks if an extension is available in the system

Parameters
string$extensionKey
Returns
boolean

Definition at line 180 of file InstallUtility.php.

◆ isLoaded()

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

Wrapper function to check for loaded extensions

Parameters
string$extensionKey
Returns
boolean TRUE if extension is loaded

Definition at line 149 of file InstallUtility.php.

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

◆ isUpdateAvailable()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::isUpdateAvailable ( \TYPO3\CMS\Extensionmanager\Domain\Model\Extension  $extensionData)

Checks if an update for an extension is available which also resolves dependencies.

Definition at line 418 of file InstallUtility.php.

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

◆ loadExtension()

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

Wrapper function for loading extensions

Parameters
string$extensionKey
Returns
void

Definition at line 159 of file InstallUtility.php.

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

◆ processDatabaseUpdates()

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::processDatabaseUpdates ( array  $extension)

Gets the content of the ext_tables.sql and ext_tables_static+adt.sql files Additionally adds the table definitions for the cache tables

Parameters
array$extension

Definition at line 231 of file InstallUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\getUrl(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\importStaticSqlFile(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\updateDbWithExtTablesSql().

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

◆ processRuntimeDatabaseUpdates()

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

Gets all database updates due to runtime configuration, like caching framework or category api for example

Parameters
string$extensionKey

Definition at line 251 of file InstallUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\InstallUtility\emitTablesDefinitionIsBeingBuiltSignal(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\updateDbWithExtTablesSql().

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

◆ reloadCaches()

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

Reload Cache files and Typo3LoadedExtensions

Returns
void

Definition at line 289 of file InstallUtility.php.

References TYPO3\CMS\Core\Utility\OpcodeCacheUtility\clearAllActive(), and TYPO3\CMS\Core\Core\Bootstrap\getInstance().

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

◆ removeExtension()

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

Remove an extension (delete the directory)

Parameters
string$extension
Exceptions

Definition at line 365 of file InstallUtility.php.

◆ uninstall()

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

Helper function to uninstall an extension

Parameters
string$extensionKey
Exceptions

Definition at line 127 of file InstallUtility.php.

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

◆ unloadExtension()

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

Wrapper function for unloading extensions

Parameters
string$extensionKey
Returns
void

Definition at line 169 of file InstallUtility.php.

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

◆ updateDbWithExtTablesSql()

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

Update database / process db updates from ext_tables

Parameters
string$rawDefinitionsThe raw SQL statements from ext_tables.sql
Returns
void

Definition at line 316 of file InstallUtility.php.

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

Referenced by TYPO3\CMS\Extensionmanager\Utility\InstallUtility\processDatabaseUpdates(), and TYPO3\CMS\Extensionmanager\Utility\InstallUtility\processRuntimeDatabaseUpdates().

Member Data Documentation

◆ $cacheManager

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$cacheManager
protected

Definition at line 79 of file InstallUtility.php.

◆ $databaseUtility

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$databaseUtility
protected

Definition at line 61 of file InstallUtility.php.

◆ $dependencyUtility

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

Definition at line 43 of file InstallUtility.php.

◆ $extensionRepository

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$extensionRepository

Definition at line 67 of file InstallUtility.php.

◆ $fileHandlingUtility

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

Definition at line 49 of file InstallUtility.php.

◆ $installToolSqlParser

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$installToolSqlParser

Definition at line 37 of file InstallUtility.php.

◆ $listUtility

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

Definition at line 55 of file InstallUtility.php.

◆ $objectManager

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$objectManager

Definition at line 31 of file InstallUtility.php.

◆ $packageManager

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$packageManager
protected

Definition at line 73 of file InstallUtility.php.

◆ $registry

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

Definition at line 91 of file InstallUtility.php.

◆ $signalSlotDispatcher

TYPO3\CMS\Extensionmanager\Utility\InstallUtility::$signalSlotDispatcher
protected

Definition at line 85 of file InstallUtility.php.