Inheritance diagram for TYPO3\CMS\Core\Resource\Driver\LocalDriver:

Public Member Functions
	__construct (array $configuration=array())

	mergeConfigurationCapabilities ($capabilities)

	processConfiguration ()

	initialize ()

	getPublicUrl ($identifier)

	getRootLevelFolder ()

	getDefaultFolder ()

	createFolder ($newFolderName, $parentFolderIdentifier='', $recursive=FALSE)

	getFileInfoByIdentifier ($fileIdentifier, array $propertiesToExtract=array())

	getFolderInfoByIdentifier ($folderIdentifier)

	sanitizeFileName ($fileName, $charset='')

	getFilesInFolder ($folderIdentifier, $start=0, $numberOfItems=0, $recursive=FALSE, array $filenameFilterCallbacks=array())

	getFoldersInFolder ($folderIdentifier, $start=0, $numberOfItems=0, $recursive=FALSE, array $folderNameFilterCallbacks=array())

	getSpecificFileInformation ($fileIdentifier, $containerPath, $property)

	hash ($fileIdentifier, $hashAlgorithm)

	addFile ($localFilePath, $targetFolderIdentifier, $newFileName='', $removeOriginal=TRUE)

	fileExists ($fileIdentifier)

	fileExistsInFolder ($fileName, $folderIdentifier)

	folderExists ($folderIdentifier)

	folderExistsInFolder ($folderName, $folderIdentifier)

	getFolderInFolder ($folderName, $folderIdentifier)

	replaceFile ($fileIdentifier, $localFilePath)

	copyFileWithinStorage ($fileIdentifier, $targetFolderIdentifier, $fileName)

	moveFileWithinStorage ($fileIdentifier, $targetFolderIdentifier, $newFileName)

	moveFolderWithinStorage ($sourceFolderIdentifier, $targetFolderIdentifier, $newFolderName)

	renameFile ($fileIdentifier, $newName)

	renameFolder ($folderIdentifier, $newName)

	deleteFile ($fileIdentifier)

	deleteFolder ($folderIdentifier, $deleteRecursively=FALSE)

	isFolderEmpty ($folderIdentifier)

	getFileForLocalProcessing ($fileIdentifier, $writable=TRUE)

	getPermissions ($identifier)

	isWithin ($folderIdentifier, $identifier)

	createFile ($fileName, $parentFolderIdentifier)

	getFileContents ($fileIdentifier)

	setFileContents ($fileIdentifier, $contents)

	getRole ($folderIdentifier)

	dumpFileContents ($identifier)

Public Member Functions inherited from TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver
	getParentFolderIdentifierOfIdentifier ($fileIdentifier)

Public Member Functions inherited from TYPO3\CMS\Core\Resource\Driver\AbstractDriver
	__construct (array $configuration=array())

	setStorageUid ($storageUid)

	getCapabilities ()

	hasCapability ($capability)

	hashIdentifier ($identifier)

	sanitizeFileName ($fileName, $charset='')

	isCaseSensitiveFileSystem ()

Public Member Functions inherited from TYPO3\CMS\Core\Resource\Driver\DriverInterface
	copyFolderWithinStorage ($sourceFolderIdentifier, $targetFolderIdentifier, $newFolderName)

Public Attributes
const	UNSAFE_FILENAME_CHARACTER_EXPRESSION = '\\x00-\\x2C\\/\\x3A-\\x3F\\x5B-\\x60\\x7B-\\xBF'

Protected Member Functions
	determineBaseUrl ()

	calculateBasePath (array $configuration)

	getDirectoryItemList ($folderIdentifier, $start=0, $numberOfItems=0, array $filterMethods, $includeFiles=TRUE, $includeDirs=TRUE, $recursive=FALSE)

	applyFilterMethodsToDirectoryItem (array $filterMethods, $itemName, $itemIdentifier, $parentIdentifier)

	extractFileInformation ($filePath, $containerPath, array $propertiesToExtract=array())

	getAbsoluteBasePath ()

	getAbsolutePath ($fileIdentifier)

	getMimeTypeOfFile ($absoluteFilePath)

	copyFileToTemporaryPath ($fileIdentifier)

	createIdentifierMap (array $filesAndFolders, $sourceFolderIdentifier, $targetFolderIdentifier)

	getCharsetConversion ()

