TYPO3 CMS  TYPO3_6-2
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\Resource\Driver\AbstractDriver Class Reference
Inheritance diagram for TYPO3\CMS\Core\Resource\Driver\AbstractDriver:
TYPO3\CMS\Core\Resource\Driver\DriverInterface TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver TYPO3\CMS\Core\Resource\Driver\LocalDriver

Public Member Functions

 __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
 processConfiguration ()
 
 initialize ()
 
 mergeConfigurationCapabilities ($capabilities)
 
 getRootLevelFolder ()
 
 getDefaultFolder ()
 
 getParentFolderIdentifierOfIdentifier ($fileIdentifier)
 
 getPublicUrl ($identifier)
 
 createFolder ($newFolderName, $parentFolderIdentifier='', $recursive=FALSE)
 
 renameFolder ($folderIdentifier, $newName)
 
 deleteFolder ($folderIdentifier, $deleteRecursively=FALSE)
 
 fileExists ($fileIdentifier)
 
 folderExists ($folderIdentifier)
 
 isFolderEmpty ($folderIdentifier)
 
 addFile ($localFilePath, $targetFolderIdentifier, $newFileName='', $removeOriginal=TRUE)
 
 createFile ($fileName, $parentFolderIdentifier)
 
 copyFileWithinStorage ($fileIdentifier, $targetFolderIdentifier, $fileName)
 
 renameFile ($fileIdentifier, $newName)
 
 replaceFile ($fileIdentifier, $localFilePath)
 
 deleteFile ($fileIdentifier)
 
 hash ($fileIdentifier, $hashAlgorithm)
 
 moveFileWithinStorage ($fileIdentifier, $targetFolderIdentifier, $newFileName)
 
 moveFolderWithinStorage ($sourceFolderIdentifier, $targetFolderIdentifier, $newFolderName)
 
 copyFolderWithinStorage ($sourceFolderIdentifier, $targetFolderIdentifier, $newFolderName)
 
 getFileContents ($fileIdentifier)
 
 setFileContents ($fileIdentifier, $contents)
 
 fileExistsInFolder ($fileName, $folderIdentifier)
 
 folderExistsInFolder ($folderName, $folderIdentifier)
 
 getFileForLocalProcessing ($fileIdentifier, $writable=TRUE)
 
 getPermissions ($identifier)
 
 dumpFileContents ($identifier)
 
 isWithin ($folderIdentifier, $identifier)
 
 getFileInfoByIdentifier ($fileIdentifier, array $propertiesToExtract=array())
 
 getFolderInfoByIdentifier ($folderIdentifier)
 
 getFilesInFolder ($folderIdentifier, $start=0, $numberOfItems=0, $recursive=FALSE, array $filenameFilterCallbacks=array())
 
 getFoldersInFolder ($folderIdentifier, $start=0, $numberOfItems=0, $recursive=FALSE, array $folderNameFilterCallbacks=array())
 

Protected Member Functions

 isValidFilename ($fileName)
 
 getTemporaryPathForFile ($fileIdentifier)
 
 canonicalizeAndCheckFilePath ($filePath)
 
 canonicalizeAndCheckFileIdentifier ($fileIdentifier)
 
 canonicalizeAndCheckFolderIdentifier ($folderIdentifier)
 

Protected Attributes

 $capabilities = 0
 
 $storageUid
 
 $supportedHashAlgorithms = array()
 
 $configuration = array()
 

Detailed Description

An abstract implementation of a storage driver.

Definition at line 25 of file AbstractDriver.php.

Constructor & Destructor Documentation

◆ __construct()

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

Creates this object.

Parameters
array$configuration

Definition at line 67 of file AbstractDriver.php.

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

Member Function Documentation

◆ canonicalizeAndCheckFileIdentifier()

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::canonicalizeAndCheckFileIdentifier (   $fileIdentifier)
abstractprotected

Makes sure the identifier given as parameter is valid

Parameters
string$fileIdentifierThe file Identifier
Returns
string
Exceptions

Referenced by TYPO3\CMS\Core\Resource\Driver\AbstractDriver\hashIdentifier(), and TYPO3\CMS\Core\Resource\Driver\AbstractDriver\isCaseSensitiveFileSystem().

◆ canonicalizeAndCheckFilePath()

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::canonicalizeAndCheckFilePath (   $filePath)
abstractprotected

Makes sure the path given as parameter is valid

