TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
UploadExtensionFileController Class Reference
Inheritance diagram for UploadExtensionFileController:
AbstractController ActionController AbstractController 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)
 

Protected Member Functions

 getExtensionFromT3xFile ($file, $overwrite=false)
 
 getExtensionFromZipFile ($file, $fileName, $overwrite=false)
 
 getExtensionKeyFromFileName ($fileName)
 
 copyExtensionFolderToTempFolder ($extensionKey)
 
 removeExtensionAndRestoreFromBackup ($fileName)
 
 removeBackupFolder ()
 
- Protected Member Functions inherited from AbstractController
 translate ($key, $arguments=null)
 
 handleTriggerArguments ()
 
- Protected Member Functions inherited from 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 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 AbstractController
 $triggerArguments
 
- Protected Attributes inherited from ActionController
 $reflectionService
 
 $cacheService
 
 $view = null
 
 $namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'
 
 $viewFormatToObjectNameMap = array()
 
 $defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
 
 $actionMethodName = 'indexAction'
 
 $errorMethodName = 'errorAction'
 
 $mvcPropertyMappingConfigurationService
 
 $request
 
 $response
 
- Protected Attributes inherited from AbstractController
 $signalSlotDispatcher
 
 $objectManager
 
 $uriBuilder
 
 $extensionName
 
 $settings
 
 $request
 
 $response
 
 $validatorResolver
 
 $arguments
 
 $supportedRequestTypes = array(\TYPO3\CMS\Extbase\Mvc\Request::class)
 
 $controllerContext
 
 $configurationManager
 

Additional Inherited Members

- Static Public Member Functions inherited from ActionController
static getActionMethodParameters ($objectManager)
 
- Public Attributes inherited from AbstractController
const TRIGGER_RefreshModuleMenu = 'refreshModuleMenu'
 

Detailed Description

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

Definition at line 27 of file UploadExtensionFileController.php.

Constructor & Destructor Documentation

__destruct ( )

Remove backup folder before destruction

Definition at line 107 of file UploadExtensionFileController.php.

References UploadExtensionFileController\removeBackupFolder().

Member Function Documentation

activateExtension (   $extensionKey)
Parameters
string$extensionKey
Returns
bool

Definition at line 229 of file UploadExtensionFileController.php.

Referenced by UploadExtensionFileController\extractAction().

checkFileName (   $fileName)

Validate the filename of an uploaded file

Parameters
string$fileName
Returns
void
Exceptions
\TYPO3\CMS\Extensionmanager\Exception\ExtensionManagerException

Definition at line 192 of file UploadExtensionFileController.php.

Referenced by UploadExtensionFileController\extractAction().

copyExtensionFolderToTempFolder (   $extensionKey)
protected

Copies current extension folder to typo3temp directory as backup

Parameters
string$extensionKey
Exceptions
\TYPO3\CMS\Extensionmanager\Exception\ExtensionManagerException
Returns
void

Definition at line 324 of file UploadExtensionFileController.php.

References UploadExtensionFileController\$extensionBackupPath, GeneralUtility\copyDirectory(), and GeneralUtility\mkdir().

Referenced by UploadExtensionFileController\getExtensionFromT3xFile(), and UploadExtensionFileController\getExtensionFromZipFile().

extractAction (   $overwrite = false)
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 213 of file UploadExtensionFileController.php.

References UploadExtensionFileController\getExtensionFromT3xFile(), and UploadExtensionFileController\getExtensionFromZipFile().

Referenced by UploadExtensionFileController\extractAction().

formAction ( )

Render upload extension form

Returns
void

Definition at line 117 of file UploadExtensionFileController.php.

References Bootstrap\usesComposerClassLoading().

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 245 of file UploadExtensionFileController.php.

References UploadExtensionFileController\copyExtensionFolderToTempFolder(), GeneralUtility\getUrl(), and AbstractController\translate().

Referenced by UploadExtensionFileController\extractExtensionFromFile().

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 289 of file UploadExtensionFileController.php.

References UploadExtensionFileController\copyExtensionFolderToTempFolder(), and UploadExtensionFileController\getExtensionKeyFromFileName().

Referenced by UploadExtensionFileController\extractExtensionFromFile().

getExtensionKeyFromFileName (   $fileName)
protected

Removes version and file extension from filename to determine extension key

Parameters
string$fileName
Returns
string

Definition at line 312 of file UploadExtensionFileController.php.

Referenced by UploadExtensionFileController\getExtensionFromZipFile(), and UploadExtensionFileController\removeExtensionAndRestoreFromBackup().

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

Definition at line 67 of file UploadExtensionFileController.php.

References UploadExtensionFileController\$configurationUtility.

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

Definition at line 75 of file UploadExtensionFileController.php.

References UploadExtensionFileController\$extensionRepository.

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

Definition at line 83 of file UploadExtensionFileController.php.

References UploadExtensionFileController\$fileHandlingUtility.

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

Definition at line 99 of file UploadExtensionFileController.php.

References UploadExtensionFileController\$managementService.

Parameters
\TYPO3\CMS\Extensionmanager\Utility\Connection\TerUtility$terUtility

Definition at line 91 of file UploadExtensionFileController.php.

References UploadExtensionFileController\$terUtility.

removeBackupFolder ( )
protected

Removes the backup folder in typo3temp

Returns
void

Definition at line 357 of file UploadExtensionFileController.php.

References GeneralUtility\rmdir().

Referenced by UploadExtensionFileController\__destruct().

removeExtensionAndRestoreFromBackup (   $fileName)
protected

Removes the extension directory and restores the extension from the backup directory

Parameters
string$fileName
See Also
UploadExtensionFileController::extractAction
Returns
void

Definition at line 341 of file UploadExtensionFileController.php.

References GeneralUtility\copyDirectory(), UploadExtensionFileController\getExtensionKeyFromFileName(), GeneralUtility\mkdir(), and GeneralUtility\rmdir().

Referenced by UploadExtensionFileController\extractAction().

Member Data Documentation

$configurationUtility
protected
$extensionBackupPath = ''
protected
$extensionRepository
protected
$fileHandlingUtility
protected
$managementService
protected
$removeFromOriginalPath = false
protected

Definition at line 62 of file UploadExtensionFileController.php.

$terUtility
protected