TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController Class Reference
Inheritance diagram for TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController:
TYPO3\CMS\Extensionmanager\Controller\AbstractController TYPO3\CMS\Extbase\Mvc\Controller\ActionController TYPO3\CMS\Extbase\Mvc\Controller\AbstractController TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface

Public Member Functions

 injectConfigurationUtility (\TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility $configurationUtility)
 
 injectExtensionRepository (\TYPO3\CMS\Extensionmanager\Domain\Repository\ExtensionRepository $extensionRepository)
 
 injectFileHandlingUtility (\TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility $fileHandlingUtility)
 
 injectTerUtility (\TYPO3\CMS\Extensionmanager\Utility\Connection\TerUtility $terUtility)
 
 injectManagementService (\TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService $managementService)
 
 __destruct ()
 
 formAction ()
 
 extractAction ($overwrite=false)
 
 checkFileName ($fileName)
 
 extractExtensionFromFile ($uploadPath, $fileName, $overwrite)
 
 activateExtension ($extensionKey)
 
- Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 injectCacheService (\TYPO3\CMS\Extbase\Service\CacheService $cacheService)
 
 injectMvcPropertyMappingConfigurationService (\TYPO3\CMS\Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
 
 processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
 
- Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
 injectSignalSlotDispatcher (\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher)
 
 injectValidatorResolver (\TYPO3\CMS\Extbase\Validation\ValidatorResolver $validatorResolver)
 
 getControllerContext ()
 
 __construct ()
 
 injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
 
 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 addFlashMessage ($messageBody, $messageTitle='', $severity=\TYPO3\CMS\Core\Messaging\AbstractMessage::OK, $storeInSession=true)
 
 canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)
 
 processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
 
 forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)
 
 throwStatus ($statusCode, $statusMessage=null, $content=null)
 

Protected Member Functions

 getExtensionFromT3xFile ($file, $overwrite=false)
 
 getExtensionFromZipFile ($file, $fileName, $overwrite=false)
 
 getExtensionKeyFromFileName ($fileName)
 
 copyExtensionFolderToTempFolder ($extensionKey)
 
 removeExtensionAndRestoreFromBackup ($fileName)
 
 removeBackupFolder ()
 
- Protected Member Functions inherited from TYPO3\CMS\Extensionmanager\Controller\AbstractController
 translate ($key, $arguments=null)
 
 handleTriggerArguments ()
 
- Protected Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 initializeActionMethodArguments ()
 
 resolveActionMethodName ()
 
 emitBeforeCallActionMethodSignal (array $preparedArguments)
 
 setViewConfiguration (ViewInterface $view)
 
 getViewProperty ($extbaseFrameworkConfiguration, $setting)
 
 resolveViewObjectName ()
 
 initializeView (ViewInterface $view)
 
 initializeAction ()
 
 errorAction ()
 
 clearCacheOnError ()
 
 addErrorFlashMessage ()
 
 getErrorFlashMessage ()
 
 forwardToReferringRequest ()
 
 getFlattenedValidationErrorMessage ()
 
- Protected Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
 redirect ($actionName, $controllerName=null, $extensionName=null, array $arguments=null, $pageUid=null, $delay=0, $statusCode=303)
 
 redirectToUri ($uri, $delay=0, $statusCode=303)
 
 addBaseUriIfNecessary ($uri)
 

Protected Attributes

 $configurationUtility
 
 $extensionRepository
 
 $fileHandlingUtility
 
 $terUtility
 
 $managementService
 
 $extensionBackupPath = ''
 
 $removeFromOriginalPath = false
 
- Protected Attributes inherited from TYPO3\CMS\Extensionmanager\Controller\AbstractController
 $triggerArguments
 
- Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 $reflectionService
 
 $cacheService
 
 $view = null
 
 $namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'
 
 $viewFormatToObjectNameMap = []
 
 $defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
 
 $actionMethodName = 'indexAction'
 
 $errorMethodName = 'errorAction'
 
 $mvcPropertyMappingConfigurationService
 
 $request
 
 $response
 
- Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
 $signalSlotDispatcher
 
 $objectManager
 
 $uriBuilder
 
 $extensionName
 
 $settings
 
 $request
 
 $response
 
 $validatorResolver
 
 $arguments
 
 $supportedRequestTypes = [\TYPO3\CMS\Extbase\Mvc\Request::class]
 
 $controllerContext
 
 $configurationManager
 

Additional Inherited Members

- Static Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
static getActionMethodParameters ($objectManager)
 
- Public Attributes inherited from TYPO3\CMS\Extensionmanager\Controller\AbstractController
const TRIGGER_RefreshModuleMenu = 'refreshModuleMenu'
 

Detailed Description

Controller for handling upload of a local extension file Handles .t3x or .zip files

Definition at line 28 of file UploadExtensionFileController.php.

Constructor & Destructor Documentation

◆ __destruct()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::__destruct ( )

Remove backup folder before destruction

Definition at line 108 of file UploadExtensionFileController.php.

References TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\removeBackupFolder().

Member Function Documentation

◆ activateExtension()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::activateExtension (   $extensionKey)
Parameters
string$extensionKey
Returns
bool

Definition at line 232 of file UploadExtensionFileController.php.

