TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility Class Reference
Inheritance diagram for TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility:
TYPO3\CMS\Core\SingletonInterface

Public Member Functions

 injectEmConfUtility (\TYPO3\CMS\Extensionmanager\Utility\EmConfUtility $emConfUtility)
 
 injectInstallUtility (\TYPO3\CMS\Extensionmanager\Utility\InstallUtility $installUtility)
 
 injectLanguageService (\TYPO3\CMS\Lang\LanguageService $languageService)
 
 initializeObject ()
 
 unpackExtensionFromExtensionDataArray (array $extensionData, Extension $extension=null, $pathType='Local')
 
 getExtensionDir ($extensionKey, $pathType='Local')
 
 ensureConfiguredDirectoriesExist (array $extension)
 
 removeDirectory ($extDirPath)
 
 isValidExtensionPath ($path)
 
 getAbsoluteExtensionPath ($extension)
 
 getExtensionVersion ($extension)
 
 createZipFileFromExtension ($extension)
 
 unzipExtensionFromFile ($file, $fileName, $pathType='Local')
 
 sendZipFileToBrowserAndDelete ($fileName, $downloadName='')
 
 sendSqlDumpFileToBrowserAndDelete ($fileName, $downloadName='')
 

Protected Member Functions

 extractDirectoriesFromExtensionData (array $files)
 
 extractFilesArrayFromExtensionData (array $extensionData)
 
 createDirectoriesForExtensionFiles (array $directories, $rootPath)
 
 createNestedDirectory ($directory)
 
 writeExtensionFiles (array $files, $rootPath)
 
 makeAndClearExtensionDir ($extensionKey, $pathType='Local')
 
 addDirectory ($extDirPath)
 
 directoryExists ($directory)
 
 getAbsolutePathsToConfiguredDirectories (array $extension)
 
 getPathToUploadFolder ($extension)
 
 writeEmConfToFile (array $extensionData, $rootPath, Extension $extension=null)
 
 getAbsolutePath ($relativePath)
 
 getRelativePath ($absolutePath)
 
 reloadPackageInformation ($extensionKey)
 

Protected Attributes

 $emConfUtility
 
 $installUtility
 
 $languageService
 

Detailed Description

Utility for dealing with files and folders

Definition at line 25 of file FileHandlingUtility.php.

Member Function Documentation

◆ addDirectory()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::addDirectory (   $extDirPath)
protected

Add specified directory

Parameters
string$extDirPath
Exceptions
ExtensionManagerException
Returns
void

Definition at line 221 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getRelativePath(), and TYPO3\CMS\Core\Utility\GeneralUtility\mkdir().

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\makeAndClearExtensionDir().

◆ createDirectoriesForExtensionFiles()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::createDirectoriesForExtensionFiles ( array  $directories,
  $rootPath 
)
protected

Loops over an array of directories and creates them in the given root path It also creates nested directory structures

Parameters
array$directories
string$rootPath
Returns
void

Definition at line 133 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\createNestedDirectory().

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\unpackExtensionFromExtensionDataArray().

◆ createNestedDirectory()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::createNestedDirectory (   $directory)
protected

Wrapper for utility method to create directory recusively

Parameters
string$directoryAbsolute path
Exceptions
ExtensionManagerException

Definition at line 146 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getRelativePath(), and TYPO3\CMS\Core\Utility\GeneralUtility\mkdir_deep().

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\createDirectoriesForExtensionFiles(), and TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\ensureConfiguredDirectoriesExist().

◆ createZipFileFromExtension()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::createZipFileFromExtension (   $extension)

Create a zip file from an extension

Parameters
array$extension
Returns
string Name and path of create zip file

Definition at line 417 of file FileHandlingUtility.php.

