TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility Class Reference

Inheritance diagram for TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility:

Public Member Functions
	injectEmConfUtility (EmConfUtility $emConfUtility)
	injectInstallUtility (InstallUtility $installUtility)
	injectLanguageServiceFactory (LanguageServiceFactory $languageServiceFactory)
	initializeObject ()
	unpackExtensionFromExtensionDataArray (string $extensionKey, array $extensionData, $pathType='Local')
string	getExtensionDir ($extensionKey, $pathType='Local')
	removeDirectory ($extDirPath)
	unzipExtensionFromFile ($file, $fileName, $pathType='Local')

Protected Member Functions
array	extractDirectoriesFromExtensionData (array $files)
	createDirectoriesForExtensionFiles (array $directories, string $rootPath)
	createNestedDirectory ($directory)
	writeExtensionFiles (array $files, $rootPath)
string	makeAndClearExtensionDir ($extensionKey, $pathType='Local')
	addDirectory ($extDirPath)
	writeEmConfToFile (string $extensionKey, array $emConfData, string $rootPath)
string	getRelativePath (string $absolutePath)
	reloadPackageInformation ($extensionKey)

Protected Attributes
EmConfUtility	$emConfUtility
InstallUtility	$installUtility
LanguageServiceFactory	$languageServiceFactory
LanguageService	$languageService = null

Detailed Description

Utility for dealing with files and folders

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

Definition at line 35 of file FileHandlingUtility.php.

Member Function Documentation

addDirectory()

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

protected

Add specified directory

Parameters

string

$extDirPath

Exceptions

ExtensionManagerException

Definition at line 210 of file FileHandlingUtility.php.

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

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

createDirectoriesForExtensionFiles()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::createDirectoriesForExtensionFiles ( array  $directories, string  $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

Definition at line 125 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 recursively

Parameters

string

$directory

‪Absolute path

Exceptions

ExtensionManagerException

Definition at line 138 of file FileHandlingUtility.php.

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

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

extractDirectoriesFromExtensionData()

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

protected

Extract needed directories from given extensionDataFilesArray

Parameters

array

$files

Returns

‪array

Definition at line 106 of file FileHandlingUtility.php.

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

getExtensionDir()

string 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	$pathType	‪Extension installation scope (Local,Global,System)

Returns

‪string

Exceptions

ExtensionManagerException

Definition at line 190 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Extension\returnInstallPaths().

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

getRelativePath()

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

protected

Returns relative path

Parameters

string

$absolutePath

Returns

‪string

Definition at line 263 of file FileHandlingUtility.php.

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

initializeObject()

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

(

)

Initialize method - loads language file

Definition at line 74 of file FileHandlingUtility.php.

References $GLOBALS.

injectEmConfUtility()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::injectEmConfUtility

(

EmConfUtility

$emConfUtility

)

Parameters

EmConfUtility

$emConfUtility

Definition at line 53 of file FileHandlingUtility.php.

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

injectInstallUtility()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::injectInstallUtility

(

InstallUtility

$installUtility

)

Parameters

InstallUtility

$installUtility

Definition at line 61 of file FileHandlingUtility.php.

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

injectLanguageServiceFactory()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::injectLanguageServiceFactory

(

LanguageServiceFactory

$languageServiceFactory

)

Definition at line 66 of file FileHandlingUtility.php.

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

makeAndClearExtensionDir()

string 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	$pathType	‪Extension installation scope (Local,Global,System)

Exceptions

ExtensionManagerException

Returns

‪string

Definition at line 172 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 296 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

Definition at line 227 of file FileHandlingUtility.php.

References TYPO3\CMS\Core\Core\Environment\isWindows(), and TYPO3\CMS\Core\Utility\GeneralUtility\rmdir().

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

unpackExtensionFromExtensionDataArray()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::unpackExtensionFromExtensionDataArray	(	string	$extensionKey,
		array	$extensionData,
			$pathType = 'Local'
	)

Unpack an extension in t3x data format and write files

Parameters

string	$extensionKey
array	$extensionData
string	$pathType

Definition at line 87 of file FileHandlingUtility.php.

References TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\createDirectoriesForExtensionFiles(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\extractDirectoriesFromExtensionData(), 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().

Referenced by TYPO3\CMS\Extensionmanager\Remote\TerExtensionRemote\downloadExtension().

unzipExtensionFromFile()

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

Unzip an extension.zip.

Parameters

string	$file	‪path to zip file
string	$fileName	‪file name
string	$pathType	‪path type (Local, Global, System)

Exceptions

ExtensionManagerException

Definition at line 276 of file FileHandlingUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\fixPermissions(), and TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\makeAndClearExtensionDir().

writeEmConfToFile()

TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::writeEmConfToFile ( string  $extensionKey, array  $emConfData, string  $rootPath  )

protected

Constructs emConf and writes it to corresponding file

Parameters

string	$extensionKey
array	$emConfData
string	$rootPath

Definition at line 251 of file FileHandlingUtility.php.

References 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

Definition at line 156 of file FileHandlingUtility.php.

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

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

Member Data Documentation

$emConfUtility

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

protected

Definition at line 41 of file FileHandlingUtility.php.

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

$installUtility

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

protected

Definition at line 45 of file FileHandlingUtility.php.

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

$languageService

LanguageService TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::$languageService = null

protected

Definition at line 48 of file FileHandlingUtility.php.

$languageServiceFactory

LanguageServiceFactory TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility::$languageServiceFactory

protected

Definition at line 47 of file FileHandlingUtility.php.

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