Protected Member Functions inherited from TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver
	isPathValid ($theFile)

	canonicalizeAndCheckFilePath ($filePath)

	canonicalizeAndCheckFileIdentifier ($fileIdentifier)

	canonicalizeAndCheckFolderIdentifier ($folderPath)

Protected Member Functions inherited from TYPO3\CMS\Core\Resource\Driver\AbstractDriver
	isValidFilename ($fileName)

	getTemporaryPathForFile ($fileIdentifier)

	canonicalizeAndCheckFilePath ($filePath)

	canonicalizeAndCheckFileIdentifier ($fileIdentifier)

	canonicalizeAndCheckFolderIdentifier ($folderIdentifier)

Protected Attributes
	$absoluteBasePath

	$supportedHashAlgorithms = array('sha1', 'md5')

	$baseUri = NULL

	$charsetConversion

	$mappingFolderNameToRole

Protected Attributes inherited from TYPO3\CMS\Core\Resource\Driver\AbstractDriver
	$capabilities = 0

	$storageUid

	$supportedHashAlgorithms = array()

	$configuration = array()

Detailed Description

Driver for the local file system

Definition at line 25 of file LocalDriver.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::__construct ( array $configuration = array() )

Parameters

array $configuration

Definition at line 69 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractDriver\$configuration, TYPO3\CMS\Core\Resource\ResourceStorageInterface\CAPABILITY_BROWSABLE, TYPO3\CMS\Core\Resource\ResourceStorageInterface\CAPABILITY_PUBLIC, and TYPO3\CMS\Core\Resource\ResourceStorageInterface\CAPABILITY_WRITABLE.

Member Function Documentation

◆ addFile()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::addFile	(	$localFilePath,
		$targetFolderIdentifier,
		$newFileName = `''`,
		$removeOriginal = `TRUE`
	)

Adds a file from the local server hard disk to a given path in TYPO3s virtual file system. This assumes that the local file exists, so no further check is done here! After a successful the original file must not exist anymore.

Parameters

string	$localFilePath	(within PATH_site)
string	$targetFolderIdentifier
string	$newFileName	optional, if not given original name is used
boolean	$removeOriginal	if set the original file will be removed after successful operation

Returns: string the identifier of the new file

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 644 of file LocalDriver.php.