Referenced by TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\extractAction().

◆ checkFileName()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::checkFileName (   $fileName)

Validate the filename of an uploaded file

Parameters
string$fileName
Returns
void
Exceptions

Definition at line 195 of file UploadExtensionFileController.php.

Referenced by TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\extractAction().

◆ copyExtensionFolderToTempFolder()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::copyExtensionFolderToTempFolder (   $extensionKey)
protected

◆ extractAction()

◆ extractExtensionFromFile()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::extractExtensionFromFile (   $uploadPath,
  $fileName,
  $overwrite 
)

Extract a given t3x or zip file

Parameters
string$uploadPathPath to existing extension file
string$fileNameFilename of the uploaded file
bool$overwriteIf true, extension will be replaced
Returns
array Extension data
Exceptions
ExtensionManagerException
DependencyConfigurationNotFoundException

Definition at line 216 of file UploadExtensionFileController.php.

References TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\getExtensionFromT3xFile(), and TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\getExtensionFromZipFile().

Referenced by TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\extractAction().

◆ formAction()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::formAction ( )

Render upload extension form

Returns
void

Definition at line 118 of file UploadExtensionFileController.php.

References TYPO3\CMS\Core\Core\Bootstrap\usesComposerClassLoading().

◆ getExtensionFromT3xFile()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::getExtensionFromT3xFile (   $file,
  $overwrite = false 
)
protected

Extracts a given t3x file and installs the extension

Parameters
string$filePath to uploaded file
bool$overwriteOverwrite existing extension if TRUE
Exceptions
ExtensionManagerException
DependencyConfigurationNotFoundException
Returns
array

Definition at line 248 of file UploadExtensionFileController.php.

References TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\copyExtensionFolderToTempFolder(), TYPO3\CMS\Core\Utility\GeneralUtility\getUrl(), and TYPO3\CMS\Extensionmanager\Controller\AbstractController\translate().

Referenced by TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\extractExtensionFromFile().

◆ getExtensionFromZipFile()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::getExtensionFromZipFile (   $file,
  $fileName,
  $overwrite = false 
)
protected

Extracts a given zip file and installs the extension As there is no information about the extension key in the zip we have to use the file name to get that information filename format is expected to be extensionkey_version.zip

Parameters
string$filePath to uploaded file
string$fileNameFilename (basename) of uploaded file
bool$overwriteOverwrite existing extension if TRUE
Returns
array
Exceptions
ExtensionManagerException

Definition at line 292 of file UploadExtensionFileController.php.

References TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\copyExtensionFolderToTempFolder(), and TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\getExtensionKeyFromFileName().

Referenced by TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\extractExtensionFromFile().

◆ getExtensionKeyFromFileName()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::getExtensionKeyFromFileName (   $fileName)
protected

Removes version and file extension from filename to determine extension key

Parameters
string$fileName
Returns
string

Definition at line 315 of file UploadExtensionFileController.php.

Referenced by TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\getExtensionFromZipFile(), and TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\removeExtensionAndRestoreFromBackup().

◆ injectConfigurationUtility()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::injectConfigurationUtility ( \TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility  $configurationUtility)
Parameters
\TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility$configurationUtility

Definition at line 68 of file UploadExtensionFileController.php.

References TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\$configurationUtility.

◆ injectExtensionRepository()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::injectExtensionRepository ( \TYPO3\CMS\Extensionmanager\Domain\Repository\ExtensionRepository  $extensionRepository)
Parameters
\TYPO3\CMS\Extensionmanager\Domain\Repository\ExtensionRepository$extensionRepository

Definition at line 76 of file UploadExtensionFileController.php.

References TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\$extensionRepository.

◆ injectFileHandlingUtility()

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

Definition at line 84 of file UploadExtensionFileController.php.

References TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\$fileHandlingUtility.

◆ injectManagementService()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::injectManagementService ( \TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService  $managementService)
Parameters
\TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService$managementService

Definition at line 100 of file UploadExtensionFileController.php.

References TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\$managementService.

◆ injectTerUtility()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::injectTerUtility ( \TYPO3\CMS\Extensionmanager\Utility\Connection\TerUtility  $terUtility)
Parameters
\TYPO3\CMS\Extensionmanager\Utility\Connection\TerUtility$terUtility

Definition at line 92 of file UploadExtensionFileController.php.

References TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\$terUtility.

◆ removeBackupFolder()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::removeBackupFolder ( )
protected

Removes the backup folder in typo3temp

Returns
void

Definition at line 360 of file UploadExtensionFileController.php.

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

Referenced by TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\__destruct().

◆ removeExtensionAndRestoreFromBackup()

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::removeExtensionAndRestoreFromBackup (   $fileName)
protected

Member Data Documentation

◆ $configurationUtility

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::$configurationUtility
protected

◆ $extensionBackupPath

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::$extensionBackupPath = ''
protected

◆ $extensionRepository

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::$extensionRepository
protected

◆ $fileHandlingUtility

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::$fileHandlingUtility
protected

◆ $managementService

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::$managementService
protected

◆ $removeFromOriginalPath

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::$removeFromOriginalPath = false
protected

Definition at line 63 of file UploadExtensionFileController.php.

◆ $terUtility

TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController::$terUtility
protected