References $GLOBALS, TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getAbsoluteExtensionPath(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getAbsolutePath(), TYPO3\CMS\Core\Utility\GeneralUtility\getAllFilesAndFoldersInPath(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getExtensionVersion(), TYPO3\CMS\Core\Utility\GeneralUtility\mkdir(), TYPO3\CMS\Core\Utility\GeneralUtility\removePrefixPathFromList(), and TYPO3\CMS\Core\Utility\PathUtility\sanitizeTrailingSeparator().

◆ directoryExists()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::directoryExists (   $directory)
protected

Wrapper method for directory existence check

Parameters
string$directory
Returns
bool

Definition at line 252 of file FileHandlingUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\ensureConfiguredDirectoriesExist().

◆ ensureConfiguredDirectoriesExist()

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

Creates directories configured in ext_emconf.php if not already present

Parameters
array$extension

Definition at line 237 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\createNestedDirectory(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\directoryExists(), and TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getAbsolutePathsToConfiguredDirectories().

◆ extractDirectoriesFromExtensionData()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::extractDirectoriesFromExtensionData ( array  $files)
protected

Extract needed directories from given extensionDataFilesArray

Parameters
array$files
Returns
array

Definition at line 102 of file FileHandlingUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\unpackExtensionFromExtensionDataArray().

◆ extractFilesArrayFromExtensionData()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::extractFilesArrayFromExtensionData ( array  $extensionData)
protected

Returns the "FILES" part from the data array

Parameters
array$extensionData
Returns
mixed

Definition at line 120 of file FileHandlingUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\unpackExtensionFromExtensionDataArray().

◆ getAbsoluteExtensionPath()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::getAbsoluteExtensionPath (   $extension)

Get extension path for an available or installed extension

Parameters
string$extension
Returns
string

Definition at line 391 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getAbsolutePath().

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\createZipFileFromExtension().

◆ getAbsolutePath()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::getAbsolutePath (   $relativePath)
protected

Returns absolute path

Parameters
string$relativePath
Exceptions
ExtensionManagerException
Returns
string

Definition at line 365 of file FileHandlingUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), and TYPO3\CMS\Core\Utility\GeneralUtility\resolveBackPath().

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\createZipFileFromExtension(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getAbsoluteExtensionPath(), and TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getAbsolutePathsToConfiguredDirectories().

◆ getAbsolutePathsToConfiguredDirectories()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::getAbsolutePathsToConfiguredDirectories ( array  $extension)
protected

Checks configuration and returns an array of absolute paths that should be created

Parameters
array$extension
Returns
array

Definition at line 263 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getAbsolutePath(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getPathToUploadFolder(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\ensureConfiguredDirectoriesExist().

◆ getExtensionDir()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::getExtensionDir (   $extensionKey,
  $pathType = 'Local' 
)

Returns the installation directory for an extension depending on the installation scope

Parameters
string$extensionKey
string$pathTypeExtension installation scope (Local,Global,System)
Returns
string
Exceptions
ExtensionManagerException

Definition at line 200 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getRelativePath(), and TYPO3\CMS\Extensionmanager\Domain\Model\Extension\returnInstallPaths().

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\makeAndClearExtensionDir().

◆ getExtensionVersion()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::getExtensionVersion (   $extension)

Get version of an available or installed extension

Parameters
string$extension
Returns
string

Definition at line 404 of file FileHandlingUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\createZipFileFromExtension().

◆ getPathToUploadFolder()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::getPathToUploadFolder (   $extension)
protected

Upload folders always reside in “uploads/tx_[extKey-with-no-underscore]”

Parameters
array$extension
Returns
string

Definition at line 287 of file FileHandlingUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getAbsolutePathsToConfiguredDirectories().

◆ getRelativePath()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::getRelativePath (   $absolutePath)
protected

Returns relative path

Parameters
string$absolutePath
Returns
string

Definition at line 380 of file FileHandlingUtility.php.

References TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix().

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\addDirectory(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\createNestedDirectory(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getExtensionDir(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\removeDirectory(), and TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\unzipExtensionFromFile().

◆ initializeObject()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::initializeObject ( )

Initialize method - loads language file

Returns
void

Definition at line 71 of file FileHandlingUtility.php.

◆ injectEmConfUtility()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::injectEmConfUtility ( \TYPO3\CMS\Extensionmanager\Utility\EmConfUtility  $emConfUtility)
Parameters
\TYPO3\CMS\Extensionmanager\Utility\EmConfUtility$emConfUtility

Definition at line 45 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\$emConfUtility.

◆ injectInstallUtility()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::injectInstallUtility ( \TYPO3\CMS\Extensionmanager\Utility\InstallUtility  $installUtility)
Parameters
\TYPO3\CMS\Extensionmanager\Utility\InstallUtility$installUtility

Definition at line 53 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\$installUtility.

◆ injectLanguageService()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::injectLanguageService ( \TYPO3\CMS\Lang\LanguageService  $languageService)
Parameters
\TYPO3\CMS\Lang\LanguageService$languageService

Definition at line 61 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\$languageService.

◆ isValidExtensionPath()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::isValidExtensionPath (   $path)

Is the given path a valid path for extension installation

Parameters
string$paththe absolute (!) path in question
Returns
bool

Definition at line 347 of file FileHandlingUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), and TYPO3\CMS\Extensionmanager\Domain\Model\Extension\returnAllowedInstallPaths().

◆ makeAndClearExtensionDir()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::makeAndClearExtensionDir (   $extensionKey,
  $pathType = 'Local' 
)
protected

Removes the current extension of $type and creates the base folder for the new one (which is going to be imported)

Parameters
string$extensionKey
string$pathTypeExtension installation scope (Local,Global,System)
Exceptions
ExtensionManagerException
Returns
string

Definition at line 181 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\addDirectory(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getExtensionDir(), and TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\removeDirectory().

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\unpackExtensionFromExtensionDataArray(), and TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\unzipExtensionFromFile().

◆ reloadPackageInformation()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::reloadPackageInformation (   $extensionKey)
protected
Parameters
string$extensionKey

Definition at line 552 of file FileHandlingUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\unpackExtensionFromExtensionDataArray().

◆ removeDirectory()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::removeDirectory (   $extDirPath)

Remove specified directory

Parameters
string$extDirPath
Exceptions
ExtensionManagerException
Returns
void

Definition at line 299 of file FileHandlingUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\fixWindowsFilePath(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getRelativePath(), and TYPO3\CMS\Core\Utility\GeneralUtility\rmdir().

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\makeAndClearExtensionDir().

◆ sendSqlDumpFileToBrowserAndDelete()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::sendSqlDumpFileToBrowserAndDelete (   $fileName,
  $downloadName = '' 
)

Sends the sql dump file to the browser and deletes it afterwards

Parameters
string$fileName
string$downloadName
Returns
void

Definition at line 534 of file FileHandlingUtility.php.

◆ sendZipFileToBrowserAndDelete()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::sendZipFileToBrowserAndDelete (   $fileName,
  $downloadName = '' 
)

Sends a zip file to the browser and deletes it afterwards

Parameters
string$fileName
string$downloadName
Returns
void

Definition at line 514 of file FileHandlingUtility.php.

◆ unpackExtensionFromExtensionDataArray()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::unpackExtensionFromExtensionDataArray ( array  $extensionData,
Extension  $extension = null,
  $pathType = 'Local' 
)

Unpack an extension in t3x data format and write files

Parameters
array$extensionData
Extension$extension
string$pathType
Returns
void

Definition at line 84 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\createDirectoriesForExtensionFiles(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\extractDirectoriesFromExtensionData(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\extractFilesArrayFromExtensionData(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\makeAndClearExtensionDir(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\reloadPackageInformation(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\writeEmConfToFile(), and TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\writeExtensionFiles().

◆ unzipExtensionFromFile()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::unzipExtensionFromFile (   $file,
  $fileName,
  $pathType = 'Local' 
)

Unzip an extension.zip.

Parameters
string$filepath to zip file
string$fileNamefile name
string$pathTypepath type (Local, Global, System)
Exceptions
ExtensionManagerException
Returns
void

Definition at line 479 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getRelativePath(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\makeAndClearExtensionDir(), TYPO3\CMS\Core\Utility\GeneralUtility\mkdir_deep(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

◆ writeEmConfToFile()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::writeEmConfToFile ( array  $extensionData,
  $rootPath,
Extension  $extension = null 
)
protected

Constructs emConf and writes it to corresponding file In case the file has been extracted already, the properties of the meta data take precedence but are merged with the present ext_emconf.php

Parameters
array$extensionData
string$rootPath
Extension$extension
Returns
void

Definition at line 325 of file FileHandlingUtility.php.

References TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\unpackExtensionFromExtensionDataArray().

◆ writeExtensionFiles()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::writeExtensionFiles ( array  $files,
  $rootPath 
)
protected

Loops over an array of files and writes them to the given rootPath

Parameters
array$files
string$rootPath
Returns
void

Definition at line 165 of file FileHandlingUtility.php.

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

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\unpackExtensionFromExtensionDataArray().

Member Data Documentation

◆ $emConfUtility

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::$emConfUtility
protected

Definition at line 30 of file FileHandlingUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\injectEmConfUtility().

◆ $installUtility

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::$installUtility
protected

Definition at line 35 of file FileHandlingUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\injectInstallUtility().

◆ $languageService

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::$languageService
protected

Definition at line 40 of file FileHandlingUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\injectLanguageService().