Parameters
string$filePathThe file path (most times filePath)
Returns
string

Referenced by TYPO3\CMS\Core\Resource\Driver\AbstractDriver\isCaseSensitiveFileSystem().

◆ canonicalizeAndCheckFolderIdentifier()

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::canonicalizeAndCheckFolderIdentifier (   $folderIdentifier)
abstractprotected

Makes sure the identifier given as parameter is valid

Parameters
string$folderIdentifierThe folder identifier
Returns
string

Referenced by TYPO3\CMS\Core\Resource\Driver\AbstractDriver\isCaseSensitiveFileSystem().

◆ getCapabilities()

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::getCapabilities ( )

Returns the capabilities of this driver.

Returns
integer
See also
Storage::CAPABILITY_* constants

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

Definition at line 104 of file AbstractDriver.php.

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

◆ getTemporaryPathForFile()

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::getTemporaryPathForFile (   $fileIdentifier)
protected

Returns a temporary path for a given file, including the file extension.

Parameters
string$fileIdentifier
Returns
string

Definition at line 128 of file AbstractDriver.php.

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

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

◆ hasCapability()

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::hasCapability (   $capability)

Returns TRUE if this driver has the given capability.

Parameters
integer$capabilityA capability, as defined in a CAPABILITY_* constant
Returns
boolean

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

Definition at line 114 of file AbstractDriver.php.

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

◆ hashIdentifier()

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::hashIdentifier (   $identifier)

Hashes a file identifier, taking the case sensitivity of the file system into account. This helps mitigating problems with case-insensitive databases.

Parameters
string$identifier
Returns
string

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

Definition at line 140 of file AbstractDriver.php.

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

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

◆ isCaseSensitiveFileSystem()

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::isCaseSensitiveFileSystem ( )

Returns TRUE if this driver uses case-sensitive identifiers. NOTE: This is a configurable setting, but the setting does not change the way the underlying file system treats the identifiers; the setting should therefore always reflect the file system and not try to change its behaviour

Returns
boolean

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

Definition at line 166 of file AbstractDriver.php.

References TYPO3\CMS\Core\Resource\Driver\AbstractDriver\canonicalizeAndCheckFileIdentifier(), TYPO3\CMS\Core\Resource\Driver\AbstractDriver\canonicalizeAndCheckFilePath(), and TYPO3\CMS\Core\Resource\Driver\AbstractDriver\canonicalizeAndCheckFolderIdentifier().

Referenced by TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\canonicalizeAndCheckFileIdentifier().

◆ isValidFilename()

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::isValidFilename (   $fileName)
protected

Checks a fileName for validity. This could be overidden in concrete drivers if they have different file naming rules.

Parameters
string$fileName
Returns
boolean TRUE if file name is valid

Definition at line 78 of file AbstractDriver.php.

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

◆ sanitizeFileName()

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

Basic implementation of the method that does directly return the file name as is.

Parameters
string$fileNameInput string, typically the body of a fileName
string$charsetCharset 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

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

Definition at line 153 of file AbstractDriver.php.

◆ setStorageUid()

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::setStorageUid (   $storageUid)

Sets the storage uid the driver belongs to

Parameters
integer$storageUid
Returns
void

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

Definition at line 94 of file AbstractDriver.php.

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

Member Data Documentation

◆ $capabilities

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::$capabilities = 0
protected

Definition at line 36 of file AbstractDriver.php.

Referenced by TYPO3\CMS\Core\Resource\Driver\AbstractDriver\getCapabilities(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\mergeConfigurationCapabilities().

◆ $configuration

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::$configuration = array()
protected

Definition at line 60 of file AbstractDriver.php.

Referenced by TYPO3\CMS\Core\Resource\Driver\AbstractDriver\__construct(), and TYPO3\CMS\Core\Resource\Driver\LocalDriver\__construct().

◆ $storageUid

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::$storageUid
protected

Definition at line 44 of file AbstractDriver.php.

Referenced by TYPO3\CMS\Core\Resource\Driver\LocalDriver\getSpecificFileInformation(), and TYPO3\CMS\Core\Resource\Driver\AbstractDriver\setStorageUid().

◆ $supportedHashAlgorithms

TYPO3\CMS\Core\Resource\Driver\AbstractDriver::$supportedHashAlgorithms = array()
protected

Definition at line 53 of file AbstractDriver.php.