References $result, TYPO3\CMS\Core\Utility\PathUtility\basename(), TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFilePath(), TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFolderIdentifier(), TYPO3\CMS\Core\Utility\GeneralUtility\fixPermissions(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath(), TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\sanitizeFileName().

◆ applyFilterMethodsToDirectoryItem()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::applyFilterMethodsToDirectoryItem	(	array	$filterMethods,
			$itemName,
			$itemIdentifier,
			$parentIdentifier
	)

protected

Applies a set of filter methods to a file name to find out if it should be used or not. This is e.g. used by directory listings.

Parameters

array	$filterMethods	The filter methods to use
string	$itemName
string	$itemIdentifier
string	$parentIdentifier

Exceptions

Definition at line 411 of file LocalDriver.php.

References $result.

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\getDirectoryItemList().

◆ calculateBasePath()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::calculateBasePath ( array $configuration )

protected

Calculates the absolute path to this drivers storage location.

Exceptions

Definition at line 147 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\$absoluteBasePath, and TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFilePath().

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\processConfiguration().

◆ copyFileToTemporaryPath()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::copyFileToTemporaryPath ( $fileIdentifier )

protected

Copies a file to a temporary path and returns that path.

Parameters

string $fileIdentifier

Returns: string The temporary path

Exceptions

Definition at line 806 of file LocalDriver.php.

References $result, TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath(), and TYPO3\CMS\Core\Resource\Driver\AbstractDriver\getTemporaryPathForFile().

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\getFileForLocalProcessing().

◆ copyFileWithinStorage()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::copyFileWithinStorage	(	$fileIdentifier,
		$targetFolderIdentifier,
		$fileName
	)

Copies a file within the current storage. Note that this is only about an intra-storage copy action, where a file is just copied to another folder in the same storage.

Parameters

string	$fileIdentifier
string	$targetFolderIdentifier
string	$fileName

Returns: string the Identifier of the new file

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 765 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFileIdentifier(), TYPO3\CMS\Core\Utility\GeneralUtility\fixPermissions(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

◆ createFile()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::createFile	(	$fileName,
		$parentFolderIdentifier
	)

Creates a new (empty) file and returns the identifier.

Parameters

string	$fileName
string	$parentFolderIdentifier

Returns: string

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 1127 of file LocalDriver.php.

References $result, TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFileIdentifier(), TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFolderIdentifier(), TYPO3\CMS\Core\Utility\GeneralUtility\fixPermissions(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath(), TYPO3\CMS\Core\Resource\Driver\AbstractDriver\isValidFilename(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\sanitizeFileName().

◆ createFolder()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::createFolder	(	$newFolderName,
		$parentFolderIdentifier = `''`,
		$recursive = `FALSE`
	)

Creates a folder, within a parent folder. If no parent folder is given, a rootlevel folder will be created

Parameters

string	$newFolderName
string	$parentFolderIdentifier
boolean	$recursive

Returns: string the Identifier of the new folder

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 223 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFolderIdentifier(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath(), TYPO3\CMS\Core\Utility\GeneralUtility\mkdir(), TYPO3\CMS\Core\Utility\GeneralUtility\mkdir_deep(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\sanitizeFileName(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\getDefaultFolder().

◆ createIdentifierMap()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::createIdentifierMap	(	array	$filesAndFolders,
			$sourceFolderIdentifier,
			$targetFolderIdentifier
	)

protected

Creates a map of old and new file/folder identifiers after renaming or moving a folder. The old identifier is used as the key, the new one as the value.

Parameters

array	$filesAndFolders
string	$sourceFolderIdentifier
string	$targetFolderIdentifier

Returns: array

Exceptions

Definition at line 828 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFileIdentifier(), TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFolderIdentifier(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\moveFolderWithinStorage(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\renameFolder().

◆ deleteFile()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::deleteFile ( $fileIdentifier )

Removes a file from the filesystem. This does not check if the file is still used or if it is a bad idea to delete it for some other reason this has to be taken care of in the upper layers (e.g. the Storage)!

Parameters

string $fileIdentifier

Returns: boolean TRUE if deleting the file succeeded

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 1005 of file LocalDriver.php.

References $result, and TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

◆ deleteFolder()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::deleteFolder	(	$folderIdentifier,
		$deleteRecursively = `FALSE`
	)

Removes a folder from this storage.

Parameters

string	$folderIdentifier
boolean	$deleteRecursively

Returns: boolean

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 1023 of file LocalDriver.php.

References $result, TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath(), and TYPO3\CMS\Core\Utility\GeneralUtility\rmdir().

◆ determineBaseUrl()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::determineBaseUrl ( )

protected

Determines the base URL for this driver, from the configuration or the TypoScript frontend object

Returns: void

Definition at line 122 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\ResourceStorageInterface\CAPABILITY_PUBLIC, TYPO3\CMS\Core\Resource\Driver\AbstractDriver\hasCapability(), TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), TYPO3\CMS\Core\Utility\GeneralUtility\isValidUrl(), and TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix().

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\processConfiguration().

◆ dumpFileContents()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::dumpFileContents ( $identifier )

Directly output the contents of the file to the output buffer. Should not take care of header files or flushing buffer before. Will be taken care of by the Storage.

Parameters

string $identifier

Returns: void

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 1227 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFileIdentifier(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

◆ extractFileInformation()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::extractFileInformation	(		$filePath,
			$containerPath,
		array	$propertiesToExtract = `array()`
	)

protected

Extracts information about a file from the filesystem.

Parameters

string	$filePath	The absolute path to the file
string	$containerPath	The relative path to the file's container
array	$propertiesToExtract	array of properties which should be returned, if empty all will be extracted

Returns: array

Definition at line 512 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\getSpecificFileInformation().

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\getFileInfoByIdentifier().

◆ fileExists()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::fileExists ( $fileIdentifier )

Checks if a file exists.

Parameters

string $fileIdentifier

Returns: boolean

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 681 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\fileExistsInFolder(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\renameFile().

◆ fileExistsInFolder()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::fileExistsInFolder	(	$fileName,
		$folderIdentifier
	)

Checks if a file inside a folder exists

Parameters

string	$fileName
string	$folderIdentifier

Returns: boolean

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 693 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFileIdentifier(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\fileExists().

◆ folderExists()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::folderExists ( $folderIdentifier )

Checks if a folder exists.

Parameters

string $folderIdentifier

Returns: boolean

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 706 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\folderExistsInFolder(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\getDefaultFolder(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\getFolderInfoByIdentifier().

◆ folderExistsInFolder()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::folderExistsInFolder	(	$folderName,
		$folderIdentifier
	)

Checks if a folder inside a folder exists.

Parameters

string	$folderName
string	$folderIdentifier

Returns: boolean

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 718 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFolderIdentifier(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\folderExists().

◆ getAbsoluteBasePath()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getAbsoluteBasePath ( )

protected

Returns the absolute path of the folder this driver operates on.

Returns: string

Definition at line 572 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\$absoluteBasePath.

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\getFoldersInFolder().

◆ getAbsolutePath()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getAbsolutePath ( $fileIdentifier )

protected

Returns the absolute path of a file or folder.

Parameters

string $fileIdentifier

Returns: string

Exceptions

Definition at line 583 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFileIdentifier().

◆ getCharsetConversion()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getCharsetConversion ( )

protected

Gets the charset conversion object.

Returns

Definition at line 1188 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\$charsetConversion, $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3_MODE.

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\sanitizeFileName().

◆ getDefaultFolder()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getDefaultFolder ( )

Returns identifier of the default folder new files should be put into.

Returns: string

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 205 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\createFolder(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\folderExists().

◆ getDirectoryItemList()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getDirectoryItemList	(		$folderIdentifier,
			$start = `0`,
			$numberOfItems = `0`,
		array	$filterMethods,
			$includeFiles = `TRUE`,
			$includeDirs = `TRUE`,
			$recursive = `FALSE`
	)

protected

Generic wrapper for extracting a list of items from a path.

Parameters

string	$folderIdentifier
integer	$start	The position to start the listing; if not set, start from the beginning
integer	$numberOfItems	The number of items to list; if set to zero, all items are returned
array	$filterMethods	The filter methods used to filter the directory items
boolean	$includeFiles
boolean	$includeDirs
boolean	$recursive

Returns: array

Exceptions

Definition at line 343 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\applyFilterMethodsToDirectoryItem(), TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFolderIdentifier(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath(), and TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\getParentFolderIdentifierOfIdentifier().

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\getFilesInFolder(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\getFoldersInFolder().

◆ getFileContents()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getFileContents ( $fileIdentifier )

Returns the contents of a file. Beware that this requires to load the complete file into memory and also may require fetching the file from an external location. So this might be an expensive operation (both in terms of processing resources and money) for large files.

Parameters

string $fileIdentifier

Returns: string The file contents

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 1157 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

◆ getFileForLocalProcessing()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getFileForLocalProcessing	(	$fileIdentifier,
		$writable = `TRUE`
	)

Returns (a local copy of) a file for processing it. This makes a copy first when in writable mode, so if you change the file, you have to update it yourself afterwards.

Parameters

string	$fileIdentifier
boolean	$writable	Set this to FALSE if you only need the file for read operations. This might speed up things, e.g. by using a cached local version. Never modify the file if you have set this flag!

Returns: string The path to the file on the local disk

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 1064 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\copyFileToTemporaryPath(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

◆ getFileInfoByIdentifier()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getFileInfoByIdentifier	(		$fileIdentifier,
		array	$propertiesToExtract = `array()`
	)

Returns information about a file.

Parameters

string	$fileIdentifier	In the case of the LocalDriver, this is the (relative) path to the file.
array	$propertiesToExtract	Array of properties which should be extracted, if empty all will be extracted

Returns: array

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 248 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFolderIdentifier(), TYPO3\CMS\Core\Utility\PathUtility\dirname(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\extractFileInformation(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

◆ getFilesInFolder()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getFilesInFolder	(		$folderIdentifier,
			$start = `0`,
			$numberOfItems = `0`,
			$recursive = `FALSE`,
		array	$filenameFilterCallbacks = `array()`
	)

Returns a list of files inside the specified path

Parameters

string	$folderIdentifier
integer	$start
integer	$numberOfItems
boolean	$recursive
array	$filenameFilterCallbacks	The method callbacks to use for filtering the items

Returns: array of FileIdentifiers

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 438 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\getDirectoryItemList().

◆ getFolderInfoByIdentifier()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getFolderInfoByIdentifier ( $folderIdentifier )

Returns information about a folder.

Parameters

string $folderIdentifier In the case of the LocalDriver, this is the (relative) path to the file.

Returns: array

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 268 of file LocalDriver.php.

References TYPO3\CMS\Core\Utility\PathUtility\basename(), TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFolderIdentifier(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\folderExists().

◆ getFolderInFolder()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getFolderInFolder	(	$folderName,
		$folderIdentifier
	)

Returns the Identifier for a folder within a given folder.

Parameters

string	$folderName	The name of the target folder
string	$folderIdentifier

Returns: string

Definition at line 732 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFolderIdentifier().

◆ getFoldersInFolder()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getFoldersInFolder	(		$folderIdentifier,
			$start = `0`,
			$numberOfItems = `0`,
			$recursive = `FALSE`,
		array	$folderNameFilterCallbacks = `array()`
	)

Returns a list of folders inside the specified path

Parameters

string	$folderIdentifier
integer	$start
integer	$numberOfItems
boolean	$recursive
array	$folderNameFilterCallbacks	The method callbacks to use for filtering the items

Returns: array of Folder Identifier

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 453 of file LocalDriver.php.

References TYPO3\CMS\Core\Utility\PathUtility\basename(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsoluteBasePath(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\getDirectoryItemList().

◆ getMimeTypeOfFile()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getMimeTypeOfFile ( $absoluteFilePath )

protected

Get MIME type of file.

Parameters

string $absoluteFilePath Absolute path to file

Returns: string|boolean MIME type. eg, text/html, FALSE on error

Definition at line 595 of file LocalDriver.php.

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\getSpecificFileInformation().

◆ getPermissions()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getPermissions ( $identifier )

Returns the permissions of a file/folder as an array (keys r, w) of boolean flags

Parameters

string $identifier

Returns: array

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 1080 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

◆ getPublicUrl()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getPublicUrl ( $identifier )

Returns the public URL to a file. For the local driver, this will always return a path relative to PATH_site.

Parameters

string $identifier

Returns: string

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 180 of file LocalDriver.php.

◆ getRole()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getRole ( $folderIdentifier )

Returns the role of an item (currently only folders; can later be extended for files as well)

Parameters

string $folderIdentifier

Returns: string

Definition at line 1209 of file LocalDriver.php.

References TYPO3\CMS\Core\Utility\PathUtility\basename(), and TYPO3\CMS\Core\Resource\FolderInterface\ROLE_DEFAULT.

◆ getRootLevelFolder()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getRootLevelFolder ( )

Returns the Identifier of the root level folder of the storage.

Returns: string

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 196 of file LocalDriver.php.

◆ getSpecificFileInformation()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::getSpecificFileInformation	(	$fileIdentifier,
		$containerPath,
		$property
	)

Extracts a specific FileInformation from the FileSystems.

Parameters

string	$fileIdentifier
string	$containerPath
string	$property

Returns: bool|int|string

Exceptions

Definition at line 537 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractDriver\$storageUid, TYPO3\CMS\Core\Utility\PathUtility\basename(), TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFileIdentifier(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\getMimeTypeOfFile(), TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\getParentFolderIdentifierOfIdentifier(), and TYPO3\CMS\Core\Resource\Driver\AbstractDriver\hashIdentifier().

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\extractFileInformation().

◆ hash()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::hash	(	$fileIdentifier,
		$hashAlgorithm
	)

Creates a (cryptographic) hash for a file.

Parameters

string	$fileIdentifier
string	$hashAlgorithm	The hash algorithm to use

Returns: string

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 614 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

◆ initialize()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::initialize ( )

Initializes this object. This is called by the storage after the driver has been attached.

Returns: void

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 113 of file LocalDriver.php.

◆ isFolderEmpty()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::isFolderEmpty ( $folderIdentifier )

Checks if a folder contains files and (if supported) other folders.

Parameters

string $folderIdentifier

Returns: boolean TRUE if there are no files and folders within $folder

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 1041 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

◆ isWithin()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::isWithin	(	$folderIdentifier,
		$identifier
	)

Checks if a given identifier is within a container, e.g. if a file or folder is within another folder. It will also return TRUE if both canonicalized identifiers are equal.

Parameters

string	$folderIdentifier
string	$identifier	identifier to be checked against $folderIdentifier

Returns: boolean TRUE if $content is within or matches $folderIdentifier

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 1104 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFileIdentifier(), and TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr().

◆ mergeConfigurationCapabilities()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::mergeConfigurationCapabilities ( $capabilities )

Merges the capabilites merged by the user at the storage configuration into the actual capabilities of the driver and returns the result.

Parameters

integer $capabilities

Returns: integer

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 87 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractDriver\$capabilities.

◆ moveFileWithinStorage()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::moveFileWithinStorage	(	$fileIdentifier,
		$targetFolderIdentifier,
		$newFileName
	)

Moves a file within the current storage. Note that this is only about an inner-storage move action, where a file is just moved to another folder in the same storage.

Parameters

string	$fileIdentifier
string	$targetFolderIdentifier
string	$newFileName

Returns: string

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 788 of file LocalDriver.php.

References $result, TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFileIdentifier(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

◆ moveFolderWithinStorage()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::moveFolderWithinStorage	(	$sourceFolderIdentifier,
		$targetFolderIdentifier,
		$newFolderName
	)

Folder equivalent to moveFileWithinStorage().

Parameters

string	$sourceFolderIdentifier
string	$targetFolderIdentifier
string	$newFolderName

Returns: array A map of old to new file identifiers

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 864 of file LocalDriver.php.

References $result, TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFolderIdentifier(), TYPO3\CMS\Core\Resource\Driver\DriverInterface\copyFolderWithinStorage(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\createIdentifierMap(), TYPO3\CMS\Core\Utility\GeneralUtility\fixPermissions(), TYPO3\CMS\Core\Utility\GeneralUtility\fixWindowsFilePath(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath(), TYPO3\CMS\Core\Utility\GeneralUtility\mkdir(), and TYPO3\CMS\Core\Utility\GeneralUtility\rmdir().

◆ processConfiguration()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::processConfiguration ( )

Processes the configuration for this driver.

Returns: void

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 98 of file LocalDriver.php.

References TYPO3\CMS\Core\Resource\Driver\LocalDriver\calculateBasePath(), TYPO3\CMS\Core\Resource\ResourceStorageInterface\CAPABILITY_PUBLIC, and TYPO3\CMS\Core\Resource\Driver\LocalDriver\determineBaseUrl().

◆ renameFile()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::renameFile	(	$fileIdentifier,
		$newName
	)

Renames a file in this storage.

Parameters

string	$fileIdentifier
string	$newName	The target path (including the file name!)

Returns: string The identifier of the file after renaming

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 938 of file LocalDriver.php.

References $result, TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFileIdentifier(), TYPO3\CMS\Core\Utility\PathUtility\dirname(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\fileExists(), TYPO3\CMS\Core\Utility\GeneralUtility\fixWindowsFilePath(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\sanitizeFileName().

◆ renameFolder()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::renameFolder	(	$folderIdentifier,
		$newName
	)

Renames a folder in this storage.

Parameters

string	$folderIdentifier
string	$newName

Returns: array A map of old to new file identifiers of all affected files and folders

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 965 of file LocalDriver.php.

References $result, TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFolderIdentifier(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\createIdentifierMap(), TYPO3\CMS\Core\Utility\PathUtility\dirname(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\sanitizeFileName().

◆ replaceFile()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::replaceFile	(	$fileIdentifier,
		$localFilePath
	)

Replaces the contents (and file-specific metadata) of a file object with a local file.

Parameters

string	$fileIdentifier
string	$localFilePath

Returns: boolean TRUE if the operation succeeded

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 745 of file LocalDriver.php.

References $result, TYPO3\CMS\Core\Utility\GeneralUtility\fixPermissions(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

◆ sanitizeFileName()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::sanitizeFileName	(	$fileName,
		$charset = `''`
	)

Returns a string where any character not matching [.a-zA-Z0-9_-] is substituted by '_' Trailing dots are removed

Previously in ::cleanFileName()

Parameters

string	$fileName	Input string, typically the body of a fileName
string	$charset	Charset of the a fileName (defaults to current charset; depending on context)

Returns: string Output string with any characters not matching [.a-zA-Z0-9_-] is substituted by '_' and trailing dots removed

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 296 of file LocalDriver.php.

References $GLOBALS, TYPO3\CMS\Core\Resource\Driver\LocalDriver\getCharsetConversion(), and TYPO3_MODE.

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\addFile(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\createFile(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\createFolder(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\renameFile(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\renameFolder().

◆ setFileContents()

TYPO3\CMS\Core\Resource\Driver\LocalDriver::setFileContents	(	$fileIdentifier,
		$contents
	)

Sets the contents of a file to the specified value.

Parameters

string	$fileIdentifier
string	$contents

Returns: integer The number of bytes written to the file

Exceptions

Implements TYPO3\CMS\Core\Resource\Driver\DriverInterface.

Definition at line 1170 of file LocalDriver.php.

References $result, and TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsolutePath().

Member Data Documentation

◆ $absoluteBasePath

TYPO3\CMS\Core\Resource\Driver\LocalDriver::$absoluteBasePath

protected

Definition at line 37 of file LocalDriver.php.

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\calculateBasePath(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\getAbsoluteBasePath().

◆ $baseUri

TYPO3\CMS\Core\Resource\Driver\LocalDriver::$baseUri = NULL

protected

Definition at line 52 of file LocalDriver.php.

◆ $charsetConversion

TYPO3\CMS\Core\Resource\Driver\LocalDriver::$charsetConversion

protected

Definition at line 57 of file LocalDriver.php.

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\getCharsetConversion().

◆ $mappingFolderNameToRole

TYPO3\CMS\Core\Resource\Driver\LocalDriver::$mappingFolderNameToRole

protected

Initial value:

= array(
        '_recycler_' => FolderInterface::ROLE_RECYCLER,
        '_temp_' => FolderInterface::ROLE_TEMPORARY,
        'user_upload' => FolderInterface::ROLE_USERUPLOAD,
    )

Definition at line 60 of file LocalDriver.php.

◆ $supportedHashAlgorithms

TYPO3\CMS\Core\Resource\Driver\LocalDriver::$supportedHashAlgorithms = array('sha1', 'md5')

protected

Definition at line 44 of file LocalDriver.php.

◆ UNSAFE_FILENAME_CHARACTER_EXPRESSION

const TYPO3\CMS\Core\Resource\Driver\LocalDriver::UNSAFE_FILENAME_CHARACTER_EXPRESSION = '\\x00-\\x2C\\/\\x3A-\\x3F\\x5B-\\x60\\x7B-\\xBF'

Definition at line 30 of file LocalDriver.php.

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFile()

◆ applyFilterMethodsToDirectoryItem()

◆ calculateBasePath()

◆ copyFileToTemporaryPath()

◆ copyFileWithinStorage()

◆ createFile()

◆ createFolder()

◆ createIdentifierMap()

◆ deleteFile()

◆ deleteFolder()

◆ determineBaseUrl()

◆ dumpFileContents()

◆ extractFileInformation()

◆ fileExists()

◆ fileExistsInFolder()

◆ folderExists()

◆ folderExistsInFolder()

◆ getAbsoluteBasePath()

◆ getAbsolutePath()

◆ getCharsetConversion()

◆ getDefaultFolder()

◆ getDirectoryItemList()

◆ getFileContents()

◆ getFileForLocalProcessing()

◆ getFileInfoByIdentifier()

◆ getFilesInFolder()

◆ getFolderInfoByIdentifier()

◆ getFolderInFolder()

◆ getFoldersInFolder()

◆ getMimeTypeOfFile()

◆ getPermissions()

◆ getPublicUrl()

◆ getRole()

◆ getRootLevelFolder()

◆ getSpecificFileInformation()

◆ hash()

◆ initialize()

◆ isFolderEmpty()

◆ isWithin()

◆ mergeConfigurationCapabilities()

◆ moveFileWithinStorage()

◆ moveFolderWithinStorage()

◆ processConfiguration()

◆ renameFile()

◆ renameFolder()

◆ replaceFile()

◆ sanitizeFileName()

◆ setFileContents()

Member Data Documentation

◆ $absoluteBasePath

◆ $baseUri

◆ $charsetConversion

◆ $mappingFolderNameToRole

◆ $supportedHashAlgorithms

◆ UNSAFE_FILENAME_CHARACTER_EXPRESSION